describe_coip_pools ¶

def describe_coip_pools(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    pool_ids: Optional["capo_ec2.types.coip_pool_id_set.CoipPoolIdSet"] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    max_results: Optional[
        "capo_ec2.types.coip_pool_max_results.CoipPoolMaxResults"
    ] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.describe_coip_pools_result.DescribeCoipPoolsResult":
    """<p>Describes the specified customer-owned address pools or all of your customer-owned address pools.</p>

    Args:
        pool_ids: <p>The IDs of the address pools.</p>
        filters: <p>One or more filters.</p> <ul> <li> <p> <code>coip-pool.local-gateway-route-table-id</code> - The ID of the local gateway route table.</p> </li> <li> <p> <code>coip-pool.pool-id</code> - The ID of the address pool.</p> </li> </ul>
        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>
        next_token: <p>The token for the next page of results.</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>

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

    def _handler(
        req: "OperationRequest[capo_ec2.types.describe_coip_pools_request.DescribeCoipPoolsRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_coip_pools_result.DescribeCoipPoolsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_coip_pools

        output, http_response = (
            capo_ec2._operations.amazon_ec2.describe_coip_pools.describe_coip_pools(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeCoipPools")
    )
    input_: capo_ec2.types.describe_coip_pools_request.DescribeCoipPoolsRequest = {}
    if pool_ids is not None:
        input_["pool_ids"] = pool_ids
    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 dry_run is not None:
        input_["dry_run"] = dry_run

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output