Skip to content

Updates the annotation table configuration for an Amazon S3 bucket's metadata configuration

Description

Updates the annotation table configuration for an Amazon S3 bucket's metadata configuration. Use this operation to enable or disable the annotation table, or to update its associated IAM role.

An annotation table is a queryable Iceberg table that contains records of all annotations attached to objects in the bucket. To use this operation, the bucket must have an existing Amazon S3 Metadata configuration.

To use this operation, you must have the s3:UpdateBucketMetadataAnnotationTableConfiguration permission. If you are specifying or changing the IAM role, you must also have iam:PassRole permission for the role.

The IAM role must have a trust policy that allows the Amazon S3 metadata service to assume it, and a permissions policy that grants the actions needed to read annotations from your bucket. The following examples show a trust policy and a permissions policy that you can adapt for your bucket and account.

The following operations are related to update_bucket_metadata_annotation_table_configuration:

Usage

s3_update_bucket_metadata_annotation_table_configuration(Bucket,
  ContentMD5, ChecksumAlgorithm, AnnotationTableConfiguration,
  ExpectedBucketOwner)

Arguments

  • Bucket

[required] The name of the bucket whose annotation table configuration to update.

  • ContentMD5

Base64-encoded MD5 digest of the message body.

  • ChecksumAlgorithm

Checksum algorithm for the request payload.

  • AnnotationTableConfiguration

[required] The annotation table configuration updates to apply.

  • ExpectedBucketOwner

The account ID of the expected bucket owner.

Value

An empty list.

Request syntax

svc$update_bucket_metadata_annotation_table_configuration(
  Bucket = "string",
  ContentMD5 = "string",
  ChecksumAlgorithm = "CRC32"|"CRC32C"|"SHA1"|"SHA256"|"CRC64NVME"|"SHA512"|"MD5"|"XXHASH64"|"XXHASH3"|"XXHASH128",
  AnnotationTableConfiguration = list(
    ConfigurationState = "ENABLED"|"DISABLED",
    EncryptionConfiguration = list(
      SseAlgorithm = "aws:kms"|"AES256",
      KmsKeyArn = "string"
    ),
    Role = "string"
  ),
  ExpectedBucketOwner = "string"
)