ec2_describe_regions {aws.ecx}

Describe Regions

Description

Describe Regions

Usage

ec2_describe_regions(
  Filter = NULL,
  RegionName = NULL,
  DryRun = NULL,
  AllRegions = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

Filter

Named list where the name is the filter name and the value is the filter's value. The value can be a vector or a list object (see below)[optional]

RegionName

List. The names of the Regions.[optional]

DryRun

Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]

AllRegions

Logical. Indicates whether to display all Regions, including Regions that are disabled for your account.[optional]

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

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

RegionName

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.