Class GetBucketAnalyticsConfigurationCommandProtected

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:

• DeleteBucketAnalyticsConfiguration

• ListBucketAnalyticsConfigurations

• PutBucketAnalyticsConfiguration

Example

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",
//           },
//         },
//       },
//     },
//   },
// };

Param

GetBucketAnalyticsConfigurationCommandInput

Returns

GetBucketAnalyticsConfigurationCommandOutput

See

• GetBucketAnalyticsConfigurationCommandInput for command's input shape.
• GetBucketAnalyticsConfigurationCommandOutput for command's response shape.
• config for S3Client's config shape.

Throws

S3ServiceException

Base exception class for all service exceptions from S3 service.