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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-regions
[--include-availability-zones | --no-include-availability-zones]
[--include-relational-database-availability-zones | --no-include-relational-database-availability-zones]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--include-availability-zones | --no-include-availability-zones (boolean)

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

--include-relational-database-availability-zones | --no-include-relational-database-availability-zones (boolean)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To get all AWS Regions for Amazon Lightsail

The following get-regions example displays details about all of the AWS Regions for Amazon Lightsail.

aws lightsail get-regions

Output:

{
    "regions": [
        {
            "continentCode": "NA",
            "description": "This region is recommended to serve users in the eastern United States",
            "displayName": "Virginia",
            "name": "us-east-1",
            "availabilityZones": [],
            "relationalDatabaseAvailabilityZones": []
        },
        {
            "continentCode": "NA",
            "description": "This region is recommended to serve users in the eastern United States",
            "displayName": "Ohio",
            "name": "us-east-2",
            "availabilityZones": [],
            "relationalDatabaseAvailabilityZones": []
        },
        {
            "continentCode": "NA",
            "description": "This region is recommended to serve users in the northwestern United States, Alaska, and western Canada",
            "displayName": "Oregon",
            "name": "us-west-2",
            "availabilityZones": [],
            "relationalDatabaseAvailabilityZones": []
        },
        ...
        }
    ]
}

Output

regions -> (list)

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

(structure)

Describes the AWS Region.

continentCode -> (string)

The continent code (e.g., NA , meaning North America).

description -> (string)

The description of the AWS Region (e.g., This region is recommended to serve users in the eastern United States and eastern Canada ).

displayName -> (string)

The display name (e.g., Ohio ).

name -> (string)

The region name (e.g., us-east-2 ).

availabilityZones -> (list)

The Availability Zones. Follows the format us-east-2a (case-sensitive).

(structure)

Describes an Availability Zone.

zoneName -> (string)

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

state -> (string)

The state of the Availability Zone.

relationalDatabaseAvailabilityZones -> (list)

The Availability Zones for databases. Follows the format us-east-2a (case-sensitive).

(structure)

Describes an Availability Zone.

zoneName -> (string)

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

state -> (string)

The state of the Availability Zone.