@aws-sdk/client-s3
Version:
AWS SDK for JavaScript S3 Client for Node.js, Browser and React Native
171 lines (170 loc) • 10.2 kB
TypeScript
import { Command as $Command } from "@smithy/smithy-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/smithy-client").CommandImpl<ListBucketMetricsConfigurationsCommandInput, ListBucketMetricsConfigurationsCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
new (input: ListBucketMetricsConfigurationsCommandInput): import("@smithy/smithy-client").CommandImpl<ListBucketMetricsConfigurationsCommandInput, ListBucketMetricsConfigurationsCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
};
/**
* <p>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.</p>
* <note>
* <p>
* <b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format <code>https://s3express-control.<i>region-code</i>.amazonaws.com/<i>bucket-name</i>
* </code>. Virtual-hosted-style requests aren't supported.
* For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
* <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Concepts for directory buckets in Local Zones</a> in the
* <i>Amazon S3 User Guide</i>.</p>
* </note>
* <p>This action supports list pagination and does not return more than 100 configurations at a time.
* Always check the <code>IsTruncated</code> element in the response. If there are no more configurations
* to list, <code>IsTruncated</code> is set to false. If there are more configurations to list,
* <code>IsTruncated</code> is set to true, and there is a value in <code>NextContinuationToken</code>.
* You use the <code>NextContinuationToken</code> value to continue the pagination of the list by passing
* the value in <code>continuation-token</code> in the request to <code>GET</code> the next page.</p>
* <dl>
* <dt>Permissions</dt>
* <dd>
* <p>To use this operation, you must have permissions to perform the
* <code>s3:GetMetricsConfiguration</code> action. The bucket owner has this permission by default. The
* bucket owner can grant this permission to others. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to Your Amazon S3
* Resources</a>.</p>
* <ul>
* <li>
* <p>
* <b>General purpose bucket permissions</b> - The
* <code>s3:GetMetricsConfiguration</code> permission is required in a policy. For more information
* about general purpose buckets permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User
* Policies</a> in the <i>Amazon S3 User Guide</i>.</p>
* </li>
* <li>
* <p>
* <b>Directory bucket permissions</b> - To grant access to
* this API operation, you must have the <code>s3express:GetMetricsConfiguration</code> 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html">Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>.</p>
* </li>
* </ul>
* </dd>
* <dt>HTTP Host header syntax</dt>
* <dd>
* <p>
* <b>Directory buckets </b> - The HTTP Host header syntax is <code>s3express-control.<i>region-code</i>.amazonaws.com</code>.</p>
* </dd>
* </dl>
* <p>For more information about metrics configurations and CloudWatch request metrics, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with
* Amazon CloudWatch</a>.</p>
* <p>The following operations are related to <code>ListBucketMetricsConfigurations</code>:</p>
* <ul>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html">PutBucketMetricsConfiguration</a>
* </p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html">GetBucketMetricsConfiguration</a>
* </p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html">DeleteBucketMetricsConfiguration</a>
* </p>
* </li>
* </ul>
* <important>
* <p>You must URL encode any signed header values that contain spaces. For example, if your header value is <code>my file.txt</code>, containing two spaces after <code>my</code>, you must URL encode this value to <code>my%20%20file.txt</code>.</p>
* </important>
* @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}
* <p>Base exception class for all service exceptions from S3 service.</p>
*
*
* @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;
};
};
}