PinpointEmail / Client / get_dedicated_ip

get_dedicated_ip#

PinpointEmail.Client.get_dedicated_ip(**kwargs)#

Get information about a dedicated IP address, including the name of the dedicated IP pool that it’s associated with, as well information about the automatic warm-up process for the address.

See also: AWS API Documentation

Request Syntax

response = client.get_dedicated_ip(
    Ip='string'
)
Parameters:

Ip (string) –

[REQUIRED]

The IP address that you want to obtain more information about. The value you specify has to be a dedicated IP address that’s assocaited with your Amazon Pinpoint account.

Return type:

dict

Returns:

Response Syntax

{
    'DedicatedIp': {
        'Ip': 'string',
        'WarmupStatus': 'IN_PROGRESS'|'DONE',
        'WarmupPercentage': 123,
        'PoolName': 'string'
    }
}

Response Structure

  • (dict) –

    Information about a dedicated IP address.

    • DedicatedIp (dict) –

      An object that contains information about a dedicated IP address.

      • Ip (string) –

        An IP address that is reserved for use by your Amazon Pinpoint account.

      • WarmupStatus (string) –

        The warm-up status of a dedicated IP address. The status can have one of the following values:

        • IN_PROGRESS – The IP address isn’t ready to use because the dedicated IP warm-up process is ongoing.

        • DONE – The dedicated IP warm-up process is complete, and the IP address is ready to use.

      • WarmupPercentage (integer) –

        Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.

      • PoolName (string) –

        The name of the dedicated IP pool that the IP address is associated with.

Exceptions