describe_ipam_policies `async` ¶

describe_ipam_policies(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    filters: Optional[FilterList] = None,
    max_results: Optional[IpamMaxResults] = None,
    next_token: Optional[NextToken] = None,
    ipam_policy_ids: Optional[ValueStringList] = None,
) -> DescribeIpamPoliciesResult

Describes one or more IPAM policies.

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.

Parameters:

dry_run (Optional[Boolean], default: None ) –

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 DryRunOperation. Otherwise, it is UnauthorizedOperation.
filters (Optional[FilterList], default: None ) –

One or more filters for the IPAM policy description.
max_results (Optional[IpamMaxResults], default: None ) –

The maximum number of results to return in a single call.
next_token (Optional[NextToken], default: None ) –

The token for the next page of results.
ipam_policy_ids (Optional[ValueStringList], default: None ) –

The IDs of the IPAM policies to describe.

Raises:

UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_ec2/_services/async_ec2.py

async def describe_ipam_policies(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    max_results: Optional["capo_ec2.types.ipam_max_results.IpamMaxResults"] = None,
    next_token: Optional["capo_ec2.types.next_token.NextToken"] = None,
    ipam_policy_ids: Optional[
        "capo_ec2.types.value_string_list.ValueStringList"
    ] = None,
) -> "capo_ec2.types.describe_ipam_policies_result.DescribeIpamPoliciesResult":
    """<p>Describes one or more 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>

    Args:
        dry_run: <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>
        filters: <p>One or more filters for the IPAM policy description.</p>
        max_results: <p>The maximum number of results to return in a single call.</p>
        next_token: <p>The token for the next page of results.</p>
        ipam_policy_ids: <p>The IDs of the IPAM policies to describe.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.describe_ipam_policies_request.DescribeIpamPoliciesRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.describe_ipam_policies_result.DescribeIpamPoliciesResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_ipam_policies

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.describe_ipam_policies.async_describe_ipam_policies(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeIpamPolicies")
    )
    input_: capo_ec2.types.describe_ipam_policies_request.DescribeIpamPoliciesRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if ipam_policy_ids is not None:
        input_["ipam_policy_ids"] = ipam_policy_ids

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_ipam_policies async ¶

describe_ipam_policies `async` ¶