Container for the parameters to the ListBucketMetricsConfigurations operation. 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:GetMetricsConfigurationaction. 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:GetMetricsConfigurationpermission 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:GetMetricsConfigurationpermission 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.
In this article ▶
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.S3.Model.ListBucketMetricsConfigurationsRequest
Namespace: Amazon.S3.Model
Assembly: AWSSDK.S3.dll
Version: 3.x.y.z
Syntax
public class ListBucketMetricsConfigurationsRequest : AmazonWebServiceRequest IAmazonWebServiceRequest
The ListBucketMetricsConfigurationsRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
ListBucketMetricsConfigurationsRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
BucketName | System.String |
Gets and sets the property BucketName. The name of the bucket containing the metrics configurations to retrieve. Directory buckets - When you use this operation with a directory bucket,
you must use path-style requests in the format |
|
|
ContinuationToken | System.String |
Gets and sets the property ContinuationToken.
The marker that is used to continue a metrics configuration listing that has been
truncated. Use the |
|
|
ExpectedBucketOwner | System.String |
Gets and sets the property ExpectedBucketOwner.
The account ID of the expected bucket owner. If the account ID that you provide does
not match the actual owner of the bucket, the request fails with the HTTP status code
For directory buckets, this header is not supported in this API operation. If you
specify this header, the request fails with the HTTP status code |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer