Get Bucket Metrics Configuration

s3_get_bucket_metrics_configuration

R Documentation

This operation is not supported by directory buckets

Description

This operation is not supported by 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 get_bucket_metrics_configuration:

• put_bucket_metrics_configuration

• delete_bucket_metrics_configuration

• list_bucket_metrics_configurations

• Monitoring Metrics with Amazon CloudWatch

Usage

s3_get_bucket_metrics_configuration(Bucket, Id, ExpectedBucketOwner)

Arguments

Bucket

[required] The name of the bucket containing the metrics configuration to retrieve.

Id

[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

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

Value

A list with the following syntax:

list(
  MetricsConfiguration = list(
    Id = "string",
    Filter = list(
      Prefix = "string",
      Tag = list(
        Key = "string",
        Value = "string"
      ),
      AccessPointArn = "string",
      And = list(
        Prefix = "string",
        Tags = list(
          list(
            Key = "string",
            Value = "string"
          )
        ),
        AccessPointArn = "string"
      )
    )
  )
)

Request syntax

svc$get_bucket_metrics_configuration(
  Bucket = "string",
  Id = "string",
  ExpectedBucketOwner = "string"
)