ec2_describe_availability_zones {aws.ecx}

Describe Availability Zones

Description

Describe Availability Zones

Usage

ec2_describe_availability_zones(
  Filter = NULL,
  ZoneName = NULL,
  ZoneId = NULL,
  AllAvailabilityZones = NULL,
  DryRun = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

Filter

Named list where the name is the filter name and the value is the filter's value. The value can be a vector or a list object (see below)[optional]

ZoneName

List. The names of the Availability Zones, Local Zones, and Wavelength Zones.[optional]

ZoneId

List. The IDs of the Availability Zones, Local Zones, and Wavelength Zones.[optional]

AllAvailabilityZones

Logical. Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status....[optional]

DryRun

Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

Filter

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.

ZoneName

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

ZoneId

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

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.

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.