List Bucket Analytics Configurations
s3_list_bucket_analytics_configurations | R Documentation |
This operation is not supported by directory buckets¶
Description¶
This operation is not supported by directory buckets.
Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.
This action supports list pagination and does not return more than 100
configurations at a time. You should always check the IsTruncated
element in the response. If there are no more configurations to list,
IsTruncated
is set to false. If there are more configurations to list,
IsTruncated
is set to true, and there will be a value in
NextContinuationToken
. You use the NextContinuationToken
value to
continue the pagination of the list by passing the value in
continuation-token in the request to GET
the next page.
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.
For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.
The following operations are related to
list_bucket_analytics_configurations
:
-
get_bucket_analytics_configuration
-
delete_bucket_analytics_configuration
-
put_bucket_analytics_configuration
Usage¶
Arguments¶
Bucket
[required] The name of the bucket from which analytics configurations are retrieved.
ContinuationToken
The
ContinuationToken
that represents a placeholder from where this request should begin.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¶
A list with the following syntax:
list(
IsTruncated = TRUE|FALSE,
ContinuationToken = "string",
NextContinuationToken = "string",
AnalyticsConfigurationList = list(
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"
)
)
)
)
)
)
)