aws_sdk_s3/operation/put_bucket_metrics_configuration/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::put_bucket_metrics_configuration::_put_bucket_metrics_configuration_input::PutBucketMetricsConfigurationInputBuilder;
3
4pub use crate::operation::put_bucket_metrics_configuration::_put_bucket_metrics_configuration_output::PutBucketMetricsConfigurationOutputBuilder;
5
6impl crate::operation::put_bucket_metrics_configuration::builders::PutBucketMetricsConfigurationInputBuilder {
7 /// Sends a request with this input using the given client.
8 pub async fn send_with(
9 self,
10 client: &crate::Client,
11 ) -> ::std::result::Result<
12 crate::operation::put_bucket_metrics_configuration::PutBucketMetricsConfigurationOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::put_bucket_metrics_configuration::PutBucketMetricsConfigurationError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.put_bucket_metrics_configuration();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `PutBucketMetricsConfiguration`.
24///
25/// <p>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.</p><note>
26/// <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>
27/// </note>
28/// <dl>
29/// <dt>
30/// Permissions
31/// </dt>
32/// <dd>
33/// <p>To use this operation, you must have permissions to perform the <code>s3:PutMetricsConfiguration</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>
34/// <ul>
35/// <li>
36/// <p><b>General purpose bucket permissions</b> - The <code>s3:PutMetricsConfiguration</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>
37/// <li>
38/// <p><b>Directory bucket permissions</b> - To grant access to this API operation, you must have the <code>s3express:PutMetricsConfiguration</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>
39/// </ul>
40/// </dd>
41/// <dt>
42/// HTTP Host header syntax
43/// </dt>
44/// <dd>
45/// <p><b>Directory buckets </b> - The HTTP Host header syntax is <code>s3express-control.<i>region-code</i>.amazonaws.com</code>.</p>
46/// </dd>
47/// </dl>
48/// <p>For information about CloudWatch request metrics for Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a>.</p>
49/// <p>The following operations are related to <code>PutBucketMetricsConfiguration</code>:</p>
50/// <ul>
51/// <li>
52/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html">DeleteBucketMetricsConfiguration</a></p></li>
53/// <li>
54/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html">GetBucketMetricsConfiguration</a></p></li>
55/// <li>
56/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html">ListBucketMetricsConfigurations</a></p></li>
57/// </ul>
58/// <p><code>PutBucketMetricsConfiguration</code> has the following special error:</p>
59/// <ul>
60/// <li>
61/// <p>Error code: <code>TooManyConfigurations</code></p>
62/// <ul>
63/// <li>
64/// <p>Description: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.</p></li>
65/// <li>
66/// <p>HTTP Status Code: HTTP 400 Bad Request</p></li>
67/// </ul></li>
68/// </ul><important>
69/// <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>
70/// </important>
71#[derive(::std::clone::Clone, ::std::fmt::Debug)]
72pub struct PutBucketMetricsConfigurationFluentBuilder {
73 handle: ::std::sync::Arc<crate::client::Handle>,
74 inner: crate::operation::put_bucket_metrics_configuration::builders::PutBucketMetricsConfigurationInputBuilder,
75 config_override: ::std::option::Option<crate::config::Builder>,
76}
77impl
78 crate::client::customize::internal::CustomizableSend<
79 crate::operation::put_bucket_metrics_configuration::PutBucketMetricsConfigurationOutput,
80 crate::operation::put_bucket_metrics_configuration::PutBucketMetricsConfigurationError,
81 > for PutBucketMetricsConfigurationFluentBuilder
82{
83 fn send(
84 self,
85 config_override: crate::config::Builder,
86 ) -> crate::client::customize::internal::BoxFuture<
87 crate::client::customize::internal::SendResult<
88 crate::operation::put_bucket_metrics_configuration::PutBucketMetricsConfigurationOutput,
89 crate::operation::put_bucket_metrics_configuration::PutBucketMetricsConfigurationError,
90 >,
91 > {
92 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
93 }
94}
95impl PutBucketMetricsConfigurationFluentBuilder {
96 /// Creates a new `PutBucketMetricsConfigurationFluentBuilder`.
97 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
98 Self {
99 handle,
100 inner: ::std::default::Default::default(),
101 config_override: ::std::option::Option::None,
102 }
103 }
104 /// Access the PutBucketMetricsConfiguration as a reference.
105 pub fn as_input(&self) -> &crate::operation::put_bucket_metrics_configuration::builders::PutBucketMetricsConfigurationInputBuilder {
106 &self.inner
107 }
108 /// Sends the request and returns the response.
109 ///
110 /// If an error occurs, an `SdkError` will be returned with additional details that
111 /// can be matched against.
112 ///
113 /// By default, any retryable failures will be retried twice. Retry behavior
114 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
115 /// set when configuring the client.
116 pub async fn send(
117 self,
118 ) -> ::std::result::Result<
119 crate::operation::put_bucket_metrics_configuration::PutBucketMetricsConfigurationOutput,
120 ::aws_smithy_runtime_api::client::result::SdkError<
121 crate::operation::put_bucket_metrics_configuration::PutBucketMetricsConfigurationError,
122 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
123 >,
124 > {
125 let input = self
126 .inner
127 .build()
128 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
129 let runtime_plugins = crate::operation::put_bucket_metrics_configuration::PutBucketMetricsConfiguration::operation_runtime_plugins(
130 self.handle.runtime_plugins.clone(),
131 &self.handle.conf,
132 self.config_override,
133 );
134 crate::operation::put_bucket_metrics_configuration::PutBucketMetricsConfiguration::orchestrate(&runtime_plugins, input).await
135 }
136
137 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
138 pub fn customize(
139 self,
140 ) -> crate::client::customize::CustomizableOperation<
141 crate::operation::put_bucket_metrics_configuration::PutBucketMetricsConfigurationOutput,
142 crate::operation::put_bucket_metrics_configuration::PutBucketMetricsConfigurationError,
143 Self,
144 > {
145 crate::client::customize::CustomizableOperation::new(self)
146 }
147 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
148 self.set_config_override(::std::option::Option::Some(config_override.into()));
149 self
150 }
151
152 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
153 self.config_override = config_override;
154 self
155 }
156 /// <p>The name of the bucket for which the metrics configuration is set.</p>
157 /// <p><b>Directory buckets </b> - When you use this operation with a directory bucket, you must use 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. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i></p>
158 pub fn bucket(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
159 self.inner = self.inner.bucket(input.into());
160 self
161 }
162 /// <p>The name of the bucket for which the metrics configuration is set.</p>
163 /// <p><b>Directory buckets </b> - When you use this operation with a directory bucket, you must use 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. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i></p>
164 pub fn set_bucket(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
165 self.inner = self.inner.set_bucket(input);
166 self
167 }
168 /// <p>The name of the bucket for which the metrics configuration is set.</p>
169 /// <p><b>Directory buckets </b> - When you use this operation with a directory bucket, you must use 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. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i></p>
170 pub fn get_bucket(&self) -> &::std::option::Option<::std::string::String> {
171 self.inner.get_bucket()
172 }
173 /// <p>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.</p>
174 pub fn id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
175 self.inner = self.inner.id(input.into());
176 self
177 }
178 /// <p>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.</p>
179 pub fn set_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
180 self.inner = self.inner.set_id(input);
181 self
182 }
183 /// <p>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.</p>
184 pub fn get_id(&self) -> &::std::option::Option<::std::string::String> {
185 self.inner.get_id()
186 }
187 /// <p>Specifies the metrics configuration.</p>
188 pub fn metrics_configuration(mut self, input: crate::types::MetricsConfiguration) -> Self {
189 self.inner = self.inner.metrics_configuration(input);
190 self
191 }
192 /// <p>Specifies the metrics configuration.</p>
193 pub fn set_metrics_configuration(mut self, input: ::std::option::Option<crate::types::MetricsConfiguration>) -> Self {
194 self.inner = self.inner.set_metrics_configuration(input);
195 self
196 }
197 /// <p>Specifies the metrics configuration.</p>
198 pub fn get_metrics_configuration(&self) -> &::std::option::Option<crate::types::MetricsConfiguration> {
199 self.inner.get_metrics_configuration()
200 }
201 /// <p>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 <code>403 Forbidden</code> (access denied).</p><note>
202 /// <p>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 <code>501 Not Implemented</code>.</p>
203 /// </note>
204 pub fn expected_bucket_owner(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
205 self.inner = self.inner.expected_bucket_owner(input.into());
206 self
207 }
208 /// <p>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 <code>403 Forbidden</code> (access denied).</p><note>
209 /// <p>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 <code>501 Not Implemented</code>.</p>
210 /// </note>
211 pub fn set_expected_bucket_owner(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
212 self.inner = self.inner.set_expected_bucket_owner(input);
213 self
214 }
215 /// <p>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 <code>403 Forbidden</code> (access denied).</p><note>
216 /// <p>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 <code>501 Not Implemented</code>.</p>
217 /// </note>
218 pub fn get_expected_bucket_owner(&self) -> &::std::option::Option<::std::string::String> {
219 self.inner.get_expected_bucket_owner()
220 }
221}