S3 / Client / put_object_retention

put_object_retention#

S3.Client.put_object_retention(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.put_object_retention(
    Bucket='string',
    Key='string',
    Retention={
        'Mode': 'GOVERNANCE'|'COMPLIANCE',
        'RetainUntilDate': datetime(2015, 1, 1)
    },
    RequestPayer='requester',
    VersionId='string',
    BypassGovernanceRetention=True|False,
    ContentMD5='string',
    ChecksumAlgorithm='CRC32'|'CRC32C'|'SHA1'|'SHA256',
    ExpectedBucketOwner='string'
)
Parameters:

  • Bucket (string) –

    [REQUIRED]

    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, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. 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.

  • Key (string) –

    [REQUIRED]

    The key name for the object that you want to apply this Object Retention configuration to.

  • Retention (dict) –

    The container element for the Object Retention configuration.

    • Mode (string) –

      Indicates the Retention mode for the specified object.

    • RetainUntilDate (datetime) –

      The date on which this Object Lock Retention will expire.

  • RequestPayer (string) –

    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 corresponding charges to copy the object. 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.

  • VersionId (string) – The version ID for the object that you want to apply this Object Retention configuration to.

  • BypassGovernanceRetention (boolean) – Indicates whether this action should bypass Governance-mode restrictions.

  • ContentMD5 (string) –

    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.

  • ChecksumAlgorithm (string) –

    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.

  • ExpectedBucketOwner (string) – 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).

Return type:

dict

Returns:

Response Syntax

{
    'RequestCharged': 'requester'
}

Response Structure

  • (dict) –

    • RequestCharged (string) –

      If present, indicates that the requester was successfully charged for the request.

      Note

      This functionality is not supported for directory buckets.