describe_ipams `async` ¶

describe_ipams(
    *,
    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_ids: Optional[ValueStringList] = None,
) -> DescribeIpamsResult

Get information about your IPAM pools.

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.

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 request. For more information about filtering, see Filtering CLI output.
max_results (Optional[IpamMaxResults], default: None ) –

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 Pagination.
next_token (Optional[NextToken], default: None ) –

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

The IDs of the IPAMs you want information on.

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_ipams(
    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_ids: Optional["capo_ec2.types.value_string_list.ValueStringList"] = None,
) -> "capo_ec2.types.describe_ipams_result.DescribeIpamsResult":
    """<p>Get information about your IPAM pools.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html">What is IPAM?</a> in the <i>Amazon VPC IPAM User Guide</i>. </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 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>
        max_results: <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>
        next_token: <p>The token for the next page of results.</p>
        ipam_ids: <p>The IDs of the IPAMs you want information on.</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_ipams_request.DescribeIpamsRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.describe_ipams_result.DescribeIpamsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_ipams

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeIpams")
    )
    input_: capo_ec2.types.describe_ipams_request.DescribeIpamsRequest = {}
    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_ids is not None:
        input_["ipam_ids"] = ipam_ids

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

describe_ipams async ¶

describe_ipams `async` ¶