S3 / Client / list_bucket_metrics_configurations

list_bucket_metrics_configurations¶

S3.Client.list_bucket_metrics_configurations(**kwargs)¶

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.

Note

Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format ``https://s3express-control.region-code.amazonaws.com/bucket-name ``. Virtual-hosted-style requests aren’t supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.

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.

Permissions

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.

General purpose bucket permissions - The s3:GetMetricsConfiguration permission is required in a policy. For more information about general purpose buckets permissions, see Using Bucket Policies and User Policies in the Amazon S3 User Guide.
Directory bucket permissions - To grant access to this API operation, you must have the s3express:GetMetricsConfiguration permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn’t supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region-code.amazonaws.com.

For more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to ListBucketMetricsConfigurations:

Warning

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

Request Syntax

response = client.list_bucket_metrics_configurations(
    Bucket='string',
    ContinuationToken='string',
    ExpectedBucketOwner='string'
)

Parameters:

Bucket (string) –
[REQUIRED]

The name of the bucket containing the metrics configurations to retrieve.

Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name ``. Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format ``bucket-base-name--zone-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide
ContinuationToken (string) – 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.
ExpectedBucketOwner (string) –
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).

Note
For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.

Return type:

dict

Returns:

Response Syntax

{
    'IsTruncated': True|False,
    'ContinuationToken': 'string',
    'NextContinuationToken': 'string',
    'MetricsConfigurationList': [
        {
            'Id': 'string',
            'Filter': {
                'Prefix': 'string',
                'Tag': {
                    'Key': 'string',
                    'Value': 'string'
                },
                'AccessPointArn': 'string',
                'And': {
                    'Prefix': 'string',
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ],
                    'AccessPointArn': 'string'
                }
            }
        },
    ]
}

Response Structure

(dict) –
- IsTruncated (boolean) –
  
  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.
- ContinuationToken (string) –
  
  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.
- NextContinuationToken (string) –
  
  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.
- MetricsConfigurationList (list) –
  
  The list of metrics configurations for a bucket.
  - (dict) –
    
    Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you’re updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don’t include the elements you want to keep, they are erased. For more information, see PutBucketMetricsConfiguration.
    - Id (string) –
      
      The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.
    - Filter (dict) –
      
      Specifies a metrics configuration filter. The metrics configuration will only include objects that meet the filter’s criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator).
      
      Note
      Metrics configurations for directory buckets do not support tag filters.
      - Prefix (string) –
        
        The prefix used when evaluating a metrics filter.
      - Tag (dict) –
        
        The tag used when evaluating a metrics filter.
        
        Note
        Tag filters are not supported for directory buckets.
        
        Key (string) –
        
        Name of the object key.
        
        Value (string) –
        
        Value of the tag.
      - AccessPointArn (string) –
        
        The access point ARN used when evaluating a metrics filter.
      - And (dict) –
        
        A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.
        
        Prefix (string) –
        
        The prefix used when evaluating an AND predicate.
        
        Tags (list) –
        
        The list of tags used when evaluating an AND predicate.
        
        Note
        Tag filters are not supported for directory buckets.
        
        (dict) –
        
        A container of a key value name pair.
        
        Key (string) –
        
        Name of the object key.
        
        Value (string) –
        
        Value of the tag.
        
        AccessPointArn (string) –
        
        The access point ARN used when evaluating an AND predicate.