Skip to content

Describe Regions

ec2_describe_regions R Documentation

Describes the Regions that are enabled for your account, or all Regions

Description

Describes the Regions that are enabled for your account, or all Regions.

For a list of the Regions supported by Amazon EC2, see Amazon EC2 service endpoints.

For information about enabling and disabling Regions for your account, see Specify which Amazon Web Services Regions your account can use in the Amazon Web Services Account Management Reference Guide.

The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.

Usage

ec2_describe_regions(Filters, RegionNames, DryRun, AllRegions)

Arguments

Filters

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

RegionNames

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

DryRun

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.

AllRegions

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

Value

A list with the following syntax: 

list(
  Regions = list(
    list(
      Endpoint = "string",
      RegionName = "string",
      OptInStatus = "string"
    )
  )
)

Request syntax

svc$describe_regions(
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  RegionNames = list(
    "string"
  ),
  DryRun = TRUE|FALSE,
  AllRegions = TRUE|FALSE
)

Examples

## Not run: 
# This example describes all the regions that are available to you.
svc$describe_regions()

## End(Not run)