GetObject
Retrieves objects from Amazon S3. To use
GET
, you must have
READ
access to the object. If you grant
READ
access to the anonymous user, you can
return the object without using an authorization header.
An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer
file system. You can, however, create a logical hierarchy by using object key names that
imply a folder structure. For example, instead of naming an object
sample.jpg
,
you can name it
photos/2006/February/sample.jpg
.
To get an object from such a logical hierarchy, specify the full key name for the object
in the
GET
operation. For a virtual hosted-style request example, if you have
the object
photos/2006/February/sample.jpg
, specify the resource 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 resource as
/examplebucket/photos/2006/February/sample.jpg
. For more information about
request types, see
HTTP Host
Header Bucket Specification
.
For more information about returning the ACL of an object, see GetObjectAcl .
If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval or
S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or
S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a
copy using
RestoreObject
. Otherwise, this action returns an
InvalidObjectState
error. For information about restoring archived objects,
see
Restoring
Archived Objects
.
Encryption request headers, like
x-amz-server-side-encryption
, should not
be sent for GET 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). If your object does use
these types of keys, you’ll get an HTTP 400 Bad Request 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-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) .
Assuming you have the relevant permission to read object tags, the response also returns
the
x-amz-tagging-count
header that provides the count of number of tags
associated with the object. You can use
GetObjectTagging
to retrieve
the tag set associated with an object.
You need the relevant read object (or version) permission for this operation.
For more information, see
Specifying Permissions in
a Policy
. 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.
By default, the
GET
action returns the current version of an
object. To return a different version, use the
versionId
subresource.
If you supply a
versionId
, you need the
s3:GetObjectVersion
permission to access a specific
version of an object. If you request a specific version, you do not need
to have the
s3:GetObject
permission. If you request the
current version without a specific version ID, only
s3:GetObject
permission is required.
s3:GetObjectVersion
permission won't be required.
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.
For more information about versioning, see PutBucketVersioning .
There are times when you want to override certain response header values in a
GET
response. For example, you might override the
Content-Disposition
response header value in your
GET
request.
You can override values for a set of response headers using the following query
parameters. These response header values are sent only on a successful request,
that is, when status code 200 OK is returned. The set of headers you can override
using these parameters is a subset of the headers that Amazon S3 accepts when you
create an object. The response headers that you can override for the
GET
response are
Content-Type
,
Content-Language
,
Expires
,
Cache-Control
,
Content-Disposition
, and
Content-Encoding
. To override these header values in the
GET
response, you use the following request parameters.
Note
You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request.
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.
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
response code.
For more information about conditional requests, see
RFC 7232
The following operations are related to
GetObject
:
Request Syntax
GET /Key+?partNumber=PartNumber&response-cache-control=ResponseCacheControl&response-content-disposition=ResponseContentDisposition&response-content-encoding=ResponseContentEncoding&response-content-language=ResponseContentLanguage&response-content-type=ResponseContentType&response-expires=ResponseExpires&versionId=VersionIdHTTP/1.1 Host:Bucket.s3.amazonaws.com If-Match:IfMatchIf-Modified-Since:IfModifiedSinceIf-None-Match:IfNoneMatchIf-Unmodified-Since:IfUnmodifiedSinceRange:Rangex-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-checksum-mode:ChecksumModeURI Request Parameters
The request uses the following URI parameters.
The bucket name containing the object.
When using this action with an access point, 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 AWS 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.
When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.
When you use this action with Amazon 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 through the AWS SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.Required: Yes
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.
Downloads the specified range bytes 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
GETrequest.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 Amazon 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.
Valid Values:
requesterSpecifies the customer-provided encryption key for Amazon S3 used to encrypt the data. 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-algorithmheader.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.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200 x-amz-delete-marker:DeleteMarkeraccept-ranges:AcceptRangesx-amz-expiration:Expirationx-amz-restore:RestoreLast-Modified:LastModifiedContent-Length:ContentLengthETag:ETagx-amz-checksum-crc32:ChecksumCRC32x-amz-checksum-crc32c:ChecksumCRC32Cx-amz-checksum-sha1:ChecksumSHA1x-amz-checksum-sha256:ChecksumSHA256x-amz-missing-meta:MissingMetax-amz-version-id:VersionIdCache-Control:CacheControlContent-Disposition:ContentDispositionContent-Encoding:ContentEncodingContent-Language:ContentLanguageContent-Range:ContentRangeContent-Type:ContentTypeExpires:Expiresx-amz-website-redirect-location:WebsiteRedirectLocationx-amz-server-side-encryption:ServerSideEncryptionx-amz-server-side-encryption-customer-algorithm:SSECustomerAlgorithmx-amz-server-side-encryption-customer-key-MD5:SSECustomerKeyMD5x-amz-server-side-encryption-aws-kms-key-id:SSEKMSKeyIdx-amz-server-side-encryption-bucket-key-enabled:BucketKeyEnabledx-amz-storage-class:StorageClassx-amz-request-charged:RequestChargedx-amz-replication-status:ReplicationStatusx-amz-mp-parts-count:PartsCountx-amz-tagging-count:TagCountx-amz-object-lock-mode:ObjectLockModex-amz-object-lock-retain-until-date:ObjectLockRetainUntilDatex-amz-object-lock-legal-hold:ObjectLockLegalHoldStatusResponse Elements
If the action is successful, the service sends back an HTTP 200 response.
The response returns the following HTTP headers.
Specifies 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.
The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the
expiry-dateandrule-idkey-value pairs providing object expiration information. The value of therule-idis URL-encoded.This is set to the number of metadata entries not returned in
x-amz-metaheaders. 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.The count of parts this object has. This value is only returned if you specify
partNumberin your request and the object was uploaded as a multipart upload.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.
Valid Values:
ON | OFFAmazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.
Valid Values:
COMPLETE | PENDING | FAILED | REPLICAThe server-side encryption algorithm used when storing this object in Amazon S3 (for example,
AES256,aws:kms,aws:kms:dsse).Valid Values:
AES256 | aws:kms | aws:kms:dsseIf present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric encryption customer managed key that was used for the object.
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.
Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
Valid Values:
STANDARD | REDUCED_REDUNDANCY | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS | GLACIER_IR | SNOWIf 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.
The following data is returned in binary format by the service.
GET /my-image.jpg HTTP/1.1 Host: bucket.s3.<Region>.amazonaws.com Date: Mon, 3 Oct 2016 22:32:00 GMT Authorization: authorization string HTTP/1.1 200 OK x-amz-id-2: eftixk72aD6Ap51TnqcoF8eFidJG9Z/2mkiDFu8yU9AS1ed4OpIszj7UDNEHGran x-amz-request-id: 318BC8BC148832E5 Date: Mon, 3 Oct 2016 22:32:00 GMT Last-Modified: Wed, 12 Oct 2009 17:50:00 GMT ETag: "fba9dede5f27731c9771645a39863328" Content-Length: 434234 [434234 bytes of object data]Sample Response: Object with associated tags
If the object had tags associated with it, Amazon S3 returns the
HTTP/1.1 200 OK x-amz-id-2: eftixk72aD6Ap51TnqcoF8eFidJG9Z/2mkiDFu8yU9AS1ed4OpIszj7UDNEHGran x-amz-request-id: 318BC8BC148832E5 Date: Mon, 3 Oct 2016 22:32:00 GMT Last-Modified: Wed, 12 Oct 2009 17:50:00 GMT ETag: "fba9dede5f27731c9771645a39863328" Content-Length: 434234 x-amz-tagging-count: 2 [434234 bytes of object data]x-amz-tagging-countheader with tag count.Sample Response: Object with an expiration
If the object had expiration set using lifecycle configuration, you get the following response with the
HTTP/1.1 200 OK x-amz-id-2: eftixk72aD6Ap51TnqcoF8eFidJG9Z/2mkiDFu8yU9AS1ed4OpIszj7UDNEHGran x-amz-request-id: 318BC8BC148832E5 Date: Wed, 28 Oct 2009 22:32:00 GMT Last-Modified: Wed, 12 Oct 2009 17:50:00 GMT x-amz-expiration: expiry-date="Fri, 23 Dec 2012 00:00:00 GMT", rule-id="picture-deletion-rule" ETag: "fba9dede5f27731c9771645a39863328" Content-Length: 434234 Content-Type: text/plain [434234 bytes of object data]x-amz-expirationheader.Sample Response if an object is archived in the S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes
If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes, you must first restore a copy using RestoreObject. Otherwise, this action returns an
HTTP/1.1 403 Forbidden x-amz-request-id: CD4BD8A1310A11B3 x-amz-id-2: m9RDbQU0+RRBTjOUN1ChQ1eqMUnr9dv8b+KP6I2gHfRJZSTSrMCoRP8RtPRzX9mb Content-Type: application/xml Date: Mon, 12 Nov 2012 23:53:21 GMT Server: Amazon S3 Content-Length: 231 <Error> <Code>InvalidObjectState</Code> <Message>The action is not valid for the object's storage class</Message> <RequestId>9FEFFF118E15B86F</RequestId> <HostId>WVQ5kzhiT+oiUfDCOiOYv8W4Tk9eNcxWi/MK+hTS/av34Xy4rBU3zsavf0aaaaa</HostId> </Error>InvalidObjectStateerror.Sample Response if an object is archived with the S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers
If the object you are retrieving is stored in the S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, you must first restore a copy using RestoreObject. Otherwise, this action returns an
HTTP/1.1 403 Forbidden x-amz-request-id: CB6AW8C4332B23B7 x-amz-id-2: n3RRfT90+PJDUhut3nhGW2ehfhfNU5f55c+a2ceCC36ab7c7fe3a71Q273b9Q45b1R5 Content-Type: application/xml Date: Mon, 12 Nov 2012 23:53:21 GMT Server: Amazon S3 Content-Length: 231 <Error> <Code>InvalidObjectState</Code> <Message>The action is not valid for the object's access tier</Message> <StorageClass>INTELLIGENT_TIERING</StorageClass> <AccessTier>ARCHIVE_ACCESS</AccessTier> <RequestId>9FEFFF118E15B86F</RequestId> <HostId>WVQ5kzhiT+oiUfDCOiOYv8W4Tk9eNcxWi/MK+hTS/av34Xy4rBU3zsavf0aaaaa</HostId> </Error>InvalidObjectStateerror. When restoring from Archive Access or Deep Archive Access tiers, the response will includeStorageClassandAccessTierelements. Access tier valid values areARCHIVE_ACCESSandDEEP_ARCHIVE_ACCESS. There is no syntax change if there is an ongoing restore.Sample Response if the Latest Object Is a Delete Marker
Notice that the delete marker returns a 404 Not Found error.
HTTP/1.1 404 Not Found x-amz-request-id: 318BC8BC148832E5 x-amz-id-2: eftixk72aD6Ap51Tnqzj7UDNEHGran x-amz-version-id: 3GL4kqtJlcpXroDTDm3vjVBH40Nr8X8g x-amz-delete-marker: true Date: Wed, 28 Oct 2009 22:32:00 GMT Content-Type: text/plain Connection: close Server: AmazonS3Sample Request: Getting a specified version of an object
The following request returns the specified version of an object.
GET /myObject?versionId=3/L4kqtJlcpXroDTDmpUMLUo HTTP/1.1 Host: bucket.s3.<Region>.amazonaws.com Date: Wed, 28 Oct 2009 22:32:00 GMT Authorization: authorization stringSample Response: To a versioned object GET request
This example illustrates one usage of GetObject.
HTTP/1.1 200 OK x-amz-id-2: eftixk72aD6Ap54OpIszj7UDNEHGran x-amz-request-id: 318BC8BC148832E5 Date: Wed, 28 Oct 2009 22:32:00 GMT Last-Modified: Sun, 1 Jan 2006 12:00:00 GMT x-amz-version-id: 3/L4kqtJlcpXroDTDmJ+rmSpXd3QBpUMLUo ETag: "fba9dede5f27731c9771645a39863328" Content-Length: 434234 Content-Type: text/plain Connection: close Server: AmazonS3 [434234 bytes of object data]Sample Request: Parameters altering response header values
The following request specifies all the query string parameters in a GET request overriding the response header values.
GET /Junk3.txt?response-cache-control=No-cache&response-content-disposition=attachment%3B%20filename%3Dtesting.txt&response-content-encoding=x-gzip&response-content-language=mi%2C%20en&response-expires=Thu%2C%2001%20Dec%201994%2016:00:00%20GMT HTTP/1.1 x-amz-date: Sun, 19 Dec 2010 01:53:44 GMT Accept: */* Authorization: AWS AKIAIOSFODNN7EXAMPLE:aaStE6nKnw8ihhiIdReoXYlMamW=Sample Response: With overridden response header values
The following request specifies all the query string parameters in a GET request overriding the response header values.
HTTP/1.1 200 OK x-amz-id-2: SIidWAK3hK+Il3/Qqiu1ZKEuegzLAAspwsgwnwygb9GgFseeFHL5CII8NXSrfWW2 x-amz-request-id: 881B1CBD9DF17WA1 Date: Sun, 19 Dec 2010 01:54:01 GMT x-amz-meta-param1: value 1 x-amz-meta-param2: value 2 Cache-Control: No-cache Content-Language: mi, en Expires: Thu, 01 Dec 1994 16:00:00 GMT Content-Disposition: attachment; filename=testing.txt Content-Encoding: x-gzip Last-Modified: Fri, 17 Dec 2010 18:10:41 GMT ETag: "0332bee1a7bf845f176c5c0d1ae7cf07" Accept-Ranges: bytes Content-Type: text/plain Content-Length: 22 Server: AmazonS3 [object data not shown]Sample Request: Range header
The following request specifies the HTTP Range header to retrieve the first 10 bytes of an object. For more information about the HTTP Range header, see https://www.rfc-editor.org/rfc/rfc9110.html#name-range
. GET /example-object HTTP/1.1 Host: example-bucket.s3.<Region>.amazonaws.com x-amz-date: Fri, 28 Jan 2011 21:32:02 GMT Range: bytes=0-9 Authorization: AWS AKIAIOSFODNN7EXAMPLE:Yxg83MZaEgh3OZ3l0rLo5RTX11o= Sample Response with Specified Range of the Object BytesNote
Amazon S3 doesn't support retrieving multiple ranges of data per
GETrequest.Sample Response
In the following sample response, note that the header values are set to the values specified in the true request.
HTTP/1.1 206 Partial Content x-amz-id-2: MzRISOwyjmnupCzjI1WC06l5TTAzm7/JypPGXLh0OVFGcJaaO3KW/hRAqKOpIEEp x-amz-request-id: 47622117804B3E11 Date: Fri, 28 Jan 2011 21:32:09 GMT x-amz-meta-title: the title Last-Modified: Fri, 28 Jan 2011 20:10:32 GMT ETag: "b2419b1e3fd45d596ee22bdf62aaaa2f" Accept-Ranges: bytes Content-Range: bytes 0-9/443 Content-Type: text/plain Content-Length: 10 Server: AmazonS3 [10 bytes of object data]Sample: Get an object stored using server-side encryption with customer-provided encryption keys
If an object is stored in Amazon S3 using server-side encryption with customer-provided encryption keys, Amazon S3 needs encryption information so that it can decrypt the object before sending it to you in response to a GET request. You provide the encryption information in your GET request using the relevant headers, as shown in the following example request.
GET /example-object HTTP/1.1 Host: example-bucket.s3.<Region>.amazonaws.com Accept: */* Authorization:authorization string Date: Wed, 28 May 2014 19:24:44 +0000 x-amz-server-side-encryption-customer-key:g0lCfA3Dv40jZz5SQJ1ZukLRFqtI5WorC/8SEKEXAMPLE x-amz-server-side-encryption-customer-key-MD5:ZjQrne1X/iTcskbY2m3example x-amz-server-side-encryption-customer-algorithm:AES256Sample Response
The following sample response shows some of the response headers Amazon S3 returns. Note that it includes the encryption information in the response.
HTTP/1.1 200 OK x-amz-id-2: ka5jRm8X3N12ZiY29Z989zg2tNSJPMcK+to7jNjxImXBbyChqc6tLAv+sau7Vjzh x-amz-request-id: 195157E3E073D3F9 Date: Wed, 28 May 2014 19:24:45 GMT Last-Modified: Wed, 28 May 2014 19:21:01 GMT ETag: "c12022c9a3c6d3a28d29d90933a2b096" x-amz-server-side-encryption-customer-algorithm: AES256 x-amz-server-side-encryption-customer-key-MD5: ZjQrne1X/iTcskbY2m3example