MemoryDB / Paginator / DescribeParameterGroups

DescribeParameterGroups#

class MemoryDB.Paginator.DescribeParameterGroups#
paginator = client.get_paginator('describe_parameter_groups')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ParameterGroupName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • ParameterGroupName (string) – The 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

{
    'ParameterGroups': [
        {
            'Name': 'string',
            'Family': 'string',
            'Description': 'string',
            'ARN': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • ParameterGroups (list) –

      A list of parameter groups. Each element in the list contains detailed information about one parameter group.

      • (dict) –

        Represents the output of a CreateParameterGroup operation. A parameter group represents a combination of specific values for the parameters that are passed to the engine software during startup.

        • Name (string) –

          The name of the parameter group

        • Family (string) –

          The name of the parameter group family that this parameter group is compatible with.

        • Description (string) –

          A description of the parameter group

        • ARN (string) –

          The Amazon Resource Name (ARN) of the parameter group