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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass DescribeAvailabilityZonesRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#all_availability_zonesBoolean

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)


15980
15981
15982
15983
15984
15985
15986
15987
15988
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15980

class DescribeAvailabilityZonesRequest < Struct.new(
  :filters,
  :zone_names,
  :zone_ids,
  :all_availability_zones,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#dry_runBoolean

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)


15980
15981
15982
15983
15984
15985
15986
15987
15988
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15980

class DescribeAvailabilityZonesRequest < Struct.new(
  :filters,
  :zone_names,
  :zone_ids,
  :all_availability_zones,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#filtersArray<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:



15980
15981
15982
15983
15984
15985
15986
15987
15988
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15980

class DescribeAvailabilityZonesRequest < Struct.new(
  :filters,
  :zone_names,
  :zone_ids,
  :all_availability_zones,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#zone_idsArray<String>

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

Returns:

  • (Array<String>)


15980
15981
15982
15983
15984
15985
15986
15987
15988
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15980

class DescribeAvailabilityZonesRequest < Struct.new(
  :filters,
  :zone_names,
  :zone_ids,
  :all_availability_zones,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#zone_namesArray<String>

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

Returns:

  • (Array<String>)


15980
15981
15982
15983
15984
15985
15986
15987
15988
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 15980

class DescribeAvailabilityZonesRequest < Struct.new(
  :filters,
  :zone_names,
  :zone_ids,
  :all_availability_zones,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end