get_bucket_analytics_configuration¶
Operation¶
get_bucket_analytics_configuration
async
¶
get_bucket_analytics_configuration(request: GetBucketAnalyticsConfigurationInput | GetBucketAnalyticsConfigurationInputDict, /, *, plugins: list[Plugin] | None = None) -> GetBucketAnalyticsConfigurationOutput
get_bucket_analytics_configuration(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetBucketAnalyticsConfigurationInputDict]) -> GetBucketAnalyticsConfigurationOutput
Note
This operation is not supported for directory buckets.
This implementation of the GET action returns an analytics configuration (identified by the analytics configuration ID) from the bucket.
To use this operation, you must have permissions to perform the
s3:GetAnalyticsConfiguration action. The bucket owner has this
permission by default. The bucket owner can grant this permission to
others. For more information about permissions, see Permissions Related
to Bucket Subresource
Operations
and Managing Access Permissions to Your Amazon S3
Resources
in the Amazon S3 User Guide.
For information about Amazon S3 analytics feature, see Amazon S3 Analytics -- Storage Class Analysis in the Amazon S3 User Guide.
The following operations are related to
GetBucketAnalyticsConfiguration:
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 |
|---|---|
GetBucketAnalyticsConfigurationOutput
|
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¶
GetBucketAnalyticsConfigurationInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetBucketAnalyticsConfigurationInput structure.
Attributes¶
bucket
class-attribute
instance-attribute
¶
bucket: str | None = ...
The name of the bucket from which an analytics configuration is retrieved.
expected_bucket_owner
class-attribute
instance-attribute
¶
expected_bucket_owner: str | None = ...
The account ID of the expected bucket owner. If the account ID that you
provide does not match the actual owner of the bucket, the request fails
with the HTTP status code 403 Forbidden (access denied).
Dictionaries¶
GetBucketAnalyticsConfigurationInputDict
¶
Bases: TypedDict
Dictionary form of GetBucketAnalyticsConfigurationInput.
Attributes¶
bucket
instance-attribute
¶
The name of the bucket from which an analytics configuration is retrieved.
Output¶
GetBucketAnalyticsConfigurationOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetBucketAnalyticsConfigurationOutput structure.
Attributes¶
analytics_configuration
class-attribute
instance-attribute
¶
analytics_configuration: AnalyticsConfiguration | None = ...
The configuration and any analyses for the analytics filter.
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.