import { Command as $Command } from "@smithy/core/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/core/client").CommandImpl; new (input: GetBucketMetricsConfigurationCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

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

* *

* Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name * . Virtual-hosted-style requests aren't supported. * For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the * Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the * Amazon S3 User Guide.

*
*
*
Permissions
*
*

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.

*
    *
  • *

    * General purpose bucket permissions - The * s3:GetMetricsConfiguration permission is required in a policy. For more information * about general purpose buckets permissions, see Using Bucket Policies and User * Policies in the Amazon S3 User Guide.

    *
  • *
  • *

    * Directory bucket permissions - To grant access to * this API operation, you must have the s3express:GetMetricsConfiguration permission in * an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. * For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

    *
  • *
*
*
HTTP Host header syntax
*
*

* Directory buckets - The HTTP Host header syntax is s3express-control.region-code.amazonaws.com.

*
*
*

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; }; }; }