AWS API Changes

2025/07/18 - Amazon Simple Email Service - 2 updated api methods

Changes Added IP Visibility support for managed dedicated pools. Enhanced GetDedicatedIp and GetDedicatedIps APIs to return managed IP addresses.

GetDedicatedIp (updated)

Link ¶
Changes (response)

{'DedicatedIp': {'WarmupStatus': {'NOT_APPLICABLE'}}}

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

client.get_dedicated_ip(
    Ip='string'
)

type Ip:

string

param Ip:

[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 Web Services account.

rtype:

dict

returns:

Response Syntax

{
    'DedicatedIp': {
        'Ip': 'string',
        'WarmupStatus': 'IN_PROGRESS'|'DONE'|'NOT_APPLICABLE',
        '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 IPv4 address.
  - 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.
    - NOT_APPLICABLE – The warm-up status doesn't apply to this IP address. This status is used for IP addresses in managed dedicated IP pools, where Amazon SES automatically handles the warm-up process.
  - WarmupPercentage (integer) --
    
    Indicates the progress of your dedicated IP warm-up:
    - 0-100 – For standard dedicated IP addresses, this shows the warm-up completion percentage. A value of 100 means the IP address is fully warmed up and ready for use.
    - -1 – Appears for IP addresses in managed dedicated pools where Amazon SES automatically handles the warm-up process, making the percentage not applicable.
  - PoolName (string) --
    
    The name of the dedicated IP pool that the IP address is associated with.

GetDedicatedIps (updated)

Link ¶
Changes (response)

{'DedicatedIps': {'WarmupStatus': {'NOT_APPLICABLE'}}}

List the dedicated IP addresses that are associated with your Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

client.get_dedicated_ips(
    PoolName='string',
    NextToken='string',
    PageSize=123
)

type PoolName:

string

param PoolName:

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

type NextToken:

string

param NextToken:

A token returned from a previous call to GetDedicatedIps to indicate the position of the dedicated IP pool in the list of IP pools.

type PageSize:

integer

param PageSize:

The number of results to show in a single call to GetDedicatedIpsRequest. 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.

rtype:

dict

returns:

Response Syntax

{
    'DedicatedIps': [
        {
            'Ip': 'string',
            'WarmupStatus': 'IN_PROGRESS'|'DONE'|'NOT_APPLICABLE',
            'WarmupPercentage': 123,
            'PoolName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Information about the dedicated IP addresses that are associated with your Amazon Web Services account.
- DedicatedIps (list) --
  
  A list of dedicated IP addresses that are associated with your Amazon Web Services account.
  - (dict) --
    
    Contains information about a dedicated IP address that is associated with your Amazon SES account.
    
    To learn more about requesting dedicated IP addresses, see Requesting and Relinquishing Dedicated IP Addresses in the Amazon SES Developer Guide.
    - Ip (string) --
      
      An IPv4 address.
    - 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.
      - NOT_APPLICABLE – The warm-up status doesn't apply to this IP address. This status is used for IP addresses in managed dedicated IP pools, where Amazon SES automatically handles the warm-up process.
    - WarmupPercentage (integer) --
      
      Indicates the progress of your dedicated IP warm-up:
      - 0-100 – For standard dedicated IP addresses, this shows the warm-up completion percentage. A value of 100 means the IP address is fully warmed up and ready for use.
      - -1 – Appears for IP addresses in managed dedicated pools where Amazon SES automatically handles the warm-up process, making the percentage not applicable.
    - PoolName (string) --
      
      The name of the dedicated IP pool that the IP address is associated with.
- NextToken (string) --
  
  A token that indicates that there are additional dedicated IP addresses to list. To view additional addresses, issue another request to GetDedicatedIps, passing this token in the NextToken parameter.