ListBucketAnalyticsConfigurations
Note
This operation is not supported for 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
ListBucketAnalyticsConfigurations
:
Request Syntax
GET /?analytics&continuation-token=ContinuationToken
HTTP/1.1
Host: Bucket
.s3.amazonaws.com
x-amz-expected-bucket-owner: ExpectedBucketOwner
URI Request Parameters
The request uses the following URI parameters.
- Bucket
-
The name of the bucket from which analytics configurations are retrieved.
Required: Yes
- continuation-token
-
The
ContinuationToken
that represents a placeholder from where this request should begin. - x-amz-expected-bucket-owner
-
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).
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<ListBucketAnalyticsConfigurationResult>
<IsTruncated>boolean</IsTruncated>
<ContinuationToken>string</ContinuationToken>
<NextContinuationToken>string</NextContinuationToken>
<AnalyticsConfiguration>
<Filter>
<And>
<Prefix>string</Prefix>
<Tag>
<Key>string</Key>
<Value>string</Value>
</Tag>
...
</And>
<Prefix>string</Prefix>
<Tag>
<Key>string</Key>
<Value>string</Value>
</Tag>
</Filter>
<Id>string</Id>
<StorageClassAnalysis>
<DataExport>
<Destination>
<S3BucketDestination>
<Bucket>string</Bucket>
<BucketAccountId>string</BucketAccountId>
<Format>string</Format>
<Prefix>string</Prefix>
</S3BucketDestination>
</Destination>
<OutputSchemaVersion>string</OutputSchemaVersion>
</DataExport>
</StorageClassAnalysis>
</AnalyticsConfiguration>
...
</ListBucketAnalyticsConfigurationResult>
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in XML format by the service.
- ListBucketAnalyticsConfigurationResult
-
Root level tag for the ListBucketAnalyticsConfigurationResult parameters.
Required: Yes
- AnalyticsConfiguration
-
The list of analytics configurations for a bucket.
Type: Array of AnalyticsConfiguration data types
- ContinuationToken
-
The marker that is used as a starting point for this analytics configuration list response. This value is present if it was sent in the request.
Type: String
- IsTruncated
-
Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.
Type: Boolean
- NextContinuationToken
-
NextContinuationToken
is sent whenisTruncated
is true, which indicates that there are more analytics configurations to list. The next request must include thisNextContinuationToken
. The token is obfuscated and is not a usable value.Type: String
Examples
Sample Request
Delete the metric configuration with a specified ID, which disables the CloudWatch
metrics with the ExampleMetrics
value for the FilterId
dimension.
GET /?analytics HTTP/1.1 Host: example-bucket.s3.<Region>.amazonaws.com x-amz-date: 20160430T233541Z Authorization: authorization string
Sample Response
This example illustrates one usage of ListBucketAnalyticsConfigurations.
HTTP/1.1 200 OK x-amz-id-2: gyB+3jRPnrkN98ZajxHXr3u7EFM67bNgSAxexeEHndCX/7GRnfTXxReKUQF28IfP x-amz-request-id: 3B3C7C725673C630 Date: Sat, 30 Apr 2016 23:29:37 GMT Content-Length: length Server: AmazonS3 <ListBucketAnalyticsConfigurationResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <AnalyticsConfiguration> <Id>list1</Id> <Filter> <And> <Prefix>images/</Prefix> <Tag> <Key>dog</Key> <Value>corgi</Value> </Tag> </And> </Filter> <StorageClassAnalysis> <DataExport> <OutputSchemaVersion>V_1</OutputSchemaVersion> <Destination> <S3BucketDestination> <Format>CSV</Format> <BucketAccountId>123456789012</BucketAccountId> <Bucket>arn:aws:s3:::destination-bucket</Bucket> <Prefix>destination-prefix</Prefix> </S3BucketDestination> </Destination> </DataExport> </StorageClassAnalysis> </AnalyticsConfiguration> <AnalyticsConfiguration> <Id>report1</Id> <Filter> <And> <Prefix>images/</Prefix> <Tag> <Key>dog</Key> <Value>bulldog</Value> </Tag> </And> </Filter> <StorageClassAnalysis> <DataExport> <OutputSchemaVersion>V_1</OutputSchemaVersion> <Destination> <S3BucketDestination> <Format>CSV</Format> <BucketAccountId>123456789012</BucketAccountId> <Bucket>arn:aws:s3:::destination-bucket</Bucket> <Prefix>destination-prefix</Prefix> </S3BucketDestination> </Destination> </DataExport> </StorageClassAnalysis> </AnalyticsConfiguration> ... <IsTruncated>false</IsTruncated> <!-- If ContinuationToken was provided in the request. --> <ContinuationToken>...</ContinuationToken> <!-- if IsTruncated == true --> <IsTruncated>true</IsTruncated> <NextContinuationToken>...</NextContinuationToken> </ListBucketAnalyticsConfigurationResult>
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: