list_dedicated_ip_pools ¶

list_dedicated_ip_pools(
    *,
    config_overrides: Optional[PinpointEmailClientConfig] = None,
    next_token: Optional[NextToken] = None,
    page_size: Optional[MaxItems] = None,
) -> ListDedicatedIpPoolsResponse

List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.

Parameters:

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

A token returned from a previous call to ListDedicatedIpPools to indicate the position in the list of dedicated IP pools.
page_size (Optional[MaxItems], default: None ) –

The number of results to show in a single call to ListDedicatedIpPools. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

Raises:

BadRequestException –

The input you provided is invalid.
TooManyRequestsException –

Too many requests have been made to the operation.
UnknownServiceError –

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

Source code in docs_src/capo_pinpoint_email/_services/pinpoint_email.py

def list_dedicated_ip_pools(
    self,
    *,
    config_overrides: Optional[PinpointEmailClientConfig] = None,
    next_token: Optional["capo_pinpoint_email.types.next_token.NextToken"] = None,
    page_size: Optional["capo_pinpoint_email.types.max_items.MaxItems"] = None,
) -> "capo_pinpoint_email.types.list_dedicated_ip_pools_response.ListDedicatedIpPoolsResponse":
    """<p>List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.</p>

    Args:
        next_token: <p>A token returned from a previous call to <code>ListDedicatedIpPools</code> to indicate the position in the list of dedicated IP pools.</p>
        page_size: <p>The number of results to show in a single call to <code>ListDedicatedIpPools</code>. If the number of results is larger than the number you specified in this parameter, then the response includes a <code>NextToken</code> element, which you can use to obtain additional results.</p>

    Raises:
        capo_pinpoint_email.errors.bad_request_exception.BadRequestException: <p>The input you provided is invalid.</p>
        capo_pinpoint_email.errors.too_many_requests_exception.TooManyRequestsException: <p>Too many requests have been made to the operation.</p>
        capo_pinpoint_email.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_pinpoint_email.types.list_dedicated_ip_pools_request.ListDedicatedIpPoolsRequest]",
    ) -> OperationResponse[
        "capo_pinpoint_email.types.list_dedicated_ip_pools_response.ListDedicatedIpPoolsResponse"
    ]:
        import capo_pinpoint_email._operations.amazon_pinpoint_email_service.list_dedicated_ip_pools

        output, http_response = (
            capo_pinpoint_email._operations.amazon_pinpoint_email_service.list_dedicated_ip_pools.list_dedicated_ip_pools(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDedicatedIpPools")
    )
    input_: capo_pinpoint_email.types.list_dedicated_ip_pools_request.ListDedicatedIpPoolsRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if page_size is not None:
        input_["page_size"] = page_size

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