Jump to Content

New API Documentation - Developer Preview Available

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.

Interface GetObjectOutput

Hierarchy

  • GetObjectOutput

Properties

AcceptRanges?: string

Indicates that a range of bytes was specified.

Body?: Readable | Blob | ReadableStream<any>

Object data.

BucketKeyEnabled?: boolean

Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

CacheControl?: string

Specifies caching behavior along the request/reply chain.

ChecksumCRC32?: string

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.

ChecksumCRC32C?: string

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.

ChecksumSHA1?: string

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.

ChecksumSHA256?: string

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.

ContentDisposition?: string

Specifies presentational information for the object.

ContentEncoding?: string

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.

ContentLanguage?: string

The language the content is in.

ContentLength?: number

Size of the body in bytes.

ContentRange?: string

The portion of the object returned in the response.

ContentType?: string

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

DeleteMarker?: boolean

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.

ETag?: string

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?: string

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.

Expires?: Date

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

LastModified?: Date

Creation date of the object.

Metadata?: Record<string, string>

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

MissingMeta?: number

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.

ObjectLockLegalHoldStatus?: string

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.

ObjectLockMode?: string

The Object Lock mode currently in place for this object.

ObjectLockRetainUntilDate?: Date

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

PartsCount?: number

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.

ReplicationStatus?: string

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

RequestCharged?: string

If present, indicates that the requester was successfully charged for the request.

Restore?: string

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

SSECustomerAlgorithm?: string

If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

SSECustomerKeyMD5?: string

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.

SSEKMSKeyId?: string

If 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 the object.

ServerSideEncryption?: string

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

StorageClass?: string

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

TagCount?: number

The number of tags, if any, on the object.

VersionId?: string

Version of the object.

WebsiteRedirectLocation?: string

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.