Skip to content

describe_address_transfers

Operation

describe_address_transfers

describe_address_transfers(request: DescribeAddressTransfersInput | DescribeAddressTransfersInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeAddressTransfersInputDict]) -> DescribeAddressTransfersOutput

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:

Name Type Description Default
request DescribeAddressTransfersInput | DescribeAddressTransfersInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DescribeAddressTransfersInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeAddressTransfersOutput

An instance of DescribeAddressTransfersOutput.

describe_address_transfers async

describe_address_transfers(request: DescribeAddressTransfersInput | DescribeAddressTransfersInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeAddressTransfersInputDict]) -> DescribeAddressTransfersOutput

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:

Name Type Description Default
request DescribeAddressTransfersInput | DescribeAddressTransfersInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DescribeAddressTransfersInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeAddressTransfersOutput

An instance of DescribeAddressTransfersOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DescribeAddressTransfersInputDict

Bases: TypedDict

Dictionary form of DescribeAddressTransfersInput.

Attributes

allocation_ids instance-attribute
allocation_ids: Sequence[str] | None

The allocation IDs of Elastic IP addresses.

dry_run instance-attribute
dry_run: bool | None

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.

max_results instance-attribute
max_results: int | None

The maximum number of address transfers to return in one page of results.

next_token instance-attribute
next_token: str | None

Specify the pagination token from a previous request to retrieve the next page of results.

DescribeAddressTransfersInput dataclass

Bases: _SerdeShape

Dataclass for DescribeAddressTransfersInput structure.

Attributes

allocation_ids class-attribute instance-attribute
allocation_ids: list[str] | None = ...

The allocation IDs of Elastic IP addresses.

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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.

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of address transfers to return in one page of results.

next_token class-attribute instance-attribute
next_token: str | None = ...

Specify the pagination token from a previous request to retrieve the next page of results.

Output

DescribeAddressTransfersOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeAddressTransfersOutput structure.

Attributes

address_transfers class-attribute instance-attribute
address_transfers: list[AddressTransfer] | None = ...

The Elastic IP address transfer.

next_token class-attribute instance-attribute
next_token: str | None = ...

Specify the pagination token from a previous request to retrieve the next page of results.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.