Redshift / Client / describe_cluster_versions

describe_cluster_versions

Redshift.Client.describe_cluster_versions(**kwargs)

Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

See also: AWS API Documentation

Request Syntax

response = client.describe_cluster_versions(
    ClusterVersion='string',
    ClusterParameterGroupFamily='string',
    MaxRecords=123,
    Marker='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

• MaxRecords (integer) –

  The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

  Default: 100

  Constraints: minimum 20, maximum 100.

• Marker (string) – An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterVersions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  Contains the output from the DescribeClusterVersions action.

  • Marker (string) –

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

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