Skip to main content

aws_sdk_ec2/client/
describe_ipam_pool_allocations.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DescribeIpamPoolAllocations`](crate::operation::describe_ipam_pool_allocations::builders::DescribeIpamPoolAllocationsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_ipam_pool_allocations::builders::DescribeIpamPoolAllocationsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`dry_run(bool)`](crate::operation::describe_ipam_pool_allocations::builders::DescribeIpamPoolAllocationsFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_ipam_pool_allocations::builders::DescribeIpamPoolAllocationsFluentBuilder::set_dry_run):<br>required: **false**<br><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><br>
8    ///   - [`ipam_pool_allocation_ids(impl Into<String>)`](crate::operation::describe_ipam_pool_allocations::builders::DescribeIpamPoolAllocationsFluentBuilder::ipam_pool_allocation_ids) / [`set_ipam_pool_allocation_ids(Option<Vec::<String>>)`](crate::operation::describe_ipam_pool_allocations::builders::DescribeIpamPoolAllocationsFluentBuilder::set_ipam_pool_allocation_ids):<br>required: **false**<br><p>The IDs of the IPAM pool allocations you want to describe.</p><br>
9    ///   - [`filters(Filter)`](crate::operation::describe_ipam_pool_allocations::builders::DescribeIpamPoolAllocationsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_ipam_pool_allocations::builders::DescribeIpamPoolAllocationsFluentBuilder::set_filters):<br>required: **false**<br><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><br>
10    ///   - [`max_results(i32)`](crate::operation::describe_ipam_pool_allocations::builders::DescribeIpamPoolAllocationsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_ipam_pool_allocations::builders::DescribeIpamPoolAllocationsFluentBuilder::set_max_results):<br>required: **false**<br><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><br>
11    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_ipam_pool_allocations::builders::DescribeIpamPoolAllocationsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_ipam_pool_allocations::builders::DescribeIpamPoolAllocationsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next page of results.</p><br>
12    /// - On success, responds with [`DescribeIpamPoolAllocationsOutput`](crate::operation::describe_ipam_pool_allocations::DescribeIpamPoolAllocationsOutput) with field(s):
13    ///   - [`ipam_pool_allocations(Option<Vec::<IpamPoolAllocation>>)`](crate::operation::describe_ipam_pool_allocations::DescribeIpamPoolAllocationsOutput::ipam_pool_allocations): <p>Information about the IPAM pool allocations.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::describe_ipam_pool_allocations::DescribeIpamPoolAllocationsOutput::next_token): <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
15    /// - On failure, responds with [`SdkError<DescribeIpamPoolAllocationsError>`](crate::operation::describe_ipam_pool_allocations::DescribeIpamPoolAllocationsError)
16    pub fn describe_ipam_pool_allocations(
17        &self,
18    ) -> crate::operation::describe_ipam_pool_allocations::builders::DescribeIpamPoolAllocationsFluentBuilder {
19        crate::operation::describe_ipam_pool_allocations::builders::DescribeIpamPoolAllocationsFluentBuilder::new(self.handle.clone())
20    }
21}