aws s3api put-object-retention
Places an Object Retention configuration on an object. For more information, see Locking Objects. This action is not supported by Amazon S3 on Outposts
Options
| Name | Description |
|---|---|
--bucket <string> | The bucket name that contains the object you want to apply this Object Retention configuration to. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon S3 User Guide |
--key <string> | The key name for the object that you want to apply this Object Retention configuration to |
--retention <structure> | The container element for the Object Retention configuration |
--request-payer <string> | Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 Developer Guide |
--version-id <string> | The version ID for the object that you want to apply this Object Retention configuration to |
--bypass-governance-retention | Indicates whether this action should bypass Governance-mode restrictions |
--no-bypass-governance-retention | Indicates whether this action should bypass Governance-mode restrictions |
--content-md5 <string> | The MD5 hash for the request body. For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically |
--expected-bucket-owner <string> | The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error |
--cli-input-json <string> | Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally |
--generate-cli-skeleton <string> | Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command |