PinpointEmail / Client / list_dedicated_ip_pools

list_dedicated_ip_pools#

PinpointEmail.Client.list_dedicated_ip_pools(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_dedicated_ip_pools(
    NextToken='string',
    PageSize=123
)
Parameters:

  • NextToken (string) – A token returned from a previous call to ListDedicatedIpPools to indicate the position in the list of dedicated IP pools.

  • PageSize (integer) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'DedicatedIpPools': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    A list of dedicated IP pools.

    • DedicatedIpPools (list) –

      A list of all of the dedicated IP pools that are associated with your Amazon Pinpoint account.

      • (string) –

        The name of a dedicated IP pool.

    • NextToken (string) –

      A token that indicates that there are additional IP pools to list. To view additional IP pools, issue another request to ListDedicatedIpPools, passing this token in the NextToken parameter.

Exceptions