Skip to content

update_bucket_metadata_inventory_table_configuration

Operation

update_bucket_metadata_inventory_table_configuration

Enables or disables a live inventory table for an S3 Metadata configuration on a general purpose bucket. For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide.

Permissions

To use this operation, you must have the following permissions. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide.

If you want to encrypt your inventory table with server-side encryption with Key Management Service (KMS) keys (SSE-KMS), you need additional permissions in your KMS key policy. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide.

  • s3:UpdateBucketMetadataInventoryTableConfiguration

  • s3tables:CreateTableBucket

  • s3tables:CreateNamespace

  • s3tables:GetTable

  • s3tables:CreateTable

  • s3tables:PutTablePolicy

  • s3tables:PutTableEncryption

  • kms:DescribeKey

The following operations are related to UpdateBucketMetadataInventoryTableConfiguration:

Warning

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

Parameters:

Name Type Description Default
request UpdateBucketMetadataInventoryTableConfigurationInput | UpdateBucketMetadataInventoryTableConfigurationInputDict | 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[UpdateBucketMetadataInventoryTableConfigurationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateBucketMetadataInventoryTableConfigurationOutput

An instance of UpdateBucketMetadataInventoryTableConfigurationOutput.

update_bucket_metadata_inventory_table_configuration async

Enables or disables a live inventory table for an S3 Metadata configuration on a general purpose bucket. For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide.

Permissions

To use this operation, you must have the following permissions. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide.

If you want to encrypt your inventory table with server-side encryption with Key Management Service (KMS) keys (SSE-KMS), you need additional permissions in your KMS key policy. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide.

  • s3:UpdateBucketMetadataInventoryTableConfiguration

  • s3tables:CreateTableBucket

  • s3tables:CreateNamespace

  • s3tables:GetTable

  • s3tables:CreateTable

  • s3tables:PutTablePolicy

  • s3tables:PutTableEncryption

  • kms:DescribeKey

The following operations are related to UpdateBucketMetadataInventoryTableConfiguration:

Warning

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

Parameters:

Name Type Description Default
request UpdateBucketMetadataInventoryTableConfigurationInput | UpdateBucketMetadataInventoryTableConfigurationInputDict | 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[UpdateBucketMetadataInventoryTableConfigurationInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateBucketMetadataInventoryTableConfigurationOutput

An instance of UpdateBucketMetadataInventoryTableConfigurationOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

UpdateBucketMetadataInventoryTableConfigurationInputDict

Bases: TypedDict

Dictionary form of UpdateBucketMetadataInventoryTableConfigurationInput.

Attributes

bucket instance-attribute
bucket: Required[str]

The general purpose bucket that corresponds to the metadata configuration that you want to enable or disable an inventory table for.

checksum_algorithm instance-attribute
checksum_algorithm: str | None

The checksum algorithm to use with your inventory table configuration.

content_md5 instance-attribute
content_md5: str | None

The Content-MD5 header for the inventory table configuration.

expected_bucket_owner instance-attribute
expected_bucket_owner: str | None

The expected owner of the general purpose bucket that corresponds to the metadata table configuration that you want to enable or disable an inventory table for.

inventory_table_configuration instance-attribute

The contents of your inventory table configuration.

UpdateBucketMetadataInventoryTableConfigurationInput dataclass

Bases: _SerdeShape

Dataclass for UpdateBucketMetadataInventoryTableConfigurationInput structure.

Attributes

bucket class-attribute instance-attribute
bucket: str | None = ...

The general purpose bucket that corresponds to the metadata configuration that you want to enable or disable an inventory table for.

checksum_algorithm class-attribute instance-attribute
checksum_algorithm: str | None = ...

The checksum algorithm to use with your inventory table configuration.

content_md5 class-attribute instance-attribute
content_md5: str | None = ...

The Content-MD5 header for the inventory table configuration.

expected_bucket_owner class-attribute instance-attribute
expected_bucket_owner: str | None = ...

The expected owner of the general purpose bucket that corresponds to the metadata table configuration that you want to enable or disable an inventory table for.

inventory_table_configuration class-attribute instance-attribute
inventory_table_configuration: InventoryTableConfigurationUpdates | None = ...

The contents of your inventory table configuration.

Output

UpdateBucketMetadataInventoryTableConfigurationOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateBucketMetadataInventoryTableConfigurationOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.