ListBucketMetricsConfigurations
Note
This operation is not supported for directory buckets.
Lists the 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 action 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.
For more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to
ListBucketMetricsConfigurations
:
Request Syntax
GET /?metrics&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 containing the metrics configurations to retrieve.
Required: Yes
- continuation-token
-
The marker that is 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. - 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"?>
<ListMetricsConfigurationsResult>
<IsTruncated>boolean</IsTruncated>
<ContinuationToken>string</ContinuationToken>
<NextContinuationToken>string</NextContinuationToken>
<MetricsConfiguration>
<Filter>
<AccessPointArn>string</AccessPointArn>
<And>
<AccessPointArn>string</AccessPointArn>
<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>
</MetricsConfiguration>
...
</ListMetricsConfigurationsResult>
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.
- ListMetricsConfigurationsResult
-
Root level tag for the ListMetricsConfigurationsResult parameters.
Required: Yes
- 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
- IsTruncated
-
Indicates whether the returned list of metrics 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
- MetricsConfiguration
-
The list of metrics configurations for a bucket.
Type: Array of MetricsConfiguration data types
- 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
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 /?metrics HTTP/1.1 Host: examplebucket.s3.<Region>.amazonaws.com x-amz-date: Thu, 15 Nov 2016 00:17:21 GMT Authorization: signatureValue
Sample Response
Delete the metric configuration with a specified ID, which disables the CloudWatch
metrics with the ExampleMetrics
value for the FilterId
dimension.
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>
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: