Available in Classic and VPC
Set retention on an Ncloud Storage object.
Commands
The command statement is as follows:
aws s3api put-object-retention --bucket <value> --key <value> --retention <value> [--options]
Parameter
The following describes the parameters.
| Parameter | Type | Required | Description | Restrictions |
|---|---|---|---|---|
| --bucket <value> | string | Y | Target bucket where the object is stored | - |
| --key <value> | string | Y | Name of the object for which retention is to be set | - |
| --retention <value> | structure | Y | Retention settings to apply | JSON structure
|
| --endpoint-url <value> | string | Y | Specify the default URL for command calls. | It is only available for the KR Region. See Ncloud Storage overview for call domain information. |
| --version-id <value> | string | N | Specify the version ID of the object for which you want to set retention. | - |
| --bypass-governance-retention | --no-bypass-governance-retention | boolean | N | Whether to bypass GOVERNANCE retention mode | Separate bypass permissions required. |
| --content-md5 <value> | string | N | Base64-encoded MD5 hash of the request body | Calculated automatically if left blank. |
| --checksum-algorithm <value> | string | N | Checksum algorithm to use for validating the request body | Available options
|
| --cli-input-json | --cli-input-yaml | string | N | Enter arguments from the provided json or yaml string. | You can't specify json and yaml together. |
| --generate-cli-skeleton <value> | integer | N | Create a parameter template that can be used as input later without executing the API command. | - |
| --debug | boolean | N | Use debug logging. | - |
| --no-verify-ssl | boolean | N | Redefine the default behavior for validating SSL certificates. | - |
| --no-paginate | boolean | N | Disable automatic pagination, call only the first page for results. | - |
| --output <value> | string | N | Specify the format of response results. | Available options
|
| --query <value> | string | N | JMESPath query to use for filtering response data | - |
| --profile <value> | string | N | Use a specific profile in the credentials file. | - |
| --region <value> | string | N | Specify the Region. | Only KR is supported. |
| --color <value> | string | N | Set output color. | Available options
|
| --no-sign-request | boolean | N | Disable credential loading. | - |
| --ca-bundle <value> | string | N | Specify the CA certificate to use when verifying SSL certificates. | - |
| --cli-read-timeout <value> | int | N | Maximum read time; entering 0 changes it to a blocked status instead of a timeout. | It is set to 60 seconds by default. |
| --cli-connect-timeout <value> | int | N | Maximum connection time; entering 0 changes it to a blocked status instead of a timeout. | It is set to 60 seconds by default. |
| --no-cli-pager | boolean | N | Disable the CLI pager for response values. | - |
| --cli-auto-prompt | boolean | N | Enable automatic prompting for CLI input parameters. | - |
| --no-cli-auto-prompt | boolean | N | Disable automatic prompting for CLI input parameters. | - |
Permissions
If a sub account user wants to use this command, they need the Change/PutObjectRetention action permission.
Examples
This section describes examples of calls to the put-object-retention command.
Apply retention settings
Call examples
You can set the retention mode and expiration date for an object by calling the put-object-retention command. The following is a call example.
aws s3api put-object-retention --bucket bucket-a --key object.csv --retention '{"Mode":"GOVERNANCE","RetainUntilDate":"2025-12-31T00:00:00"}' --endpoint-url=https://kr.ncloudstorage.com
Related commands
Related commands are as follows: