GetBucketAnalyticsConfiguration - Amazon Simple Storage Service



This operation is not supported by 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:

Request Syntax

GET /?analytics&id=Id HTTP/1.1 Host: x-amz-expected-bucket-owner: ExpectedBucketOwner

URI Request Parameters

The request uses the following URI parameters.


The name of the bucket from which an analytics configuration is retrieved.

Required: Yes


The ID that identifies the analytics configuration.

Required: Yes


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"?> <AnalyticsConfiguration> <Id>string</Id> <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> <StorageClassAnalysis> <DataExport> <Destination> <S3BucketDestination> <Bucket>string</Bucket> <BucketAccountId>string</BucketAccountId> <Format>string</Format> <Prefix>string</Prefix> </S3BucketDestination> </Destination> <OutputSchemaVersion>string</OutputSchemaVersion> </DataExport> </StorageClassAnalysis> </AnalyticsConfiguration>

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.


Root level tag for the AnalyticsConfiguration parameters.

Required: Yes


The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.

Type: AnalyticsFilter data type


The ID that identifies the analytics configuration.

Type: String


Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes.

Type: StorageClassAnalysis data type


Configure an Analytics Report

The following GET request for the bucket examplebucket returns the inventory configuration with the ID list1:

GET /?analytics&id=list1 HTTP/1.1 Host: examplebucket.s3.<Region> Date: Mon, 31 Oct 2016 12:00:00 GMT Authorization: authorization string


The following is a sample response to the preceding GET request.

HTTP/1.1 200 OK x-amz-id-2: YgIPIfBiKa2bj0KMgUAdQkf3ShJTOOpXUueF6QKo x-amz-request-id: 236A8905248E5A02 Date: Mon, 31 Oct 2016 12:00:00 GMT Server: AmazonS3 Content-Length: length <?xml version="1.0" encoding="UTF-8"?> <AnalyticsConfiguration xmlns=""> <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>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: