Retrieves all the metadata from an object without returning the object itself. This operation is useful if you're interested only in an object's metadata.
See https://www.paws-r-sdk.com/docs/s3_get_object_attributes/ for full documentation.
s3_get_object_attributes(
Bucket,
Key,
VersionId = NULL,
MaxParts = NULL,
PartNumberMarker = NULL,
SSECustomerAlgorithm = NULL,
SSECustomerKey = NULL,
SSECustomerKeyMD5 = NULL,
RequestPayer = NULL,
ExpectedBucketOwner = NULL,
ObjectAttributes
)
[required] The name of the bucket that contains the object.
Directory buckets - When you use this operation with a directory
bucket, you must use virtual-hosted-style requests in the format
Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests
are not supported. Directory bucket names must be unique in the chosen
Availability Zone. Bucket names must follow the format
bucket_base_name--az-id--x-s3
(for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket
naming restrictions, see Directory bucket naming rules
in the Amazon S3 User Guide.
Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use 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 you use this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts access point ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts?
in the Amazon S3 User Guide.
[required] The object key.
The version ID used to reference a specific version of the object.
S3 Versioning isn't enabled and supported for directory buckets. For
this API operation, only the null
value of the version ID is supported
by directory buckets. You can only specify null
to the versionId
query parameter in the request.
Sets the maximum number of parts to return.
Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.
Specifies the algorithm to use when encrypting the object (for example, AES256).
This functionality is not supported for directory buckets.
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.
This functionality is not supported for directory buckets.
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.
This functionality is not supported for directory buckets.
The account ID of the expected bucket owner. If the account ID that you
provide does not match the actual owner of the bucket, the request fails
with the HTTP status code 403 Forbidden
(access denied).
[required] Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.