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

*******************************
get_relational_database_bundles
*******************************



.. py:method:: Lightsail.Client.get_relational_database_bundles(**kwargs)

  

  Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database.

   

  You can use a bundle ID to create a new database with explicit performance specifications.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/GetRelationalDatabaseBundles>`_  


  **Request Syntax**
  ::

    response = client.get_relational_database_bundles(
        pageToken='string',
        includeInactive=True|False
    )
    
  :type pageToken: string
  :param pageToken: 

    The token to advance to the next page of results from your request.

     

    To get a page token, perform an initial ``GetRelationalDatabaseBundles`` request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

    

  
  :type includeInactive: boolean
  :param includeInactive: 

    A Boolean value that indicates whether to include inactive (unavailable) bundles in the response of your request.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'bundles': [
              {
                  'bundleId': 'string',
                  'name': 'string',
                  'price': ...,
                  'ramSizeInGb': ...,
                  'diskSizeInGb': 123,
                  'transferPerMonthInGb': 123,
                  'cpuCount': 123,
                  'isEncrypted': True|False,
                  'isActive': True|False
              },
          ],
          'nextPageToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **bundles** *(list) --* 

        An object describing the result of your get relational database bundles request.

        
        

        - *(dict) --* 

          Describes a database bundle. A bundle describes the performance specifications of the database.

          
          

          - **bundleId** *(string) --* 

            The ID for the database bundle.

            
          

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

            The name for the database bundle.

            
          

          - **price** *(float) --* 

            The cost of the database bundle in US currency.

            
          

          - **ramSizeInGb** *(float) --* 

            The amount of RAM in GB (for example, ``2.0``) for the database bundle.

            
          

          - **diskSizeInGb** *(integer) --* 

            The size of the disk for the database bundle.

            
          

          - **transferPerMonthInGb** *(integer) --* 

            The data transfer rate per month in GB for the database bundle.

            
          

          - **cpuCount** *(integer) --* 

            The number of virtual CPUs (vCPUs) for the database bundle.

            
          

          - **isEncrypted** *(boolean) --* 

            A Boolean value indicating whether the database bundle is encrypted.

            
          

          - **isActive** *(boolean) --* 

            A Boolean value indicating whether the database bundle is active.

            
      
    
      

      - **nextPageToken** *(string) --* 

        The token to advance to the next page of results from your request.

         

        A next page token is not returned if there are no more results to display.

         

        To get the next page of results, perform another ``GetRelationalDatabaseBundles`` request and specify the next page token using the ``pageToken`` parameter.

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

  