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

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::DescribeAvailabilityZonesRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #all_availability_zones ⇒ 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.

• #filters ⇒ Array<Types::Filter>

  The filters.

• #zone_ids ⇒ 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.

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)

# File 'lib/aws-sdk-ec2/types.rb', line 18168

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

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

# File 'lib/aws-sdk-ec2/types.rb', line 18168

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

#filters ⇒ Array<Types::Filter>

The filters.

• ‘group-long-name` - The long name of the zone group for the Availability Zone (for example, `US West (Oregon) 1`), the Local Zone (for example, for Zone group `us-west-2-lax-1`, it is `US West (Los Angeles)`, or the Wavelength Zone (for example, for Zone group `us-east-1-wl1`, it is `US East (Verizon)`.

• ‘group-name` - The name of the zone group for the Availability Zone (for example, `us-east-1-zg-1`), the Local Zone (for example, `us-west-2-lax-1`), or the Wavelength Zone (for example, `us-east-1-wl1`).

• ‘message` - The Zone message.

• ‘opt-in-status` - The opt-in status (`opted-in` | `not-opted-in` | `opt-in-not-required`).

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

• ‘parent-zone-name` - 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` | `unavailable` | `constrained`).

• ‘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-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 (`availability-zone` | `local-zone` | `wavelength-zone`).

Returns:

• (Array<Types::Filter>)

# File 'lib/aws-sdk-ec2/types.rb', line 18168

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

#zone_ids ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 18168

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

#zone_names ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 18168

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