Lightsail / Client / get_relational_database_blueprints

get_relational_database_blueprints#

Lightsail.Client.get_relational_database_blueprints(**kwargs)#

Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database.

You can use a blueprint ID to create a new database that runs a specific database engine.

Request Syntax

response = client.get_relational_database_blueprints(
    pageToken='string'
)

Parameters:

pageToken (string) –

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

To get a page token, perform an initial GetRelationalDatabaseBlueprints 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.

Return type:

dict

Returns:

Response Syntax

{
    'blueprints': [
        {
            'blueprintId': 'string',
            'engine': 'mysql',
            'engineVersion': 'string',
            'engineDescription': 'string',
            'engineVersionDescription': 'string',
            'isEngineDefault': True|False
        },
    ],
    'nextPageToken': 'string'
}

Response Structure

(dict) –
- blueprints (list) –
  
  An object describing the result of your get relational database blueprints request.
  - (dict) –
    
    Describes a database image, or blueprint. A blueprint describes the major engine version of a database.
    - blueprintId (string) –
      
      The ID for the database blueprint.
    - engine (string) –
      
      The database software of the database blueprint (for example, MySQL).
    - engineVersion (string) –
      
      The database engine version for the database blueprint (for example, 5.7.23).
    - engineDescription (string) –
      
      The description of the database engine for the database blueprint.
    - engineVersionDescription (string) –
      
      The description of the database engine version for the database blueprint.
    - isEngineDefault (boolean) –
      
      A Boolean value indicating whether the engine version is the default for the database blueprint.
- 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 GetRelationalDatabaseBlueprints request and specify the next page token using the pageToken parameter.

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