aws_sdk_ec2/operation/describe_transit_gateways/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_transit_gateways::_describe_transit_gateways_output::DescribeTransitGatewaysOutputBuilder;
3
4pub use crate::operation::describe_transit_gateways::_describe_transit_gateways_input::DescribeTransitGatewaysInputBuilder;
5
6impl crate::operation::describe_transit_gateways::builders::DescribeTransitGatewaysInputBuilder {
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_transit_gateways::DescribeTransitGatewaysOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::describe_transit_gateways::DescribeTransitGatewaysError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.describe_transit_gateways();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DescribeTransitGateways`.
24///
25/// <p>Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct DescribeTransitGatewaysFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::describe_transit_gateways::builders::DescribeTransitGatewaysInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::describe_transit_gateways::DescribeTransitGatewaysOutput,
35        crate::operation::describe_transit_gateways::DescribeTransitGatewaysError,
36    > for DescribeTransitGatewaysFluentBuilder
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_transit_gateways::DescribeTransitGatewaysOutput,
44            crate::operation::describe_transit_gateways::DescribeTransitGatewaysError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl DescribeTransitGatewaysFluentBuilder {
51    /// Creates a new `DescribeTransitGatewaysFluentBuilder`.
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 DescribeTransitGateways as a reference.
60    pub fn as_input(&self) -> &crate::operation::describe_transit_gateways::builders::DescribeTransitGatewaysInputBuilder {
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_transit_gateways::DescribeTransitGatewaysOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::describe_transit_gateways::DescribeTransitGatewaysError,
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_transit_gateways::DescribeTransitGateways::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::describe_transit_gateways::DescribeTransitGateways::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_transit_gateways::DescribeTransitGatewaysOutput,
97        crate::operation::describe_transit_gateways::DescribeTransitGatewaysError,
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_transit_gateways::paginator::DescribeTransitGatewaysPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
114    pub fn into_paginator(self) -> crate::operation::describe_transit_gateways::paginator::DescribeTransitGatewaysPaginator {
115        crate::operation::describe_transit_gateways::paginator::DescribeTransitGatewaysPaginator::new(self.handle, self.inner)
116    }
117    ///
118    /// Appends an item to `TransitGatewayIds`.
119    ///
120    /// To override the contents of this collection use [`set_transit_gateway_ids`](Self::set_transit_gateway_ids).
121    ///
122    /// <p>The IDs of the transit gateways.</p>
123    pub fn transit_gateway_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
124        self.inner = self.inner.transit_gateway_ids(input.into());
125        self
126    }
127    /// <p>The IDs of the transit gateways.</p>
128    pub fn set_transit_gateway_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
129        self.inner = self.inner.set_transit_gateway_ids(input);
130        self
131    }
132    /// <p>The IDs of the transit gateways.</p>
133    pub fn get_transit_gateway_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
134        self.inner.get_transit_gateway_ids()
135    }
136    ///
137    /// Appends an item to `Filters`.
138    ///
139    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
140    ///
141    /// <p>One or more filters. The possible values are:</p>
142    /// <ul>
143    /// <li>
144    /// <p><code>options.propagation-default-route-table-id</code> - The ID of the default propagation route table.</p></li>
145    /// <li>
146    /// <p><code>options.amazon-side-asn</code> - The private ASN for the Amazon side of a BGP session.</p></li>
147    /// <li>
148    /// <p><code>options.association-default-route-table-id</code> - The ID of the default association route table.</p></li>
149    /// <li>
150    /// <p><code>options.auto-accept-shared-attachments</code> - Indicates whether there is automatic acceptance of attachment requests (<code>enable</code> | <code>disable</code>).</p></li>
151    /// <li>
152    /// <p><code>options.default-route-table-association</code> - Indicates whether resource attachments are automatically associated with the default association route table (<code>enable</code> | <code>disable</code>).</p></li>
153    /// <li>
154    /// <p><code>options.default-route-table-propagation</code> - Indicates whether resource attachments automatically propagate routes to the default propagation route table (<code>enable</code> | <code>disable</code>).</p></li>
155    /// <li>
156    /// <p><code>options.dns-support</code> - Indicates whether DNS support is enabled (<code>enable</code> | <code>disable</code>).</p></li>
157    /// <li>
158    /// <p><code>options.vpn-ecmp-support</code> - Indicates whether Equal Cost Multipath Protocol support is enabled (<code>enable</code> | <code>disable</code>).</p></li>
159    /// <li>
160    /// <p><code>owner-id</code> - The ID of the Amazon Web Services account that owns the transit gateway.</p></li>
161    /// <li>
162    /// <p><code>state</code> - The state of the transit gateway (<code>available</code> | <code>deleted</code> | <code>deleting</code> | <code>modifying</code> | <code>pending</code>).</p></li>
163    /// <li>
164    /// <p><code>transit-gateway-id</code> - The ID of the transit gateway.</p></li>
165    /// <li>
166    /// <p><code>tag-key </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>
167    /// </ul>
168    pub fn filters(mut self, input: crate::types::Filter) -> Self {
169        self.inner = self.inner.filters(input);
170        self
171    }
172    /// <p>One or more filters. The possible values are:</p>
173    /// <ul>
174    /// <li>
175    /// <p><code>options.propagation-default-route-table-id</code> - The ID of the default propagation route table.</p></li>
176    /// <li>
177    /// <p><code>options.amazon-side-asn</code> - The private ASN for the Amazon side of a BGP session.</p></li>
178    /// <li>
179    /// <p><code>options.association-default-route-table-id</code> - The ID of the default association route table.</p></li>
180    /// <li>
181    /// <p><code>options.auto-accept-shared-attachments</code> - Indicates whether there is automatic acceptance of attachment requests (<code>enable</code> | <code>disable</code>).</p></li>
182    /// <li>
183    /// <p><code>options.default-route-table-association</code> - Indicates whether resource attachments are automatically associated with the default association route table (<code>enable</code> | <code>disable</code>).</p></li>
184    /// <li>
185    /// <p><code>options.default-route-table-propagation</code> - Indicates whether resource attachments automatically propagate routes to the default propagation route table (<code>enable</code> | <code>disable</code>).</p></li>
186    /// <li>
187    /// <p><code>options.dns-support</code> - Indicates whether DNS support is enabled (<code>enable</code> | <code>disable</code>).</p></li>
188    /// <li>
189    /// <p><code>options.vpn-ecmp-support</code> - Indicates whether Equal Cost Multipath Protocol support is enabled (<code>enable</code> | <code>disable</code>).</p></li>
190    /// <li>
191    /// <p><code>owner-id</code> - The ID of the Amazon Web Services account that owns the transit gateway.</p></li>
192    /// <li>
193    /// <p><code>state</code> - The state of the transit gateway (<code>available</code> | <code>deleted</code> | <code>deleting</code> | <code>modifying</code> | <code>pending</code>).</p></li>
194    /// <li>
195    /// <p><code>transit-gateway-id</code> - The ID of the transit gateway.</p></li>
196    /// <li>
197    /// <p><code>tag-key </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>
198    /// </ul>
199    pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
200        self.inner = self.inner.set_filters(input);
201        self
202    }
203    /// <p>One or more filters. The possible values are:</p>
204    /// <ul>
205    /// <li>
206    /// <p><code>options.propagation-default-route-table-id</code> - The ID of the default propagation route table.</p></li>
207    /// <li>
208    /// <p><code>options.amazon-side-asn</code> - The private ASN for the Amazon side of a BGP session.</p></li>
209    /// <li>
210    /// <p><code>options.association-default-route-table-id</code> - The ID of the default association route table.</p></li>
211    /// <li>
212    /// <p><code>options.auto-accept-shared-attachments</code> - Indicates whether there is automatic acceptance of attachment requests (<code>enable</code> | <code>disable</code>).</p></li>
213    /// <li>
214    /// <p><code>options.default-route-table-association</code> - Indicates whether resource attachments are automatically associated with the default association route table (<code>enable</code> | <code>disable</code>).</p></li>
215    /// <li>
216    /// <p><code>options.default-route-table-propagation</code> - Indicates whether resource attachments automatically propagate routes to the default propagation route table (<code>enable</code> | <code>disable</code>).</p></li>
217    /// <li>
218    /// <p><code>options.dns-support</code> - Indicates whether DNS support is enabled (<code>enable</code> | <code>disable</code>).</p></li>
219    /// <li>
220    /// <p><code>options.vpn-ecmp-support</code> - Indicates whether Equal Cost Multipath Protocol support is enabled (<code>enable</code> | <code>disable</code>).</p></li>
221    /// <li>
222    /// <p><code>owner-id</code> - The ID of the Amazon Web Services account that owns the transit gateway.</p></li>
223    /// <li>
224    /// <p><code>state</code> - The state of the transit gateway (<code>available</code> | <code>deleted</code> | <code>deleting</code> | <code>modifying</code> | <code>pending</code>).</p></li>
225    /// <li>
226    /// <p><code>transit-gateway-id</code> - The ID of the transit gateway.</p></li>
227    /// <li>
228    /// <p><code>tag-key </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>
229    /// </ul>
230    pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
231        self.inner.get_filters()
232    }
233    /// <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
234    pub fn max_results(mut self, input: i32) -> Self {
235        self.inner = self.inner.max_results(input);
236        self
237    }
238    /// <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
239    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
240        self.inner = self.inner.set_max_results(input);
241        self
242    }
243    /// <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
244    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
245        self.inner.get_max_results()
246    }
247    /// <p>The token for the next page of results.</p>
248    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
249        self.inner = self.inner.next_token(input.into());
250        self
251    }
252    /// <p>The token for the next page of results.</p>
253    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
254        self.inner = self.inner.set_next_token(input);
255        self
256    }
257    /// <p>The token for the next page of results.</p>
258    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
259        self.inner.get_next_token()
260    }
261    /// <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>
262    pub fn dry_run(mut self, input: bool) -> Self {
263        self.inner = self.inner.dry_run(input);
264        self
265    }
266    /// <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>
267    pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
268        self.inner = self.inner.set_dry_run(input);
269        self
270    }
271    /// <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>
272    pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
273        self.inner.get_dry_run()
274    }
275}