Documentation Amazon Simple Storage Service (S3)API Reference

Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetObjectAttributes

Retrieves all of the metadata from an object without returning the object itself. This operation is useful if you're interested only in an object's metadata.

GetObjectAttributes combines the functionality ofHeadObject andListParts. All of the data returned with both of those individual calls can be returned with a single call toGetObjectAttributes.

Note

Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the formathttps://amzn-s3-demo-bucket.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 theAmazon S3 User Guide. For more information about endpoints in Local Zones, seeConcepts for directory buckets in Local Zones in theAmazon S3 User Guide.

Permissions

General purpose bucket permissions - To useGetObjectAttributes, you must have READ access to the object.
The other permissions that you need to use this operation depend on whether the bucket is versioned and if a version ID is passed in theGetObjectAttributes request.
- If you pass a version ID in your request, you need both thes3:GetObjectVersion ands3:GetObjectVersionAttributes permissions.
- If you do not pass a version ID in your request, you need thes3:GetObject ands3:GetObjectAttributes permissions.
For more information, seeSpecifying Permissions in a Policy in theAmazon S3 User Guide.
If the object that you request does not exist, the error Amazon S3 returns depends on whether you also have thes3:ListBucket permission.
- If you have thes3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code404 Not Found ("no such key") error.
- If you don't have thes3:ListBucket permission, Amazon S3 returns an HTTP status code403 Forbidden ("access denied") error.
Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use theCreateSession API operation for session-based authorization. Specifically, you grant thes3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make theCreateSession 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 anotherCreateSession API call to generate a new session token for use. AWS CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, seeCreateSession.
If the object is encrypted with SSE-KMS, you must also have thekms:GenerateDataKey andkms:Decrypt permissions in IAM identity-based policies and AWS KMS key policies for the AWS KMS key.

Encryption

Note

Encryption request headers, likex-amz-server-side-encryption, should not be sent forHEAD requests if your object uses server-side encryption with AWS Key Management Service (AWS KMS) keys (SSE-KMS), dual-layer server-side encryption with AWS KMS keys (DSSE-KMS), or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). Thex-amz-server-side-encryption header is used when youPUT an object to S3 and want to specify the encryption method. If you include this header in aGET request for an object that uses these types of keys, you’ll get an HTTP400 Bad Request error. It's because the encryption method can't be changed when you retrieve the object.

If you encrypted an object when you stored the object in Amazon S3 by using server-side encryption with customer-provided encryption keys (SSE-C), then when you retrieve the metadata from the object, you must use the following headers. These headers provide the server with the encryption key required to retrieve the object's metadata. The headers are:

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 theAmazon S3 User Guide.

Note

Directory bucket permissions - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with AWS KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in yourCreateSession requests orPUT object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see Protecting data with server-side encryption in theAmazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, seeSpecifying server-side encryption with AWS KMS for new object uploads.

Versioning

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

Conditional request headers

Consider the following when using request headers:

If both of theIf-Match andIf-Unmodified-Since headers are present in the request as follows, then Amazon S3 returns the HTTP status code200 OK and the data requested:
- If-Match condition evaluates totrue.
- If-Unmodified-Since condition evaluates tofalse.
For more information about conditional requests, seeRFC 7232 .
If both of theIf-None-Match andIf-Modified-Since headers are present in the request as follows, then Amazon S3 returns the HTTP status code304 Not Modified:
- If-None-Match condition evaluates tofalse.
- If-Modified-Since condition evaluates totrue.
For more information about conditional requests, seeRFC 7232 .

HTTP Host header syntax

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

The following actions are related toGetObjectAttributes:

Important

You must URL encode any signed header values that contain spaces. For example, if your header value ismy file.txt, containing two spaces aftermy, you must URL encode this value tomy%20%20file.txt.

Request Syntax


