Lightsail / Client / get_regions

get_regions

Lightsail.Client.get_regions(**kwargs)

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

Request Syntax

response = client.get_regions(
    includeAvailabilityZones=True|False,
    includeRelationalDatabaseAvailabilityZones=True|False
)

Parameters:

• includeAvailabilityZones (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.

• includeRelationalDatabaseAvailabilityZones (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).

Return type:

dict

Returns:

Response Syntax

{
    'regions': [
        {
            'continentCode': 'string',
            'description': 'string',
            'displayName': 'string',
            'name': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'eu-north-1',
            'availabilityZones': [
                {
                    'zoneName': 'string',
                    'state': 'string'
                },
            ],
            'relationalDatabaseAvailabilityZones': [
                {
                    'zoneName': 'string',
                    'state': 'string'
                },
            ]
        },
    ]
}

Response Structure

• (dict) –

  • regions (list) –

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

    • (dict) –

      Describes the Amazon Web Services Region.

      • continentCode (string) –

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

      • description (string) –

        The description of the Amazon Web Services 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).

        • (dict) –

          Describes an Availability Zone. This is returned only as part of a GetRegions request.

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

        • (dict) –

          Describes an Availability Zone. This is returned only as part of a GetRegions request.

          • zoneName (string) –

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

          • state (string) –

            The state of the Availability Zone.

Exceptions

• Lightsail.Client.exceptions.ServiceException

• Lightsail.Client.exceptions.InvalidInputException

• Lightsail.Client.exceptions.NotFoundException

• Lightsail.Client.exceptions.OperationFailureException

• Lightsail.Client.exceptions.AccessDeniedException

• Lightsail.Client.exceptions.AccountSetupInProgressException

• Lightsail.Client.exceptions.UnauthenticatedException