S3 / Client / put_object_annotation

put_object_annotation

S3.Client.put_object_annotation(**kwargs)

Attaches an annotation to an Amazon S3 object. An annotation is a named payload of 1 byte to 1 MiB that you can associate with a specific object or object version. Each object can have up to 1,000 annotations.

For annotation naming rules and restrictions, see Annotation naming guidelines in the Amazon S3 User Guide.

Annotations inherit the encryption of their parent object. For objects without server-side encryption, annotations are encrypted with SSE-S3 (the default for new objects). Objects encrypted with SSE-C cannot have annotations.

To use this operation, you must have the s3:PutObjectAnnotation permission. If the bucket has Requester Pays enabled, you must include the x-amz-request-payer header.

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

See also: AWS API Documentation

Request Syntax

response = client.put_object_annotation(
    Bucket='string',
    Key='string',
    VersionId='string',
    AnnotationName='string',
    AnnotationPayload=b'bytes'|file,
    ObjectIfMatch='string',
    ChecksumAlgorithm='CRC32'|'CRC32C'|'SHA1'|'SHA256'|'CRC64NVME'|'SHA512'|'MD5'|'XXHASH64'|'XXHASH3'|'XXHASH128',
    ChecksumCRC32='string',
    ChecksumCRC32C='string',
    ChecksumCRC64NVME='string',
    ChecksumSHA1='string',
    ChecksumSHA256='string',
    ChecksumSHA512='string',
    ChecksumMD5='string',
    ChecksumXXHASH64='string',
    ChecksumXXHASH3='string',
    ChecksumXXHASH128='string',
    ContentMD5='string',
    RequestPayer='requester',
    ExpectedBucketOwner='string'
)
Parameters:

  • Bucket (string) –

    [REQUIRED]

    The name of the bucket that contains the object.

  • Key (string) –

    [REQUIRED]

    The object key.

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

  • AnnotationName (string) –

    [REQUIRED]

    The name of the annotation.

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

  • AnnotationPayload (bytes or seekable file-like object) –

    [REQUIRED]

    The annotation payload. Must be between 1 byte and 1 MiB in size, and must be valid UTF-8 encoded text. If the payload contains invalid UTF-8 bytes, the request fails with HTTP 415 (Unsupported Media Type). To store binary data, encode the payload using Base64 before uploading.

  • ObjectIfMatch (string) – If specified, the operation only succeeds if the object’s ETag matches the provided value.

  • ChecksumAlgorithm (string) – The checksum algorithm to use. Supported values: CRC32, CRC32C, CRC64NVME, SHA1, SHA256, SHA512, MD5, XXHASH64, XXHASH3, XXHASH128.

  • ChecksumCRC32 (string) – Base64-encoded CRC32 checksum of the annotation payload.

  • ChecksumCRC32C (string) – Base64-encoded CRC32C checksum of the annotation payload.

  • ChecksumCRC64NVME (string) – Base64-encoded CRC64NVME checksum of the annotation payload.

  • ChecksumSHA1 (string) – Base64-encoded SHA1 checksum of the annotation payload.

  • ChecksumSHA256 (string) – Base64-encoded SHA256 checksum of the annotation payload.

  • ChecksumSHA512 (string) – Base64-encoded SHA512 checksum of the annotation payload.

  • ChecksumMD5 (string) – Base64-encoded MD5 checksum of the annotation payload.

  • ChecksumXXHASH64 (string) – Base64-encoded XXHASH64 checksum of the annotation payload.

  • ChecksumXXHASH3 (string) – Base64-encoded XXHASH3 checksum of the annotation payload.

  • ChecksumXXHASH128 (string) – Base64-encoded XXHASH128 checksum of the annotation payload.

  • ContentMD5 (string) – Base64-encoded MD5 digest of the message.

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

Return type:

dict

Returns:

Response Syntax

{
    'Key': 'string',
    'AnnotationName': 'string',
    'ObjectVersionId': 'string',
    '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'
}

Response Structure

  • (dict) –

    • Key (string) –

      The object key.

    • AnnotationName (string) –

      The name of the annotation.

    • ObjectVersionId (string) –

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

    • ETag (string) –

      The entity tag of the annotation.

    • ChecksumCRC32 (string) –

      The CRC32 checksum of the stored annotation.

    • ChecksumCRC32C (string) –

      The CRC32C checksum of the stored annotation.

    • ChecksumCRC64NVME (string) –

      The CRC64NVME checksum of the stored annotation.

    • ChecksumSHA1 (string) –

      The SHA1 checksum of the stored annotation.

    • ChecksumSHA256 (string) –

      The SHA256 checksum of the stored annotation.

    • ChecksumSHA512 (string) –

      The SHA512 checksum of the stored annotation.

    • ChecksumMD5 (string) –

      The MD5 checksum of the stored annotation.

    • ChecksumXXHASH64 (string) –

      The XXHASH64 checksum of the stored annotation.

    • ChecksumXXHASH3 (string) –

      The XXHASH3 checksum of the stored annotation.

    • ChecksumXXHASH128 (string) –

      The XXHASH128 checksum of the stored annotation.

    • ChecksumType (string) –

      The type of checksum used.

    • ServerSideEncryption (string) –

      The server-side encryption algorithm used to encrypt the annotation.

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

Exceptions

  • S3.Client.exceptions.NoSuchBucket

  • S3.Client.exceptions.NoSuchKey

  • S3.Client.exceptions.InvalidRequest

  • S3.Client.exceptions.AnnotationNameTooLong

  • S3.Client.exceptions.AnnotationLimitExceeded

  • S3.Client.exceptions.InvalidAnnotationName

  • S3.Client.exceptions.UnsupportedMediaType