aws_sdk_ec2/operation/describe_network_acls/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_network_acls::_describe_network_acls_output::DescribeNetworkAclsOutputBuilder;
3
4pub use crate::operation::describe_network_acls::_describe_network_acls_input::DescribeNetworkAclsInputBuilder;
5
6impl crate::operation::describe_network_acls::builders::DescribeNetworkAclsInputBuilder {
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_network_acls::DescribeNetworkAclsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::describe_network_acls::DescribeNetworkAclsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.describe_network_acls();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DescribeNetworkAcls`.
24///
25/// <p>Describes your network ACLs. The default is to describe all your network ACLs. Alternatively, you can specify specific network ACL IDs or filter the results to include only the network ACLs that match specific criteria.</p>
26/// <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/vpc-network-acls.html">Network ACLs</a> in the <i>Amazon VPC User Guide</i>.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct DescribeNetworkAclsFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::describe_network_acls::builders::DescribeNetworkAclsInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::describe_network_acls::DescribeNetworkAclsOutput,
36        crate::operation::describe_network_acls::DescribeNetworkAclsError,
37    > for DescribeNetworkAclsFluentBuilder
38{
39    fn send(
40        self,
41        config_override: crate::config::Builder,
42    ) -> crate::client::customize::internal::BoxFuture<
43        crate::client::customize::internal::SendResult<
44            crate::operation::describe_network_acls::DescribeNetworkAclsOutput,
45            crate::operation::describe_network_acls::DescribeNetworkAclsError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl DescribeNetworkAclsFluentBuilder {
52    /// Creates a new `DescribeNetworkAclsFluentBuilder`.
53    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54        Self {
55            handle,
56            inner: ::std::default::Default::default(),
57            config_override: ::std::option::Option::None,
58        }
59    }
60    /// Access the DescribeNetworkAcls as a reference.
61    pub fn as_input(&self) -> &crate::operation::describe_network_acls::builders::DescribeNetworkAclsInputBuilder {
62        &self.inner
63    }
64    /// Sends the request and returns the response.
65    ///
66    /// If an error occurs, an `SdkError` will be returned with additional details that
67    /// can be matched against.
68    ///
69    /// By default, any retryable failures will be retried twice. Retry behavior
70    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71    /// set when configuring the client.
72    pub async fn send(
73        self,
74    ) -> ::std::result::Result<
75        crate::operation::describe_network_acls::DescribeNetworkAclsOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::describe_network_acls::DescribeNetworkAclsError,
78            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79        >,
80    > {
81        let input = self
82            .inner
83            .build()
84            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85        let runtime_plugins = crate::operation::describe_network_acls::DescribeNetworkAcls::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::describe_network_acls::DescribeNetworkAcls::orchestrate(&runtime_plugins, input).await
91    }
92
93    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94    pub fn customize(
95        self,
96    ) -> crate::client::customize::CustomizableOperation<
97        crate::operation::describe_network_acls::DescribeNetworkAclsOutput,
98        crate::operation::describe_network_acls::DescribeNetworkAclsError,
99        Self,
100    > {
101        crate::client::customize::CustomizableOperation::new(self)
102    }
103    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104        self.set_config_override(::std::option::Option::Some(config_override.into()));
105        self
106    }
107
108    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109        self.config_override = config_override;
110        self
111    }
112    /// Create a paginator for this request
113    ///
114    /// Paginators are used by calling [`send().await`](crate::operation::describe_network_acls::paginator::DescribeNetworkAclsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
115    pub fn into_paginator(self) -> crate::operation::describe_network_acls::paginator::DescribeNetworkAclsPaginator {
116        crate::operation::describe_network_acls::paginator::DescribeNetworkAclsPaginator::new(self.handle, self.inner)
117    }
118    /// <p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p>
119    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
120        self.inner = self.inner.next_token(input.into());
121        self
122    }
123    /// <p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p>
124    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
125        self.inner = self.inner.set_next_token(input);
126        self
127    }
128    /// <p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p>
129    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
130        self.inner.get_next_token()
131    }
132    /// <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>
133    pub fn max_results(mut self, input: i32) -> Self {
134        self.inner = self.inner.max_results(input);
135        self
136    }
137    /// <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>
138    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
139        self.inner = self.inner.set_max_results(input);
140        self
141    }
142    /// <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>
143    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
144        self.inner.get_max_results()
145    }
146    /// <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>
147    pub fn dry_run(mut self, input: bool) -> Self {
148        self.inner = self.inner.dry_run(input);
149        self
150    }
151    /// <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>
152    pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
153        self.inner = self.inner.set_dry_run(input);
154        self
155    }
156    /// <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>
157    pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
158        self.inner.get_dry_run()
159    }
160    ///
161    /// Appends an item to `NetworkAclIds`.
162    ///
163    /// To override the contents of this collection use [`set_network_acl_ids`](Self::set_network_acl_ids).
164    ///
165    /// <p>The IDs of the network ACLs.</p>
166    pub fn network_acl_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
167        self.inner = self.inner.network_acl_ids(input.into());
168        self
169    }
170    /// <p>The IDs of the network ACLs.</p>
171    pub fn set_network_acl_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
172        self.inner = self.inner.set_network_acl_ids(input);
173        self
174    }
175    /// <p>The IDs of the network ACLs.</p>
176    pub fn get_network_acl_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
177        self.inner.get_network_acl_ids()
178    }
179    ///
180    /// Appends an item to `Filters`.
181    ///
182    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
183    ///
184    /// <p>The filters.</p>
185    /// <ul>
186    /// <li>
187    /// <p><code>association.association-id</code> - The ID of an association ID for the ACL.</p></li>
188    /// <li>
189    /// <p><code>association.network-acl-id</code> - The ID of the network ACL involved in the association.</p></li>
190    /// <li>
191    /// <p><code>association.subnet-id</code> - The ID of the subnet involved in the association.</p></li>
192    /// <li>
193    /// <p><code>default</code> - Indicates whether the ACL is the default network ACL for the VPC.</p></li>
194    /// <li>
195    /// <p><code>entry.cidr</code> - The IPv4 CIDR range specified in the entry.</p></li>
196    /// <li>
197    /// <p><code>entry.icmp.code</code> - The ICMP code specified in the entry, if any.</p></li>
198    /// <li>
199    /// <p><code>entry.icmp.type</code> - The ICMP type specified in the entry, if any.</p></li>
200    /// <li>
201    /// <p><code>entry.ipv6-cidr</code> - The IPv6 CIDR range specified in the entry.</p></li>
202    /// <li>
203    /// <p><code>entry.port-range.from</code> - The start of the port range specified in the entry.</p></li>
204    /// <li>
205    /// <p><code>entry.port-range.to</code> - The end of the port range specified in the entry.</p></li>
206    /// <li>
207    /// <p><code>entry.protocol</code> - The protocol specified in the entry (<code>tcp</code> | <code>udp</code> | <code>icmp</code> or a protocol number).</p></li>
208    /// <li>
209    /// <p><code>entry.rule-action</code> - Allows or denies the matching traffic (<code>allow</code> | <code>deny</code>).</p></li>
210    /// <li>
211    /// <p><code>entry.egress</code> - A Boolean that indicates the type of rule. Specify <code>true</code> for egress rules, or <code>false</code> for ingress rules.</p></li>
212    /// <li>
213    /// <p><code>entry.rule-number</code> - The number of an entry (in other words, rule) in the set of ACL entries.</p></li>
214    /// <li>
215    /// <p><code>network-acl-id</code> - The ID of the network ACL.</p></li>
216    /// <li>
217    /// <p><code>owner-id</code> - The ID of the Amazon Web Services account that owns the network ACL.</p></li>
218    /// <li>
219    /// <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>
220    /// <li>
221    /// <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>
222    /// <li>
223    /// <p><code>vpc-id</code> - The ID of the VPC for the network ACL.</p></li>
224    /// </ul>
225    pub fn filters(mut self, input: crate::types::Filter) -> Self {
226        self.inner = self.inner.filters(input);
227        self
228    }
229    /// <p>The filters.</p>
230    /// <ul>
231    /// <li>
232    /// <p><code>association.association-id</code> - The ID of an association ID for the ACL.</p></li>
233    /// <li>
234    /// <p><code>association.network-acl-id</code> - The ID of the network ACL involved in the association.</p></li>
235    /// <li>
236    /// <p><code>association.subnet-id</code> - The ID of the subnet involved in the association.</p></li>
237    /// <li>
238    /// <p><code>default</code> - Indicates whether the ACL is the default network ACL for the VPC.</p></li>
239    /// <li>
240    /// <p><code>entry.cidr</code> - The IPv4 CIDR range specified in the entry.</p></li>
241    /// <li>
242    /// <p><code>entry.icmp.code</code> - The ICMP code specified in the entry, if any.</p></li>
243    /// <li>
244    /// <p><code>entry.icmp.type</code> - The ICMP type specified in the entry, if any.</p></li>
245    /// <li>
246    /// <p><code>entry.ipv6-cidr</code> - The IPv6 CIDR range specified in the entry.</p></li>
247    /// <li>
248    /// <p><code>entry.port-range.from</code> - The start of the port range specified in the entry.</p></li>
249    /// <li>
250    /// <p><code>entry.port-range.to</code> - The end of the port range specified in the entry.</p></li>
251    /// <li>
252    /// <p><code>entry.protocol</code> - The protocol specified in the entry (<code>tcp</code> | <code>udp</code> | <code>icmp</code> or a protocol number).</p></li>
253    /// <li>
254    /// <p><code>entry.rule-action</code> - Allows or denies the matching traffic (<code>allow</code> | <code>deny</code>).</p></li>
255    /// <li>
256    /// <p><code>entry.egress</code> - A Boolean that indicates the type of rule. Specify <code>true</code> for egress rules, or <code>false</code> for ingress rules.</p></li>
257    /// <li>
258    /// <p><code>entry.rule-number</code> - The number of an entry (in other words, rule) in the set of ACL entries.</p></li>
259    /// <li>
260    /// <p><code>network-acl-id</code> - The ID of the network ACL.</p></li>
261    /// <li>
262    /// <p><code>owner-id</code> - The ID of the Amazon Web Services account that owns the network ACL.</p></li>
263    /// <li>
264    /// <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>
265    /// <li>
266    /// <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>
267    /// <li>
268    /// <p><code>vpc-id</code> - The ID of the VPC for the network ACL.</p></li>
269    /// </ul>
270    pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
271        self.inner = self.inner.set_filters(input);
272        self
273    }
274    /// <p>The filters.</p>
275    /// <ul>
276    /// <li>
277    /// <p><code>association.association-id</code> - The ID of an association ID for the ACL.</p></li>
278    /// <li>
279    /// <p><code>association.network-acl-id</code> - The ID of the network ACL involved in the association.</p></li>
280    /// <li>
281    /// <p><code>association.subnet-id</code> - The ID of the subnet involved in the association.</p></li>
282    /// <li>
283    /// <p><code>default</code> - Indicates whether the ACL is the default network ACL for the VPC.</p></li>
284    /// <li>
285    /// <p><code>entry.cidr</code> - The IPv4 CIDR range specified in the entry.</p></li>
286    /// <li>
287    /// <p><code>entry.icmp.code</code> - The ICMP code specified in the entry, if any.</p></li>
288    /// <li>
289    /// <p><code>entry.icmp.type</code> - The ICMP type specified in the entry, if any.</p></li>
290    /// <li>
291    /// <p><code>entry.ipv6-cidr</code> - The IPv6 CIDR range specified in the entry.</p></li>
292    /// <li>
293    /// <p><code>entry.port-range.from</code> - The start of the port range specified in the entry.</p></li>
294    /// <li>
295    /// <p><code>entry.port-range.to</code> - The end of the port range specified in the entry.</p></li>
296    /// <li>
297    /// <p><code>entry.protocol</code> - The protocol specified in the entry (<code>tcp</code> | <code>udp</code> | <code>icmp</code> or a protocol number).</p></li>
298    /// <li>
299    /// <p><code>entry.rule-action</code> - Allows or denies the matching traffic (<code>allow</code> | <code>deny</code>).</p></li>
300    /// <li>
301    /// <p><code>entry.egress</code> - A Boolean that indicates the type of rule. Specify <code>true</code> for egress rules, or <code>false</code> for ingress rules.</p></li>
302    /// <li>
303    /// <p><code>entry.rule-number</code> - The number of an entry (in other words, rule) in the set of ACL entries.</p></li>
304    /// <li>
305    /// <p><code>network-acl-id</code> - The ID of the network ACL.</p></li>
306    /// <li>
307    /// <p><code>owner-id</code> - The ID of the Amazon Web Services account that owns the network ACL.</p></li>
308    /// <li>
309    /// <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>
310    /// <li>
311    /// <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>
312    /// <li>
313    /// <p><code>vpc-id</code> - The ID of the VPC for the network ACL.</p></li>
314    /// </ul>
315    pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
316        self.inner.get_filters()
317    }
318}