:doc:`Lightsail <../../lightsail>` / Client / get_regions

***********
get_regions
***********



.. py:method:: 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 <https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRegions>`_  


  **Request Syntax**
  ::

    response = client.get_regions(
        includeAvailabilityZones=True|False,
        includeRelationalDatabaseAvailabilityZones=True|False
    )
    
  :type includeAvailabilityZones: boolean
  :param includeAvailabilityZones: 

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

    

  
  :type includeRelationalDatabaseAvailabilityZones: boolean
  :param includeRelationalDatabaseAvailabilityZones: 

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

    

  
  
  :rtype: 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'|'ap-southeast-3',
                  '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 ( ``NA``, meaning North America).

            
          

          - **description** *(string) --* 

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

            
          

          - **displayName** *(string) --* 

            The display name ( ``Ohio``).

            
          

          - **name** *(string) --* 

            The region name ( ``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**
  
  *   :py:class:`Lightsail.Client.exceptions.ServiceException`

  
  *   :py:class:`Lightsail.Client.exceptions.InvalidInputException`

  
  *   :py:class:`Lightsail.Client.exceptions.NotFoundException`

  
  *   :py:class:`Lightsail.Client.exceptions.OperationFailureException`

  
  *   :py:class:`Lightsail.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Lightsail.Client.exceptions.AccountSetupInProgressException`

  
  *   :py:class:`Lightsail.Client.exceptions.RegionSetupInProgressException`

  
  *   :py:class:`Lightsail.Client.exceptions.UnauthenticatedException`

  