| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.S3.GetObject
Description
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 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 InvalidObjectStateError 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 KMS keys (SSE-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 BadRequest 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).
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.
Permissions
You need the relevant read object (or version) permission for this
operation. For more information, see
Specifying Permissions in a Policy.
If the object you request does not exist, the error Amazon S3 returns
depends on whether you also have the s3:ListBucket permission.
- If you have the
s3:ListBucketpermission on the bucket, Amazon S3 will return an HTTP status code 404 ("no such key") error. - If you don’t have the
s3:ListBucketpermission, Amazon S3 will return an HTTP status code 403 ("access denied") error.
Versioning
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 thes3:GetObjectVersionpermission to access a specific version of an object. If you request a specific version, you do not need to have thes3:GetObjectpermission. - 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: truein the response.
For more information about versioning, see PutBucketVersioning.
Overriding Response Header Values
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.
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.
response-content-type
response-content-language
response-expires
response-cache-control
response-content-disposition
response-content-encoding
Additional Considerations about Request Headers
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:
Synopsis
- data GetObject = GetObject' {
- checksumMode :: Maybe ChecksumMode
- expectedBucketOwner :: Maybe Text
- ifMatch :: Maybe Text
- ifModifiedSince :: Maybe RFC822
- ifNoneMatch :: Maybe Text
- ifUnmodifiedSince :: Maybe RFC822
- partNumber :: Maybe Int
- range :: Maybe Text
- requestPayer :: Maybe RequestPayer
- responseCacheControl :: Maybe Text
- responseContentDisposition :: Maybe Text
- responseContentEncoding :: Maybe Text
- responseContentLanguage :: Maybe Text
- responseContentType :: Maybe Text
- responseExpires :: Maybe RFC822
- sSECustomerAlgorithm :: Maybe Text
- sSECustomerKey :: Maybe (Sensitive Text)
- sSECustomerKeyMD5 :: Maybe Text
- versionId :: Maybe ObjectVersionId
- bucket :: BucketName
- key :: ObjectKey
- newGetObject :: BucketName -> ObjectKey -> GetObject
- getObject_checksumMode :: Lens' GetObject (Maybe ChecksumMode)
- getObject_expectedBucketOwner :: Lens' GetObject (Maybe Text)
- getObject_ifMatch :: Lens' GetObject (Maybe Text)
- getObject_ifModifiedSince :: Lens' GetObject (Maybe UTCTime)
- getObject_ifNoneMatch :: Lens' GetObject (Maybe Text)
- getObject_ifUnmodifiedSince :: Lens' GetObject (Maybe UTCTime)
- getObject_partNumber :: Lens' GetObject (Maybe Int)
- getObject_range :: Lens' GetObject (Maybe Text)
- getObject_requestPayer :: Lens' GetObject (Maybe RequestPayer)
- getObject_responseCacheControl :: Lens' GetObject (Maybe Text)
- getObject_responseContentDisposition :: Lens' GetObject (Maybe Text)
- getObject_responseContentEncoding :: Lens' GetObject (Maybe Text)
- getObject_responseContentLanguage :: Lens' GetObject (Maybe Text)
- getObject_responseContentType :: Lens' GetObject (Maybe Text)
- getObject_responseExpires :: Lens' GetObject (Maybe UTCTime)
- getObject_sSECustomerAlgorithm :: Lens' GetObject (Maybe Text)
- getObject_sSECustomerKey :: Lens' GetObject (Maybe Text)
- getObject_sSECustomerKeyMD5 :: Lens' GetObject (Maybe Text)
- getObject_versionId :: Lens' GetObject (Maybe ObjectVersionId)
- getObject_bucket :: Lens' GetObject BucketName
- getObject_key :: Lens' GetObject ObjectKey
- data GetObjectResponse = GetObjectResponse' {
- acceptRanges :: Maybe Text
- bucketKeyEnabled :: Maybe Bool
- cacheControl :: Maybe Text
- checksumCRC32 :: Maybe Text
- checksumCRC32C :: Maybe Text
- checksumSHA1 :: Maybe Text
- checksumSHA256 :: Maybe Text
- contentDisposition :: Maybe Text
- contentEncoding :: Maybe Text
- contentLanguage :: Maybe Text
- contentLength :: Maybe Integer
- contentRange :: Maybe Text
- contentType :: Maybe Text
- deleteMarker :: Maybe Bool
- eTag :: Maybe ETag
- expiration :: Maybe Text
- expires :: Maybe RFC822
- lastModified :: Maybe RFC822
- metadata :: HashMap Text Text
- missingMeta :: Maybe Int
- objectLockLegalHoldStatus :: Maybe ObjectLockLegalHoldStatus
- objectLockMode :: Maybe ObjectLockMode
- objectLockRetainUntilDate :: Maybe ISO8601
- partsCount :: Maybe Int
- replicationStatus :: Maybe ReplicationStatus
- requestCharged :: Maybe RequestCharged
- restore :: Maybe Text
- sSECustomerAlgorithm :: Maybe Text
- sSECustomerKeyMD5 :: Maybe Text
- sSEKMSKeyId :: Maybe (Sensitive Text)
- serverSideEncryption :: Maybe ServerSideEncryption
- storageClass :: Maybe StorageClass
- tagCount :: Maybe Int
- versionId :: Maybe ObjectVersionId
- websiteRedirectLocation :: Maybe Text
- httpStatus :: Int
- body :: ResponseBody
- newGetObjectResponse :: Int -> ResponseBody -> GetObjectResponse
- getObjectResponse_acceptRanges :: Lens' GetObjectResponse (Maybe Text)
- getObjectResponse_bucketKeyEnabled :: Lens' GetObjectResponse (Maybe Bool)
- getObjectResponse_cacheControl :: Lens' GetObjectResponse (Maybe Text)
- getObjectResponse_checksumCRC32 :: Lens' GetObjectResponse (Maybe Text)
- getObjectResponse_checksumCRC32C :: Lens' GetObjectResponse (Maybe Text)
- getObjectResponse_checksumSHA1 :: Lens' GetObjectResponse (Maybe Text)
- getObjectResponse_checksumSHA256 :: Lens' GetObjectResponse (Maybe Text)
- getObjectResponse_contentDisposition :: Lens' GetObjectResponse (Maybe Text)
- getObjectResponse_contentEncoding :: Lens' GetObjectResponse (Maybe Text)
- getObjectResponse_contentLanguage :: Lens' GetObjectResponse (Maybe Text)
- getObjectResponse_contentLength :: Lens' GetObjectResponse (Maybe Integer)
- getObjectResponse_contentRange :: Lens' GetObjectResponse (Maybe Text)
- getObjectResponse_contentType :: Lens' GetObjectResponse (Maybe Text)
- getObjectResponse_deleteMarker :: Lens' GetObjectResponse (Maybe Bool)
- getObjectResponse_eTag :: Lens' GetObjectResponse (Maybe ETag)
- getObjectResponse_expiration :: Lens' GetObjectResponse (Maybe Text)
- getObjectResponse_expires :: Lens' GetObjectResponse (Maybe UTCTime)
- getObjectResponse_lastModified :: Lens' GetObjectResponse (Maybe UTCTime)
- getObjectResponse_metadata :: Lens' GetObjectResponse (HashMap Text Text)
- getObjectResponse_missingMeta :: Lens' GetObjectResponse (Maybe Int)
- getObjectResponse_objectLockLegalHoldStatus :: Lens' GetObjectResponse (Maybe ObjectLockLegalHoldStatus)
- getObjectResponse_objectLockMode :: Lens' GetObjectResponse (Maybe ObjectLockMode)
- getObjectResponse_objectLockRetainUntilDate :: Lens' GetObjectResponse (Maybe UTCTime)
- getObjectResponse_partsCount :: Lens' GetObjectResponse (Maybe Int)
- getObjectResponse_replicationStatus :: Lens' GetObjectResponse (Maybe ReplicationStatus)
- getObjectResponse_requestCharged :: Lens' GetObjectResponse (Maybe RequestCharged)
- getObjectResponse_restore :: Lens' GetObjectResponse (Maybe Text)
- getObjectResponse_sSECustomerAlgorithm :: Lens' GetObjectResponse (Maybe Text)
- getObjectResponse_sSECustomerKeyMD5 :: Lens' GetObjectResponse (Maybe Text)
- getObjectResponse_sSEKMSKeyId :: Lens' GetObjectResponse (Maybe Text)
- getObjectResponse_serverSideEncryption :: Lens' GetObjectResponse (Maybe ServerSideEncryption)
- getObjectResponse_storageClass :: Lens' GetObjectResponse (Maybe StorageClass)
- getObjectResponse_tagCount :: Lens' GetObjectResponse (Maybe Int)
- getObjectResponse_versionId :: Lens' GetObjectResponse (Maybe ObjectVersionId)
- getObjectResponse_websiteRedirectLocation :: Lens' GetObjectResponse (Maybe Text)
- getObjectResponse_httpStatus :: Lens' GetObjectResponse Int
- getObjectResponse_body :: Lens' GetObjectResponse ResponseBody
Creating a Request
See: newGetObject smart constructor.
Constructors
| GetObject' | |
Fields
| |
Instances
Arguments
| :: BucketName | |
| -> ObjectKey | |
| -> GetObject |
Create a value of GetObject with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:checksumMode:GetObject', getObject_checksumMode - To retrieve the checksum, this mode must be enabled.
$sel:expectedBucketOwner:GetObject', getObject_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
$sel:ifMatch:GetObject', getObject_ifMatch - Return the object only if its entity tag (ETag) is the same as the one
specified; otherwise, return a 412 (precondition failed) error.
$sel:ifModifiedSince:GetObject', getObject_ifModifiedSince - Return the object only if it has been modified since the specified time;
otherwise, return a 304 (not modified) error.
$sel:ifNoneMatch:GetObject', getObject_ifNoneMatch - Return the object only if its entity tag (ETag) is different from the
one specified; otherwise, return a 304 (not modified) error.
$sel:ifUnmodifiedSince:GetObject', getObject_ifUnmodifiedSince - Return the object only if it has not been modified since the specified
time; otherwise, return a 412 (precondition failed) error.
GetObject, getObject_partNumber - 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.
$sel:range:GetObject', getObject_range - Downloads the specified range bytes of an object. For more information
about the HTTP Range header, see
https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
Amazon S3 doesn't support retrieving multiple ranges of data per GET
request.
$sel:requestPayer:GetObject', getObject_requestPayer - Undocumented member.
$sel:responseCacheControl:GetObject', getObject_responseCacheControl - Sets the Cache-Control header of the response.
$sel:responseContentDisposition:GetObject', getObject_responseContentDisposition - Sets the Content-Disposition header of the response
$sel:responseContentEncoding:GetObject', getObject_responseContentEncoding - Sets the Content-Encoding header of the response.
$sel:responseContentLanguage:GetObject', getObject_responseContentLanguage - Sets the Content-Language header of the response.
$sel:responseContentType:GetObject', getObject_responseContentType - Sets the Content-Type header of the response.
$sel:responseExpires:GetObject', getObject_responseExpires - Sets the Expires header of the response.
GetObject, getObject_sSECustomerAlgorithm - Specifies the algorithm to use to when decrypting the object (for
example, AES256).
$sel:sSECustomerKey:GetObject', getObject_sSECustomerKey - Specifies 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-algorithm header.
GetObject, getObject_sSECustomerKeyMD5 - 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.
GetObject, getObject_versionId - VersionId used to reference a specific version of the object.
GetObject, getObject_bucket - 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 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.
When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.
When using 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 using this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on Outposts
in the Amazon S3 User Guide.
GetObject, getObject_key - Key of the object to get.
Request Lenses
getObject_checksumMode :: Lens' GetObject (Maybe ChecksumMode) Source #
To retrieve the checksum, this mode must be enabled.
getObject_expectedBucketOwner :: Lens' GetObject (Maybe Text) Source #
The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
getObject_ifMatch :: Lens' GetObject (Maybe Text) Source #
Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.
getObject_ifModifiedSince :: Lens' GetObject (Maybe UTCTime) Source #
Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.
getObject_ifNoneMatch :: Lens' GetObject (Maybe Text) Source #
Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.
getObject_ifUnmodifiedSince :: Lens' GetObject (Maybe UTCTime) Source #
Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.
getObject_partNumber :: Lens' GetObject (Maybe Int) Source #
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.
getObject_range :: Lens' GetObject (Maybe Text) Source #
Downloads the specified range bytes of an object. For more information about the HTTP Range header, see https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
Amazon S3 doesn't support retrieving multiple ranges of data per GET
request.
getObject_requestPayer :: Lens' GetObject (Maybe RequestPayer) Source #
Undocumented member.
getObject_responseCacheControl :: Lens' GetObject (Maybe Text) Source #
Sets the Cache-Control header of the response.
getObject_responseContentDisposition :: Lens' GetObject (Maybe Text) Source #
Sets the Content-Disposition header of the response
getObject_responseContentEncoding :: Lens' GetObject (Maybe Text) Source #
Sets the Content-Encoding header of the response.
getObject_responseContentLanguage :: Lens' GetObject (Maybe Text) Source #
Sets the Content-Language header of the response.
getObject_responseContentType :: Lens' GetObject (Maybe Text) Source #
Sets the Content-Type header of the response.
getObject_responseExpires :: Lens' GetObject (Maybe UTCTime) Source #
Sets the Expires header of the response.
getObject_sSECustomerAlgorithm :: Lens' GetObject (Maybe Text) Source #
Specifies the algorithm to use to when decrypting the object (for example, AES256).
getObject_sSECustomerKey :: Lens' GetObject (Maybe Text) Source #
Specifies 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-algorithm header.
getObject_sSECustomerKeyMD5 :: Lens' GetObject (Maybe Text) Source #
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.
getObject_versionId :: Lens' GetObject (Maybe ObjectVersionId) Source #
VersionId used to reference a specific version of the object.
getObject_bucket :: Lens' GetObject BucketName Source #
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 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.
When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.
When using 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 using this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
Using Amazon S3 on Outposts
in the Amazon S3 User Guide.
Destructuring the Response
data GetObjectResponse Source #
See: newGetObjectResponse smart constructor.
Constructors
| GetObjectResponse' | |
Fields
| |
Instances
Arguments
| :: Int | |
| -> ResponseBody | |
| -> GetObjectResponse |
Create a value of GetObjectResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:acceptRanges:GetObjectResponse', getObjectResponse_acceptRanges - Indicates that a range of bytes was specified.
GetObjectResponse, getObjectResponse_bucketKeyEnabled - Indicates whether the object uses an S3 Bucket Key for server-side
encryption with Amazon Web Services KMS (SSE-KMS).
$sel:cacheControl:GetObjectResponse', getObjectResponse_cacheControl - Specifies caching behavior along the request/reply chain.
GetObjectResponse, getObjectResponse_checksumCRC32 - 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.
GetObjectResponse, getObjectResponse_checksumCRC32C - 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.
GetObjectResponse, getObjectResponse_checksumSHA1 - 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.
GetObjectResponse, getObjectResponse_checksumSHA256 - 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.
$sel:contentDisposition:GetObjectResponse', getObjectResponse_contentDisposition - Specifies presentational information for the object.
$sel:contentEncoding:GetObjectResponse', getObjectResponse_contentEncoding - 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.
$sel:contentLanguage:GetObjectResponse', getObjectResponse_contentLanguage - The language the content is in.
$sel:contentLength:GetObjectResponse', getObjectResponse_contentLength - Size of the body in bytes.
$sel:contentRange:GetObjectResponse', getObjectResponse_contentRange - The portion of the object returned in the response.
$sel:contentType:GetObjectResponse', getObjectResponse_contentType - A standard MIME type describing the format of the object data.
GetObjectResponse, getObjectResponse_deleteMarker - Specifies whether the object retrieved was (true) or was not (false) a
Delete Marker. If false, this response header does not appear in the
response.
GetObjectResponse, getObjectResponse_eTag - An entity tag (ETag) is an opaque identifier assigned by a web server to
a specific version of a resource found at a URL.
GetObjectResponse, getObjectResponse_expiration - If the object expiration is configured (see PUT Bucket lifecycle), 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.
$sel:expires:GetObjectResponse', getObjectResponse_expires - The date and time at which the object is no longer cacheable.
GetObjectResponse, getObjectResponse_lastModified - Creation date of the object.
$sel:metadata:GetObjectResponse', getObjectResponse_metadata - A map of metadata to store with the object in S3.
$sel:missingMeta:GetObjectResponse', getObjectResponse_missingMeta - This is set to the number of metadata entries not returned in
x-amz-meta headers. 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.
$sel:objectLockLegalHoldStatus:GetObjectResponse', getObjectResponse_objectLockLegalHoldStatus - 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.
$sel:objectLockMode:GetObjectResponse', getObjectResponse_objectLockMode - The Object Lock mode currently in place for this object.
$sel:objectLockRetainUntilDate:GetObjectResponse', getObjectResponse_objectLockRetainUntilDate - The date and time when this object's Object Lock will expire.
$sel:partsCount:GetObjectResponse', getObjectResponse_partsCount - 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.
$sel:replicationStatus:GetObjectResponse', getObjectResponse_replicationStatus - Amazon S3 can return this if your request involves a bucket that is
either a source or destination in a replication rule.
$sel:requestCharged:GetObjectResponse', getObjectResponse_requestCharged - Undocumented member.
$sel:restore:GetObjectResponse', getObjectResponse_restore - Provides information about object restoration action and expiration time
of the restored object copy.
GetObject, getObjectResponse_sSECustomerAlgorithm - If server-side encryption with a customer-provided encryption key was
requested, the response will include this header confirming the
encryption algorithm used.
GetObject, getObjectResponse_sSECustomerKeyMD5 - 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.
$sel:sSEKMSKeyId:GetObjectResponse', getObjectResponse_sSEKMSKeyId - If present, specifies the ID of the Amazon Web Services Key Management
Service (Amazon Web Services KMS) symmetric customer managed key that
was used for the object.
$sel:serverSideEncryption:GetObjectResponse', getObjectResponse_serverSideEncryption - The server-side encryption algorithm used when storing this object in
Amazon S3 (for example, AES256, aws:kms).
GetObjectResponse, getObjectResponse_storageClass - Provides storage class information of the object. Amazon S3 returns this
header for all objects except for S3 Standard storage class objects.
$sel:tagCount:GetObjectResponse', getObjectResponse_tagCount - The number of tags, if any, on the object.
GetObject, getObjectResponse_versionId - Version of the object.
$sel:websiteRedirectLocation:GetObjectResponse', getObjectResponse_websiteRedirectLocation - 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.
$sel:httpStatus:GetObjectResponse', getObjectResponse_httpStatus - The response's http status code.
$sel:body:GetObjectResponse', getObjectResponse_body - Object data.
Response Lenses
getObjectResponse_acceptRanges :: Lens' GetObjectResponse (Maybe Text) Source #
Indicates that a range of bytes was specified.
getObjectResponse_bucketKeyEnabled :: Lens' GetObjectResponse (Maybe Bool) Source #
Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
getObjectResponse_cacheControl :: Lens' GetObjectResponse (Maybe Text) Source #
Specifies caching behavior along the request/reply chain.
getObjectResponse_checksumCRC32 :: Lens' GetObjectResponse (Maybe Text) Source #
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.
getObjectResponse_checksumCRC32C :: Lens' GetObjectResponse (Maybe Text) Source #
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.
getObjectResponse_checksumSHA1 :: Lens' GetObjectResponse (Maybe Text) Source #
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.
getObjectResponse_checksumSHA256 :: Lens' GetObjectResponse (Maybe Text) Source #
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.
getObjectResponse_contentDisposition :: Lens' GetObjectResponse (Maybe Text) Source #
Specifies presentational information for the object.
getObjectResponse_contentEncoding :: Lens' GetObjectResponse (Maybe Text) Source #
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.
getObjectResponse_contentLanguage :: Lens' GetObjectResponse (Maybe Text) Source #
The language the content is in.
getObjectResponse_contentLength :: Lens' GetObjectResponse (Maybe Integer) Source #
Size of the body in bytes.
getObjectResponse_contentRange :: Lens' GetObjectResponse (Maybe Text) Source #
The portion of the object returned in the response.
getObjectResponse_contentType :: Lens' GetObjectResponse (Maybe Text) Source #
A standard MIME type describing the format of the object data.
getObjectResponse_deleteMarker :: Lens' GetObjectResponse (Maybe Bool) Source #
Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.
getObjectResponse_eTag :: Lens' GetObjectResponse (Maybe ETag) Source #
An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
getObjectResponse_expiration :: Lens' GetObjectResponse (Maybe Text) Source #
If the object expiration is configured (see PUT Bucket lifecycle), 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.
getObjectResponse_expires :: Lens' GetObjectResponse (Maybe UTCTime) Source #
The date and time at which the object is no longer cacheable.
getObjectResponse_lastModified :: Lens' GetObjectResponse (Maybe UTCTime) Source #
Creation date of the object.
getObjectResponse_metadata :: Lens' GetObjectResponse (HashMap Text Text) Source #
A map of metadata to store with the object in S3.
getObjectResponse_missingMeta :: Lens' GetObjectResponse (Maybe Int) Source #
This is set to the number of metadata entries not returned in
x-amz-meta headers. 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.
getObjectResponse_objectLockLegalHoldStatus :: Lens' GetObjectResponse (Maybe ObjectLockLegalHoldStatus) Source #
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.
getObjectResponse_objectLockMode :: Lens' GetObjectResponse (Maybe ObjectLockMode) Source #
The Object Lock mode currently in place for this object.
getObjectResponse_objectLockRetainUntilDate :: Lens' GetObjectResponse (Maybe UTCTime) Source #
The date and time when this object's Object Lock will expire.
getObjectResponse_partsCount :: Lens' GetObjectResponse (Maybe Int) Source #
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.
getObjectResponse_replicationStatus :: Lens' GetObjectResponse (Maybe ReplicationStatus) Source #
Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.
getObjectResponse_requestCharged :: Lens' GetObjectResponse (Maybe RequestCharged) Source #
Undocumented member.
getObjectResponse_restore :: Lens' GetObjectResponse (Maybe Text) Source #
Provides information about object restoration action and expiration time of the restored object copy.
getObjectResponse_sSECustomerAlgorithm :: Lens' GetObjectResponse (Maybe Text) Source #
If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
getObjectResponse_sSECustomerKeyMD5 :: Lens' GetObjectResponse (Maybe Text) Source #
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.
getObjectResponse_sSEKMSKeyId :: Lens' GetObjectResponse (Maybe Text) Source #
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.
getObjectResponse_serverSideEncryption :: Lens' GetObjectResponse (Maybe ServerSideEncryption) Source #
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
getObjectResponse_storageClass :: Lens' GetObjectResponse (Maybe StorageClass) Source #
Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
getObjectResponse_tagCount :: Lens' GetObjectResponse (Maybe Int) Source #
The number of tags, if any, on the object.
getObjectResponse_versionId :: Lens' GetObjectResponse (Maybe ObjectVersionId) Source #
Version of the object.
getObjectResponse_websiteRedirectLocation :: Lens' GetObjectResponse (Maybe Text) Source #
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.
getObjectResponse_httpStatus :: Lens' GetObjectResponse Int Source #
The response's http status code.
getObjectResponse_body :: Lens' GetObjectResponse ResponseBody Source #
Object data.