Redshift / Paginator / DescribeClusterVersions

DescribeClusterVersions

class Redshift.Paginator.DescribeClusterVersions

paginator = client.get_paginator('describe_cluster_versions')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• ClusterVersion (string) –

  The specific cluster version to return.

  Example: 1.0

• ClusterParameterGroupFamily (string) –

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

  Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

• 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

{
    'ClusterVersions': [
        {
            'ClusterVersion': 'string',
            'ClusterParameterGroupFamily': 'string',
            'Description': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Contains the output from the DescribeClusterVersions action.

  • ClusterVersions (list) –

    A list of Version elements.

    • (dict) –

      Describes a cluster version, including the parameter group family and description of the version.

      • ClusterVersion (string) –

        The version number used by the cluster.

      • ClusterParameterGroupFamily (string) –

        The name of the cluster parameter group family for the cluster.

      • Description (string) –

        The description of the cluster version.

  • NextToken (string) –

    A token to resume pagination.