Lightsail / Paginator / GetRelationalDatabaseParameters

GetRelationalDatabaseParameters

class Lightsail.Paginator.GetRelationalDatabaseParameters

paginator = client.get_paginator('get_relational_database_parameters')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• relationalDatabaseName (string) –

  [REQUIRED]

  The name of your database for which to get 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

{
    'parameters': [
        {
            'allowedValues': 'string',
            'applyMethod': 'string',
            'applyType': 'string',
            'dataType': 'string',
            'description': 'string',
            'isModifiable': True|False,
            'parameterName': 'string',
            'parameterValue': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • parameters (list) –

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

    • (dict) –

      Describes the parameters of a database.

      • allowedValues (string) –

        Specifies the valid range of values for the parameter.

      • applyMethod (string) –

        Indicates when parameter updates are applied.

        Can be immediate or pending-reboot.

      • applyType (string) –

        Specifies the engine-specific parameter type.

      • dataType (string) –

        Specifies the valid data type for the parameter.

      • description (string) –

        Provides a description of the parameter.

      • isModifiable (boolean) –

        A Boolean value indicating whether the parameter can be modified.

      • parameterName (string) –

        Specifies the name of the parameter.

      • parameterValue (string) –

        Specifies the value of the parameter.

  • NextToken (string) –

    A token to resume pagination.