S3 / Client / get_bucket_metrics_configuration

get_bucket_metrics_configuration#

S3.Client.get_bucket_metrics_configuration(**kwargs)#

Note

This operation is not supported for directory buckets.

Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn’t include the daily storage metrics.

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 information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to GetBucketMetricsConfiguration:

See also: AWS API Documentation

Request Syntax

response = client.get_bucket_metrics_configuration(
    Bucket='string',
    Id='string',
    ExpectedBucketOwner='string'
)
Parameters:

  • Bucket (string) –

    [REQUIRED]

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

  • Id (string) –

    [REQUIRED]

    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.

  • 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).

Return type:

dict

Returns:

Response Syntax

{
    'MetricsConfiguration': {
        '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) –

    • MetricsConfiguration (dict) –

      Specifies the metrics configuration.

      • 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).

        • Prefix (string) –

          The prefix used when evaluating a metrics filter.

        • Tag (dict) –

          The tag used when evaluating a metrics filter.

          • 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.

            • (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.