Skip to content

DedicatedIp

Source code in docs_src/capo_sesv2/types/dedicated_ip.py
class DedicatedIp(TypedDict, closed=True):
    ip: "capo_sesv2.types.ip.Ip"
    """<p>An IPv4 address.</p>"""
    warmup_status: "capo_sesv2.types.warmup_status.WarmupStatus"
    """<p>The warm-up status of a dedicated IP address. The status can have one of the following values:</p> <ul> <li> <p> <code>IN_PROGRESS</code> – The IP address isn't ready to use because the dedicated IP warm-up process is ongoing.</p> </li> <li> <p> <code>DONE</code> – The dedicated IP warm-up process is complete, and the IP address is ready to use.</p> </li> <li> <p> <code>NOT_APPLICABLE</code> – 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.</p> </li> </ul>"""
    warmup_percentage: "capo_sesv2.types.percentage100_wrapper.Percentage100Wrapper"
    """<p>Indicates the progress of your dedicated IP warm-up:</p> <ul> <li> <p> <code>0-100</code> – 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.</p> </li> <li> <p> <code>-1</code> – Appears for IP addresses in managed dedicated pools where Amazon SES automatically handles the warm-up process, making the percentage not applicable.</p> </li> </ul>"""
    pool_name: NotRequired["capo_sesv2.types.pool_name.PoolName"]
    """<p>The name of the dedicated IP pool that the IP address is associated with.</p>"""

ip instance-attribute

ip: Ip

An IPv4 address.

pool_name instance-attribute

pool_name: NotRequired[PoolName]

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

warmup_percentage instance-attribute

warmup_percentage: Percentage100Wrapper

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.

warmup_status instance-attribute

warmup_status: WarmupStatus

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.