Class GetBucketAnalyticsConfigurationCommand

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:

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

Example

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

import { S3Client, GetBucketAnalyticsConfigurationCommand } from "ibm-cos-sdk-v2"; // ES Modules import
// const { S3Client, GetBucketAnalyticsConfigurationCommand } = require("ibm-cos-sdk-v2"); // CommonJS import
// import type { S3ClientConfig } from "ibm-cos-sdk-v2";
const config = {}; // type is S3ClientConfig
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

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.

Hierarchy

CommandImpl<
    GetBucketAnalyticsConfigurationCommandInput,
    GetBucketAnalyticsConfigurationCommandOutput,
    S3ClientResolvedConfig,
    ServiceInputTypes,
    ServiceOutputTypes,
    this,
>
- GetBucketAnalyticsConfigurationCommand

Index

Constructors

constructor

Constructors

constructor

new GetBucketAnalyticsConfigurationCommand(
input: GetBucketAnalyticsConfigurationCommandInput,
): GetBucketAnalyticsConfigurationCommand
Parameters
- input: GetBucketAnalyticsConfigurationCommandInput
Returns GetBucketAnalyticsConfigurationCommand
Inherited from $Command .classBuilder< GetBucketAnalyticsConfigurationCommandInput, GetBucketAnalyticsConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes >() .ep({ ...commonParams, UseS3ExpressControlEndpoint: { type: "staticContextParams", value: true }, Bucket: { type: "contextParams", name: "Bucket" }, }) .m(function (this: any, Command: any, cs: any, config: S3ClientResolvedConfig, o: any) { return [ getEndpointPlugin(config, Command.getEndpointParameterInstructions()), getThrow200ExceptionsPlugin(config), ]; }) .s("AmazonS3", "GetBucketAnalyticsConfiguration", {}) .n("S3Client", "GetBucketAnalyticsConfigurationCommand") .sc(GetBucketAnalyticsConfiguration$) .build().constructor
- Defined in node_modules/@smithy/smithy-client/dist-types/command.d.ts:103
new GetBucketAnalyticsConfigurationCommand(
...__namedParameters: [GetBucketAnalyticsConfigurationCommandInput],
): GetBucketAnalyticsConfigurationCommand
Parameters
- ...__namedParameters: [GetBucketAnalyticsConfigurationCommandInput]
Returns GetBucketAnalyticsConfigurationCommand
Inherited from $Command .classBuilder< GetBucketAnalyticsConfigurationCommandInput, GetBucketAnalyticsConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes >() .ep({ ...commonParams, UseS3ExpressControlEndpoint: { type: "staticContextParams", value: true }, Bucket: { type: "contextParams", name: "Bucket" }, }) .m(function (this: any, Command: any, cs: any, config: S3ClientResolvedConfig, o: any) { return [ getEndpointPlugin(config, Command.getEndpointParameterInstructions()), getThrow200ExceptionsPlugin(config), ]; }) .s("AmazonS3", "GetBucketAnalyticsConfiguration", {}) .n("S3Client", "GetBucketAnalyticsConfigurationCommand") .sc(GetBucketAnalyticsConfiguration$) .build().constructor
- Defined in node_modules/@smithy/smithy-client/dist-types/command.d.ts:104

Class GetBucketAnalyticsConfigurationCommand

Example

Param: GetBucketAnalyticsConfigurationCommandInput

Returns

See

Throws

Hierarchy

Index

Constructors

Constructors

constructor

Parameters

Returns GetBucketAnalyticsConfigurationCommand

Parameters

Returns GetBucketAnalyticsConfigurationCommand

Settings

On This Page