Interface WriteGetObjectResponseRequest

interface WriteGetObjectResponseRequest {
    RequestRoute: string | undefined;
    RequestToken: string | undefined;
    Body?: StreamingBlobTypes;
    StatusCode?: number;
    ErrorCode?: string;
    ErrorMessage?: string;
    AcceptRanges?: string;
    CacheControl?: string;
    ContentDisposition?: string;
    ContentEncoding?: string;
    ContentLanguage?: string;
    ContentLength?: number;
    ContentRange?: string;
    ContentType?: string;
    ChecksumCRC32?: string;
    ChecksumCRC32C?: string;
    ChecksumCRC64NVME?: string;
    ChecksumSHA1?: string;
    ChecksumSHA256?: string;
    DeleteMarker?: boolean;
    ETag?: string;
    Expires?: string;
    Expiration?: string;
    LastModified?: Date;
    MissingMeta?: number;
    Metadata?: Record<string, string>;
    ObjectLockMode?: ObjectLockMode;
    ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus;
    ObjectLockRetainUntilDate?: Date;
    PartsCount?: number;
    ReplicationStatus?: ReplicationStatus;
    RequestCharged?: "requester";
    Restore?: string;
    ServerSideEncryption?: ServerSideEncryption;
    SSECustomerAlgorithm?: string;
    SSEKMSKeyId?: string;
    SSECustomerKeyMD5?: string;
    StorageClass?: StorageClass;
    TagCount?: number;
    VersionId?: string;
    BucketKeyEnabled?: boolean;
}

Properties

RequestRoute

RequestRoute: string | undefined

Route prefix to the HTTP URL generated.

RequestToken

RequestToken: string | undefined

A single use encrypted token that maps WriteGetObjectResponse to the end user GetObject request.

`Optional`Body

Body?: StreamingBlobTypes

The object data.

`Optional`StatusCode

StatusCode?: number

