External DocumentationTo learn more, visit the AWS documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| AWS Region(s) | Enter the desired AWS Region(s). To execute the action in multiple regions, provide a comma-separated list. For example: us-east-1,eu-west-2.If you wish to run the action in all available regions, use the asterisk symbol ( *) instead. |
| All Availability Zones | 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. |
| Zone Names | The names of the Availability Zones, Local Zones, and Wavelength Zones. |
Advanced Parameters
| Parameter | Description | ||||
|---|---|---|---|---|---|
| Disable XML To JSON Auto Convert | When checked, XML responses are not automatically converted into JSON format. | ||||
| Dry Run | 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. | ||||
| Filters | 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. |
| Zone IDs | The IDs of the Availability Zones, Local Zones, and Wavelength Zones. |
Example Output
{
"af-south-1": {
"DescribeAvailabilityZonesResponse": {
"-xmlns": "<string>",
"availabilityZoneInfo": {
"item": [
{
"groupLongName": "<string>",
"groupName": "<string>",
"messageSet": "<string>",
"networkBorderGroup": "<string>",
"optInStatus": "<string>",
"regionName": "<string>",
"zoneId": "<string>",
"zoneName": "<string>",
"zoneState": "<string>",
"zoneType": "<string>"
}
]
},
"requestId": "<string>"
}
},
"ap-south-1": {
"DescribeAvailabilityZonesResponse": {
"-xmlns": "<string>",
"availabilityZoneInfo": {
"item": [
{
"groupLongName": "<string>",
"groupName": "<string>",
"messageSet": "<string>",
"networkBorderGroup": "<string>",
"optInStatus": "<string>",
"regionName": "<string>",
"zoneId": "<string>",
"zoneName": "<string>",
"zoneState": "<string>",
"zoneType": "<string>"
}
]
},
"requestId": "<string>"
}
},
"ap-southeast-1": {
"DescribeAvailabilityZonesResponse": {
"-xmlns": "<string>",
"availabilityZoneInfo": {
"item": [
{
"groupLongName": "<string>",
"groupName": "<string>",
"messageSet": "<string>",
"networkBorderGroup": "<string>",
"optInStatus": "<string>",
"regionName": "<string>",
"zoneId": "<string>",
"zoneName": "<string>",
"zoneState": "<string>",
"zoneType": "<string>"
}
]
},
"requestId": "<string>"
}
},
"ap-southeast-2": {
"DescribeAvailabilityZonesResponse": {
"-xmlns": "<string>",
"availabilityZoneInfo": {
"item": [
{
"groupLongName": "<string>",
"groupName": "<string>",
"messageSet": "<string>",
"networkBorderGroup": "<string>",
"optInStatus": "<string>",
"regionName": "<string>",
"zoneId": "<string>",
"zoneName": "<string>",
"zoneState": "<string>",
"zoneType": "<string>"
}
]
},
"requestId": "<string>"
}
},
"ap-southeast-3": {
"DescribeAvailabilityZonesResponse": {
"-xmlns": "<string>",
"availabilityZoneInfo": {
"item": [
{
"groupLongName": "<string>",
"groupName": "<string>",
"messageSet": "<string>",
"networkBorderGroup": "<string>",
"optInStatus": "<string>",
"regionName": "<string>",
"zoneId": "<string>",
"zoneName": "<string>",
"zoneState": "<string>",
"zoneType": "<string>"
}
]
},
"requestId": "<string>"
}
},
"ca-central-1": {
"DescribeAvailabilityZonesResponse": {
"-xmlns": "<string>",
"availabilityZoneInfo": {
"item": [
{
"groupLongName": "<string>",
"groupName": "<string>",
"messageSet": "<string>",
"networkBorderGroup": "<string>",
"optInStatus": "<string>",
"regionName": "<string>",
"zoneId": "<string>",
"zoneName": "<string>",
"zoneState": "<string>",
"zoneType": "<string>"
}
]
},
"requestId": "<string>"
}
},
"eu-central-1": {
"DescribeAvailabilityZonesResponse": {
"-xmlns": "<string>",
"availabilityZoneInfo": {
"item": [
{
"groupLongName": "<string>",
"groupName": "<string>",
"messageSet": "<string>",
"networkBorderGroup": "<string>",
"optInStatus": "<string>",
"regionName": "<string>",
"zoneId": "<string>",
"zoneName": "<string>",
"zoneState": "<string>",
"zoneType": "<string>"
}
]
},
"requestId": "<string>"
}
},
"us-west-2": {
"DescribeAvailabilityZonesResponse": {
"-xmlns": "<string>",
"availabilityZoneInfo": {
"item": [
{
"groupLongName": "<string>",
"groupName": "<string>",
"messageSet": "<string>",
"networkBorderGroup": "<string>",
"optInStatus": "<string>",
"regionName": "<string>",
"zoneId": "<string>",
"zoneName": "<string>",
"zoneState": "<string>",
"zoneType": "<string>"
}
]
},
"requestId": "<string>"
}
}
}