aws_sdk_ec2/operation/describe_internet_gateways/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_internet_gateways::_describe_internet_gateways_output::DescribeInternetGatewaysOutputBuilder;
3
4pub use crate::operation::describe_internet_gateways::_describe_internet_gateways_input::DescribeInternetGatewaysInputBuilder;
5
6impl crate::operation::describe_internet_gateways::builders::DescribeInternetGatewaysInputBuilder {
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_internet_gateways::DescribeInternetGatewaysOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::describe_internet_gateways::DescribeInternetGatewaysError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.describe_internet_gateways();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DescribeInternetGateways`.
24///
25/// <p>Describes your internet gateways. The default is to describe all your internet gateways. Alternatively, you can specify specific internet gateway IDs or filter the results to include only the internet gateways that match specific criteria.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct DescribeInternetGatewaysFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::describe_internet_gateways::builders::DescribeInternetGatewaysInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::describe_internet_gateways::DescribeInternetGatewaysOutput,
35        crate::operation::describe_internet_gateways::DescribeInternetGatewaysError,
36    > for DescribeInternetGatewaysFluentBuilder
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_internet_gateways::DescribeInternetGatewaysOutput,
44            crate::operation::describe_internet_gateways::DescribeInternetGatewaysError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl DescribeInternetGatewaysFluentBuilder {
51    /// Creates a new `DescribeInternetGatewaysFluentBuilder`.
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 DescribeInternetGateways as a reference.
60    pub fn as_input(&self) -> &crate::operation::describe_internet_gateways::builders::DescribeInternetGatewaysInputBuilder {
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_internet_gateways::DescribeInternetGatewaysOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::describe_internet_gateways::DescribeInternetGatewaysError,
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_internet_gateways::DescribeInternetGateways::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::describe_internet_gateways::DescribeInternetGateways::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_internet_gateways::DescribeInternetGatewaysOutput,
97        crate::operation::describe_internet_gateways::DescribeInternetGatewaysError,
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_internet_gateways::paginator::DescribeInternetGatewaysPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
114    pub fn into_paginator(self) -> crate::operation::describe_internet_gateways::paginator::DescribeInternetGatewaysPaginator {
115        crate::operation::describe_internet_gateways::paginator::DescribeInternetGatewaysPaginator::new(self.handle, self.inner)
116    }
117    /// <p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p>
118    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
119        self.inner = self.inner.next_token(input.into());
120        self
121    }
122    /// <p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p>
123    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
124        self.inner = self.inner.set_next_token(input);
125        self
126    }
127    /// <p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p>
128    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
129        self.inner.get_next_token()
130    }
131    /// <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>
132    pub fn max_results(mut self, input: i32) -> Self {
133        self.inner = self.inner.max_results(input);
134        self
135    }
136    /// <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>
137    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
138        self.inner = self.inner.set_max_results(input);
139        self
140    }
141    /// <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>
142    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
143        self.inner.get_max_results()
144    }
145    /// <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>
146    pub fn dry_run(mut self, input: bool) -> Self {
147        self.inner = self.inner.dry_run(input);
148        self
149    }
150    /// <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>
151    pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
152        self.inner = self.inner.set_dry_run(input);
153        self
154    }
155    /// <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>
156    pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
157        self.inner.get_dry_run()
158    }
159    ///
160    /// Appends an item to `InternetGatewayIds`.
161    ///
162    /// To override the contents of this collection use [`set_internet_gateway_ids`](Self::set_internet_gateway_ids).
163    ///
164    /// <p>The IDs of the internet gateways.</p>
165    /// <p>Default: Describes all your internet gateways.</p>
166    pub fn internet_gateway_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
167        self.inner = self.inner.internet_gateway_ids(input.into());
168        self
169    }
170    /// <p>The IDs of the internet gateways.</p>
171    /// <p>Default: Describes all your internet gateways.</p>
172    pub fn set_internet_gateway_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
173        self.inner = self.inner.set_internet_gateway_ids(input);
174        self
175    }
176    /// <p>The IDs of the internet gateways.</p>
177    /// <p>Default: Describes all your internet gateways.</p>
178    pub fn get_internet_gateway_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
179        self.inner.get_internet_gateway_ids()
180    }
181    ///
182    /// Appends an item to `Filters`.
183    ///
184    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
185    ///
186    /// <p>The filters.</p>
187    /// <ul>
188    /// <li>
189    /// <p><code>attachment.state</code> - The current state of the attachment between the gateway and the VPC (<code>available</code>). Present only if a VPC is attached.</p></li>
190    /// <li>
191    /// <p><code>attachment.vpc-id</code> - The ID of an attached VPC.</p></li>
192    /// <li>
193    /// <p><code>internet-gateway-id</code> - The ID of the Internet gateway.</p></li>
194    /// <li>
195    /// <p><code>owner-id</code> - The ID of the Amazon Web Services account that owns the internet gateway.</p></li>
196    /// <li>
197    /// <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>
198    /// <li>
199    /// <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>
200    /// </ul>
201    pub fn filters(mut self, input: crate::types::Filter) -> Self {
202        self.inner = self.inner.filters(input);
203        self
204    }
205    /// <p>The filters.</p>
206    /// <ul>
207    /// <li>
208    /// <p><code>attachment.state</code> - The current state of the attachment between the gateway and the VPC (<code>available</code>). Present only if a VPC is attached.</p></li>
209    /// <li>
210    /// <p><code>attachment.vpc-id</code> - The ID of an attached VPC.</p></li>
211    /// <li>
212    /// <p><code>internet-gateway-id</code> - The ID of the Internet gateway.</p></li>
213    /// <li>
214    /// <p><code>owner-id</code> - The ID of the Amazon Web Services account that owns the internet gateway.</p></li>
215    /// <li>
216    /// <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>
217    /// <li>
218    /// <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>
219    /// </ul>
220    pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
221        self.inner = self.inner.set_filters(input);
222        self
223    }
224    /// <p>The filters.</p>
225    /// <ul>
226    /// <li>
227    /// <p><code>attachment.state</code> - The current state of the attachment between the gateway and the VPC (<code>available</code>). Present only if a VPC is attached.</p></li>
228    /// <li>
229    /// <p><code>attachment.vpc-id</code> - The ID of an attached VPC.</p></li>
230    /// <li>
231    /// <p><code>internet-gateway-id</code> - The ID of the Internet gateway.</p></li>
232    /// <li>
233    /// <p><code>owner-id</code> - The ID of the Amazon Web Services account that owns the internet gateway.</p></li>
234    /// <li>
235    /// <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>
236    /// <li>
237    /// <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>
238    /// </ul>
239    pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
240        self.inner.get_filters()
241    }
242}