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 and Local 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)


12369
12370
12371
12372
12373
12374
12375
12376
12377
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12369

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)


12369
12370
12371
12372
12373
12374
12375
12376
12377
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12369

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

  • message - The Availability Zone or Local Zone message.

  • opt-in-status - The opt in status (opted-in, and not-opted-in | opt-in-not-required).

  • region-name - The name of the Region for the Availability Zone or Local Zone (for example, us-east-1).

  • state - The state of the Availability Zone or Local Zone (available | information | impaired | unavailable).

  • zone-id - The ID of the Availability Zone (for example, use1-az1) or the Local Zone (for example, use usw2-lax1-az1).

  • zone-name - The name of the Availability Zone (for example, us-east-1a) or the Local Zone (for example, use us-west-2-lax-1a).

Returns:



12369
12370
12371
12372
12373
12374
12375
12376
12377
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12369

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 and Local Zones.

Returns:

  • (Array<String>)


12369
12370
12371
12372
12373
12374
12375
12376
12377
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12369

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 and Local Zones.

Returns:

  • (Array<String>)


12369
12370
12371
12372
12373
12374
12375
12376
12377
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 12369

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