Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . s3api ]

put-bucket-metrics-configuration

Description

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 PutBucketMetricsConfiguration :

  • DeleteBucketMetricsConfiguration
  • PutBucketMetricsConfiguration
  • ListBucketMetricsConfigurations
GetBucketLifecycle 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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  put-bucket-metrics-configuration
--bucket <value>
--id <value>
--metrics-configuration <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--bucket (string)

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

--id (string)

The ID used to identify the metrics configuration.

--metrics-configuration (structure)

Specifies the metrics configuration.

JSON Syntax:

{
  "Id": "string",
  "Filter": {
    "Prefix": "string",
    "Tag": {
      "Key": "string",
      "Value": "string"
    },
    "And": {
      "Prefix": "string",
      "Tags": [
        {
          "Key": "string",
          "Value": "string"
        }
        ...
      ]
    }
  }
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

None