put-object-retention

Classic/VPC環境で利用できます。

Ncloud Storageオブジェクトにリテンション設定を適用します。リテンションが設定されたオブジェクトは、指定された期限まで削除または変更することはできません。

参考

Sub Accountユーザーがこのコマンドを実行するには、Change/PutObjectRetentionアクションの権限が必要です。

構文

put-object-retention構文は次の通りです。

aws s3api put-object-retention \
    --bucket <bucket> \
    --key <key> \
    --retention <retention> \
    [--version-id <version-id>] \
    [--bypass-governance-retention | --no-bypass-governance-retention] \
    [--content-md5 <content-md5>] \
    [--checksum-algorithm <checksum-algorithm>] \
    --endpoint-url <endpoint-url>

オプション

put-object-retentionの実行時に指定できるオプションについて説明します。

必須オプション

put-object-retentionの必須オプションです。

オプション	タイプ	必須の有無	説明
`--bucket`	String	Required	バケット名
`--key`	String	Required	オブジェクト名
`--retention`	String	Required	オブジェクトのリテンション設定 JSON形式で入力 `Mode`: `GOVERNANCE` \| `COMPLIANCE` `RetainUntilDate`: リテンション期限。ISO 8601形式、未来の日時のみ指定可能空の JSON(`{}`)入力時、リテンションを解除

任意オプション

put-object-retentionの任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

オプション	タイプ	必須の有無	説明
`--version-id`	String	Optional	オブジェクトバージョン ID
`--bypass-governance-retention`	Boolean	Optional	`GOVERNANCE`モードリテンション設定のバイパスバイパス権限が必要
`--no-bypass-governance-retention`	Boolean	Optional	`GOVERNANCE`モードリテンション設定をバイパスしない
`--content-md5`	String	Optional	リクエストデータの Base64エンコードされた128ビット MD5ハッシュ値リクエストデータの整合性検証に使用未入力の場合、自動計算
`--checksum-algorithm`	String	Optional	リクエストデータ検証に使用するチェックサムアルゴリズム `CRC32` \| `CRC32C` \| `SHA1` \| `SHA256` \| `CRC64NVME`

共通オプション

awsコマンドで共通して使用するオプションについては、Ncloud Storageのオプションをご参照ください。

例

リテンションの設定リクエストが成功すると、設定が適用され、結果は出力されません。

コマンド

コマンドの例は次の通りです。

aws s3api put-object-retention --bucket my-locked-bucket \
    --key locked.txt \
    --retention '{"Mode":"GOVERNANCE","RetainUntilDate":"2026-08-25T00:00:00Z"}' \
    --endpoint-url=https://kr.ncloudstorage.com