Lightsail / Paginator / GetRelationalDatabaseBlueprints

GetRelationalDatabaseBlueprints

class Lightsail.Paginator.GetRelationalDatabaseBlueprints

paginator = client.get_paginator('get_relational_database_blueprints')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Lightsail.Client.get_relational_database_blueprints().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

• MaxItems (integer) –

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• StartingToken (string) –

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'blueprints': [
        {
            'blueprintId': 'string',
            'engine': 'mysql',
            'engineVersion': 'string',
            'engineDescription': 'string',
            'engineVersionDescription': 'string',
            'isEngineDefault': True|False
        },
    ],
    'NextToken': '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.

  • NextToken (string) –

    A token to resume pagination.