Skip to content

S3  >  Operations  >  get_object

get_object

Operation

get_object async 

get_object(input: GetObjectInput, plugins: list[Plugin] | None = None) -> GetObjectOutput

Retrieves an object from Amazon S3.

In the GetObject request, specify the full key name for the object.

General purpose buckets - Both the virtual-hosted-style requests and the path-style requests are supported. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg, specify the object key name as /photos/2006/February/sample.jpg. For a path-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named examplebucket, specify the object key name as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host Header Bucket Specification in the Amazon S3 User Guide.

Directory buckets - Only virtual-hosted-style requests are supported. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named amzn-s3-demo-bucket--usw2-az1--x-s3, specify the object key name as /photos/2006/February/sample.jpg. Also, when you make requests to this API operation, your requests are sent to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name. Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.

Permissions
  • General purpose bucket permissions - You must have the required permissions in a policy. To use GetObject, you must have the READ access to the object (or version). If you grant READ access to the anonymous user, the GetObject operation returns the object without using an authorization header. For more information, see Specifying permissions in a policy in the Amazon S3 User Guide.

If you include a versionId in your request header, you must have the s3:GetObjectVersion permission to access a specific version of an object. The s3:GetObject permission is not required in this scenario.

If you request the current version of an object without a specific versionId in the request header, only the s3:GetObject permission is required. The s3:GetObjectVersion permission is not required in this scenario.

If the object that you request doesn't exist, the error that Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

  • If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 Not Found error.

  • If you don't have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 Access Denied error.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

    If the object is encrypted using SSE-KMS, you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key.

Storage classes

If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage class, the S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access tier, or the S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this operation returns an InvalidObjectState error. For information about restoring archived objects, see Restoring Archived Objects in the Amazon S3 User Guide.

Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones. Unsupported storage class values won't write a destination object and will respond with the HTTP status code 400 Bad Request.

Encryption

Encryption request headers, like x-amz-server-side-encryption, should not be sent for the GetObject requests, if your object uses server-side encryption with Amazon S3 managed encryption keys (SSE-S3), server-side encryption with Key Management Service (KMS) keys (SSE-KMS), or dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). If you include the header in your GetObject requests for the object that uses these types of keys, you'll get an HTTP 400 Bad Request error.

Directory buckets - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. SSE-C isn't supported. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide.

Overriding response header values through the request

There are times when you want to override certain response header values of a GetObject response. For example, you might override the Content-Disposition response header value through your GetObject request.

You can override values for a set of response headers. These modified response header values are included only in a successful response, that is, when the HTTP status code 200 OK is returned. The headers you can override using the following query parameters in the request are a subset of the headers that Amazon S3 accepts when you create an object.

The response headers that you can override for the GetObject response are Cache-Control, Content-Disposition, Content-Encoding, Content-Language, Content-Type, and Expires.

To override values for a set of response headers in the GetObject response, you can use the following query parameters in the request.

  • response-cache-control

  • response-content-disposition

  • response-content-encoding

  • response-content-language

  • response-content-type

  • response-expires

Note: When you use these parameters, you must sign the request by using either an Authorization header or a presigned URL. These parameters cannot be used with an unsigned (anonymous) request.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket-name.s3express-zone-id.region-code.amazonaws.com.

The following operations are related to GetObject:

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
input GetObjectInput

An instance of GetObjectInput.

 required
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

Returns:

Type Description
GetObjectOutput

An instance of GetObjectOutput.

Input

GetObjectInput dataclass

Bases: _SerdeShape

Dataclass for GetObjectInput structure.

Attributes

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

The bucket name containing the object.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

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.

Object Lambda access points - When you use this action with an Object Lambda access point, you must direct requests to the Object Lambda access point hostname. The Object Lambda access point hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.

Note

Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

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

To retrieve the checksum, this mode must be enabled.

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

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

Return the object only if its entity tag (ETag) is the same as the one specified in this header; otherwise, return a 412 Precondition Failed error.

If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; then, S3 returns 200 OK and the data requested.

For more information about conditional requests, see RFC 7232.

