Table Of Contents


User Guide

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

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . s3api ]



Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket.

You can choose to have storage class analysis export analysis reports sent to a comma-separated values (CSV) flat file. See the DataExport request element. Reports are updated daily and are based on the object filters that you configure. When selecting data export, you specify a destination bucket and an optional destination prefix where the file is written. You can export the data to a destination bucket in a different account. However, the destination bucket must be in the same Region as the bucket that you are making the PUT analytics configuration to. For more information, see Amazon S3 Analytics – Storage Class Analysis .


You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis .

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

Special Errors
    • HTTP Error: HTTP 400 Bad Request
    • Code: InvalidArgument
    • Cause: Invalid argument.
    • HTTP Error: HTTP 400 Bad Request
    • Code: TooManyConfigurations
    • Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
    • HTTP Error: HTTP 403 Forbidden
    • Code: AccessDenied
    • Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration bucket permission to set the configuration on the bucket.

    Related Resources

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


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


--bucket (string)

The name of the bucket to which an analytics configuration is stored.

--id (string)

The ID that identifies the analytics configuration.

--analytics-configuration (structure)

The configuration and any analyses for the analytics filter.

JSON Syntax:

  "Id": "string",
  "Filter": {
    "Prefix": "string",
    "Tag": {
      "Key": "string",
      "Value": "string"
    "And": {
      "Prefix": "string",
      "Tags": [
          "Key": "string",
          "Value": "string"
  "StorageClassAnalysis": {
    "DataExport": {
      "OutputSchemaVersion": "V_1",
      "Destination": {
        "S3BucketDestination": {
          "Format": "CSV",
          "BucketAccountId": "string",
          "Bucket": "string",
          "Prefix": "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.


To sets an analytics configuration for the bucket

The following put-bucket-analytics-configuration example configures analytics for the specified bucket.

aws s3api put-bucket-analytics-configuration \
    --bucket my-bucket --id 1 \
    --analytics-configuration '{"Id": "1","StorageClassAnalysis": {}}'

This command produces no output.