Skip to content

describe_ipv6_pools async

describe_ipv6_pools(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    pool_ids: Optional[Ipv6PoolIdList] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[Ipv6PoolMaxResults] = None,
    dry_run: Optional[Boolean] = None,
    filters: Optional[FilterList] = None,
) -> DescribeIpv6PoolsResult

Describes your IPv6 address pools.

Parameters:

  • pool_ids (Optional[Ipv6PoolIdList], default: None ) –

    The IDs of the IPv6 address pools.

  • next_token (Optional[NextToken], default: None ) –

    The token for the next page of results.

  • max_results (Optional[Ipv6PoolMaxResults], default: None ) –

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

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

    Checks 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.

    • tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

Raises:

Source code in docs_src/capo_ec2/_services/async_ec2.py
async def describe_ipv6_pools(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    pool_ids: Optional["capo_ec2.types.ipv6_pool_id_list.Ipv6PoolIdList"] = None,
    next_token: Optional["capo_ec2.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_ec2.types.ipv6_pool_max_results.Ipv6PoolMaxResults"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
) -> "capo_ec2.types.describe_ipv6_pools_result.DescribeIpv6PoolsResult":
    """<p>Describes your IPv6 address pools.</p>

    Args:
        pool_ids: <p>The IDs of the IPv6 address pools.</p>
        next_token: <p>The token for the next page of results.</p>
        max_results: <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
        dry_run: <p>Checks 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.</p> <ul> <li> <p> <code>tag</code>:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.</p> </li> </ul>

    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_ipv6_pools_request.DescribeIpv6PoolsRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.describe_ipv6_pools_result.DescribeIpv6PoolsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_ipv6_pools

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeIpv6Pools")
    )
    input_: capo_ec2.types.describe_ipv6_pools_request.DescribeIpv6PoolsRequest = {}
    if pool_ids is not None:
        input_["pool_ids"] = pool_ids
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if filters is not None:
        input_["filters"] = filters

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