Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GetObjectAttributesCommandInput

Hierarchy

Index

Properties

Bucket

Bucket: string | undefined

The name of the bucket that contains 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 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 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).

Key

Key: string | undefined

The object key.

Optional MaxParts

MaxParts: undefined | number

Sets the maximum number of parts to return.

ObjectAttributes

ObjectAttributes: (ObjectAttributes | string)[] | undefined

An XML header that specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.

Optional PartNumberMarker

PartNumberMarker: undefined | string

Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

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 SSECustomerAlgorithm

SSECustomerAlgorithm: undefined | string

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

Optional SSECustomerKey

SSECustomerKey: undefined | string

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. 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

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