Skip to content

EC2  >  Operations  >  describe_addresses

describe_addresses

Operation

describe_addresses async

describe_addresses(request: DescribeAddressesInput | DescribeAddressesInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeAddressesOutput
describe_addresses(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeAddressesInputDict]) -> DescribeAddressesOutput

Describes the specified Elastic IP addresses or all of your Elastic IP addresses.

Parameters:

Name Type Description Default
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

Returns:

Type Description
DescribeAddressesOutput

An instance of DescribeAddressesOutput.

Input

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

Model

DescribeAddressesInput dataclass

Bases: _SerdeShape

Dataclass for DescribeAddressesInput structure.

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

Information about the allocation IDs.

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.

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

One or more filters. Filter names and values are case-sensitive.

  • allocation-id - The allocation ID for the address.

  • association-id - The association ID for the address.

  • instance-id - The ID of the instance the address is associated with, if any.

  • network-border-group - A unique set of Availability Zones, Local Zones, or Wavelength Zones from where Amazon Web Services advertises IP addresses.

  • network-interface-id - The ID of the network interface that the address is associated with, if any.

  • network-interface-owner-id - The Amazon Web Services account ID of the owner.

  • private-ip-address - The private IP address associated with the Elastic IP address.

  • public-ip - The Elastic IP address, or the carrier IP address.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

Dictionaries

DescribeAddressesInputDict

Bases: TypedDict

Dictionary form of DescribeAddressesInput.

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

Information about the allocation IDs.

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.

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

One or more filters. Filter names and values are case-sensitive.

  • allocation-id - The allocation ID for the address.

  • association-id - The association ID for the address.

  • instance-id - The ID of the instance the address is associated with, if any.

  • network-border-group - A unique set of Availability Zones, Local Zones, or Wavelength Zones from where Amazon Web Services advertises IP addresses.

  • network-interface-id - The ID of the network interface that the address is associated with, if any.

  • network-interface-owner-id - The Amazon Web Services account ID of the owner.

  • private-ip-address - The private IP address associated with the Elastic IP address.

  • public-ip - The Elastic IP address, or the carrier IP address.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

Output

DescribeAddressesOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeAddressesOutput structure.

Attributes

addresses class-attribute instance-attribute
addresses: list[Address] | None = ...

Information about the Elastic IP addresses.

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.