put-object-legal-hold

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

Ncloud Storageオブジェクトにリーガルホールドの状態を設定または解除します。リーガルホールドが設定されたオブジェクトは、リテンション期限に関わらず削除または変更を行うことができません。

参考

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

構文

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

aws s3api put-object-legal-hold \
    --bucket <bucket> \
    --key <key> \
    --legal-hold <legal-hold> \
    [--version-id <version-id>] \
    [--content-md5 <content-md5>] \
    [--checksum-algorithm <checksum-algorithm>] \
    --endpoint-url <endpoint-url>

オプション

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

必須オプション

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

オプション	タイプ	必須の有無	説明
`--bucket`	String	Required	バケット名
`--key`	String	Required	オブジェクト名
`--legal-hold`	String	Required	リーガルホールド設定 JSON形式で入力 `Status`: リーガルホールドを適用するか `ON` \| `OFF`

任意オプション

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

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

共通オプション

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

例

リーガルホールドの設定リクエストが成功すると、設定が適用され、結果は出力されません。

コマンド

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

aws s3api put-object-legal-hold --bucket my-locked-bucket \
    --key locked.txt \
    --legal-hold Status=ON \
    --endpoint-url=https://kr.ncloudstorage.com