s3_get_bucket_metrics_configuration: Gets a metrics configuration (specified by the metrics...

In paws.storage: 'Amazon Web Services' Storage Services

Description

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.
ExpectedBucketOwner	The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Value

A list with the following syntax:

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

Request syntax

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

paws.storage documentation built on Aug. 23, 2021, 1:06 a.m.