Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace GetObjectOutput

Hierarchy

Index

Properties

Optional AcceptRanges

AcceptRanges: undefined | string

Indicates that a range of bytes was specified.

Optional Body

Body: Readable | ReadableStream | Blob

Object data.

Optional BucketKeyEnabled

BucketKeyEnabled: undefined | false | true

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

Optional CacheControl

CacheControl: undefined | string

Specifies caching behavior along the request/reply chain.

Optional ChecksumCRC32

ChecksumCRC32: undefined | 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.

Optional ChecksumCRC32C

ChecksumCRC32C: undefined | 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.

Optional ChecksumSHA1

ChecksumSHA1: undefined | 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.

Optional ChecksumSHA256

ChecksumSHA256: undefined | 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.

Optional ContentDisposition

ContentDisposition: undefined | string

Specifies presentational information for the object.

Optional ContentEncoding

ContentEncoding: undefined | 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.

Optional ContentLanguage

ContentLanguage: undefined | string

The language the content is in.

Optional ContentLength

ContentLength: undefined | number

Size of the body in bytes.

Optional ContentRange

ContentRange: undefined | string

The portion of the object returned in the response.

Optional ContentType

ContentType: undefined | string

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

Optional DeleteMarker

DeleteMarker: undefined | false | true

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.

Optional ETag

ETag: undefined | 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.

Optional Expiration

Expiration: undefined | 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.

Optional Expires

Expires: Date

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

Optional LastModified

LastModified: Date

Creation date of the object.

Optional Metadata

Metadata: Record<string, string>

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

Optional MissingMeta

MissingMeta: undefined | 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.

Optional ObjectLockLegalHoldStatus

ObjectLockLegalHoldStatus: 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.

Optional ObjectLockMode

ObjectLockMode: ObjectLockMode | string

The Object Lock mode currently in place for this object.

Optional ObjectLockRetainUntilDate

ObjectLockRetainUntilDate: Date

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

Optional PartsCount

PartsCount: undefined | 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.

Optional ReplicationStatus

ReplicationStatus: ReplicationStatus | string

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

Optional RequestCharged

RequestCharged: RequestCharged | string

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

Optional Restore

Restore: undefined | string

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

Optional SSECustomerAlgorithm

SSECustomerAlgorithm: undefined | string

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

Optional SSECustomerKeyMD5

SSECustomerKeyMD5: undefined | 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.

Optional SSEKMSKeyId

SSEKMSKeyId: undefined | string

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.

Optional ServerSideEncryption

ServerSideEncryption: ServerSideEncryption | string

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

Optional StorageClass

StorageClass: StorageClass | string

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

Optional TagCount

TagCount: undefined | number

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

Optional VersionId

VersionId: undefined | string

Version of the object.

Optional WebsiteRedirectLocation

WebsiteRedirectLocation: undefined | 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.