put_bucket_analytics_configuration¶
Operation¶
put_bucket_analytics_configuration
async
¶
put_bucket_analytics_configuration(request: PutBucketAnalyticsConfigurationInput | PutBucketAnalyticsConfigurationInputDict, /, *, plugins: list[Plugin] | None = None) -> PutBucketAnalyticsConfigurationOutput
put_bucket_analytics_configuration(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutBucketAnalyticsConfigurationInputDict]) -> PutBucketAnalyticsConfigurationOutput
Note
This operation is not supported for directory buckets.
Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket.
You can choose to have storage class analysis export analysis reports
sent to a comma-separated values (CSV) flat file. See the DataExport
request element. Reports are updated daily and are based on the object
filters that you configure. When selecting data export, you specify a
destination bucket and an optional destination prefix where the file is
written. You can export the data to a destination bucket in a different
account. However, the destination bucket must be in the same Region as
the bucket that you are making the PUT analytics configuration to. For
more information, see Amazon S3 Analytics -- Storage Class
Analysis.
Warning
You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
To use this operation, you must have permissions to perform the
s3:PutAnalyticsConfiguration 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.
PutBucketAnalyticsConfiguration has the following special errors:
-
- HTTP Error: HTTP 400 Bad Request
-
Code: InvalidArgument
-
Cause: Invalid argument.
-
- HTTP Error: HTTP 400 Bad Request
-
Code: TooManyConfigurations
-
Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
-
- HTTP Error: HTTP 403 Forbidden
-
Code: AccessDenied
-
Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration bucket permission to set the configuration on the bucket.
The following operations are related to
PutBucketAnalyticsConfiguration:
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 |
|---|---|
PutBucketAnalyticsConfigurationOutput
|
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¶
PutBucketAnalyticsConfigurationInput
dataclass
¶
Bases: _SerdeShape
Dataclass for PutBucketAnalyticsConfigurationInput structure.
Attributes¶
analytics_configuration
class-attribute
instance-attribute
¶
analytics_configuration: AnalyticsConfiguration | None = ...
The configuration and any analyses for the analytics filter.
bucket
class-attribute
instance-attribute
¶
bucket: str | None = ...
The name of the bucket to which an analytics configuration is stored.
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¶
PutBucketAnalyticsConfigurationInputDict
¶
Bases: TypedDict
Dictionary form of PutBucketAnalyticsConfigurationInput.
Attributes¶
analytics_configuration
instance-attribute
¶
analytics_configuration: Required[AnalyticsConfiguration | AnalyticsConfigurationDict]
The configuration and any analyses for the analytics filter.
bucket
instance-attribute
¶
The name of the bucket to which an analytics configuration is stored.
Output¶
PutBucketAnalyticsConfigurationOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for PutBucketAnalyticsConfigurationOutput structure.