if_modified_since class-attribute instance-attribute 
if_modified_since: datetime | None = ...

Return the object only if it has been modified since the specified time; otherwise, return a 304 Not Modified error.

If both of the If-None-Match and If-Modified-Since headers are present in the request as follows:If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; then, S3 returns 304 Not Modified status code.

For more information about conditional requests, see RFC 7232.

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

Return the object only if its entity tag (ETag) is different from the one specified in this header; otherwise, return a 304 Not Modified error.

If both of the If-None-Match and If-Modified-Since headers are present in the request as follows:If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; then, S3 returns 304 Not Modified HTTP status code.

For more information about conditional requests, see RFC 7232.

if_unmodified_since class-attribute instance-attribute 
if_unmodified_since: datetime | None = ...

Return the object only if it has not been modified since the specified time; otherwise, return a 412 Precondition Failed error.

If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; then, S3 returns 200 OK and the data requested.

For more information about conditional requests, see RFC 7232.

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

Key of the object to get.

part_number class-attribute instance-attribute 
part_number: int | None = ...

Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.

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

Downloads the specified byte range of an object. For more information about the HTTP Range header, see https://www.rfc-editor.org/rfc/rfc9110.html#name-range.

Note

Amazon S3 doesn't support retrieving multiple ranges of data per GET request.

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.

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

Sets the Cache-Control header of the response.

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

Sets the Content-Disposition header of the response.

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

Sets the Content-Encoding header of the response.

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

Sets the Content-Language header of the response.

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

Sets the Content-Type header of the response.

response_expires class-attribute instance-attribute 
response_expires: datetime | None = ...

Sets the Expires header of the response.

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

Specifies the algorithm to use when decrypting the object (for example, AES256).

If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:

  • x-amz-server-side-encryption-customer-algorithm

  • x-amz-server-side-encryption-customer-key

  • x-amz-server-side-encryption-customer-key-MD5

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.

Note

This functionality is not supported for directory buckets.

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

Specifies the customer-provided encryption key that you originally provided for Amazon S3 to encrypt the data before storing it. This value is used to decrypt the object when recovering it and must match the one used when storing the data. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:

  • x-amz-server-side-encryption-customer-algorithm

  • x-amz-server-side-encryption-customer-key

  • x-amz-server-side-encryption-customer-key-MD5

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.

Note

This functionality is not supported for directory buckets.

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

Specifies the 128-bit MD5 digest of the customer-provided encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:

  • x-amz-server-side-encryption-customer-algorithm

  • x-amz-server-side-encryption-customer-key

  • x-amz-server-side-encryption-customer-key-MD5

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) 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 = ...

Version ID used to reference a specific version of the object.

By default, the GetObject operation returns the current version of an object. To return a different version, use the versionId subresource.

Note

  • If you include a versionId in your request header, you must have the s3:GetObjectVersion permission to access a specific version of an object. The s3:GetObject permission is not required in this scenario.

  • If you request the current version of an object without a specific versionId in the request header, only the s3:GetObject permission is required. The s3:GetObjectVersion permission is not required in this scenario.

  • Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request.

For more information about versioning, see PutBucketVersioning.

Output

GetObjectOutput dataclass

Bases: _SerdeShape

Dataclass for GetObjectOutput structure.

Attributes

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

Indicates that a range of bytes was specified in the request.

body class-attribute instance-attribute 
body: StreamingBlob = ...

Object data.

bucket_key_enabled class-attribute instance-attribute 
bucket_key_enabled: bool | None = ...

Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

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

Specifies caching behavior along the request/reply chain.

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

The Base64 encoded, 32-bit CRC32 checksum of the object. This checksum is only present if the checksum was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

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

The Base64 encoded, 32-bit CRC32C checksum of the object. This checksum is only present if the checksum was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

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

The Base64 encoded, 64-bit CRC64NVME checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

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

The Base64 encoded, 128-bit MD5 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

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

The Base64 encoded, 160-bit SHA1 digest of the object. This checksum is only present if the checksum was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

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

The Base64 encoded, 256-bit SHA256 digest of the object. This checksum is only present if the checksum was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

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

