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

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,
}

Contains the parameters for DescribeRegions.

Instance Attribute Summary collapse

Instance Attribute Details

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


10057
10058
10059
10060
10061
10062
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10057

class DescribeRegionsRequest < Struct.new(
  :filters,
  :region_names,
  :dry_run)
  include Aws::Structure
end

#filtersArray<Types::Filter>

One or more filters.

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

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

Returns:



10057
10058
10059
10060
10061
10062
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10057

class DescribeRegionsRequest < Struct.new(
  :filters,
  :region_names,
  :dry_run)
  include Aws::Structure
end

#region_namesArray<String>

The names of one or more regions.

Returns:

  • (Array<String>)


10057
10058
10059
10060
10061
10062
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10057

class DescribeRegionsRequest < Struct.new(
  :filters,
  :region_names,
  :dry_run)
  include Aws::Structure
end