aws_sdk_ec2/operation/describe_regions/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_regions::_describe_regions_output::DescribeRegionsOutputBuilder;
3
4pub use crate::operation::describe_regions::_describe_regions_input::DescribeRegionsInputBuilder;
5
6impl crate::operation::describe_regions::builders::DescribeRegionsInputBuilder {
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::describe_regions::DescribeRegionsOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::describe_regions::DescribeRegionsError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.describe_regions();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `DescribeRegions`.
24///
25/// <p>Describes the Regions that are enabled for your account, or all Regions.</p>
26/// <p>For a list of the Regions supported by Amazon EC2, see <a href="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-endpoints.html">Amazon EC2 service endpoints</a>.</p>
27/// <p>For information about enabling and disabling Regions for your account, see <a href="https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-regions.html">Specify which Amazon Web Services Regions your account can use</a> in the <i>Amazon Web Services Account Management Reference Guide</i>.</p><note>
28/// <p>The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.</p>
29/// </note>
30#[derive(::std::clone::Clone, ::std::fmt::Debug)]
31pub struct DescribeRegionsFluentBuilder {
32 handle: ::std::sync::Arc<crate::client::Handle>,
33 inner: crate::operation::describe_regions::builders::DescribeRegionsInputBuilder,
34 config_override: ::std::option::Option<crate::config::Builder>,
35}
36impl
37 crate::client::customize::internal::CustomizableSend<
38 crate::operation::describe_regions::DescribeRegionsOutput,
39 crate::operation::describe_regions::DescribeRegionsError,
40 > for DescribeRegionsFluentBuilder
41{
42 fn send(
43 self,
44 config_override: crate::config::Builder,
45 ) -> crate::client::customize::internal::BoxFuture<
46 crate::client::customize::internal::SendResult<
47 crate::operation::describe_regions::DescribeRegionsOutput,
48 crate::operation::describe_regions::DescribeRegionsError,
49 >,
50 > {
51 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
52 }
53}
54impl DescribeRegionsFluentBuilder {
55 /// Creates a new `DescribeRegionsFluentBuilder`.
56 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
57 Self {
58 handle,
59 inner: ::std::default::Default::default(),
60 config_override: ::std::option::Option::None,
61 }
62 }
63 /// Access the DescribeRegions as a reference.
64 pub fn as_input(&self) -> &crate::operation::describe_regions::builders::DescribeRegionsInputBuilder {
65 &self.inner
66 }
67 /// Sends the request and returns the response.
68 ///
69 /// If an error occurs, an `SdkError` will be returned with additional details that
70 /// can be matched against.
71 ///
72 /// By default, any retryable failures will be retried twice. Retry behavior
73 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
74 /// set when configuring the client.
75 pub async fn send(
76 self,
77 ) -> ::std::result::Result<
78 crate::operation::describe_regions::DescribeRegionsOutput,
79 ::aws_smithy_runtime_api::client::result::SdkError<
80 crate::operation::describe_regions::DescribeRegionsError,
81 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
82 >,
83 > {
84 let input = self
85 .inner
86 .build()
87 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
88 let runtime_plugins = crate::operation::describe_regions::DescribeRegions::operation_runtime_plugins(
89 self.handle.runtime_plugins.clone(),
90 &self.handle.conf,
91 self.config_override,
92 );
93 crate::operation::describe_regions::DescribeRegions::orchestrate(&runtime_plugins, input).await
94 }
95
96 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
97 pub fn customize(
98 self,
99 ) -> crate::client::customize::CustomizableOperation<
100 crate::operation::describe_regions::DescribeRegionsOutput,
101 crate::operation::describe_regions::DescribeRegionsError,
102 Self,
103 > {
104 crate::client::customize::CustomizableOperation::new(self)
105 }
106 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
107 self.set_config_override(::std::option::Option::Some(config_override.into()));
108 self
109 }
110
111 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
112 self.config_override = config_override;
113 self
114 }
115 ///
116 /// Appends an item to `RegionNames`.
117 ///
118 /// To override the contents of this collection use [`set_region_names`](Self::set_region_names).
119 ///
120 /// <p>The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.</p>
121 pub fn region_names(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
122 self.inner = self.inner.region_names(input.into());
123 self
124 }
125 /// <p>The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.</p>
126 pub fn set_region_names(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
127 self.inner = self.inner.set_region_names(input);
128 self
129 }
130 /// <p>The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.</p>
131 pub fn get_region_names(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
132 self.inner.get_region_names()
133 }
134 /// <p>Indicates whether to display all Regions, including Regions that are disabled for your account.</p>
135 pub fn all_regions(mut self, input: bool) -> Self {
136 self.inner = self.inner.all_regions(input);
137 self
138 }
139 /// <p>Indicates whether to display all Regions, including Regions that are disabled for your account.</p>
140 pub fn set_all_regions(mut self, input: ::std::option::Option<bool>) -> Self {
141 self.inner = self.inner.set_all_regions(input);
142 self
143 }
144 /// <p>Indicates whether to display all Regions, including Regions that are disabled for your account.</p>
145 pub fn get_all_regions(&self) -> &::std::option::Option<bool> {
146 self.inner.get_all_regions()
147 }
148 /// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
149 pub fn dry_run(mut self, input: bool) -> Self {
150 self.inner = self.inner.dry_run(input);
151 self
152 }
153 /// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
154 pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
155 self.inner = self.inner.set_dry_run(input);
156 self
157 }
158 /// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
159 pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
160 self.inner.get_dry_run()
161 }
162 ///
163 /// Appends an item to `Filters`.
164 ///
165 /// To override the contents of this collection use [`set_filters`](Self::set_filters).
166 ///
167 /// <p>The filters.</p>
168 /// <ul>
169 /// <li>
170 /// <p><code>endpoint</code> - The endpoint of the Region (for example, <code>ec2.us-east-1.amazonaws.com</code>).</p></li>
171 /// <li>
172 /// <p><code>opt-in-status</code> - The opt-in status of the Region (<code>opt-in-not-required</code> | <code>opted-in</code> | <code>not-opted-in</code>).</p></li>
173 /// <li>
174 /// <p><code>region-name</code> - The name of the Region (for example, <code>us-east-1</code>).</p></li>
175 /// </ul>
176 pub fn filters(mut self, input: crate::types::Filter) -> Self {
177 self.inner = self.inner.filters(input);
178 self
179 }
180 /// <p>The filters.</p>
181 /// <ul>
182 /// <li>
183 /// <p><code>endpoint</code> - The endpoint of the Region (for example, <code>ec2.us-east-1.amazonaws.com</code>).</p></li>
184 /// <li>
185 /// <p><code>opt-in-status</code> - The opt-in status of the Region (<code>opt-in-not-required</code> | <code>opted-in</code> | <code>not-opted-in</code>).</p></li>
186 /// <li>
187 /// <p><code>region-name</code> - The name of the Region (for example, <code>us-east-1</code>).</p></li>
188 /// </ul>
189 pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
190 self.inner = self.inner.set_filters(input);
191 self
192 }
193 /// <p>The filters.</p>
194 /// <ul>
195 /// <li>
196 /// <p><code>endpoint</code> - The endpoint of the Region (for example, <code>ec2.us-east-1.amazonaws.com</code>).</p></li>
197 /// <li>
198 /// <p><code>opt-in-status</code> - The opt-in status of the Region (<code>opt-in-not-required</code> | <code>opted-in</code> | <code>not-opted-in</code>).</p></li>
199 /// <li>
200 /// <p><code>region-name</code> - The name of the Region (for example, <code>us-east-1</code>).</p></li>
201 /// </ul>
202 pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
203 self.inner.get_filters()
204 }
205}