S3 / Client / get_object_annotation

get_object_annotation

S3.Client.get_object_annotation(**kwargs)

Retrieves an annotation from an Amazon S3 object. To use this operation, you must have the s3:GetObjectAnnotation permission.

If checksum mode is enabled via the x-amz-checksum-mode header, Amazon S3 returns the stored checksum in the response headers for client-side validation.

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 GetObjectAnnotation:

See also: AWS API Documentation

Request Syntax

response = client.get_object_annotation(
    Bucket='string',
    Key='string',
    AnnotationName='string',
    VersionId='string',
    RequestPayer='requester',
    ExpectedBucketOwner='string',
    ChecksumMode='ENABLED'
)
Parameters:

  • Bucket (string) –

    [REQUIRED]

    The name of the bucket that contains the object.

  • Key (string) –

    [REQUIRED]

    The object key.

  • AnnotationName (string) –

    [REQUIRED]

    The name of the annotation to retrieve.

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

  • VersionId (string) – The version ID of the object.

  • RequestPayer (string) –

    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.

  • ExpectedBucketOwner (string) – 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.

  • ChecksumMode (string) – Set to ENABLED to validate the checksum of the annotation payload on retrieval.

Return type:

dict

Returns:

Response Syntax

{
    'AnnotationPayload': StreamingBody(),
    'ObjectVersionId': 'string',
    'LastModified': datetime(2015, 1, 1),
    'ContentLength': 123,
    'ETag': 'string',
    'ChecksumCRC32': 'string',
    'ChecksumCRC32C': 'string',
    'ChecksumCRC64NVME': 'string',
    'ChecksumSHA1': 'string',
    'ChecksumSHA256': 'string',
    'ChecksumSHA512': 'string',
    'ChecksumMD5': 'string',
    'ChecksumXXHASH64': 'string',
    'ChecksumXXHASH3': 'string',
    'ChecksumXXHASH128': 'string',
    'ChecksumType': 'COMPOSITE'|'FULL_OBJECT',
    'ServerSideEncryption': 'AES256'|'aws:fsx'|'aws:kms'|'aws:kms:dsse',
    'RequestCharged': 'requester',
    'ReplicationStatus': 'COMPLETE'|'PENDING'|'FAILED'|'REPLICA'|'COMPLETED'
}

Response Structure

  • (dict) –

    • AnnotationPayload (StreamingBody) –

      The annotation payload.

    • ObjectVersionId (string) –

      The version ID of the object that the annotation is attached to.

    • LastModified (datetime) –

      The date and time the annotation was last modified.

    • ContentLength (integer) –

      The size of the annotation payload, in bytes.

    • ETag (string) –

      The entity tag of the annotation.

    • ChecksumCRC32 (string) –

      The CRC32 checksum of the annotation payload.

    • ChecksumCRC32C (string) –

      The CRC32C checksum of the annotation payload.

    • ChecksumCRC64NVME (string) –

      The CRC64NVME checksum of the annotation payload.

    • ChecksumSHA1 (string) –

      The SHA1 checksum of the annotation payload.

    • ChecksumSHA256 (string) –

      The SHA256 checksum of the annotation payload.

    • ChecksumSHA512 (string) –

      The SHA512 checksum of the annotation payload.

    • ChecksumMD5 (string) –

      The MD5 checksum of the annotation payload.

    • ChecksumXXHASH64 (string) –

      The XXHASH64 checksum of the annotation payload.

    • ChecksumXXHASH3 (string) –

      The XXHASH3 checksum of the annotation payload.

    • ChecksumXXHASH128 (string) –

      The XXHASH128 checksum of the annotation payload.

    • ChecksumType (string) –

      The type of checksum used.

    • ServerSideEncryption (string) –

      The server-side encryption algorithm used.

    • RequestCharged (string) –

      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.

    • ReplicationStatus (string) –

      The replication status of the annotation. Possible values include PENDING, COMPLETED, FAILED, and REPLICA.

Exceptions

  • S3.Client.exceptions.NoSuchBucket

  • S3.Client.exceptions.NoSuchKey

  • S3.Client.exceptions.NoSuchAnnotation