The Base64 encoded, 512-bit SHA512 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

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

The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header response to verify that the checksum type that is received is the same checksum type that was specified in the CreateMultipartUpload request. For more information, see Checking object integrity in the Amazon S3 User Guide.

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

The Base64 encoded, 128-bit XXHASH128 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

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

The Base64 encoded, 64-bit XXHASH3 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

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

The Base64 encoded, 64-bit XXHASH64 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

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

Specifies presentational information for the object.

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

Indicates what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

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

The language the content is in.

content_length class-attribute instance-attribute 
content_length: int | None = ...

Size of the body in bytes.

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

The portion of the object returned in the response.

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

A standard MIME type describing the format of the object data.

delete_marker class-attribute instance-attribute 
delete_marker: bool | None = ...

Indicates whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.

Note

  • If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response.

  • If the specified version in the request is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.

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

An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

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

If the object expiration is configured (see PutBucketLifecycleConfiguration ), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL-encoded.

Note

Object expiration information is not returned in directory buckets and this header returns the value "NotImplemented" in all responses for directory buckets.

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

The date and time at which the object is no longer cacheable.

last_modified class-attribute instance-attribute 
last_modified: datetime | None = ...

Date and time when the object was last modified.

General purpose buckets - When you specify a versionId of the object in your request, if the specified version in the request is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.

metadata class-attribute instance-attribute 
metadata: dict[str, str] | None = ...

A map of metadata to store with the object in S3.

missing_meta class-attribute instance-attribute 
missing_meta: int | None = ...

This is set to the number of metadata entries not returned in the headers that are prefixed with x-amz-meta-. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.

Note

This functionality is not supported for directory buckets.

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

The event hold status for this object. This header is only returned if the requester has the s3:GetObjectRetention permission.

Note

This functionality is not supported for directory buckets.

object_lock_event_hold_duration_days class-attribute instance-attribute 
object_lock_event_hold_duration_days: int | None = ...

The event hold duration in days for this object. Only returned when the event hold is enabled.

Note

This functionality is not supported for directory buckets.

object_lock_event_hold_duration_years class-attribute instance-attribute 
object_lock_event_hold_duration_years: int | None = ...

The event hold duration in years for this object. Only returned when the event hold is enabled.

Note

This functionality is not supported for directory buckets.

object_lock_legal_hold_status: str | None = ...

Indicates whether this object has an active legal hold. This field is only returned if you have permission to view an object's legal hold status.

Note

This functionality is not supported for directory buckets.

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

The Object Lock mode that's currently in place for this object.

Note

This functionality is not supported for directory buckets.

object_lock_retain_until_date class-attribute instance-attribute 
object_lock_retain_until_date: datetime | None = ...

The date and time when this object's Object Lock will expire.

Note

This functionality is not supported for directory buckets.

parts_count class-attribute instance-attribute 
parts_count: int | None = ...

The count of parts this object has. This value is only returned if you specify partNumber in your request and the object was uploaded as a multipart upload.

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

Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.

Note

This functionality is not supported for directory buckets.

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

If present, indicates that the requester was successfully charged for the request. For more information, see Using Requester Pays buckets for storage transfers and usage in the Amazon Simple Storage Service user guide.

Note

This functionality is not supported for directory buckets.

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.

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

Provides information about object restoration action and expiration time of the restored object copy.

Note

This functionality is not supported for directory buckets. Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.

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

The server-side encryption algorithm used when you store this object in Amazon S3 or Amazon FSx.

Note

When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is aws:fsx.

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

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.

Note

This functionality is not supported for directory buckets.

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

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

Note

This functionality is not supported for directory buckets.

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

If present, indicates the ID of the KMS key that was used for object encryption.

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

Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

Note

Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.

tag_count class-attribute instance-attribute 
tag_count: int | None = ...

The number of tags, if any, on the object, when you have the relevant permission to read object tags.

You can use GetObjectTagging to retrieve the tag set associated with an object.

Note

This functionality is not supported for directory buckets.

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

Version ID of the object.

Note

This functionality is not supported for directory buckets.

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

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

Note

This functionality is not supported for directory buckets.