address_transfers

Creates, updates, deletes, gets or lists an address_transfers resource.

Overview

Name	address_transfers
Type	Resource
Id	aws.ec2.address_transfers

Fields

The following fields are returned by SELECT queries:

describe_address_transfers

Name	Datatype	Description
address_transfer_status	string	The Elastic IP address transfer status.
allocation_id	string	The allocation ID of an Elastic IP address.
public_ip	string	The Elastic IP address being transferred.
transfer_account_id	string	The ID of the account that you want to transfer the Elastic IP address to.
transfer_offer_accepted_timestamp	string	The timestamp when the Elastic IP address transfer was accepted.
transfer_offer_expiration_timestamp	string	The timestamp when the Elastic IP address transfer expired. When the source account starts the transfer, the transfer account has seven hours to allocate the Elastic IP address to complete the transfer, or the Elastic IP address will return to its original owner.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_address_transfers	select	region	AllocationId, NextToken, MaxResults, DryRun	Describes an Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon VPC User Guide. When you transfer an Elastic IP address, there is a two-step handshake between the source and transfer Amazon Web Services accounts. When the source account starts the transfer, the transfer account has seven days to accept the Elastic IP address transfer. During those seven days, the source account can view the pending transfer by using this action. After seven days, the transfer expires and ownership of the Elastic IP address returns to the source account. Accepted transfers are visible to the source account for 14 days after the transfers have been accepted.

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
region	string	AWS region (default: us-east-1)
AllocationId	array	The allocation IDs of Elastic IP addresses.
DryRun	boolean	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
MaxResults	integer	The maximum number of address transfers to return in one page of results.
NextToken	string	Specify the pagination token from a previous request to retrieve the next page of results.

SELECT examples

describe_address_transfers

Describes an Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon VPC User Guide. When you transfer an Elastic IP address, there is a two-step handshake between the source and transfer Amazon Web Services accounts. When the source account starts the transfer, the transfer account has seven days to accept the Elastic IP address transfer. During those seven days, the source account can view the pending transfer by using this action. After seven days, the transfer expires and ownership of the Elastic IP address returns to the source account. Accepted transfers are visible to the source account for 14 days after the transfers have been accepted.

SELECT
address_transfer_status,
allocation_id,
public_ip,
transfer_account_id,
transfer_offer_accepted_timestamp,
transfer_offer_expiration_timestamp
FROM aws.ec2.address_transfers
WHERE region = '{{ region }}' -- required
AND AllocationId = '{{ AllocationId }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
AND DryRun = '{{ DryRun }}'
;