regions

Creates, updates, deletes, gets or lists a regions resource.

Overview

Name	regions
Type	Resource
Id	aws.ec2.regions

Fields

The following fields are returned by SELECT queries:

describe_regions

Name	Datatype	Description
endpoint	string	The Region service endpoint.
geography	string	The geography information for the Region. The geography is returned as a list.
opt_in_status	string	The Region opt-in status. The possible values are opt-in-not-required, opted-in, and not-opted-in.
region_name	string	The name of the Region.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_regions	select	region	RegionName, AllRegions, DryRun, Filter	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
AllRegions	boolean	Indicates whether to display all Regions, including Regions that are disabled for your account.
DryRun	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.
Filter	array	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	array	The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.

SELECT examples

describe_regions

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.

SELECT
endpoint,
geography,
opt_in_status,
region_name
FROM aws.ec2.regions
WHERE region = '{{ region }}' -- required
AND RegionName = '{{ RegionName }}'
AND AllRegions = '{{ AllRegions }}'
AND DryRun = '{{ DryRun }}'
AND Filter = '{{ Filter }}'
;