Amazon Pinpoint Email Service
API Reference (API Version 2018-07-26)

DedicatedIp

Contains information about a dedicated IP address that is associated with your Amazon Pinpoint account.

Contents

Ip

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

Type: String

Required: Yes

PoolName

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

Type: String

Required: No

WarmupPercentage

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.

Type: Integer

Required: Yes

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.

Type: String

Valid Values: IN_PROGRESS | DONE

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: