Put Bucket Analytics Configuration
s3_put_bucket_analytics_configuration | R Documentation |
This operation is not supported by directory buckets¶
Description¶
This operation is not supported by 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.
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.
put_bucket_analytics_configuration
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
put_bucket_analytics_configuration
:
-
get_bucket_analytics_configuration
-
delete_bucket_analytics_configuration
-
list_bucket_analytics_configurations
Usage¶
Arguments¶
Bucket
[required] The name of the bucket to which an analytics configuration is stored.
Id
[required] The ID that identifies the analytics configuration.
AnalyticsConfiguration
[required] The configuration and any analyses for the analytics filter.
ExpectedBucketOwner
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).
Value¶
An empty list.
Request syntax¶
svc$put_bucket_analytics_configuration(
Bucket = "string",
Id = "string",
AnalyticsConfiguration = list(
Id = "string",
Filter = list(
Prefix = "string",
Tag = list(
Key = "string",
Value = "string"
),
And = list(
Prefix = "string",
Tags = list(
list(
Key = "string",
Value = "string"
)
)
)
),
StorageClassAnalysis = list(
DataExport = list(
OutputSchemaVersion = "V_1",
Destination = list(
S3BucketDestination = list(
Format = "CSV",
BucketAccountId = "string",
Bucket = "string",
Prefix = "string"
)
)
)
)
),
ExpectedBucketOwner = "string"
)