The Wayback Machine - https://web.archive.org/web/20190919191433/https://docs.aws.amazon.com/AmazonS3/latest/API/RESTListBucketMetricsConfiguration.html
Sign In to the Console
Amazon Simple Storage Service
API Reference (API Version 2006-03-01)

AWS Documentation » Amazon Simple Storage Service (S3) » API Reference » Operations on Buckets » List Bucket Metrics Configurations
The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

List Bucket Metrics Configurations

Description

This implementation of the GET operation returns a list of Amazon CloudWatch metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per bucket.

This operation supports list pagination and does not return more than 100 configurations at a time. 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 is 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:GetMetricsConfiguration 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 Simple Storage Service Developer Guide.

For more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch in the Amazon Simple Storage Service Developer Guide.

Requests

Syntax

GET /?metrics HTTP/1.1
HOST: BucketName.s3.amazonaws.com
Content-Length: length
Date: date
Authorization: authorization string (see Authenticating Requests (AWS Signature Version
		4))

Request Parameters

Parameter Description Required
continuation-token

When the Amazon S3 response to this API call is truncated (that is, when the IsTruncated response element value is true), the response also includes the NextContinuationToken element. You can use the value of that element in the next request as the continuation-token to list the next page. The continuation token is an opaque value that Amazon S3 understands.

Type: String

Default: None

 No

Request Headers

This operation uses only Request Headers common to most requests. For more information, see Common Request Headers.

Request Elements

This operation does not use request elements.

Responses

Response Headers

The operation returns response headers that are common to most responses. For more information, see Common Response Headers.

Response Elements

Name Description
IsTruncated

Tells whether the returned list of metrics configurations is complete. A value of true indicates that the list is not complete, and the NextContinuationToken is provided for a subsequent request.

Type: Boolean

Ancestor: ListMetricsConfigurationResult
ContinuationToken

The marker that is used as a starting point for this metrics configuration list response. This value is present if it was sent in the request.

Type: String

Ancestor: ListMetricsConfigurationResult
NextContinuationToken

The marker used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

Type: String

Ancestor: ListMetricsConfigurationResult
ListMetricsConfigurationsResult

The list of metrics configurations for a bucket.

Type: Container

Examples

Sample Request

GET /?metrics HTTP/1.1
Host: examplebucket.s3.amazonaws.com
x-amz-date: Thu, 15 Nov 2016 00:17:21 GMT
Authorization: signatureValue

Sample Response

HTTP/1.1 200 OK
x-amz-id-2: ITnGT1y4REXAMPLEPi4hklTXouTf0hccUjo0iCPEXAMPLEutBj3M7fPGlWO2SEWp
x-amz-request-id: 51991EXAMPLE5321
Date: Thu, 15 Nov 2016 00:17:22 GMT
Server: AmazonS3
Content-Length: 758
 
<?xml version="1.0" encoding="UTF-8"?>
<ListMetricsConfigurationsResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
    <MetricsConfiguration>
        <Id>EntireBucket</Id>
    </MetricsConfiguration>
    <MetricsConfiguration>
        <Id>Documents</Id>
        <Filter>
            <Prefix>documents/</Prefix>
        </Filter>
    </MetricsConfiguration>
    <MetricsConfiguration>
        <Id>BlueDocuments</Id>
        <Filter>
            <And>
                <Prefix>documents/</Prefix>
                <Tag>
                    <Key>class</Key>
                    <Value>blue</Value>
                </Tag>
            </And>
        </Filter>
    </MetricsConfiguration>
    <IsTruncated>false</IsTruncated>
</ListMetricsConfigurationsResult>