Classic/VPC環境で利用できます。
Ncloud Storageオブジェクトにリーガルホールド(Legal Hold)状態を設定したり、解除したりします。
コマンド
コマンド構文は次の通りです。
aws s3api put-object-legal-hold --bucket <value> --key <value> --legal-hold <value> [--options]
パラメータ
パラメータの説明は次の通りです。
| パラメータ | タイプ | 必須の有無 | 説明 | 制限事項 |
|---|---|---|---|---|
| --bucket <value> | string | Y | オブジェクトが保存されているバケット | - |
| --key <value> | string | Y | リーガルホールドを設定するオブジェクトの名前 | - |
| --legal-hold <value> | structure | Y | 適用するリーガルホールドの状態 | JSON形式
|
| --endpoint-url <value> | string | Y | コマンド呼び出しのデフォルト URLを指定 | krリージョンのみ対応、呼び出しドメイン情報はNcloud Storageの概要を参照 |
| --version-id <value> | string | N | リーガルホールドを設定するオブジェクトのバージョン IDを指定 | - |
| --content-md5 <value> | string | N | リクエストボディの Base64エンコードされた MD5ハッシュ値 | 未入力の場合は自動計算 |
| --checksum-algorithm <value> | string | N | リクエストボディの検証に使用するチェックサムアルゴリズム | 選択可能なオプション
|
| --cli-input-json | --cli-input-yaml | string | N | 提供した jsonまたは yaml文字列で引数を入力 | jsonと yamlは一緒に指定できない |
| --generate-cli-skeleton <value> | integer | N | APIコマンドを実行せずに、後に inputとして使用できるパラメータテンプレートを作成 | - |
| --debug | boolean | N | デバッグロギングを使用 | - |
| --no-verify-ssl | boolean | N | SSL証明書を検証する基本動作を再定義 | - |
| --no-paginate | boolean | N | 自動 pagination無効化、結果に対して最初のページが一度だけ呼び出される | - |
| --output <value> | string | N | レスポンスの形式を指定 | 選択可能なオプション
|
| --query <value> | string | N | レスポンスデータの絞り込みに使用する JMESPathクエリ | - |
| --profile <value> | string | N | 認証情報ファイルで特定の profileを使用 | - |
| --region <value> | string | N | リージョンを指定 | krのみ対応 |
| --color <value> | string | N | output color設定 | 選択可能なオプション
|
| --no-sign-request | boolean | N | 認証情報のロードを無効化 | - |
| --ca-bundle <value> | string | N | SSL証明書の確認時に使用する CA証明書を指定 | - |
| --cli-read-timeout <value> | int | N | 最大読み取り時間、0を入力するとタイムアウトではなく、ブロック状態に変更される | デフォルトは60秒に設定 |
| --cli-connect-timeout <value> | int | N | 最大接続時間、0を入力するとタイムアウトではなく、ブロック状態に変更される | デフォルトは60秒に設定 |
| --no-cli-pager | boolean | N | レスポンスの cli pagerを無効化 | - |
| --cli-auto-prompt | boolean | N | CLI入力パラメータの自動プロンプト設定 | - |
| --no-cli-auto-prompt | boolean | N | CLI入力パラメータの自動プロンプトを無効化 | - |
権限
Sub Accountユーザーがこのコマンドを使用するには、Change/PutObjectLegalHoldアクションの権限が必要です。
例
put-object-legal-holdコマンドの呼び出し例を説明します。
リーガルホールドの設定
呼び出し例
put-object-legal-holdコマンドを呼び出すと、オブジェクトにリーガルホールド状態を設定または解除することができます。呼び出しのサンプルコードは次の通りです。
aws s3api put-object-legal-hold --bucket bucket-a --key object.csv --legal-hold '{"Status":"ON"}' --endpoint-url=https://kr.ncloudstorage.com
関連コマンド
関連コマンドは次の通りです。