aws_sdk_ec2/client/
describe_ipams.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 [`DescribeIpams`](crate::operation::describe_ipams::builders::DescribeIpamsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_ipams::builders::DescribeIpamsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`dry_run(bool)`](crate::operation::describe_ipams::builders::DescribeIpamsFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_ipams::builders::DescribeIpamsFluentBuilder::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    ///   - [`filters(Filter)`](crate::operation::describe_ipams::builders::DescribeIpamsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_ipams::builders::DescribeIpamsFluentBuilder::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>
9    ///   - [`max_results(i32)`](crate::operation::describe_ipams::builders::DescribeIpamsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_ipams::builders::DescribeIpamsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in the request.</p><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_ipams::builders::DescribeIpamsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_ipams::builders::DescribeIpamsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next page of results.</p><br>
11    ///   - [`ipam_ids(impl Into<String>)`](crate::operation::describe_ipams::builders::DescribeIpamsFluentBuilder::ipam_ids) / [`set_ipam_ids(Option<Vec::<String>>)`](crate::operation::describe_ipams::builders::DescribeIpamsFluentBuilder::set_ipam_ids):<br>required: **false**<br><p>The IDs of the IPAMs you want information on.</p><br>
12    /// - On success, responds with [`DescribeIpamsOutput`](crate::operation::describe_ipams::DescribeIpamsOutput) with field(s):
13    ///   - [`next_token(Option<String>)`](crate::operation::describe_ipams::DescribeIpamsOutput::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>
14    ///   - [`ipams(Option<Vec::<Ipam>>)`](crate::operation::describe_ipams::DescribeIpamsOutput::ipams): <p>Information about the IPAMs.</p>
15    /// - On failure, responds with [`SdkError<DescribeIpamsError>`](crate::operation::describe_ipams::DescribeIpamsError)
16    pub fn describe_ipams(&self) -> crate::operation::describe_ipams::builders::DescribeIpamsFluentBuilder {
17        crate::operation::describe_ipams::builders::DescribeIpamsFluentBuilder::new(self.handle.clone())
18    }
19}