Skip to content

Put Bucket Metrics Configuration

s3_put_bucket_metrics_configuration R Documentation

This operation is not supported by directory buckets

Description

This operation is not supported by directory buckets.

Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per 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.

To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration 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 put_bucket_metrics_configuration:

  • delete_bucket_metrics_configuration

  • get_bucket_metrics_configuration

  • list_bucket_metrics_configurations

put_bucket_metrics_configuration has the following special error:

  • Error code: TooManyConfigurations

    • Description: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.

    • HTTP Status Code: HTTP 400 Bad Request

Usage

s3_put_bucket_metrics_configuration(Bucket, Id, MetricsConfiguration,
  ExpectedBucketOwner)

Arguments

Bucket

[required] The name of the bucket for which the metrics configuration is set.

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.

MetricsConfiguration

[required] Specifies the metrics configuration.

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

An empty list.

Request syntax

svc$put_bucket_metrics_configuration(
  Bucket = "string",
  Id = "string",
  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"
      )
    )
  ),
  ExpectedBucketOwner = "string"
)