get_bucket_metadata_table_configuration¶
Operation¶
get_bucket_metadata_table_configuration
async
¶
get_bucket_metadata_table_configuration(request: GetBucketMetadataTableConfigurationInput | GetBucketMetadataTableConfigurationInputDict, /, *, plugins: list[Plugin] | None = None) -> GetBucketMetadataTableConfigurationOutput
get_bucket_metadata_table_configuration(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetBucketMetadataTableConfigurationInputDict]) -> GetBucketMetadataTableConfigurationOutput
Warning
We recommend that you retrieve your S3 Metadata configurations by using
the V2
GetBucketMetadataTableConfiguration
API operation. We no longer recommend using the V1
GetBucketMetadataTableConfiguration API operation.
If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfiguration so that you can expire journal table records and create a live inventory table.
Retrieves the V1 S3 Metadata configuration for a general purpose bucket. For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide.
Note
You can use the V2 GetBucketMetadataConfiguration API operation with
V1 or V2 metadata table configurations. However, if you try to use the
V1 GetBucketMetadataTableConfiguration API operation with V2
configurations, you will receive an HTTP 405 Method Not Allowed error.
Make sure that you update your processes to use the new V2 API
operations (CreateBucketMetadataConfiguration,
GetBucketMetadataConfiguration, and
DeleteBucketMetadataConfiguration) instead of the V1 API operations.
- Permissions
-
To use this operation, you must have the
s3:GetBucketMetadataTableConfigurationpermission. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide.
The following operations are related to
GetBucketMetadataTableConfiguration:
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 |
|---|---|---|---|
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
|
Returns:
| Type | Description |
|---|---|
GetBucketMetadataTableConfigurationOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
GetBucketMetadataTableConfigurationInput
dataclass
¶
Dictionaries¶
GetBucketMetadataTableConfigurationInputDict
¶
Output¶
GetBucketMetadataTableConfigurationOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetBucketMetadataTableConfigurationOutput structure.
Attributes¶
get_bucket_metadata_table_configuration_result
class-attribute
instance-attribute
¶
get_bucket_metadata_table_configuration_result: GetBucketMetadataTableConfigurationResult | None = ...
The metadata table configuration for the general purpose bucket.
response_metadata
class-attribute
instance-attribute
¶
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.