import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { GetBucketMetricsConfigurationOutput, GetBucketMetricsConfigurationRequest } from "../models/models_0"; import type { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link GetBucketMetricsConfigurationCommand}. */ export interface GetBucketMetricsConfigurationCommandInput extends GetBucketMetricsConfigurationRequest { } /** * @public * * The output of {@link GetBucketMetricsConfigurationCommand}. */ export interface GetBucketMetricsConfigurationCommandOutput extends GetBucketMetricsConfigurationOutput, __MetadataBearer { } declare const GetBucketMetricsConfigurationCommand_base: { new (input: GetBucketMetricsConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: GetBucketMetricsConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * *

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. * ```javascript * import { S3Client, GetBucketMetricsConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import * // const { S3Client, GetBucketMetricsConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import * // import type { S3ClientConfig } from "@aws-sdk/client-s3"; * 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 - {@link GetBucketMetricsConfigurationCommandInput} * @returns {@link GetBucketMetricsConfigurationCommandOutput} * @see {@link GetBucketMetricsConfigurationCommandInput} for command's `input` shape. * @see {@link GetBucketMetricsConfigurationCommandOutput} for command's `response` shape. * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape. * * @throws {@link S3ServiceException} *

Base exception class for all service exceptions from S3 service.

* * * @public */ export declare class GetBucketMetricsConfigurationCommand extends GetBucketMetricsConfigurationCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetBucketMetricsConfigurationRequest; output: GetBucketMetricsConfigurationOutput; }; sdk: { input: GetBucketMetricsConfigurationCommandInput; output: GetBucketMetricsConfigurationCommandOutput; }; }; }