get_bucket_metadata_configuration¶
Operation¶
get_bucket_metadata_configuration
async
¶
get_bucket_metadata_configuration(request: GetBucketMetadataConfigurationInput | GetBucketMetadataConfigurationInputDict, /, *, plugins: list[Plugin] | None = None) -> GetBucketMetadataConfigurationOutput
get_bucket_metadata_configuration(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetBucketMetadataConfigurationInputDict]) -> GetBucketMetadataConfigurationOutput
Retrieves the 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 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.
- 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.Note: The IAM policy action name is the same for the V1 and V2 API operations.
The following operations are related to
GetBucketMetadataConfiguration:
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 |
|---|---|
GetBucketMetadataConfigurationOutput
|
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¶
GetBucketMetadataConfigurationInput
dataclass
¶
Dictionaries¶
GetBucketMetadataConfigurationInputDict
¶
Output¶
GetBucketMetadataConfigurationOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetBucketMetadataConfigurationOutput structure.
Attributes¶
get_bucket_metadata_configuration_result
class-attribute
instance-attribute
¶
get_bucket_metadata_configuration_result: GetBucketMetadataConfigurationResult | None = ...
The metadata 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.