aws_sdk_ec2/operation/get_ipam_pool_allocations/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::get_ipam_pool_allocations::_get_ipam_pool_allocations_output::GetIpamPoolAllocationsOutputBuilder;
3
4pub use crate::operation::get_ipam_pool_allocations::_get_ipam_pool_allocations_input::GetIpamPoolAllocationsInputBuilder;
5
6impl crate::operation::get_ipam_pool_allocations::builders::GetIpamPoolAllocationsInputBuilder {
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::get_ipam_pool_allocations::GetIpamPoolAllocationsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::get_ipam_pool_allocations::GetIpamPoolAllocationsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.get_ipam_pool_allocations();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `GetIpamPoolAllocations`.
24///
25/// <p>Get a list of all the CIDR allocations in an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations.</p><note>
26/// <p>If you use this action after <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_AllocateIpamPoolCidr.html">AllocateIpamPoolCidr</a> or <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ReleaseIpamPoolAllocation.html">ReleaseIpamPoolAllocation</a>, note that all EC2 API actions follow an <a href="https://docs.aws.amazon.com/ec2/latest/devguide/eventual-consistency.html">eventual consistency</a> model.</p>
27/// </note>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct GetIpamPoolAllocationsFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::get_ipam_pool_allocations::builders::GetIpamPoolAllocationsInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::get_ipam_pool_allocations::GetIpamPoolAllocationsOutput,
37        crate::operation::get_ipam_pool_allocations::GetIpamPoolAllocationsError,
38    > for GetIpamPoolAllocationsFluentBuilder
39{
40    fn send(
41        self,
42        config_override: crate::config::Builder,
43    ) -> crate::client::customize::internal::BoxFuture<
44        crate::client::customize::internal::SendResult<
45            crate::operation::get_ipam_pool_allocations::GetIpamPoolAllocationsOutput,
46            crate::operation::get_ipam_pool_allocations::GetIpamPoolAllocationsError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl GetIpamPoolAllocationsFluentBuilder {
53    /// Creates a new `GetIpamPoolAllocationsFluentBuilder`.
54    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
55        Self {
56            handle,
57            inner: ::std::default::Default::default(),
58            config_override: ::std::option::Option::None,
59        }
60    }
61    /// Access the GetIpamPoolAllocations as a reference.
62    pub fn as_input(&self) -> &crate::operation::get_ipam_pool_allocations::builders::GetIpamPoolAllocationsInputBuilder {
63        &self.inner
64    }
65    /// Sends the request and returns the response.
66    ///
67    /// If an error occurs, an `SdkError` will be returned with additional details that
68    /// can be matched against.
69    ///
70    /// By default, any retryable failures will be retried twice. Retry behavior
71    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
72    /// set when configuring the client.
73    pub async fn send(
74        self,
75    ) -> ::std::result::Result<
76        crate::operation::get_ipam_pool_allocations::GetIpamPoolAllocationsOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::get_ipam_pool_allocations::GetIpamPoolAllocationsError,
79            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
80        >,
81    > {
82        let input = self
83            .inner
84            .build()
85            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
86        let runtime_plugins = crate::operation::get_ipam_pool_allocations::GetIpamPoolAllocations::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::get_ipam_pool_allocations::GetIpamPoolAllocations::orchestrate(&runtime_plugins, input).await
92    }
93
94    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
95    pub fn customize(
96        self,
97    ) -> crate::client::customize::CustomizableOperation<
98        crate::operation::get_ipam_pool_allocations::GetIpamPoolAllocationsOutput,
99        crate::operation::get_ipam_pool_allocations::GetIpamPoolAllocationsError,
100        Self,
101    > {
102        crate::client::customize::CustomizableOperation::new(self)
103    }
104    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
105        self.set_config_override(::std::option::Option::Some(config_override.into()));
106        self
107    }
108
109    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
110        self.config_override = config_override;
111        self
112    }
113    /// Create a paginator for this request
114    ///
115    /// Paginators are used by calling [`send().await`](crate::operation::get_ipam_pool_allocations::paginator::GetIpamPoolAllocationsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
116    pub fn into_paginator(self) -> crate::operation::get_ipam_pool_allocations::paginator::GetIpamPoolAllocationsPaginator {
117        crate::operation::get_ipam_pool_allocations::paginator::GetIpamPoolAllocationsPaginator::new(self.handle, self.inner)
118    }
119    /// <p>A check for 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>
120    pub fn dry_run(mut self, input: bool) -> Self {
121        self.inner = self.inner.dry_run(input);
122        self
123    }
124    /// <p>A check for 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>
125    pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
126        self.inner = self.inner.set_dry_run(input);
127        self
128    }
129    /// <p>A check for 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>
130    pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
131        self.inner.get_dry_run()
132    }
133    /// <p>The ID of the IPAM pool you want to see the allocations for.</p>
134    pub fn ipam_pool_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
135        self.inner = self.inner.ipam_pool_id(input.into());
136        self
137    }
138    /// <p>The ID of the IPAM pool you want to see the allocations for.</p>
139    pub fn set_ipam_pool_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
140        self.inner = self.inner.set_ipam_pool_id(input);
141        self
142    }
143    /// <p>The ID of the IPAM pool you want to see the allocations for.</p>
144    pub fn get_ipam_pool_id(&self) -> &::std::option::Option<::std::string::String> {
145        self.inner.get_ipam_pool_id()
146    }
147    /// <p>The ID of the allocation.</p>
148    pub fn ipam_pool_allocation_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
149        self.inner = self.inner.ipam_pool_allocation_id(input.into());
150        self
151    }
152    /// <p>The ID of the allocation.</p>
153    pub fn set_ipam_pool_allocation_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
154        self.inner = self.inner.set_ipam_pool_allocation_id(input);
155        self
156    }
157    /// <p>The ID of the allocation.</p>
158    pub fn get_ipam_pool_allocation_id(&self) -> &::std::option::Option<::std::string::String> {
159        self.inner.get_ipam_pool_allocation_id()
160    }
161    ///
162    /// Appends an item to `Filters`.
163    ///
164    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
165    ///
166    /// <p>One or more filters for the request. For more information about filtering, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html">Filtering CLI output</a>.</p>
167    pub fn filters(mut self, input: crate::types::Filter) -> Self {
168        self.inner = self.inner.filters(input);
169        self
170    }
171    /// <p>One or more filters for the request. For more information about filtering, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html">Filtering CLI output</a>.</p>
172    pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
173        self.inner = self.inner.set_filters(input);
174        self
175    }
176    /// <p>One or more filters for the request. For more information about filtering, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html">Filtering CLI output</a>.</p>
177    pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
178        self.inner.get_filters()
179    }
180    /// <p>The maximum number of results you would like returned per page.</p>
181    pub fn max_results(mut self, input: i32) -> Self {
182        self.inner = self.inner.max_results(input);
183        self
184    }
185    /// <p>The maximum number of results you would like returned per page.</p>
186    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
187        self.inner = self.inner.set_max_results(input);
188        self
189    }
190    /// <p>The maximum number of results you would like returned per page.</p>
191    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
192        self.inner.get_max_results()
193    }
194    /// <p>The token for the next page of results.</p>
195    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
196        self.inner = self.inner.next_token(input.into());
197        self
198    }
199    /// <p>The token for the next page of results.</p>
200    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
201        self.inner = self.inner.set_next_token(input);
202        self
203    }
204    /// <p>The token for the next page of results.</p>
205    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
206        self.inner.get_next_token()
207    }
208}