Amazon Elastic Compute Cloud
CLI Reference (API Version 2011-12-15)
Print this pageEmail this pageGo to the ForumsView the PDFShare this page on TwitterShare this page on FacebookBookmark this page on DeliciousSubmit this page to RedditSubmit this page to DiggDid this page help you?  Yes  No   Tell us about it...

ec2-describe-addresses

Description

Gives information about Elastic IP addresses allocated to your account. This includes both EC2 and VPC Elastic IP addresses. For information about VPC addresses and how they differ from EC2 addresses, go to Elastic IP Addresses in the Amazon Virtual Private Cloud User Guide.

You can filter the results to return information only about Elastic IP addresses that match criteria you specify. For example, you could get information only about addresses tagged with a certain value. You can specify multiple values for a filter. An address must match at least one of the specified values for it to be included in the results.

You can specify multiple filters (e.g., the address is a particular value, and is tagged with a certain value). The result includes information for an address only if it matches all your filters. If there's no match, no special message is returned; the response is simply empty.

You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly one character. You can escape special characters using a backslash before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\.

The following table shows the available filters.

Filter Name Description

domain

Whether the address is a EC2 address, or a VPC address.

Type: String

Valid Values: standard | vpc

instance-id

Instance the address is associated with (if any).

Type: String

public-ip

The Elastic IP address.

Type: String

allocation-id

Allocation ID for the address (for VPC addresses only).

Type: String

association-id

Association ID for the address (for VPC addresses only).

Type: String

The short version of this command is ec2daddr.

Syntax

ec2-describe-addresses [public_ip ... | allocation_id ...] [[--filter name=value] ...]

Options

NameDescriptionRequired

public_ip

EC2 Elastic IP address to describe.

Type: String

Default: Describes all addresses you own, or only those otherwise specified.

Example: 198.51.100.1

No

allocation_id

VPC Elastic IP address to describe.

Type: String

Default: Describes all addresses you own, or only those otherwise specified.

Example: eipalloc-9558a4fc

No

--filter name=value

A filter for limiting the results. See the preceding table for a list of allowed filter names and values. If you're using the command line tools on a Windows system, you might need to use quotation marks (i.e., "name=value").

Type: String

Default: Describes all addresses you own, or only those otherwise specified.

Example: --filter "instance-id=i-1a2b3c4d"

No

Common Options

OptionDescription

--region REGION

Overrides the Region specified in the EC2_URL environment variable and the URL specified by the -U option.

Default: The EC2_URL environment variable, or us-east-1 if the environment variable is not set.

Example: --region eu-west-1

-U, --url URL

URL is the uniform resource locator of the Amazon EC2 web service entry point.

Default: The EC2_URL environment variable, or https://ec2.amazonaws.com if the environment variable is not set.

Example: -U https://ec2.amazonaws.com

-K, --private-key EC2-PRIVATE-KEY

The private key to use when constructing requests to Amazon EC2.

Default: The value of the EC2_PRIVATE_KEY environment variable.

Example: -K pk-HKZYKTAIG2ECMXYIBH3HXV4ZBZQ55CLO.pem

-C, --cert EC2-CERT

The X.509 certificate to use when constructing requests to Amazon EC2.

Default: The value of the EC2_CERT environment variable.

Example: -C cert-HKZYKTAIG2ECMXYIBH3HXV4ZBZQ55CLO.pem

--connection-timeout TIMEOUT

Specifies a connection timeout (in seconds).

Example: --connection-timeout 30

--request-timeout TIMEOUT

Specifies a request timeout (in seconds).

Example: --request-timeout 45

-v, --verbose

Displays verbose output by showing the SOAP request and response on the command line. This is particularly useful if you are building tools to talk directly to our SOAP API.

-H, --headers

Displays column headers in the output.

--show-empty-fields

Shows empty columns as (nil).

--hide-tags

Do not display tags for tagged resources.

--debug

Prints internal debugging information. This is useful to assist us when troubleshooting problems.

-?, --help, -h

Displays Help.

-

If - is specified as an argument to one of the parameters, a list of arguments is read from standard input. This is useful for piping the output of one command into the input of another.

Example: ec2-describe-instances | grep stopped | cut -f 2 | ec2-start-instances -

Output

The command returns a table that contains the following information:

  • Output type identifier ("ADDRESS")

  • Elastic IP address

  • Instance ID to which the IP address is assigned

  • The domain of the address (standard or vpc)

  • Allocation ID (for VPC addresses only)

  • Association ID (for VPC addresses only)

Amazon EC2 command line tools display errors on stderr.

Examples

Example Request

This example describes the EC2 address 192.0.2.1, which is assigned to instance i-f15ebb98.

PROMPT> ec2-describe-addresses 192.0.2.1
ADDRESS  192.0.2.1   i-f15ebb98  standard

Example Request

This example describes the VPC address with allocation ID eipalloc-9258a4fb, which is assigned to instance i-9e9da4e9.

PROMPT> ec2-describe-addresses eipalloc-9258a4fb
ADDRESS 198.51.100.1   i-9e9da4e9      vpc     eipalloc-9258a4fb   eipassoc-0659a56f

Example Request

This example describes all your Elastic IP addresses (both EC2 and VPC).

PROMPT> ec2-describe-addresses 
ADDRESS 192.0.2.1   i-f15ebb98  standard
ADDRESS 198.51.100.1   i-9e9da4e9      vpc     eipalloc-9258a4fb   eipassoc-0659a56f
ADDRESS 203.0.113.1            vpc     eipalloc-9558a4fc

Example Request

This example describes only your VPC Elastic IP addresses.

PROMPT> ec2-describe-addresses --filter "allocation-id=*"
ADDRESS 198.51.100.1   i-9e9da4e9      vpc     eipalloc-9258a4fb   eipassoc-0659a56f
ADDRESS 203.0.113.1            vpc     eipalloc-9558a4fc