MemoryDB / Paginator / DescribeParameters

DescribeParameters

class MemoryDB.Paginator.DescribeParameters

paginator = client.get_paginator('describe_parameters')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MemoryDB.Client.describe_parameters().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• ParameterGroupName (string) –

  [REQUIRED]

  he name of a specific parameter group to return details for.

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

dict

Returns:

Response Syntax

{
    'Parameters': [
        {
            'Name': 'string',
            'Value': 'string',
            'Description': 'string',
            'DataType': 'string',
            'AllowedValues': 'string',
            'MinimumEngineVersion': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • Parameters (list) –

    A list of parameters specific to a particular parameter group. Each element in the list contains detailed information about one parameter.

    • (dict) –

      Describes an individual setting that controls some aspect of MemoryDB behavior.

      • Name (string) –

        The name of the parameter

      • Value (string) –

        The value of the parameter

      • Description (string) –

        A description of the parameter

      • DataType (string) –

        The parameter’s data type

      • AllowedValues (string) –

        The valid range of values for the parameter.

      • MinimumEngineVersion (string) –

        The earliest engine version to which the parameter can apply.