Class ListBucketAnalyticsConfigurationsCommand

This operation is not supported for directory buckets.

Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

This action supports list pagination and does not return more than 100 configurations at a time. You should always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there will be a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

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.

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.

The following operations are related to ListBucketAnalyticsConfigurations:

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, ListBucketAnalyticsConfigurationsCommand } from "ibm-cos-sdk-v2"; // ES Modules import
// const { S3Client, ListBucketAnalyticsConfigurationsCommand } = 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 = { // ListBucketAnalyticsConfigurationsRequest
  Bucket: "STRING_VALUE", // required
  ContinuationToken: "STRING_VALUE",
  ExpectedBucketOwner: "STRING_VALUE",
};
const command = new ListBucketAnalyticsConfigurationsCommand(input);
const response = await client.send(command);
// { // ListBucketAnalyticsConfigurationsOutput
//   IsTruncated: true || false,
//   ContinuationToken: "STRING_VALUE",
//   NextContinuationToken: "STRING_VALUE",
//   AnalyticsConfigurationList: [ // AnalyticsConfigurationList
//     { // 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",
//             },
//           },
//         },
//       },
//     },
//   ],
// };

Base exception class for all service exceptions from S3 service.

Hierarchy

CommandImpl<
    ListBucketAnalyticsConfigurationsCommandInput,
    ListBucketAnalyticsConfigurationsCommandOutput,
    S3ClientResolvedConfig,
    ServiceInputTypes,
    ServiceOutputTypes,
    this,
>
- ListBucketAnalyticsConfigurationsCommand

Index

Constructors

constructor

Constructors

constructor

new ListBucketAnalyticsConfigurationsCommand(
input: ListBucketAnalyticsConfigurationsCommandInput,
): ListBucketAnalyticsConfigurationsCommand
Parameters
- input: ListBucketAnalyticsConfigurationsCommandInput
Returns ListBucketAnalyticsConfigurationsCommand
Inherited from $Command .classBuilder< ListBucketAnalyticsConfigurationsCommandInput, ListBucketAnalyticsConfigurationsCommandOutput, 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", "ListBucketAnalyticsConfigurations", {}) .n("S3Client", "ListBucketAnalyticsConfigurationsCommand") .sc(ListBucketAnalyticsConfigurations$) .build().constructor
- Defined in node_modules/@smithy/smithy-client/dist-types/command.d.ts:103
new ListBucketAnalyticsConfigurationsCommand(
...__namedParameters: [ListBucketAnalyticsConfigurationsCommandInput],
): ListBucketAnalyticsConfigurationsCommand
Parameters
- ...__namedParameters: [ListBucketAnalyticsConfigurationsCommandInput]
Returns ListBucketAnalyticsConfigurationsCommand
Inherited from $Command .classBuilder< ListBucketAnalyticsConfigurationsCommandInput, ListBucketAnalyticsConfigurationsCommandOutput, 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", "ListBucketAnalyticsConfigurations", {}) .n("S3Client", "ListBucketAnalyticsConfigurationsCommand") .sc(ListBucketAnalyticsConfigurations$) .build().constructor
- Defined in node_modules/@smithy/smithy-client/dist-types/command.d.ts:104

Class ListBucketAnalyticsConfigurationsCommand

Example

Param: ListBucketAnalyticsConfigurationsCommandInput

Returns

See

Throws

Hierarchy

Index

Constructors

Constructors

constructor

Parameters

Returns ListBucketAnalyticsConfigurationsCommand

Parameters

Returns ListBucketAnalyticsConfigurationsCommand

Settings

On This Page