get-object-retention

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

Ncloud Storageオブジェクトに設定されているリテンション情報を照会します。

参考

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

構文

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

aws s3api get-object-retention \
    --bucket <bucket> \
    --key <key> \
    [--version-id <version-id>] \
    --endpoint-url <endpoint-url>

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

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

オプション	タイプ	必須の有無	説明
`--bucket`	String	Required	バケット名
`--key`	String	Required	オブジェクト名

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

オプション	タイプ	必須の有無	説明
`--version-id`	String	Optional	オブジェクトバージョン ID

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

リテンション設定の照会リクエストが成功すると、オブジェクトのリテンションモードとリテンション期限が返されます。

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

aws s3api get-object-retention --bucket my-locked-bucket \
    --key locked.txt \
    --endpoint-url=https://kr.ncloudstorage.com

出力の例は次の通りです。

{
    "Retention": {
        "Mode": "GOVERNANCE",
        "RetainUntilDate": "2026-08-25T00:00:00.000Z"
    }
}