GetBucketAnalyticsConfiguration
Gets an analytics configuration for a bucket.
Description
The GetBucketAnalyticsConfiguration operation returns an analytics configuration (identified by the configuration ID) from the bucket. By default, this operation returns information about access patterns for objects in a bucket.
note
- To use this operation, you must have permission to perform the
s3:GetAnalyticsConfigurationaction. - You must be the bucket owner to use this operation.
- If the specified configuration does not exist, QStorage returns a
NoSuchConfigurationerror.
Request Syntax
GET /?analytics&id=ConfigurationId HTTP/1.1
Host: BucketName.qstorage.quilibrium.com
x-amz-expected-bucket-owner: OwnerAccountId
Values in italics indicate user input and should be replaced with actual values.
This operation does not have a request body.
Request Parameters
URI Parameters
| Name | Description | Required | Type |
|---|---|---|---|
| id | The ID that identifies the analytics configuration | Yes | text |
Headers
| Name | Description | Required | Type |
|---|---|---|---|
| x-amz-expected-bucket-owner | The account ID of the expected bucket owner | No | text |
Examples
Example 1: Get analytics configuration from a bucket
GET /?analytics&id=config1 HTTP/1.1
Host: my-bucket.qstorage.quilibrium.com
Values in italics indicate user input and should be replaced with actual values.
HTTP/1.1 200 OK
x-amz-id-2: Example7qoYGN7uMuFuYS6m7a4l
x-amz-request-id: TX234S0F24A06C7
Date: Wed, 01 Mar 2024 12:00:00 GMT
<?xml version="1.0" encoding="UTF-8"?>
<AnalyticsConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
<Id>config1</Id>
<Filter>
<Prefix>documents/</Prefix>
</Filter>
<StorageClassAnalysis>
<DataExport>
<OutputSchemaVersion>V_1</OutputSchemaVersion>
<Destination>
<S3BucketDestination>
<Format>CSV</Format>
<BucketAccountId>123456789012</BucketAccountId>
<Bucket>arn:aws:s3:::destination-bucket</Bucket>
<Prefix>reports/</Prefix>
</S3BucketDestination>
</Destination>
</DataExport>
</StorageClassAnalysis>
</AnalyticsConfiguration>
Values in italics indicate variable response values.
Response Syntax
HTTP/1.1 200 OK
x-amz-id-2: RequestId
x-amz-request-id: AmazonRequestId
Date: ISO8601Date
<?xml version="1.0" encoding="UTF-8"?>
<AnalyticsConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
<Id>ConfigurationId</Id>
<Filter>
<And>
<Prefix>Prefix</Prefix>
<Tag>
<Key>Key</Key>
<Value>Value</Value>
</Tag>
</And>
</Filter>
<StorageClassAnalysis>
<DataExport>
<OutputSchemaVersion>Version</OutputSchemaVersion>
<Destination>
<S3BucketDestination>
<Format>Format</Format>
<BucketAccountId>AccountId</BucketAccountId>
<Bucket>BucketARN</Bucket>
<Prefix>Prefix</Prefix>
</S3BucketDestination>
</Destination>
</DataExport>
</StorageClassAnalysis>
</AnalyticsConfiguration>
Values in italics indicate variable response values.
Response Elements
Response Headers
| Name | Description | Required | Type |
|---|---|---|---|
| x-amz-id-2 | An identifier for the request | No | String |
| x-amz-request-id | A unique identifier for the request | No | String |
| Date | The date and time at which the response was sent | No | String |
Response Body Elements
| Name | Type | Description | Required |
|---|---|---|---|
| AnalyticsConfiguration | Container | Container for the analytics configuration | Yes |
| Id | String | The ID that identifies the analytics configuration | Yes |
| Filter | AnalyticsFilter | Container for the filter used to describe a set of objects for analyses | No |
Special Errors
| Error Code | Description |
|---|---|
| NoSuchBucket | The specified bucket does not exist |
| NoSuchConfiguration | The specified configuration does not exist |
| 403 | Forbidden. Authentication failed or you do not have permission to get the analytics configuration |
Permissions
You must have the s3:GetAnalyticsConfiguration permission.
Try It Out
Test GetBucketAnalyticsConfiguration
Get an analytics configuration from a bucket.
Coming Soon
This feature is currently under development and will be available soon.