The 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`ErrorCode

ErrorCode?: string

A 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]+$".

`OptionalErrorMessage`

ErrorMessage?: string

Contains a generic description of the 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 body.

`OptionalAcceptRanges`

AcceptRanges?: string

Indicates that a range of bytes was specified.

`OptionalCacheControl`

CacheControl?: string

Specifies caching behavior along the request/reply chain.

`OptionalContentDisposition`

ContentDisposition?: string

Specifies presentational information for the object.

`OptionalContentEncoding`

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.

`OptionalContentLanguage`

ContentLanguage?: string

The language the content is in.

`OptionalContentLength`

ContentLength?: number

The size of the content body in bytes.

`OptionalContentRange`

ContentRange?: string

The portion of the object returned in the response.

`OptionalContentType`

ContentType?: string

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

`OptionalChecksumCRC32`

ChecksumCRC32?: string

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

`OptionalChecksumCRC32C`

ChecksumCRC32C?: string

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

`OptionalChecksumCRC64NVME`

ChecksumCRC64NVME?: string

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 64-bit CRC64NVME checksum of the part. For more information, see Checking object integrity in the Amazon S3 User Guide.

`OptionalChecksumSHA1`

ChecksumSHA1?: string

This 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 SHA1 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.

`OptionalChecksumSHA256`

ChecksumSHA256?: string

This 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 SHA256 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.

`OptionalDeleteMarker`

DeleteMarker?: boolean

Specifies whether an object stored in Amazon S3 is (true) or is not (false) a delete marker. To learn more about delete markers, see Working with delete markers.

`OptionalETag`

ETag?: string

An opaque identifier assigned by a web server to a specific version of a resource found at a URL.

`OptionalExpires`

Expires?: string

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

`OptionalExpiration`

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 that provide the object expiration information. The value of the rule-id is URL-encoded.

`OptionalLastModified`

LastModified?: Date

The date and time that the object was last modified.

`OptionalMissingMeta`

MissingMeta?: number

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.

`OptionalMetadata`

Metadata?: Record<string, string>

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

`OptionalObjectLockMode`

ObjectLockMode?: ObjectLockMode

Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more information about S3 Object Lock, see Object Lock.

`OptionalObjectLockLegalHoldStatus`

ObjectLockLegalHoldStatus?: ObjectLockLegalHoldStatus

Indicates whether an object stored in Amazon S3 has an active legal hold.

`OptionalObjectLockRetainUntilDate`

ObjectLockRetainUntilDate?: Date

The date and time when Object Lock is configured to expire.

`OptionalPartsCount`

PartsCount?: number

The count of parts this object has.

`OptionalReplicationStatus`

ReplicationStatus?: ReplicationStatus

Indicates if request involves bucket that is either a source or destination in a Replication rule. For more information about S3 Replication, see Replication.

`OptionalRequestCharged`

RequestCharged?: "requester"

If present, indicates that the requester was successfully charged for the request. For more information, see Using Requester Pays buckets for storage transfers and usage in the Amazon Simple Storage Service user guide.


         
            This functionality is not supported for directory buckets.

`OptionalRestore`

Restore?: string

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

`OptionalServerSideEncryption`

ServerSideEncryption?: ServerSideEncryption

The server-side encryption algorithm used when storing requested object in Amazon S3 or Amazon FSx.


         
            When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side
        encryption option is aws:fsx.

`OptionalSSECustomerAlgorithm`

SSECustomerAlgorithm?: string

Encryption algorithm used if server-side encryption with a customer-provided encryption key was specified for object stored in Amazon S3.

`OptionalSSEKMSKeyId`

SSEKMSKeyId?: string

If present, specifies the ID (Key ID, Key ARN, or Key Alias) 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.

`OptionalSSECustomerKeyMD5`

SSECustomerKeyMD5?: string

128-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).

`OptionalStorageClass`

StorageClass?: StorageClass

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.

`OptionalTagCount`

TagCount?: number

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

`OptionalVersionId`

VersionId?: string

An ID used to reference a specific version of the object.

`OptionalBucketKeyEnabled`

BucketKeyEnabled?: boolean

Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

Interface WriteGetObjectResponseRequest

Index

Properties

Properties

RequestRoute

RequestToken

OptionalBody

OptionalStatusCode

OptionalErrorCode

OptionalErrorMessage

OptionalAcceptRanges

OptionalCacheControl

OptionalContentDisposition

OptionalContentEncoding

OptionalContentLanguage

OptionalContentLength

OptionalContentRange

OptionalContentType

OptionalChecksumCRC32

OptionalChecksumCRC32C

OptionalChecksumCRC64NVME

OptionalChecksumSHA1

OptionalChecksumSHA256

OptionalDeleteMarker

OptionalETag

OptionalExpires

OptionalExpiration

OptionalLastModified

OptionalMissingMeta

OptionalMetadata

OptionalObjectLockMode

OptionalObjectLockLegalHoldStatus

OptionalObjectLockRetainUntilDate

OptionalPartsCount

OptionalReplicationStatus

OptionalRequestCharged

OptionalRestore

OptionalServerSideEncryption

OptionalSSECustomerAlgorithm

OptionalSSEKMSKeyId

OptionalSSECustomerKeyMD5

OptionalStorageClass

OptionalTagCount

OptionalVersionId

OptionalBucketKeyEnabled

Settings

On This Page

`Optional`Body

`Optional`StatusCode

`Optional`ErrorCode

`OptionalErrorMessage`

`OptionalAcceptRanges`

`OptionalCacheControl`

`OptionalContentDisposition`

`OptionalContentEncoding`

`OptionalContentLanguage`

`OptionalContentLength`

`OptionalContentRange`

`OptionalContentType`

`OptionalChecksumCRC32`

`OptionalChecksumCRC32C`

`OptionalChecksumCRC64NVME`

`OptionalChecksumSHA1`

`OptionalChecksumSHA256`

`OptionalDeleteMarker`

`OptionalETag`

`OptionalExpires`

`OptionalExpiration`

`OptionalLastModified`

`OptionalMissingMeta`

`OptionalMetadata`

`OptionalObjectLockMode`

`OptionalObjectLockLegalHoldStatus`

`OptionalObjectLockRetainUntilDate`

`OptionalPartsCount`

`OptionalReplicationStatus`

`OptionalRequestCharged`

`OptionalRestore`

`OptionalServerSideEncryption`

`OptionalSSECustomerAlgorithm`

`OptionalSSEKMSKeyId`

`OptionalSSECustomerKeyMD5`

`OptionalStorageClass`

`OptionalTagCount`

`OptionalVersionId`

`OptionalBucketKeyEnabled`

`Settings`

`On This Page`