aws_sdk_ec2/operation/describe_vpcs/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_vpcs::_describe_vpcs_output::DescribeVpcsOutputBuilder;
3
4pub use crate::operation::describe_vpcs::_describe_vpcs_input::DescribeVpcsInputBuilder;
5
6impl crate::operation::describe_vpcs::builders::DescribeVpcsInputBuilder {
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_vpcs::DescribeVpcsOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::describe_vpcs::DescribeVpcsError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.describe_vpcs();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `DescribeVpcs`.
24///
25/// <p>Describes your VPCs. The default is to describe all your VPCs. Alternatively, you can specify specific VPC IDs or filter the results to include only the VPCs that match specific criteria.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct DescribeVpcsFluentBuilder {
28 handle: ::std::sync::Arc<crate::client::Handle>,
29 inner: crate::operation::describe_vpcs::builders::DescribeVpcsInputBuilder,
30 config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33 crate::client::customize::internal::CustomizableSend<
34 crate::operation::describe_vpcs::DescribeVpcsOutput,
35 crate::operation::describe_vpcs::DescribeVpcsError,
36 > for DescribeVpcsFluentBuilder
37{
38 fn send(
39 self,
40 config_override: crate::config::Builder,
41 ) -> crate::client::customize::internal::BoxFuture<
42 crate::client::customize::internal::SendResult<
43 crate::operation::describe_vpcs::DescribeVpcsOutput,
44 crate::operation::describe_vpcs::DescribeVpcsError,
45 >,
46 > {
47 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48 }
49}
50impl DescribeVpcsFluentBuilder {
51 /// Creates a new `DescribeVpcsFluentBuilder`.
52 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53 Self {
54 handle,
55 inner: ::std::default::Default::default(),
56 config_override: ::std::option::Option::None,
57 }
58 }
59 /// Access the DescribeVpcs as a reference.
60 pub fn as_input(&self) -> &crate::operation::describe_vpcs::builders::DescribeVpcsInputBuilder {
61 &self.inner
62 }
63 /// Sends the request and returns the response.
64 ///
65 /// If an error occurs, an `SdkError` will be returned with additional details that
66 /// can be matched against.
67 ///
68 /// By default, any retryable failures will be retried twice. Retry behavior
69 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70 /// set when configuring the client.
71 pub async fn send(
72 self,
73 ) -> ::std::result::Result<
74 crate::operation::describe_vpcs::DescribeVpcsOutput,
75 ::aws_smithy_runtime_api::client::result::SdkError<
76 crate::operation::describe_vpcs::DescribeVpcsError,
77 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78 >,
79 > {
80 let input = self
81 .inner
82 .build()
83 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84 let runtime_plugins = crate::operation::describe_vpcs::DescribeVpcs::operation_runtime_plugins(
85 self.handle.runtime_plugins.clone(),
86 &self.handle.conf,
87 self.config_override,
88 );
89 crate::operation::describe_vpcs::DescribeVpcs::orchestrate(&runtime_plugins, input).await
90 }
91
92 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93 pub fn customize(
94 self,
95 ) -> crate::client::customize::CustomizableOperation<
96 crate::operation::describe_vpcs::DescribeVpcsOutput,
97 crate::operation::describe_vpcs::DescribeVpcsError,
98 Self,
99 > {
100 crate::client::customize::CustomizableOperation::new(self)
101 }
102 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103 self.set_config_override(::std::option::Option::Some(config_override.into()));
104 self
105 }
106
107 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108 self.config_override = config_override;
109 self
110 }
111 /// Create a paginator for this request
112 ///
113 /// Paginators are used by calling [`send().await`](crate::operation::describe_vpcs::paginator::DescribeVpcsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
114 pub fn into_paginator(self) -> crate::operation::describe_vpcs::paginator::DescribeVpcsPaginator {
115 crate::operation::describe_vpcs::paginator::DescribeVpcsPaginator::new(self.handle, self.inner)
116 }
117 ///
118 /// Appends an item to `Filters`.
119 ///
120 /// To override the contents of this collection use [`set_filters`](Self::set_filters).
121 ///
122 /// <p>The filters.</p>
123 /// <ul>
124 /// <li>
125 /// <p><code>cidr</code> - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, <code>/28</code>).</p></li>
126 /// <li>
127 /// <p><code>cidr-block-association.cidr-block</code> - An IPv4 CIDR block associated with the VPC.</p></li>
128 /// <li>
129 /// <p><code>cidr-block-association.association-id</code> - The association ID for an IPv4 CIDR block associated with the VPC.</p></li>
130 /// <li>
131 /// <p><code>cidr-block-association.state</code> - The state of an IPv4 CIDR block associated with the VPC.</p></li>
132 /// <li>
133 /// <p><code>dhcp-options-id</code> - The ID of a set of DHCP options.</p></li>
134 /// <li>
135 /// <p><code>ipv6-cidr-block-association.ipv6-cidr-block</code> - An IPv6 CIDR block associated with the VPC.</p></li>
136 /// <li>
137 /// <p><code>ipv6-cidr-block-association.ipv6-pool</code> - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.</p></li>
138 /// <li>
139 /// <p><code>ipv6-cidr-block-association.association-id</code> - The association ID for an IPv6 CIDR block associated with the VPC.</p></li>
140 /// <li>
141 /// <p><code>ipv6-cidr-block-association.state</code> - The state of an IPv6 CIDR block associated with the VPC.</p></li>
142 /// <li>
143 /// <p><code>is-default</code> - Indicates whether the VPC is the default VPC.</p></li>
144 /// <li>
145 /// <p><code>owner-id</code> - The ID of the Amazon Web Services account that owns the VPC.</p></li>
146 /// <li>
147 /// <p><code>state</code> - The state of the VPC (<code>pending</code> | <code>available</code>).</p></li>
148 /// <li>
149 /// <p><code>tag</code> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p></li>
150 /// <li>
151 /// <p><code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.</p></li>
152 /// <li>
153 /// <p><code>vpc-id</code> - The ID of the VPC.</p></li>
154 /// </ul>
155 pub fn filters(mut self, input: crate::types::Filter) -> Self {
156 self.inner = self.inner.filters(input);
157 self
158 }
159 /// <p>The filters.</p>
160 /// <ul>
161 /// <li>
162 /// <p><code>cidr</code> - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, <code>/28</code>).</p></li>
163 /// <li>
164 /// <p><code>cidr-block-association.cidr-block</code> - An IPv4 CIDR block associated with the VPC.</p></li>
165 /// <li>
166 /// <p><code>cidr-block-association.association-id</code> - The association ID for an IPv4 CIDR block associated with the VPC.</p></li>
167 /// <li>
168 /// <p><code>cidr-block-association.state</code> - The state of an IPv4 CIDR block associated with the VPC.</p></li>
169 /// <li>
170 /// <p><code>dhcp-options-id</code> - The ID of a set of DHCP options.</p></li>
171 /// <li>
172 /// <p><code>ipv6-cidr-block-association.ipv6-cidr-block</code> - An IPv6 CIDR block associated with the VPC.</p></li>
173 /// <li>
174 /// <p><code>ipv6-cidr-block-association.ipv6-pool</code> - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.</p></li>
175 /// <li>
176 /// <p><code>ipv6-cidr-block-association.association-id</code> - The association ID for an IPv6 CIDR block associated with the VPC.</p></li>
177 /// <li>
178 /// <p><code>ipv6-cidr-block-association.state</code> - The state of an IPv6 CIDR block associated with the VPC.</p></li>
179 /// <li>
180 /// <p><code>is-default</code> - Indicates whether the VPC is the default VPC.</p></li>
181 /// <li>
182 /// <p><code>owner-id</code> - The ID of the Amazon Web Services account that owns the VPC.</p></li>
183 /// <li>
184 /// <p><code>state</code> - The state of the VPC (<code>pending</code> | <code>available</code>).</p></li>
185 /// <li>
186 /// <p><code>tag</code> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p></li>
187 /// <li>
188 /// <p><code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.</p></li>
189 /// <li>
190 /// <p><code>vpc-id</code> - The ID of the VPC.</p></li>
191 /// </ul>
192 pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
193 self.inner = self.inner.set_filters(input);
194 self
195 }
196 /// <p>The filters.</p>
197 /// <ul>
198 /// <li>
199 /// <p><code>cidr</code> - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, <code>/28</code>).</p></li>
200 /// <li>
201 /// <p><code>cidr-block-association.cidr-block</code> - An IPv4 CIDR block associated with the VPC.</p></li>
202 /// <li>
203 /// <p><code>cidr-block-association.association-id</code> - The association ID for an IPv4 CIDR block associated with the VPC.</p></li>
204 /// <li>
205 /// <p><code>cidr-block-association.state</code> - The state of an IPv4 CIDR block associated with the VPC.</p></li>
206 /// <li>
207 /// <p><code>dhcp-options-id</code> - The ID of a set of DHCP options.</p></li>
208 /// <li>
209 /// <p><code>ipv6-cidr-block-association.ipv6-cidr-block</code> - An IPv6 CIDR block associated with the VPC.</p></li>
210 /// <li>
211 /// <p><code>ipv6-cidr-block-association.ipv6-pool</code> - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.</p></li>
212 /// <li>
213 /// <p><code>ipv6-cidr-block-association.association-id</code> - The association ID for an IPv6 CIDR block associated with the VPC.</p></li>
214 /// <li>
215 /// <p><code>ipv6-cidr-block-association.state</code> - The state of an IPv6 CIDR block associated with the VPC.</p></li>
216 /// <li>
217 /// <p><code>is-default</code> - Indicates whether the VPC is the default VPC.</p></li>
218 /// <li>
219 /// <p><code>owner-id</code> - The ID of the Amazon Web Services account that owns the VPC.</p></li>
220 /// <li>
221 /// <p><code>state</code> - The state of the VPC (<code>pending</code> | <code>available</code>).</p></li>
222 /// <li>
223 /// <p><code>tag</code> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p></li>
224 /// <li>
225 /// <p><code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.</p></li>
226 /// <li>
227 /// <p><code>vpc-id</code> - The ID of the VPC.</p></li>
228 /// </ul>
229 pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
230 self.inner.get_filters()
231 }
232 ///
233 /// Appends an item to `VpcIds`.
234 ///
235 /// To override the contents of this collection use [`set_vpc_ids`](Self::set_vpc_ids).
236 ///
237 /// <p>The IDs of the VPCs.</p>
238 pub fn vpc_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
239 self.inner = self.inner.vpc_ids(input.into());
240 self
241 }
242 /// <p>The IDs of the VPCs.</p>
243 pub fn set_vpc_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
244 self.inner = self.inner.set_vpc_ids(input);
245 self
246 }
247 /// <p>The IDs of the VPCs.</p>
248 pub fn get_vpc_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
249 self.inner.get_vpc_ids()
250 }
251 /// <p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p>
252 pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
253 self.inner = self.inner.next_token(input.into());
254 self
255 }
256 /// <p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p>
257 pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
258 self.inner = self.inner.set_next_token(input);
259 self
260 }
261 /// <p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p>
262 pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
263 self.inner.get_next_token()
264 }
265 /// <p>The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p>
266 pub fn max_results(mut self, input: i32) -> Self {
267 self.inner = self.inner.max_results(input);
268 self
269 }
270 /// <p>The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p>
271 pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
272 self.inner = self.inner.set_max_results(input);
273 self
274 }
275 /// <p>The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p>
276 pub fn get_max_results(&self) -> &::std::option::Option<i32> {
277 self.inner.get_max_results()
278 }
279 /// <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>
280 pub fn dry_run(mut self, input: bool) -> Self {
281 self.inner = self.inner.dry_run(input);
282 self
283 }
284 /// <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>
285 pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
286 self.inner = self.inner.set_dry_run(input);
287 self
288 }
289 /// <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>
290 pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
291 self.inner.get_dry_run()
292 }
293}