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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeRegionsRequest as input to an Aws::Client method, you can use a vanilla Hash:

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#all_regions ⇒ Boolean

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

Returns:

  • (Boolean) —

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

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

    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.

  • 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:

#region_names ⇒ Array<String>

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

Returns:

  • (Array<String>) —

    The names of the Regions.