Skip to content

DedicatedIp

Source code in docs_src/capo_pinpoint_email/types/dedicated_ip.py 
16
17
18
19
20
21
22
23
24
25
26
class DedicatedIp(TypedDict, closed=True):
    ip: "capo_pinpoint_email.types.ip.Ip"
    """<p>An IP address that is reserved for use by your Amazon Pinpoint account.</p>"""
    warmup_status: "capo_pinpoint_email.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> </ul>"""
    warmup_percentage: (
        "capo_pinpoint_email.types.percentage100_wrapper.Percentage100Wrapper"
    )
    """<p>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.</p>"""
    pool_name: NotRequired["capo_pinpoint_email.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 IP address that is reserved for use by your Amazon Pinpoint account.

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 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.

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.