We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.
Protected Optional AcceptIndicates that a range of bytes was specified.
Optional BodyFor WriteGetObjectResponseRequest["Body"], see Body.
Optional BucketIndicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
Optional CacheSpecifies caching behavior along the request/reply chain.
Optional ChecksumCRC32This header can be used as a data integrity check to verify that the data received is
the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC32
checksum of the object returned by the Object Lambda function. This may not match the
checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values
only when the original GetObject request required checksum validation. For
more information about checksums, see Checking object
integrity in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
Optional ChecksumCRC32CThis header can be used as a data integrity check to verify that the data received is
the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC32C
checksum of the object returned by the Object Lambda function. This may not match the
checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values
only when the original GetObject request required checksum validation. For
more information about checksums, see Checking object
integrity in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
Optional ChecksumSHA1This header can be used as a data integrity check to verify that the data received is
the same data that was originally sent. This specifies the base64-encoded, 160-bit SHA-1
digest of the object returned by the Object Lambda function. This may not match the
checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values
only when the original GetObject request required checksum validation. For
more information about checksums, see Checking object
integrity in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
Optional ChecksumSHA256This header can be used as a data integrity check to verify that the data received is
the same data that was originally sent. This specifies the base64-encoded, 256-bit SHA-256
digest of the object returned by the Object Lambda function. This may not match the
checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values
only when the original GetObject request required checksum validation. For
more information about checksums, see Checking object
integrity in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
Optional ContentSpecifies presentational information for the object.
Optional ContentSpecifies 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.
Optional ContentThe language the content is in.
Optional ContentThe size of the content body in bytes.
Optional ContentThe portion of the object returned in the response.
Optional ContentA standard MIME type describing the format of the object data.
Optional DeleteSpecifies whether an object stored in Amazon S3 is (true) or is not
(false) a delete marker.
Optional ETagAn opaque identifier assigned by a web server to a specific version of a resource found at a URL.
Optional ErrorA string that uniquely identifies an error condition. Returned in the tag
of the error XML response for a corresponding GetObject call. Cannot be used
with a successful StatusCode header or when the transformed object is provided
in the body. All error codes from S3 are sentence-cased. The regular expression (regex)
value is "^[A-Z][a-zA-Z]+$".
Optional ErrorContains a generic description of the error condition. Returned in the GetObject call. Cannot be
used with a successful StatusCode header or when the transformed object is
provided in body.
Optional ExpirationIf 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 that provide the object expiration information. The value of the rule-id
is URL-encoded.
Optional ExpiresThe date and time at which the object is no longer cacheable.
Optional LastThe date and time that the object was last modified.
Optional MetadataA map of metadata to store with the object in S3.
Optional MissingSet 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.
Optional ObjectIndicates whether an object stored in Amazon S3 has an active legal hold.
Optional ObjectIndicates whether an object stored in Amazon S3 has Object Lock enabled. For more information about S3 Object Lock, see Object Lock.
Optional ObjectThe date and time when Object Lock is configured to expire.
Optional PartsThe count of parts this object has.
Optional ReplicationIndicates if request involves bucket that is either a source or destination in a Replication rule. For more information about S3 Replication, see Replication.
Optional RequestIf present, indicates that the requester was successfully charged for the request.
Route prefix to the HTTP URL generated.
A single use encrypted token that maps WriteGetObjectResponse to the end
user GetObject request.
Optional RestoreProvides information about object restoration operation and expiration time of the restored object copy.
Optional SSECustomerEncryption algorithm used if server-side encryption with a customer-provided encryption key was specified for object stored in Amazon S3.
Optional SSECustomer128-bit MD5 digest of customer-provided encryption key used in Amazon S3 to encrypt data stored in S3. For more information, see Protecting data using server-side encryption with customer-provided encryption keys (SSE-C).
Optional SSEKMSKeyIf present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric encryption customer managed key that was used for stored in Amazon S3 object.
Optional Server The server-side encryption algorithm used when storing requested object in Amazon S3 (for
example, AES256, aws:kms).
Optional StatusThe integer status code for an HTTP response of a corresponding GetObject
request. The following is a list of status codes.
200 - OK
206 - Partial Content
304 - Not Modified
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
409 - Conflict
411 - Length Required
412 - Precondition Failed
416 - Range Not Satisfiable
500 - Internal Server Error
503 - Service Unavailable
Optional StorageProvides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
For more information, see Storage Classes.
Optional TagThe number of tags, if any, on the object.
Optional VersionAn ID used to reference a specific version of the object.
This interface extends from
WriteGetObjectResponseRequestinterface. There are more parameters thanBodydefined in WriteGetObjectResponseRequest