S3 / Client / delete_object_annotation

delete_object_annotation

S3.Client.delete_object_annotation(**kwargs)

Deletes a specific annotation from an Amazon S3 object. Use the x-amz-object-if-match header to perform a conditional delete that only succeeds if the object’s ETag matches the provided value, preventing race conditions during concurrent updates.

Deleting an annotation is permanent. Annotations are not independently versioned, so there is no delete marker or way to recover a deleted annotation.

To use this operation, you must have the s3:DeleteObjectAnnotation permission. If the object is protected by Object Lock in governance mode, you must also include the x-amz-bypass-governance-retention 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 DeleteObjectAnnotation:

See also: AWS API Documentation

Request Syntax

response = client.delete_object_annotation(
    Bucket='string',
    Key='string',
    AnnotationName='string',
    VersionId='string',
    RequestPayer='requester',
    ExpectedBucketOwner='string',
    ObjectIfMatch='string'
)
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 delete. Annotation names are UTF-8 encoded and cannot start with aws or s3 (case-insensitive).

    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.

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

Return type:

dict

Returns:

Response Syntax

{
    'ObjectVersionId': 'string',
    'RequestCharged': 'requester'
}

Response Structure

  • (dict) –

    • ObjectVersionId (string) –

      The version ID of the object that the annotation was deleted from.

    • 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