put_object_retention¶
Operation¶
async
¶
put_object_retention(input: PutObjectRetentionInput, plugins: list[Plugin] | None = None) -> PutObjectRetentionOutput
Note
This operation is not supported for directory buckets.
Places an Object Retention configuration on an object. For more
information, see Locking
Objects.
Users or accounts require the s3:PutObjectRetention permission in
order to place an Object Retention configuration on objects. Bypassing a
Governance Retention configuration requires the
s3:BypassGovernanceRetention permission.
This functionality is not supported for Amazon S3 on Outposts.
Warning
You must URL encode any signed header values that contain spaces. For
example, if your header value is my file.txt, containing two spaces
after my, you must URL encode this value to my%20%20file.txt.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PutObjectRetentionInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
PutObjectRetentionOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for PutObjectRetentionInput structure.
Attributes¶
class-attribute
instance-attribute
¶
bucket: str | None = ...
The bucket name that contains the object you want to apply this Object Retention configuration to.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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 Amazon Web Services 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.
class-attribute
instance-attribute
¶
bypass_governance_retention: bool | None = ...
Indicates whether this action should bypass Governance-mode restrictions.
class-attribute
instance-attribute
¶
checksum_algorithm: str | None = ...
Indicates the algorithm used to create the checksum for the object when
you use the SDK. This header will not provide any additional
functionality if you don't use the SDK. When you send this header,
there must be a corresponding x-amz-checksum or x-amz-trailer header
sent. Otherwise, Amazon S3 fails the request with the HTTP status code
400 Bad Request. For more information, see Checking object
integrity
in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm parameter.
class-attribute
instance-attribute
¶
content_md5: str | None = ...
The MD5 hash for the request body.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
class-attribute
instance-attribute
¶
expected_bucket_owner: str | None = ...
The account ID of the expected bucket owner. If the account ID that you
provide does not match the actual owner of the bucket, the request fails
with the HTTP status code 403 Forbidden (access denied).
class-attribute
instance-attribute
¶
key: str | None = ...
The key name for the object that you want to apply this Object Retention configuration to.
class-attribute
instance-attribute
¶
request_payer: str | None = ...
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for the corresponding charges. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
Note
This functionality is not supported for directory buckets.
class-attribute
instance-attribute
¶
The container element for the Object Retention configuration.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for PutObjectRetentionOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
request_charged: str | None = ...
If present, indicates that the requester was successfully charged for the request. For more information, see Using Requester Pays buckets for storage transfers and usage in the Amazon Simple Storage Service user guide.
Note
This functionality is not supported for directory buckets.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.