Neptune / Paginator / DescribeDBParameters


class Neptune.Paginator.DescribeDBParameters#
paginator = client.get_paginator('describe_db_parameters')

Creates an iterator that will paginate through responses from Neptune.Client.describe_db_parameters().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
            'Name': 'string',
            'Values': [
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • DBParameterGroupName (string) –


    The name of a specific DB parameter group to return details for.


    • If supplied, must match the name of an existing DBParameterGroup.

  • Source (string) –

    The parameter types to return.

    Default: All parameter types returned

    Valid Values: user | system | engine-default

  • Filters (list) –

    This parameter is not currently supported.

    • (dict) –

      This type is not currently supported.

      • Name (string) – [REQUIRED]

        This parameter is not currently supported.

      • Values (list) – [REQUIRED]

        This parameter is not currently supported.

        • (string) –

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

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

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

Return type:



Response Syntax

    'Parameters': [
            'ParameterName': 'string',
            'ParameterValue': 'string',
            'Description': 'string',
            'Source': 'string',
            'ApplyType': 'string',
            'DataType': 'string',
            'AllowedValues': 'string',
            'IsModifiable': True|False,
            'MinimumEngineVersion': 'string',
            'ApplyMethod': 'immediate'|'pending-reboot'
    'NextToken': 'string'

Response Structure

  • (dict) –

    • Parameters (list) –

      A list of Parameter values.

      • (dict) –

        Specifies a parameter.

        • ParameterName (string) –

          Specifies the name of the parameter.

        • ParameterValue (string) –

          Specifies the value of the parameter.

        • Description (string) –

          Provides a description of the parameter.

        • Source (string) –

          Indicates the source of the parameter value.

        • ApplyType (string) –

          Specifies the engine specific parameters type.

        • DataType (string) –

          Specifies the valid data type for the parameter.

        • AllowedValues (string) –

          Specifies the valid range of values for the parameter.

        • IsModifiable (boolean) –

          Indicates whether ( true) or not ( false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

        • MinimumEngineVersion (string) –

          The earliest engine version to which the parameter can apply.

        • ApplyMethod (string) –

          Indicates when to apply parameter updates.

    • NextToken (string) –

      A token to resume pagination.