Class GetBucketMetricsConfigurationCommand

This operation is not supported for directory buckets.

Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.

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 information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to GetBucketMetricsConfiguration:

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, GetBucketMetricsConfigurationCommand } from "ibm-cos-sdk-v2"; // ES Modules import
// const { S3Client, GetBucketMetricsConfigurationCommand } = 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 = { // GetBucketMetricsConfigurationRequest
  Bucket: "STRING_VALUE", // required
  Id: "STRING_VALUE", // required
  ExpectedBucketOwner: "STRING_VALUE",
};
const command = new GetBucketMetricsConfigurationCommand(input);
const response = await client.send(command);
// { // GetBucketMetricsConfigurationOutput
//   MetricsConfiguration: { // 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: GetBucketMetricsConfigurationCommandInput

GetBucketMetricsConfigurationCommandInput

Returns

GetBucketMetricsConfigurationCommandOutput

See

GetBucketMetricsConfigurationCommandInput for command's input shape.
GetBucketMetricsConfigurationCommandOutput 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<
    GetBucketMetricsConfigurationCommandInput,
    GetBucketMetricsConfigurationCommandOutput,
    S3ClientResolvedConfig,
    ServiceInputTypes,
    ServiceOutputTypes,
    this,
>
- GetBucketMetricsConfigurationCommand

Index

Constructors

constructor

Constructors

constructor

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

Class GetBucketMetricsConfigurationCommand

Example

Param: GetBucketMetricsConfigurationCommandInput

Returns

See

Throws

Hierarchy

Index

Constructors

Constructors

constructor

Parameters

Returns GetBucketMetricsConfigurationCommand

Parameters

Returns GetBucketMetricsConfigurationCommand

Settings

On This Page