Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GetObjectCommandInput

Hierarchy

Index

Properties

Bucket

Bucket: string | undefined

The bucket name containing the object.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues

Optional ChecksumMode

ChecksumMode: ChecksumMode | string

To retrieve the checksum, this mode must be enabled.

Optional ExpectedBucketOwner

ExpectedBucketOwner: undefined | string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Optional IfMatch

IfMatch: undefined | string

Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.

Optional IfModifiedSince

IfModifiedSince: Date

Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.

Optional IfNoneMatch

IfNoneMatch: undefined | string

Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.

Optional IfUnmodifiedSince

IfUnmodifiedSince: Date

Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.

Key

Key: string | undefined

Key of the object to get.

Optional PartNumber

PartNumber: undefined | number

Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.

Optional Range

Range: undefined | string

Downloads the specified range bytes of an object. For more information about the HTTP Range header, see https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

Amazon S3 doesn't support retrieving multiple ranges of data per GET request.

Optional RequestPayer

RequestPayer: RequestPayer | string

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

Optional ResponseCacheControl

ResponseCacheControl: undefined | string

Sets the Cache-Control header of the response.

Optional ResponseContentDisposition

ResponseContentDisposition: undefined | string

Sets the Content-Disposition header of the response

Optional ResponseContentEncoding

ResponseContentEncoding: undefined | string

Sets the Content-Encoding header of the response.

Optional ResponseContentLanguage

ResponseContentLanguage: undefined | string

Sets the Content-Language header of the response.

Optional ResponseContentType

ResponseContentType: undefined | string

Sets the Content-Type header of the response.

Optional ResponseExpires

ResponseExpires: Date

Sets the Expires header of the response.

Optional SSECustomerAlgorithm

SSECustomerAlgorithm: undefined | string

Specifies the algorithm to use to when decrypting the object (for example, AES256).

Optional SSECustomerKey

SSECustomerKey: undefined | string

Specifies the customer-provided encryption key for Amazon S3 used to encrypt the data. This value is used to decrypt the object when recovering it and must match the one used when storing the data. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

Optional SSECustomerKeyMD5

SSECustomerKeyMD5: undefined | string

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

Optional VersionId

VersionId: undefined | string

VersionId used to reference a specific version of the object.