DescribeAddresses - Amazon Elastic Compute Cloud

DescribeAddresses

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

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

AllocationId.N

Information about the allocation IDs.

Type: Array of strings

Required: No

DryRun

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.

Type: Boolean

Required: No

Filter.N

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 AWS 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 AWS 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.

Type: Array of Filter objects

Required: No

PublicIp.N

One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

Type: Array of strings

Required: No

Response Elements

The following elements are returned by the service.

addressesSet

Information about the Elastic IP addresses.

Type: Array of Address objects

requestId

The ID of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common client error codes.

Examples

Example

This example request describes a specific Elastic IP address allocated to your account.

Sample Request

https://ec2.amazonaws.com/?Action=DescribeAddresses &AllocationId.1= eipalloc-08229861 &AUTHPARAMS

Sample Response

<DescribeAddressesResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>f7de5e98-491a-4c19-a92d-908d6EXAMPLE</requestId> <addressesSet> <item> <publicIp>203.0.113.41</publicIp> <allocationId>eipalloc-08229861</allocationId> <domain>vpc</domain> <instanceId>i-0598c7d356eba48d7</instanceId> <associationId>eipassoc-f0229899</associationId> <networkInterfaceId>eni-ef229886</networkInterfaceId> <networkInterfaceOwnerId>053230519467</networkInterfaceOwnerId> <privateIpAddress>10.0.0.228</privateIpAddress> </item> </addressesSet> </DescribeAddressesResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: