[ aws . ec2 ]

describe-availability-zones

Description

Describes the Availability Zones and Local Zones that are available to you. If there is an event impacting an Availability Zone or Local Zone, you can use this request to view the state and any provided messages for that Availability Zone or Local Zone.

For more information about Availability Zones and Local Zones, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-availability-zones
[--filters <value>]
[--zone-names <value>]
[--zone-ids <value>]
[--all-availability-zones | --no-all-availability-zones]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--filters (list)

The filters.

• group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1 ).

• message - The Zone message.

• opt-in-status - The opt in status (opted-in , and not-opted-in | opt-in-not-required ).

• The ID of the zone that handles some of the Local Zone control plane operations, such as API calls.

• region-name - The name of the Region for the Zone (for example, us-east-1 ).

• state - The state of the Availability Zone or Local Zone (available | information | impaired | unavailable ).

• zone-id - The ID of the Availability Zone (for example, use1-az1 ) or the Local Zone (for example, use usw2-lax1-az1 ).

• zone-type - The type of zone, for example, local-zone .

• zone-name - The name of the Availability Zone (for example, us-east-1a ) or the Local Zone (for example, use us-west-2-lax-1a ).

• zone-type - The type of zone, for example, local-zone .

(structure)

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. The filters supported by a describe operation are documented with the describe operation. For example:

• DescribeAvailabilityZones

• DescribeImages

• DescribeInstances

• DescribeKeyPairs

• DescribeSecurityGroups

• DescribeSnapshots

• DescribeSubnets

• DescribeTags

• DescribeVolumes

• DescribeVpcs

Name -> (string)

The name of the filter. Filter names are case-sensitive.

Values -> (list)

The filter values. Filter values are case-sensitive.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--zone-names (list)

The names of the Zones.

(string)

Syntax:

"string" "string" ...

--zone-ids (list)

The IDs of the Zones.

(string)

Syntax:

"string" "string" ...

--all-availability-zones | --no-all-availability-zones (boolean)

Include all Availability Zones and Local Zones regardless of your opt in status.

If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.

--dry-run | --no-dry-run (boolean)

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 .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To describe your Availability Zones

The following example describe-availability-zones displays details for the Availability Zones that are available to you. The response includes Availability Zones only for the current Region. In this example, it uses the profiles default us-west-2 (Oregon) Region.

aws ec2 describe-availability-zones

Output:

{
    "AvailabilityZones": [
        {
            "State": "available",
            "OptInStatus": "opt-in-not-required",
            "Messages": [],
            "RegionName": "us-west-2",
            "ZoneName": "us-west-2a",
            "ZoneId": "usw2-az1",
            "GroupName": "us-west-2",
            "NetworkBorderGroup": "us-west-2"
        },
        {
            "State": "available",
            "OptInStatus": "opt-in-not-required",
            "Messages": [],
            "RegionName": "us-west-2",
            "ZoneName": "us-west-2b",
            "ZoneId": "usw2-az2",
            "GroupName": "us-west-2",
            "NetworkBorderGroup": "us-west-2"
        },
        {
            "State": "available",
            "OptInStatus": "opt-in-not-required",
            "Messages": [],
            "RegionName": "us-west-2",
            "ZoneName": "us-west-2c",
            "ZoneId": "usw2-az3",
            "GroupName": "us-west-2",
            "NetworkBorderGroup": "us-west-2"
        },
        {
            "State": "available",
            "OptInStatus": "opt-in-not-required",
            "Messages": [],
            "RegionName": "us-west-2",
            "ZoneName": "us-west-2d",
            "ZoneId": "usw2-az4",
            "GroupName": "us-west-2",
            "NetworkBorderGroup": "us-west-2"
        },
        {
            "State": "available",
            "OptInStatus": "opted-in",
            "Messages": [],
            "RegionName": "us-west-2",
            "ZoneName": "us-west-2-lax-1a",
            "ZoneId": "usw2-lax1-az1",
            "GroupName": "us-west-2-lax-1",
            "NetworkBorderGroup": "us-west-2-lax-1"
        }
    ]
}

Output

AvailabilityZones -> (list)

Information about the Zones.

(structure)

Describes a Zone.

State -> (string)

The state of the Zone.

OptInStatus -> (string)

For Availability Zones, this parameter always has the value of opt-in-not-required .

For Local Zones, this parameter is the opt in status. The possible values are opted-in , and not-opted-in .

Messages -> (list)

Any messages about the Zone.

(structure)

Describes a message about a Zone.

Message -> (string)

The message about the Zone.

RegionName -> (string)

The name of the Region.

ZoneName -> (string)

The name of the Zone.

ZoneId -> (string)

The ID of the Zone.

GroupName -> (string)

For Availability Zones, this parameter has the same value as the Region name.

For Local Zones, the name of the associated group, for example us-west-2-lax-1 .

NetworkBorderGroup -> (string)

The name of the location from which the address is advertised.

ZoneType -> (string)

The type of zone. The valid values are availability-zone and local-zone .

ParentZoneName -> (string)

The name of the zone that handles some of the Local Zone control plane operations, such as API calls.

ParentZoneId -> (string)

The ID of the zone that handles some of the Local Zone control plane operations, such as API calls.