Lists the annotations attached to an Amazon S3 object¶
Description¶
Lists the annotations attached to an Amazon S3 object. Results are paginated, with a maximum of 1,000 annotations per object. Use the AnnotationPrefix parameter to filter the results by name prefix.
To use this operation, you must have the s3:ListObjectAnnotations permission.
Annotations are not supported by the following features: S3 Inventory Reports, API Gateway, S3 Storage Lens, Amazon S3 File Gateway, Amazon FSx, S3 on Outposts, and S3 Express One Zone (directory buckets).
The following operations are related to list_object_annotations:
Usage¶
s3_list_object_annotations(Bucket, Key, VersionId, MaxAnnotationResults,
AnnotationPrefix, ContinuationToken, RequestPayer, ExpectedBucketOwner)
Arguments¶
Bucket
[required] The name of the bucket that contains the object.
Key
[required] The object key.
VersionId
The version ID of the object.
MaxAnnotationResults
The maximum number of annotations to return in the response. Maximum is 1,000.
AnnotationPrefix
Filter results to annotations whose name begins with the specified prefix.
ContinuationToken
Continuation token returned by a previous request to retrieve the next page.
RequestPayer
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for the corresponding charges. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
ExpectedBucketOwner
The account ID of the expected bucket owner.
Value¶
A list with the following syntax:
list(
Annotations = list(
list(
AnnotationName = "string",
LastModified = as.POSIXct(
"2015-01-01"
),
ETag = "string",
ChecksumAlgorithm = list(
"CRC32"|"CRC32C"|"SHA1"|"SHA256"|"CRC64NVME"|"SHA512"|"MD5"|"XXHASH64"|"XXHASH3"|"XXHASH128"
),
Size = 123,
ReplicationStatus = "COMPLETE"|"PENDING"|"FAILED"|"REPLICA"|"COMPLETED"
)
),
Bucket = "string",
Key = "string",
ObjectVersionId = "string",
AnnotationPrefix = "string",
MaxAnnotationResults = 123,
AnnotationCount = 123,
ContinuationToken = "string",
NextContinuationToken = "string",
RequestCharged = "requester"
)