Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace HeadObjectOutput

Hierarchy

Index

Properties

Optional AcceptRanges

AcceptRanges: undefined | string

Indicates that a range of bytes was specified.

Optional ArchiveStatus

ArchiveStatus: ArchiveStatus | string

The archive state of the head object.

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 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

Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the s3:GetObjectLegalHold permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.

Optional ObjectLockMode

ObjectLockMode: ObjectLockMode | string

The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the s3:GetObjectRetention permission. For more information about S3 Object Lock, see Object Lock.

Optional ObjectLockRetainUntilDate

ObjectLockRetainUntilDate: Date

The date and time when the Object Lock retention period expires. This header is only returned if the requester has the s3:GetObjectRetention permission.

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 header if your request involves a bucket that is either a source or a destination in a replication rule.

In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (GetObject) or object metadata (HeadObject) from these buckets, Amazon S3 will return the x-amz-replication-status header in the response as follows:

  • If requesting an object from the source bucket, Amazon S3 will return the x-amz-replication-status header if the object in your request is eligible for replication.

    For example, suppose that in your replication configuration, you specify object prefix TaxDocs requesting Amazon S3 to replicate objects with key prefix TaxDocs. Any objects you upload with this key name prefix, for example TaxDocs/document1.pdf, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the x-amz-replication-status header with value PENDING, COMPLETED or FAILED indicating object replication status.

  • If requesting an object from a destination bucket, Amazon S3 will return the x-amz-replication-status header with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress.

  • When replicating objects to multiple destination buckets, the x-amz-replication-status header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED.

For more information, see Replication.

Optional RequestCharged

RequestCharged: RequestCharged | string

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

Optional Restore

Restore: undefined | string

If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.

If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:

x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"

If the object restoration is in progress, the header returns the value ongoing-request="true".

For more information about archiving objects, see Transitioning Objects: General Considerations.

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

If the object is stored using server-side encryption either with an Amazon Web Services KMS key or an Amazon S3-managed encryption key, the response includes this header with the value of 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.

For more information, see Storage Classes.

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.