Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

$metadata

$metadata: ResponseMetadata

Metadata pertaining to this request.

Optional BucketKeyEnabled

BucketKeyEnabled: boolean

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

Optional ChecksumCRC32

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.

Optional ChecksumCRC32C

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.

Optional ChecksumSHA1

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.

Optional ChecksumSHA256

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.

Optional ETag

ETag: string

Entity tag for the uploaded object.

Optional Expiration

Expiration: string

If the expiration is configured for the object (see PutBucketLifecycleConfiguration), the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide information about object expiration. The value of the rule-id is URL-encoded.

Optional RequestCharged

RequestCharged: RequestCharged | string

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

Optional SSECustomerAlgorithm

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.

Optional SSECustomerKeyMD5

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.

Optional SSEKMSEncryptionContext

SSEKMSEncryptionContext: string

If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future GetObject or CopyObject operations on this object.

Optional SSEKMSKeyId

SSEKMSKeyId: string

If x-amz-server-side-encryption is has a valid value of aws:kms, this header 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.

Optional ServerSideEncryption

ServerSideEncryption: ServerSideEncryption | string

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

Optional VersionId

VersionId: string

Version of the object.