S3 / Client / get_object_legal_hold

get_object_legal_hold

S3.Client.get_object_legal_hold(**kwargs)

Note

This operation is not supported for directory buckets.

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

This functionality is not supported for 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',
    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) –

  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.

• 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

{
    '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.