import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { ListBucketMetricsConfigurationsOutput, ListBucketMetricsConfigurationsRequest } from "../models/models_0"; import type { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link ListBucketMetricsConfigurationsCommand}. */ export interface ListBucketMetricsConfigurationsCommandInput extends ListBucketMetricsConfigurationsRequest { } /** * @public * * The output of {@link ListBucketMetricsConfigurationsCommand}. */ export interface ListBucketMetricsConfigurationsCommandOutput extends ListBucketMetricsConfigurationsOutput, __MetadataBearer { } declare const ListBucketMetricsConfigurationsCommand_base: { new (input: ListBucketMetricsConfigurationsCommandInput): import("@smithy/core/client").CommandImpl; new (input: ListBucketMetricsConfigurationsCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

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.

* *

* 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.

*
*

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.

*
*
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 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. * ```javascript * import { S3Client, ListBucketMetricsConfigurationsCommand } from "@aws-sdk/client-s3"; // ES Modules import * // const { S3Client, ListBucketMetricsConfigurationsCommand } = 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 = { // 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 - {@link ListBucketMetricsConfigurationsCommandInput} * @returns {@link ListBucketMetricsConfigurationsCommandOutput} * @see {@link ListBucketMetricsConfigurationsCommandInput} for command's `input` shape. * @see {@link ListBucketMetricsConfigurationsCommandOutput} 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 ListBucketMetricsConfigurationsCommand extends ListBucketMetricsConfigurationsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: ListBucketMetricsConfigurationsRequest; output: ListBucketMetricsConfigurationsOutput; }; sdk: { input: ListBucketMetricsConfigurationsCommandInput; output: ListBucketMetricsConfigurationsCommandOutput; }; }; }