You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EC2::Types::DescribeAvailabilityZonesRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeAvailabilityZonesRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  zone_names: ["String"],
  zone_ids: ["String"],
  all_availability_zones: false,
  dry_run: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#all_availability_zones ⇒ Boolean

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.

Returns:

  • (Boolean) —

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

#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.

Returns:

  • (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

#filters ⇒ Array<Types::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.

Returns:

#zone_ids ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#zone_names ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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