DocDB / Paginator / DescribeDBClusterParameterGroups


class DocDB.Paginator.DescribeDBClusterParameterGroups#
paginator = client.get_paginator('describe_db_cluster_parameter_groups')

Creates an iterator that will paginate through responses from DocDB.Client.describe_db_cluster_parameter_groups().

See also: AWS API Documentation

Request Syntax

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

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


    • If provided, must match the name of an existing DBClusterParameterGroup.

  • Filters (list) –

    This parameter is not currently supported.

    • (dict) –

      A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.

      Wildcards are not supported in filters.

      • Name (string) – [REQUIRED]

        The name of the filter. Filter names are case sensitive.

      • Values (list) – [REQUIRED]

        One or more filter values. Filter values are case sensitive.

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

    'DBClusterParameterGroups': [
            'DBClusterParameterGroupName': 'string',
            'DBParameterGroupFamily': 'string',
            'Description': 'string',
            'DBClusterParameterGroupArn': 'string'
    'NextToken': 'string'

Response Structure

  • (dict) –

    Represents the output of DBClusterParameterGroups.

    • DBClusterParameterGroups (list) –

      A list of cluster parameter groups.

      • (dict) –

        Detailed information about a cluster parameter group.

        • DBClusterParameterGroupName (string) –

          Provides the name of the cluster parameter group.

        • DBParameterGroupFamily (string) –

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

        • Description (string) –

          Provides the customer-specified description for this cluster parameter group.

        • DBClusterParameterGroupArn (string) –

          The Amazon Resource Name (ARN) for the cluster parameter group.

    • NextToken (string) –

      A token to resume pagination.