GET /{Key+}?attributes&versionId=VersionId HTTP/1.1Host:Bucket.s3.amazonaws.comx-amz-max-parts:MaxPartsx-amz-part-number-marker:PartNumberMarkerx-amz-server-side-encryption-customer-algorithm:SSECustomerAlgorithmx-amz-server-side-encryption-customer-key:SSECustomerKeyx-amz-server-side-encryption-customer-key-MD5:SSECustomerKeyMD5x-amz-request-payer:RequestPayerx-amz-expected-bucket-owner:ExpectedBucketOwnerx-amz-object-attributes:ObjectAttributes

URI Request Parameters

The request uses the following URI parameters.

Bucket

The name of the bucket that contains the object.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the formatBucket-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 formatbucket-base-name--zone-id--x-s3 (for example,amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, seeDirectory bucket naming rules in theAmazon 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 formAccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, seeUsing access points in theAmazon S3 User Guide.

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 formAccessPointName-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 theAmazon S3 User Guide.

Required: Yes

Key

The object key.

Length Constraints: Minimum length of 1.

Required: Yes

versionId

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

Note

S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only thenull value of the version ID is supported by directory buckets. You can only specifynull to theversionId query parameter in the request.

x-amz-expected-bucket-owner

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 code403 Forbidden (access denied).

x-amz-max-parts

Sets the maximum number of parts to return. For more information, seeUploading and copying objects using multipart upload in Amazon S3 in theAmazon Simple Storage Service user guide.

x-amz-object-attributes

Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.

Valid Values:ETag | Checksum | ObjectParts | StorageClass | ObjectSize

Required: Yes

x-amz-part-number-marker

Specifies the part after which listing should begin. Only parts with higher part numbers will be listed. For more information, seeUploading and copying objects using multipart upload in Amazon S3 in theAmazon Simple Storage Service user guide.

x-amz-request-payer

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, seeDownloading Objects in Requester Pays Buckets in theAmazon S3 User Guide.

Note

This functionality is not supported for directory buckets.

Valid Values:requester

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

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

Note

This functionality is not supported for directory buckets.

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

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in thex-amz-server-side-encryption-customer-algorithm header.

Note

This functionality is not supported for directory buckets.

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

Specifies the 128-bit MD5 digest of the 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.

Note

This functionality is not supported for directory buckets.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200x-amz-delete-marker:DeleteMarkerLast-Modified:LastModifiedx-amz-version-id:VersionIdx-amz-request-charged:RequestCharged<?xml version="1.0" encoding="UTF-8"?><GetObjectAttributesResponse>   <ETag>string</ETag>   <Checksum>      <ChecksumCRC32>string</ChecksumCRC32>      <ChecksumCRC32C>string</ChecksumCRC32C>      <ChecksumCRC64NVME>string</ChecksumCRC64NVME>      <ChecksumSHA1>string</ChecksumSHA1>      <ChecksumSHA256>string</ChecksumSHA256>      <ChecksumType>string</ChecksumType>   </Checksum>   <ObjectParts>      <IsTruncated>boolean</IsTruncated>      <MaxParts>integer</MaxParts>      <NextPartNumberMarker>integer</NextPartNumberMarker>      <PartNumberMarker>integer</PartNumberMarker>      <Part>         <ChecksumCRC32>string</ChecksumCRC32>         <ChecksumCRC32C>string</ChecksumCRC32C>         <ChecksumCRC64NVME>string</ChecksumCRC64NVME>         <ChecksumSHA1>string</ChecksumSHA1>         <ChecksumSHA256>string</ChecksumSHA256>         <PartNumber>integer</PartNumber>         <Size>long</Size>      </Part>      ...      <PartsCount>integer</PartsCount>   </ObjectParts>   <StorageClass>string</StorageClass>   <ObjectSize>long</ObjectSize></GetObjectAttributesResponse>

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The response returns the following HTTP headers.

Last-Modified

Date and time when the object was last modified.

x-amz-delete-marker

Specifies whether the object retrieved was (true) or was not (false) a delete marker. Iffalse, this response header does not appear in the response. To learn more about delete markers, seeWorking with delete markers.

Note

This functionality is not supported for directory buckets.

x-amz-request-charged

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