PutBucketAnalyticsConfigurationCommand

Suggest an Edit

This operation is not supported for directory buckets.

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 .

PutBucketAnalyticsConfiguration has the following 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.

The following operations are related to PutBucketAnalyticsConfiguration:

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { S3Client, PutBucketAnalyticsConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import
// const { S3Client, PutBucketAnalyticsConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
const client = new S3Client(config);
const input = { // PutBucketAnalyticsConfigurationRequest
  Bucket: "STRING_VALUE", // required
  Id: "STRING_VALUE", // required
  AnalyticsConfiguration: { // AnalyticsConfiguration
    Id: "STRING_VALUE", // required
    Filter: { // AnalyticsFilter Union: only one key present
      Prefix: "STRING_VALUE",
      Tag: { // Tag
        Key: "STRING_VALUE", // required
        Value: "STRING_VALUE", // required
      },
      And: { // AnalyticsAndOperator
        Prefix: "STRING_VALUE",
        Tags: [ // TagSet
          {
            Key: "STRING_VALUE", // required
            Value: "STRING_VALUE", // required
          },
        ],
      },
    },
    StorageClassAnalysis: { // StorageClassAnalysis
      DataExport: { // StorageClassAnalysisDataExport
        OutputSchemaVersion: "V_1", // required
        Destination: { // AnalyticsExportDestination
          S3BucketDestination: { // AnalyticsS3BucketDestination
            Format: "CSV", // required
            BucketAccountId: "STRING_VALUE",
            Bucket: "STRING_VALUE", // required
            Prefix: "STRING_VALUE",
          },
        },
      },
    },
  },
  ExpectedBucketOwner: "STRING_VALUE",
};
const command = new PutBucketAnalyticsConfigurationCommand(input);
const response = await client.send(command);
// {};

PutBucketAnalyticsConfigurationCommand Input

See PutBucketAnalyticsConfigurationCommandInput for more details

Parameter
Type
Description
AnalyticsConfiguration
Required
AnalyticsConfiguration | undefined

The configuration and any analyses for the analytics filter.

Bucket
Required
string | undefined

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

Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "aws-sdk/signature-v4-crt" package to your project dependencies. For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues

Id
Required
string | undefined

The ID that identifies the analytics configuration.

ExpectedBucketOwner
string | undefined

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

PutBucketAnalyticsConfigurationCommand Output

See PutBucketAnalyticsConfigurationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
S3ServiceException
Base exception class for all service exceptions from S3 service.