Skip to content
AWS for Query.Farm

aws.lightsail.get_regions

Example SQL Queries

SELECT * FROM
aws.lightsail.get_regions;

Description

Returns a list of all valid regions for Amazon Lightsail. Use the include availability zones parameter to also return the Availability Zones in a region.

Table Definition

Column NameColumn Data Type
include_availability_zones Input Column

A Boolean value indicating whether to also include Availability Zones in your get regions request. Availability Zones are indicated with a letter: us-east-2a.

BOOLEAN
include_relational_database_availability_zones Input Column

A Boolean value indicating whether to also include Availability Zones for databases in your get regions request. Availability Zones are indicated with a letter (us-east-2a).

BOOLEAN
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
regions

An array of key-value pairs containing information about your get regions request.

STRUCT(
    "continent_code" VARCHAR,
    "description" VARCHAR,
    "display_name" VARCHAR,
    "name" VARCHAR,
    "availability_zones" STRUCT(
        "zone_name" VARCHAR,
        "state" VARCHAR
    )[],
    "relational_database_availability_zones" STRUCT(
        "zone_name" VARCHAR,
        "state" VARCHAR
    )[]
)[]
Show child fields
regions[]
Show child fields
regions[].availability_zones[]
Show child fields
regions[].availability_zones[].state

The state of the Availability Zone.

regions[].availability_zones[].zone_name

The name of the Availability Zone. The format is us-east-2a (case-sensitive).

regions[].continent_code

The continent code (NA, meaning North America).

regions[].description

The description of the Amazon Web Services Region (This region is recommended to serve users in the eastern United States and eastern Canada).

regions[].display_name

The display name (Ohio).

regions[].name

The region name (us-east-2).

regions[].relational_database_availability_zones[]
Show child fields
regions[].relational_database_availability_zones[].state

The state of the Availability Zone.

regions[].relational_database_availability_zones[].zone_name

The name of the Availability Zone. The format is us-east-2a (case-sensitive).