S3 / Client / put_object_legal_hold

put_object_legal_hold

S3.Client.put_object_legal_hold(**kwargs)

Applies a legal hold configuration to the specified object. For more information, see Locking Objects.

This action is not supported by Amazon S3 on Outposts.

See also: AWS API Documentation

Request Syntax

response = client.put_object_legal_hold(
    Bucket='string',
    Key='string',
    LegalHold={
        'Status': 'ON'|'OFF'
    },
    RequestPayer='requester',
    VersionId='string',
    ContentMD5='string',
    ExpectedBucketOwner='string'
)

Parameters:

• Bucket (string) –

  [REQUIRED]

  The bucket name containing the object that you want to place a legal hold on.

  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 place a Legal Hold on.

• LegalHold (dict) –

  Container element for the Legal Hold configuration you want to apply to the specified object.

  • Status (string) –

    Indicates whether the specified object has a Legal Hold in place.

• RequestPayer (string) – Ignored by COS if present.

• VersionId (string) – The version ID of the object that you want to place a Legal Hold on.

• ContentMD5 (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.

• 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.