GetBucketAnalyticsConfigurationCommand

Suggest an Edit

This operation is not supported for directory buckets.

This implementation of the GET action returns an analytics configuration (identified by the analytics configuration ID) from the bucket.

To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration 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  in the Amazon S3 User Guide.

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis  in the Amazon S3 User Guide.

The following operations are related to GetBucketAnalyticsConfiguration:

Example Syntax

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

import { S3Client, GetBucketAnalyticsConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import
// const { S3Client, GetBucketAnalyticsConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
const client = new S3Client(config);
const input = { // GetBucketAnalyticsConfigurationRequest
  Bucket: "STRING_VALUE", // required
  Id: "STRING_VALUE", // required
  ExpectedBucketOwner: "STRING_VALUE",
};
const command = new GetBucketAnalyticsConfigurationCommand(input);
const response = await client.send(command);
// { // GetBucketAnalyticsConfigurationOutput
//   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",
//           },
//         },
//       },
//     },
//   },
// };

GetBucketAnalyticsConfigurationCommand Input

See GetBucketAnalyticsConfigurationCommandInput for more details

Parameter
Type
Description
Bucket
Required
string | undefined

The name of the bucket from which an analytics configuration is retrieved.

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

GetBucketAnalyticsConfigurationCommand Output

See GetBucketAnalyticsConfigurationCommandOutput for details

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

The configuration and any analyses for the analytics filter.

Throws

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