Skip to content

GetObjectAnnotationRequest

Source code in docs_src/capo_s3/types/get_object_annotation_request.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class GetObjectAnnotationRequest(TypedDict, closed=True):
    bucket: "capo_s3.types.bucket_name.BucketName"
    """<p>The name of the bucket that contains the object.</p>"""
    key: "capo_s3.types.object_key.ObjectKey"
    """<p>The object key.</p>"""
    annotation_name: "capo_s3.types.annotation_name.AnnotationName"
    """<p>The name of the annotation to retrieve.</p> <p>Length Constraints: Minimum length of 1. Maximum length of 512 bytes.</p>"""
    version_id: NotRequired["capo_s3.types.object_version_id.ObjectVersionId"]
    """<p>The version ID of the object.</p>"""
    request_payer: NotRequired["capo_s3.types.request_payer.RequestPayer"]
    expected_bucket_owner: NotRequired["capo_s3.types.account_id.AccountId"]
    """<p>The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with an HTTP 403 (Access Denied) error.</p>"""
    checksum_mode: NotRequired["capo_s3.types.checksum_mode.ChecksumMode"]
    """<p>Set to <code>ENABLED</code> to validate the checksum of the annotation payload on retrieval.</p>"""

annotation_name instance-attribute 

annotation_name: AnnotationName

The name of the annotation to retrieve.

Length Constraints: Minimum length of 1. Maximum length of 512 bytes.

bucket instance-attribute 

bucket: BucketName

The name of the bucket that contains the object.

checksum_mode instance-attribute 

checksum_mode: NotRequired[ChecksumMode]

Set to ENABLED to validate the checksum of the annotation payload on retrieval.

expected_bucket_owner instance-attribute 

expected_bucket_owner: NotRequired[AccountId]

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with an HTTP 403 (Access Denied) error.

key instance-attribute 

key: ObjectKey

The object key.

request_payer instance-attribute 

request_payer: NotRequired[RequestPayer]

version_id instance-attribute 

version_id: NotRequired[ObjectVersionId]

The version ID of the object.