dedicated_ips

Creates, updates, deletes, gets or lists a dedicated_ips resource.

Overview

Name	dedicated_ips
Type	Resource
Id	aws.pinpoint_email.dedicated_ips

Fields

The following fields are returned by SELECT queries:

get_dedicated_ip

Name	Datatype	Description
ip	string	A dedicated IP address that is associated with your Amazon Pinpoint account.
pool_name	string	The name of a dedicated IP pool.
warmup_percentage	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.
warmup_status	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. (IN_PROGRESS, DONE)

get_dedicated_ips

Name	Datatype	Description
ip	string	A dedicated IP address that is associated with your Amazon Pinpoint account.
pool_name	string	The name of a dedicated IP pool.
warmup_percentage	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.
warmup_status	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. (IN_PROGRESS, DONE)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_dedicated_ip	select	ip, region		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.
get_dedicated_ips	select	region	PoolName, NextToken, PageSize	List the dedicated IP addresses that are associated with your Amazon Pinpoint account.
put_dedicated_ip_in_pool	replace	ip, region, DestinationPoolName		Move a dedicated IP address to an existing dedicated IP pool. The dedicated IP address that you specify must already exist, and must be associated with your Amazon Pinpoint account. The dedicated IP pool you specify must already exist. You can create a new pool by using the CreateDedicatedIpPool operation.
put_dedicated_ip_warmup_attributes	replace	ip, region, WarmupPercentage

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
ip	string	The dedicated IP address that you want to update the warm-up attributes for.
region	string	AWS region (default: us-east-1)
NextToken	string	A token returned from a previous call to GetDedicatedIps to indicate the position of the dedicated IP pool in the list of IP pools.
PageSize	integer	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.
PoolName	string	The name of the IP pool that the dedicated IP address is associated with.

SELECT examples

get_dedicated_ip

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.

SELECT
ip,
pool_name,
warmup_percentage,
warmup_status
FROM aws.pinpoint_email.dedicated_ips
WHERE ip = '{{ ip }}' -- required
AND region = '{{ region }}' -- required
;

get_dedicated_ips

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

SELECT
ip,
pool_name,
warmup_percentage,
warmup_status
FROM aws.pinpoint_email.dedicated_ips
WHERE region = '{{ region }}' -- required
AND PoolName = '{{ PoolName }}'
AND NextToken = '{{ NextToken }}'
AND PageSize = '{{ PageSize }}'
;

REPLACE examples

put_dedicated_ip_in_pool

Move a dedicated IP address to an existing dedicated IP pool. The dedicated IP address that you specify must already exist, and must be associated with your Amazon Pinpoint account. The dedicated IP pool you specify must already exist. You can create a new pool by using the CreateDedicatedIpPool operation.

REPLACE aws.pinpoint_email.dedicated_ips
SET 
DestinationPoolName = '{{ DestinationPoolName }}'
WHERE 
ip = '{{ ip }}' --required
AND region = '{{ region }}' --required
AND DestinationPoolName = '{{ DestinationPoolName }}' --required;

put_dedicated_ip_warmup_attributes

No description available.

REPLACE aws.pinpoint_email.dedicated_ips
SET 
WarmupPercentage = {{ WarmupPercentage }}
WHERE 
ip = '{{ ip }}' --required
AND region = '{{ region }}' --required
AND WarmupPercentage = '{{ WarmupPercentage }}' --required;