s3_get_object_attributes: Retrieves all the metadata from an object without returning...

View source: R/s3_operations.R

s3_get_object_attributesR Documentation

Retrieves all the metadata from an object without returning the object itself

Description

Retrieves all the metadata from an object without returning the object itself. This action is useful if you're interested only in an object's metadata. To use get_object_attributes, you must have READ access to the object.

See https://www.paws-r-sdk.com/docs/s3_get_object_attributes/ for full documentation.

Usage

s3_get_object_attributes(
  Bucket,
  Key,
  VersionId = NULL,
  MaxParts = NULL,
  PartNumberMarker = NULL,
  SSECustomerAlgorithm = NULL,
  SSECustomerKey = NULL,
  SSECustomerKeyMD5 = NULL,
  RequestPayer = NULL,
  ExpectedBucketOwner = NULL,
  ObjectAttributes
)

Arguments

Bucket

[required] 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 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.

Key

[required] The object key.

VersionId

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

MaxParts

Sets the maximum number of parts to return.

PartNumberMarker

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

SSECustomerAlgorithm

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

SSECustomerKey

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.

SSECustomerKeyMD5

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.

RequestPayer
ExpectedBucketOwner

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

ObjectAttributes

[required] Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.


paws.storage documentation built on Sept. 12, 2023, 1:23 a.m.