S3 / Client / get_object_legal_hold

get_object_legal_hold

S3.Client.get_object_legal_hold(**kwargs)

Gets an object’s current legal hold status. For more information, see Locking Objects.

This action is not supported by Amazon S3 on Outposts.

The following action is related to GetObjectLegalHold:

• GetObjectAttributes

See also: AWS API Documentation

Request Syntax

response = client.get_object_legal_hold(
    Bucket='string',
    Key='string',
    VersionId='string',
    RequestPayer='requester',
    ContentMD5='string',
    ExpectedBucketOwner='string'
)

Parameters:

• Bucket (string) –

  [REQUIRED]

  The bucket name containing the object whose legal hold status you want to retrieve.

  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 whose Legal Hold status you want to retrieve.

• VersionId (string) – The version ID of the object whose Legal Hold status you want to retrieve.

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

• ContentMD5 (string) –

  The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.

  For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

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

Return type:

dict

Returns:

Response Syntax

{
    'LegalHold': {
        'Status': 'ON'|'OFF'
    }
}

Response Structure

• (dict) –

  • LegalHold (dict) –

    The current Legal Hold status for the specified object.

    • Status (string) –

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