DescribeAvailabilityZones - Amazon Elastic Compute Cloud
AWS services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with AWS services in China.

DescribeAvailabilityZones

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

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

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.

AllAvailabilityZones

Include all Availability Zones, Local Zones, and Wavelength 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.

Type: Boolean

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

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) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

  • message - The Zone message.

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

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

  • parent-zoneName - The ID of the zone that handles some of the Local Zone and Wavelength 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, the Local Zone, or the Wavelength Zone (available | information | impaired | unavailable).

  • zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).

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

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

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

Type: Array of Filter objects

Required: No

ZoneId.N

The IDs of the Availability Zones, Local Zones, and Wavelength Zones.

Type: Array of strings

Required: No

ZoneName.N

The names of the Availability Zones, Local Zones, and Wavelength Zones.

Type: Array of strings

Required: No

Response Elements

The following elements are returned by the service.

availabilityZoneInfo

Information about the Availability Zones, Local Zones, and Wavelength Zones.

Type: Array of AvailabilityZone objects

requestId

The ID of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common Client Errors.

Example

Example

This example request describes the zones that are available to you.

Sample Request

https://ec2.amazonaws.com/?Action=DescribeAvailabilityZones &AUTHPARAMS

Sample Response

<DescribeAvailabilityZonesResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>e23c5a54-a29c-43ee-8b55-0c13c26e9e01</requestId> <availabilityZoneInfo> <item> <optInStatus>opt-in-not-required</optInStatus> <zoneName>us-west-2a</zoneName> <zoneId>usw2-az1</zoneId> <zoneState>available</zoneState> <regionName>us-west-2</regionName> <messageSet/> <NetworkBorderGroup>us-west-2-lax-1</NetworkBorderGroup> </item> <item> <groupName>us-west-2</groupName> <optInStatus>opt-in-not-required</optInStatus> <zoneName>us-west-2b</zoneName> <zoneId>usw2-az2</zoneId> <zoneState>available</zoneState> <regionName>us-west-2</regionName> <messageSet/> <NetworkBorderGroup>us-west-2-lax-1</NetworkBorderGroup> </item> <item> <groupName>us-west-2</groupName> <optInStatus>opt-in-not-required</optInStatus> <zoneName>us-west-2c</zoneName> <zoneId>usw2-az3</zoneId> <zoneState>available</zoneState> <regionName>us-west-2</regionName> <messageSet/> <NetworkBorderGroup>us-west-2-lax-1</NetworkBorderGroup> </item> <item> <groupName>us-west-2</groupName> <optInStatus>opt-in-not-required</optInStatus> <zoneName>us-west-2d</zoneName> <zoneId>usw2-az4</zoneId> <zoneState>available</zoneState> <regionName>us-west-2</regionName> <messageSet/> </item> <item> <groupName>us-west-2-lax-1</groupName> <optInStatus>opted-in</optInStatus> <zoneName>us-west-2-lax-1a</zoneName> <zoneId>usw2-lax1-az1</zoneId> <zoneState>available</zoneState> <regionName>us-west-2</regionName> <messageSet/> </item> </availabilityZoneInfo> </DescribeAvailabilityZonesResponse>

See Also

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