Amazon Elastic Compute Cloud
CLI Reference (API Version 2013-02-01)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Did this page help you?  Yes | No |  Tell us about it...

ec2-describe-availability-zones

Description

Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using.

Note

Availability Zones are not the same across accounts. The Availability Zone us-east-1a for account A is not necessarily the same as us-east-1a for account B. Availability Zone assignments are mapped independently for each account.

The short version of this command is ec2daz.

Syntax

ec2-describe-availability-zones [zone_name ...] [[--filter "name=value"] ...]

Options

NameDescription

zone_name

One or more Availability Zone names.

Type: String

Default: Describes all zones in the region.

Required: No

Example: us-east-1a

-F, --filter name=value

A filter for limiting the results. See the Supported Filters section for a list of supported filters. Use quotation marks if the value string has a space ("name=value example"). On a Windows system, use quotation marks even without a space in the value string ("name=value").

Type: String

Default: Describes all zones in the region, or only those you specified by name.

Required: No

Example: --filter "region-name=ap-southeast-1"

Supported Filters

You can specify filters so that the response includes information for only certain Availability Zones. For example, you can use a filter to specify that you're interested in Availability Zones in the available state. You can specify multiple values for a filter. The response includes information for an Availability Zone only if it matches at least one of the filter values that you specified.

You can specify multiple filters; for example, specify Availability Zones that are in a particular region and are in the available state. The response includes information for an Availability Zone only if it matches all the filters that you specified. If there's no match, no special message is returned, the response is simply empty.

You can use wildcards in a filter value. An asterisk (*) matches zero or more characters, and a question mark (?) 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 are the available filters.

message

Information about the Availability Zone.

Type: String

region-name

The region for the Availability Zone (for example, us-east-1).

Type: String

state

The state of the Availability Zone

Type: String

Valid values: available

zone-name

The name of the zone.

Type: String

Common Options

OptionDescription

--region REGION

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

Default: The value of the EC2_URL environment variable, or us-east-1 if EC2_URL isn't set.

Example: --region eu-west-1

-U, --url URL

The uniform resource locator (URL) of the Amazon EC2 web service entry point.

Default: The value of the EC2_URL environment variable, or https://ec2.amazonaws.com if EC2_URL isn't set.

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

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

The private key that identifies you to Amazon EC2. For more information, see Tell the Tools Who You Are.

Default: The value of the EC2_PRIVATE_KEY environment variable. If EC2_PRIVATE_KEY isn't set, you must specify this option.

Example: -K pk-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem

-C, --cert EC2-CERT

The X.509 certificate that identifies you to Amazon EC2.

Default: The value of the EC2_CERT environment variable. If EC2_CERT isn't set, you must specify this option.

Example: -C cert-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem

-O, --aws-access-key AWS_ACCESS_KEY

The access key ID associated with your AWS account. For more information, see Tell the Tools Who You Are.

Default: The value of the AWS_ACCESS_KEY environment variable. If AWS_ACCESS_KEY isn't set, you must specify this option.

Example: -O AKIAIOSFODNN7EXAMPLE

Note

For more information, see the following section, Deprecated Options.

-W, --aws-secret-key AWS_SECRET_KEY

The secret access key associated with your AWS account.

Default: The value of the AWS_SECRET_KEY environment variable. If AWS_SECRET_KEY isn't set, you must specify this option.

Example: -W wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

Note

For more information, see the following section, Deprecated Options.

-T, --security-token TOKEN AWS_DELEGATION_TOKEN

The AWS delegation token.

Default: The value of the environment variable (if set).

--connection-timeout TIMEOUT

The connection timeout, in seconds.

Example: --connection-timeout 30

--request-timeout TIMEOUT

The request timeout, in seconds.

Example: --request-timeout 45

-v, --verbose

Displays verbose output, including the API request and response on the command line. This is useful if you are building tools to talk directly to our Query API.

-H, --headers

Includes column headers in the command output.

--show-empty-fields

Shows empty columns as (nil).

--hide-tags

Omits tags for tagged resources.

--debug

Displays internal debugging information. This can assist us when helping you troubleshooting problems.

-?, --help, -h

Displays usage information for the command.

-

Reads arguments from standard input. This is useful when piping the output from one command to the input of another.

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

Deprecated Options

For a limited time, you can still use the private key and X.509 certificate instead of your access key ID and secret access key. However, we recommend that you start using your access key ID (-O, --aws-access-key) and secret access key (-W, --aws-secret-key) now, as the private key (-K, --private-key) and X.509 certificate (-C, --cert) won't be supported after the transition period elapses. For more information, see Tell the Tools Who You Are.

OptionDescription

-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-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.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-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem

Output

This command returns a table that contains the following information for each Availability Zones retrieved:

  • The AVAILABILITYZONE identifier

  • The name of the Availability Zone

  • The state of the zone

  • The region that the Availability Zone belongs to

  • Any messages associated with the Availability Zone

Amazon EC2 command line tools display errors on stderr.

Examples

Example Request

This example displays information about Availability Zones that are available to the account. The response includes zones only for the region you're currently using.

PROMPT> > ec2-describe-availability-zones
AVAILABILITYZONE	us-west-2a	available	us-west-2
AVAILABILITYZONE	us-west-2b	available	us-west-2
AVAILABILITYZONE	us-west-2c	available	us-west-2

Example Request

This example displays information about Availability Zones that are available to the account in the us-east-1 region.

PROMPT> > ec2-describe-availability-zones --region us-east-1
AVAILABILITYZONE	us-east-1a	available	us-east-1
AVAILABILITYZONE	us-east-1b	available	us-east-1
AVAILABILITYZONE	us-east-1c	available	us-east-1
AVAILABILITYZONE	us-east-1d	available	us-east-1