Class: Aws::EC2::Types::DescribeRegionsRequest

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 DescribeRegionsRequest data as a hash:

{
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  region_names: ["String"],
  dry_run: false,
  all_regions: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#all_regionsBoolean

Indicates whether to display all Regions, including Regions that are disabled for your account.

Returns:

  • (Boolean)


18166
18167
18168
18169
18170
18171
18172
18173
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 18166

class DescribeRegionsRequest < Struct.new(
  :filters,
  :region_names,
  :dry_run,
  :all_regions)
  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)


18166
18167
18168
18169
18170
18171
18172
18173
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 18166

class DescribeRegionsRequest < Struct.new(
  :filters,
  :region_names,
  :dry_run,
  :all_regions)
  SENSITIVE = []
  include Aws::Structure
end

#filtersArray<Types::Filter>

The filters.

  • endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).

  • opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in | not-opted-in).

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

Returns:



18166
18167
18168
18169
18170
18171
18172
18173
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 18166

class DescribeRegionsRequest < Struct.new(
  :filters,
  :region_names,
  :dry_run,
  :all_regions)
  SENSITIVE = []
  include Aws::Structure
end

#region_namesArray<String>

The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.

Returns:

  • (Array<String>)


18166
18167
18168
18169
18170
18171
18172
18173
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 18166

class DescribeRegionsRequest < Struct.new(
  :filters,
  :region_names,
  :dry_run,
  :all_regions)
  SENSITIVE = []
  include Aws::Structure
end