update_bucket_metadata_annotation_table_configuration¶
Operation¶
update_bucket_metadata_annotation_table_configuration
¶
update_bucket_metadata_annotation_table_configuration(request: UpdateBucketMetadataAnnotationTableConfigurationInput | UpdateBucketMetadataAnnotationTableConfigurationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateBucketMetadataAnnotationTableConfigurationInputDict]) -> UpdateBucketMetadataAnnotationTableConfigurationOutput
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
UpdateBucketMetadataAnnotationTableConfiguration:
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateBucketMetadataAnnotationTableConfigurationInput | UpdateBucketMetadataAnnotationTableConfigurationInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[UpdateBucketMetadataAnnotationTableConfigurationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateBucketMetadataAnnotationTableConfigurationOutput
|
An instance of |
update_bucket_metadata_annotation_table_configuration
async
¶
update_bucket_metadata_annotation_table_configuration(request: UpdateBucketMetadataAnnotationTableConfigurationInput | UpdateBucketMetadataAnnotationTableConfigurationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateBucketMetadataAnnotationTableConfigurationInputDict]) -> UpdateBucketMetadataAnnotationTableConfigurationOutput
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
UpdateBucketMetadataAnnotationTableConfiguration:
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateBucketMetadataAnnotationTableConfigurationInput | UpdateBucketMetadataAnnotationTableConfigurationInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[UpdateBucketMetadataAnnotationTableConfigurationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateBucketMetadataAnnotationTableConfigurationOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
UpdateBucketMetadataAnnotationTableConfigurationInputDict
¶
Bases: TypedDict
Dictionary form of UpdateBucketMetadataAnnotationTableConfigurationInput.
Attributes¶
annotation_table_configuration
instance-attribute
¶
annotation_table_configuration: Required[AnnotationTableConfigurationUpdates | AnnotationTableConfigurationUpdatesDict]
The annotation table configuration updates to apply.
bucket
instance-attribute
¶
The name of the bucket whose annotation table configuration to update.
checksum_algorithm
instance-attribute
¶
checksum_algorithm: str | None
Checksum algorithm for the request payload.
UpdateBucketMetadataAnnotationTableConfigurationInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateBucketMetadataAnnotationTableConfigurationInput structure.
Attributes¶
annotation_table_configuration
class-attribute
instance-attribute
¶
annotation_table_configuration: AnnotationTableConfigurationUpdates | None = ...
The annotation table configuration updates to apply.
bucket
class-attribute
instance-attribute
¶
bucket: str | None = ...
The name of the bucket whose annotation table configuration to update.
checksum_algorithm
class-attribute
instance-attribute
¶
checksum_algorithm: str | None = ...
Checksum algorithm for the request payload.
Output¶
UpdateBucketMetadataAnnotationTableConfigurationOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateBucketMetadataAnnotationTableConfigurationOutput structure.