aws_sdk_ec2/client/

describe_ipam_policies.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeIpamPolicies`](crate::operation::describe_ipam_policies::builders::DescribeIpamPoliciesFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`dry_run(bool)`](crate::operation::describe_ipam_policies::builders::DescribeIpamPoliciesFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_ipam_policies::builders::DescribeIpamPoliciesFluentBuilder::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>
    ///   - [`filters(Filter)`](crate::operation::describe_ipam_policies::builders::DescribeIpamPoliciesFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_ipam_policies::builders::DescribeIpamPoliciesFluentBuilder::set_filters):<br>required: **false**<br><p>One or more filters for the IPAM policy description.</p><br>
    ///   - [`max_results(i32)`](crate::operation::describe_ipam_policies::builders::DescribeIpamPoliciesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_ipam_policies::builders::DescribeIpamPoliciesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in a single call.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_ipam_policies::builders::DescribeIpamPoliciesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_ipam_policies::builders::DescribeIpamPoliciesFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next page of results.</p><br>
    ///   - [`ipam_policy_ids(impl Into<String>)`](crate::operation::describe_ipam_policies::builders::DescribeIpamPoliciesFluentBuilder::ipam_policy_ids) / [`set_ipam_policy_ids(Option<Vec::<String>>)`](crate::operation::describe_ipam_policies::builders::DescribeIpamPoliciesFluentBuilder::set_ipam_policy_ids):<br>required: **false**<br><p>The IDs of the IPAM policies to describe.</p><br>
    /// - On success, responds with [`DescribeIpamPoliciesOutput`](crate::operation::describe_ipam_policies::DescribeIpamPoliciesOutput) with field(s):
    ///   - [`next_token(Option<String>)`](crate::operation::describe_ipam_policies::DescribeIpamPoliciesOutput::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>
    ///   - [`ipam_policies(Option<Vec::<IpamPolicy>>)`](crate::operation::describe_ipam_policies::DescribeIpamPoliciesOutput::ipam_policies): <p>Information about the IPAM policies.</p> <p>An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations.</p>
    /// - On failure, responds with [`SdkError<DescribeIpamPoliciesError>`](crate::operation::describe_ipam_policies::DescribeIpamPoliciesError)
    pub fn describe_ipam_policies(&self) -> crate::operation::describe_ipam_policies::builders::DescribeIpamPoliciesFluentBuilder {
        crate::operation::describe_ipam_policies::builders::DescribeIpamPoliciesFluentBuilder::new(self.handle.clone())
    }
}