Class ListBucketMetricsConfigurationsCommand

This operation is not supported for directory buckets.

Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per bucket.

This action supports list pagination and does not return more than 100 configurations at a time. 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 is 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:GetMetricsConfiguration 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 more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to ListBucketMetricsConfigurations:

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, ListBucketMetricsConfigurationsCommand } from "ibm-cos-sdk-v2"; // ES Modules import
// const { S3Client, ListBucketMetricsConfigurationsCommand } = 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 = { // ListBucketMetricsConfigurationsRequest
  Bucket: "STRING_VALUE", // required
  ContinuationToken: "STRING_VALUE",
  ExpectedBucketOwner: "STRING_VALUE",
};
const command = new ListBucketMetricsConfigurationsCommand(input);
const response = await client.send(command);
// { // ListBucketMetricsConfigurationsOutput
//   IsTruncated: true || false,
//   ContinuationToken: "STRING_VALUE",
//   NextContinuationToken: "STRING_VALUE",
//   MetricsConfigurationList: [ // MetricsConfigurationList
//     { // MetricsConfiguration
//       Id: "STRING_VALUE", // required
//       Filter: { // MetricsFilter Union: only one key present
//         Prefix: "STRING_VALUE",
//         Tag: { // Tag
//           Key: "STRING_VALUE", // required
//           Value: "STRING_VALUE", // required
//         },
//         AccessPointArn: "STRING_VALUE",
//         And: { // MetricsAndOperator
//           Prefix: "STRING_VALUE",
//           Tags: [ // TagSet
//             {
//               Key: "STRING_VALUE", // required
//               Value: "STRING_VALUE", // required
//             },
//           ],
//           AccessPointArn: "STRING_VALUE",
//         },
//       },
//     },
//   ],
// };

Param: ListBucketMetricsConfigurationsCommandInput

ListBucketMetricsConfigurationsCommandInput

Returns

ListBucketMetricsConfigurationsCommandOutput

See

ListBucketMetricsConfigurationsCommandInput for command's input shape.
ListBucketMetricsConfigurationsCommandOutput 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<
    ListBucketMetricsConfigurationsCommandInput,
    ListBucketMetricsConfigurationsCommandOutput,
    S3ClientResolvedConfig,
    ServiceInputTypes,
    ServiceOutputTypes,
    this,
>
- ListBucketMetricsConfigurationsCommand

Index

Constructors

constructor

Constructors

constructor

new ListBucketMetricsConfigurationsCommand(
input: ListBucketMetricsConfigurationsCommandInput,
): ListBucketMetricsConfigurationsCommand
Parameters
- input: ListBucketMetricsConfigurationsCommandInput
Returns ListBucketMetricsConfigurationsCommand
Inherited from $Command .classBuilder< ListBucketMetricsConfigurationsCommandInput, ListBucketMetricsConfigurationsCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes >() .ep({ ...commonParams, 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", "ListBucketMetricsConfigurations", {}) .n("S3Client", "ListBucketMetricsConfigurationsCommand") .sc(ListBucketMetricsConfigurations$) .build().constructor
- Defined in node_modules/@smithy/smithy-client/dist-types/command.d.ts:103
new ListBucketMetricsConfigurationsCommand(
...__namedParameters: [ListBucketMetricsConfigurationsCommandInput],
): ListBucketMetricsConfigurationsCommand
Parameters
- ...__namedParameters: [ListBucketMetricsConfigurationsCommandInput]
Returns ListBucketMetricsConfigurationsCommand
Inherited from $Command .classBuilder< ListBucketMetricsConfigurationsCommandInput, ListBucketMetricsConfigurationsCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes >() .ep({ ...commonParams, 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", "ListBucketMetricsConfigurations", {}) .n("S3Client", "ListBucketMetricsConfigurationsCommand") .sc(ListBucketMetricsConfigurations$) .build().constructor
- Defined in node_modules/@smithy/smithy-client/dist-types/command.d.ts:104

Class ListBucketMetricsConfigurationsCommand

Example

Param: ListBucketMetricsConfigurationsCommandInput

Returns

See

Throws

Hierarchy

Index

Constructors

Constructors

constructor

Parameters

Returns ListBucketMetricsConfigurationsCommand

Parameters

Returns ListBucketMetricsConfigurationsCommand

Settings

On This Page