Skip to content

get_object_legal_hold

Operation

get_object_legal_hold(request: GetObjectLegalHoldInput | GetObjectLegalHoldInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetObjectLegalHoldInputDict]) -> GetObjectLegalHoldOutput
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:

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
request GetObjectLegalHoldInput | GetObjectLegalHoldInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetObjectLegalHoldInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetObjectLegalHoldOutput

An instance of GetObjectLegalHoldOutput.

get_object_legal_hold(request: GetObjectLegalHoldInput | GetObjectLegalHoldInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetObjectLegalHoldInputDict]) -> GetObjectLegalHoldOutput
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:

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
request GetObjectLegalHoldInput | GetObjectLegalHoldInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetObjectLegalHoldInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetObjectLegalHoldOutput

An instance of GetObjectLegalHoldOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetObjectLegalHoldInputDict

Bases: TypedDict

Dictionary form of GetObjectLegalHoldInput.

Attributes

bucket instance-attribute
bucket: Required[str]

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

expected_bucket_owner 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).

key instance-attribute
key: Required[str]

The key name for the object whose legal hold status you want to retrieve.

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

version_id instance-attribute
version_id: str | None

The version ID of the object whose legal hold status you want to retrieve.

GetObjectLegalHoldInput dataclass

Bases: _SerdeShape

Dataclass for GetObjectLegalHoldInput structure.

Attributes

bucket class-attribute instance-attribute
bucket: str | None = ...

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

expected_bucket_owner 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).

key class-attribute instance-attribute
key: str | None = ...

The key name for the object whose legal hold status you want to retrieve.

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

version_id class-attribute instance-attribute
version_id: str | None = ...

The version ID of the object whose legal hold status you want to retrieve.

Output

GetObjectLegalHoldOutput dataclass

Bases: _SerdeShape

Dataclass for GetObjectLegalHoldOutput structure.

Attributes

legal_hold class-attribute instance-attribute
legal_hold: ObjectLockLegalHold | None = ...

The current legal hold status for the specified object.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.