put_bucket_metrics_configuration¶
Operation¶
put_bucket_metrics_configuration
¶
put_bucket_metrics_configuration(request: PutBucketMetricsConfigurationInput | PutBucketMetricsConfigurationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutBucketMetricsConfigurationInputDict]) -> PutBucketMetricsConfigurationOutput
Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased.
Note
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:PutMetricsConfigurationaction. 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:PutMetricsConfigurationpermission 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:PutMetricsConfigurationpermission 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 PutBucketMetricsConfiguration:
PutBucketMetricsConfiguration has the following special error:
-
Error code:
TooManyConfigurations -
Description: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
-
HTTP Status Code: HTTP 400 Bad Request
Warning
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
PutBucketMetricsConfigurationInput | PutBucketMetricsConfigurationInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[PutBucketMetricsConfigurationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
PutBucketMetricsConfigurationOutput
|
An instance of |
put_bucket_metrics_configuration
async
¶
put_bucket_metrics_configuration(request: PutBucketMetricsConfigurationInput | PutBucketMetricsConfigurationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutBucketMetricsConfigurationInputDict]) -> PutBucketMetricsConfigurationOutput
Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased.
Note
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:PutMetricsConfigurationaction. 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:PutMetricsConfigurationpermission 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:PutMetricsConfigurationpermission 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 PutBucketMetricsConfiguration:
PutBucketMetricsConfiguration has the following special error:
-
Error code:
TooManyConfigurations -
Description: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
-
HTTP Status Code: HTTP 400 Bad Request
Warning
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
PutBucketMetricsConfigurationInput | PutBucketMetricsConfigurationInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[PutBucketMetricsConfigurationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
PutBucketMetricsConfigurationOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
PutBucketMetricsConfigurationInputDict
¶
Bases: TypedDict
Dictionary form of PutBucketMetricsConfigurationInput.
Attributes¶
bucket
instance-attribute
¶
The name of the bucket for which the metrics configuration is set.
Directory buckets - When you use this operation with a directory
bucket, you must use path-style requests in the format
https://s3express-control.region-code.amazonaws.com/bucket-name.
Virtual-hosted-style requests aren't supported. Directory bucket names
must be unique in the chosen Zone (Availability Zone or Local Zone).
Bucket names must also follow the format
bucket-base-name--zone-id--x-s3 (for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information
about bucket naming restrictions, see Directory bucket naming
rules
in the Amazon S3 User Guide
expected_bucket_owner
instance-attribute
¶
expected_bucket_owner: str | None
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 403 Forbidden (access denied).
Note
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 501 Not Implemented.
id
instance-attribute
¶
The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.
metrics_configuration
instance-attribute
¶
metrics_configuration: Required[MetricsConfiguration | MetricsConfigurationDict]
Specifies the metrics configuration.
PutBucketMetricsConfigurationInput
dataclass
¶
Bases: _SerdeShape
Dataclass for PutBucketMetricsConfigurationInput structure.
Attributes¶
bucket
class-attribute
instance-attribute
¶
bucket: str | None = ...
The name of the bucket for which the metrics configuration is set.
Directory buckets - When you use this operation with a directory
bucket, you must use path-style requests in the format
https://s3express-control.region-code.amazonaws.com/bucket-name.
Virtual-hosted-style requests aren't supported. Directory bucket names
must be unique in the chosen Zone (Availability Zone or Local Zone).
Bucket names must also follow the format
bucket-base-name--zone-id--x-s3 (for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information
about bucket naming restrictions, see Directory bucket naming
rules
in the Amazon S3 User Guide
expected_bucket_owner
class-attribute
instance-attribute
¶
expected_bucket_owner: str | None = ...
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 403 Forbidden (access denied).
Note
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 501 Not Implemented.
id
class-attribute
instance-attribute
¶
id: str | None = ...
The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.
metrics_configuration
class-attribute
instance-attribute
¶
metrics_configuration: MetricsConfiguration | None = ...
Specifies the metrics configuration.
Output¶
PutBucketMetricsConfigurationOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for PutBucketMetricsConfigurationOutput structure.