Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . pinpoint-email ]

get-dedicated-ip

Description

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

See 'aws help' for descriptions of global parameters.

Synopsis

  get-dedicated-ip
--ip <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--ip (string)

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.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

DedicatedIp -> (structure)

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.