Redshift / Paginator / DescribeClusterParameterGroups

DescribeClusterParameterGroups

class Redshift.Paginator.DescribeClusterParameterGroups

paginator = client.get_paginator('describe_cluster_parameter_groups')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Redshift.Client.describe_cluster_parameter_groups().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• ParameterGroupName (string) – The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.

• TagKeys (list) –

  A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.

  • (string) –

• TagValues (list) –

  A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.

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

dict

Returns:

Response Syntax

{
    'ParameterGroups': [
        {
            'ParameterGroupName': 'string',
            'ParameterGroupFamily': 'string',
            'Description': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Contains the output from the DescribeClusterParameterGroups action.

  • ParameterGroups (list) –

    A list of ClusterParameterGroup instances. Each instance describes one cluster parameter group.

    • (dict) –

      Describes a parameter group.

      • ParameterGroupName (string) –

        The name of the cluster parameter group.

      • ParameterGroupFamily (string) –

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

      • Description (string) –

        The description of the parameter group.

      • Tags (list) –

        The list of tags for the cluster parameter group.

        • (dict) –

          A tag consisting of a name/value pair for a resource.

          • Key (string) –

            The key, or name, for the resource tag.

          • Value (string) –

            The value for the resource tag.

  • NextToken (string) –

    A token to resume pagination.