aws_sdk_s3/operation/get_bucket_metrics_configuration/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::get_bucket_metrics_configuration::_get_bucket_metrics_configuration_input::GetBucketMetricsConfigurationInputBuilder;
3
4pub use crate::operation::get_bucket_metrics_configuration::_get_bucket_metrics_configuration_output::GetBucketMetricsConfigurationOutputBuilder;
5
6impl crate::operation::get_bucket_metrics_configuration::builders::GetBucketMetricsConfigurationInputBuilder {
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::get_bucket_metrics_configuration::GetBucketMetricsConfigurationOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::get_bucket_metrics_configuration::GetBucketMetricsConfigurationError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.get_bucket_metrics_configuration();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `GetBucketMetricsConfiguration`.
24///
25/// <p>Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.</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: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>
34/// <ul>
35/// <li>
36/// <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>
37/// <li>
38/// <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>
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>GetBucketMetricsConfiguration</code>:</p>
50/// <ul>
51/// <li>
52/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html">PutBucketMetricsConfiguration</a></p></li>
53/// <li>
54/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html">DeleteBucketMetricsConfiguration</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/// <li>
58/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a></p></li>
59/// </ul><important>
60/// <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>
61/// </important>
62#[derive(::std::clone::Clone, ::std::fmt::Debug)]
63pub struct GetBucketMetricsConfigurationFluentBuilder {
64 handle: ::std::sync::Arc<crate::client::Handle>,
65 inner: crate::operation::get_bucket_metrics_configuration::builders::GetBucketMetricsConfigurationInputBuilder,
66 config_override: ::std::option::Option<crate::config::Builder>,
67}
68impl
69 crate::client::customize::internal::CustomizableSend<
70 crate::operation::get_bucket_metrics_configuration::GetBucketMetricsConfigurationOutput,
71 crate::operation::get_bucket_metrics_configuration::GetBucketMetricsConfigurationError,
72 > for GetBucketMetricsConfigurationFluentBuilder
73{
74 fn send(
75 self,
76 config_override: crate::config::Builder,
77 ) -> crate::client::customize::internal::BoxFuture<
78 crate::client::customize::internal::SendResult<
79 crate::operation::get_bucket_metrics_configuration::GetBucketMetricsConfigurationOutput,
80 crate::operation::get_bucket_metrics_configuration::GetBucketMetricsConfigurationError,
81 >,
82 > {
83 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
84 }
85}
86impl GetBucketMetricsConfigurationFluentBuilder {
87 /// Creates a new `GetBucketMetricsConfigurationFluentBuilder`.
88 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
89 Self {
90 handle,
91 inner: ::std::default::Default::default(),
92 config_override: ::std::option::Option::None,
93 }
94 }
95 /// Access the GetBucketMetricsConfiguration as a reference.
96 pub fn as_input(&self) -> &crate::operation::get_bucket_metrics_configuration::builders::GetBucketMetricsConfigurationInputBuilder {
97 &self.inner
98 }
99 /// Sends the request and returns the response.
100 ///
101 /// If an error occurs, an `SdkError` will be returned with additional details that
102 /// can be matched against.
103 ///
104 /// By default, any retryable failures will be retried twice. Retry behavior
105 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
106 /// set when configuring the client.
107 pub async fn send(
108 self,
109 ) -> ::std::result::Result<
110 crate::operation::get_bucket_metrics_configuration::GetBucketMetricsConfigurationOutput,
111 ::aws_smithy_runtime_api::client::result::SdkError<
112 crate::operation::get_bucket_metrics_configuration::GetBucketMetricsConfigurationError,
113 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
114 >,
115 > {
116 let input = self
117 .inner
118 .build()
119 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
120 let runtime_plugins = crate::operation::get_bucket_metrics_configuration::GetBucketMetricsConfiguration::operation_runtime_plugins(
121 self.handle.runtime_plugins.clone(),
122 &self.handle.conf,
123 self.config_override,
124 );
125 crate::operation::get_bucket_metrics_configuration::GetBucketMetricsConfiguration::orchestrate(&runtime_plugins, input).await
126 }
127
128 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
129 pub fn customize(
130 self,
131 ) -> crate::client::customize::CustomizableOperation<
132 crate::operation::get_bucket_metrics_configuration::GetBucketMetricsConfigurationOutput,
133 crate::operation::get_bucket_metrics_configuration::GetBucketMetricsConfigurationError,
134 Self,
135 > {
136 crate::client::customize::CustomizableOperation::new(self)
137 }
138 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
139 self.set_config_override(::std::option::Option::Some(config_override.into()));
140 self
141 }
142
143 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
144 self.config_override = config_override;
145 self
146 }
147 /// <p>The name of the bucket containing the metrics configuration to retrieve.</p>
148 /// <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>
149 pub fn bucket(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
150 self.inner = self.inner.bucket(input.into());
151 self
152 }
153 /// <p>The name of the bucket containing the metrics configuration to retrieve.</p>
154 /// <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>
155 pub fn set_bucket(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
156 self.inner = self.inner.set_bucket(input);
157 self
158 }
159 /// <p>The name of the bucket containing the metrics configuration to retrieve.</p>
160 /// <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>
161 pub fn get_bucket(&self) -> &::std::option::Option<::std::string::String> {
162 self.inner.get_bucket()
163 }
164 /// <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>
165 pub fn id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
166 self.inner = self.inner.id(input.into());
167 self
168 }
169 /// <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>
170 pub fn set_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
171 self.inner = self.inner.set_id(input);
172 self
173 }
174 /// <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>
175 pub fn get_id(&self) -> &::std::option::Option<::std::string::String> {
176 self.inner.get_id()
177 }
178 /// <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>
179 /// <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>
180 /// </note>
181 pub fn expected_bucket_owner(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
182 self.inner = self.inner.expected_bucket_owner(input.into());
183 self
184 }
185 /// <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>
186 /// <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>
187 /// </note>
188 pub fn set_expected_bucket_owner(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
189 self.inner = self.inner.set_expected_bucket_owner(input);
190 self
191 }
192 /// <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>
193 /// <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>
194 /// </note>
195 pub fn get_expected_bucket_owner(&self) -> &::std::option::Option<::std::string::String> {
196 self.inner.get_expected_bucket_owner()
197 }
198}