list_object_annotations¶
Operation¶
async
¶
list_object_annotations(input: ListObjectAnnotationsInput, plugins: list[Plugin] | None = None) -> ListObjectAnnotationsOutput
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.
Note
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 ListObjectAnnotations:
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListObjectAnnotationsInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
ListObjectAnnotationsOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ListObjectAnnotationsInput structure.
Attributes¶
class-attribute
instance-attribute
¶
annotation_prefix: str | None = ...
Filter results to annotations whose name begins with the specified prefix.
class-attribute
instance-attribute
¶
bucket: str | None = ...
The name of the bucket that contains the object.
class-attribute
instance-attribute
¶
continuation_token: str | None = ...
Continuation token returned by a previous request to retrieve the next page.
class-attribute
instance-attribute
¶
expected_bucket_owner: str | None = ...
The account ID of the expected bucket owner.
class-attribute
instance-attribute
¶
max_annotation_results: int | None = ...
The maximum number of annotations to return in the response. Maximum is 1,000.
class-attribute
instance-attribute
¶
request_payer: str | None = ...
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.
Note
This functionality is not supported for directory buckets.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ListObjectAnnotationsOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
annotation_count: int | None = ...
The number of annotations returned.
class-attribute
instance-attribute
¶
annotation_prefix: str | None = ...
The prefix used to filter the response.
class-attribute
instance-attribute
¶
annotations: list[AnnotationEntry] | None = ...
The list of annotations attached to the object.
class-attribute
instance-attribute
¶
continuation_token: str | None = ...
The continuation token used in this request.
class-attribute
instance-attribute
¶
max_annotation_results: int | None = ...
The maximum number of annotations returned in the response.
class-attribute
instance-attribute
¶
next_continuation_token: str | None = ...
The continuation token to use to retrieve the next page of results.
class-attribute
instance-attribute
¶
object_version_id: str | None = ...
The version ID of the object.
class-attribute
instance-attribute
¶
request_charged: str | None = ...
If present, indicates that the requester was successfully charged for the request. For more information, see Using Requester Pays buckets for storage transfers and usage in the Amazon Simple Storage Service user guide.
Note
This functionality is not supported for directory buckets.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.