Skip to content

Describe Cluster Versions

redshift_describe_cluster_versions R Documentation

Returns descriptions of the available Amazon Redshift cluster versions

Description

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.

Usage

redshift_describe_cluster_versions(ClusterVersion,
  ClusterParameterGroupFamily, MaxRecords, Marker)

Arguments

ClusterVersion

The specific cluster version to return.

Example: 1.0

ClusterParameterGroupFamily

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

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

An optional parameter that specifies the starting point to return a set of response records. When the results of a describe_cluster_versions 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.

Value

A list with the following syntax: 

list(
  Marker = "string",
  ClusterVersions = list(
    list(
      ClusterVersion = "string",
      ClusterParameterGroupFamily = "string",
      Description = "string"
    )
  )
)

Request syntax

svc$describe_cluster_versions(
  ClusterVersion = "string",
  ClusterParameterGroupFamily = "string",
  MaxRecords = 123,
  Marker = "string"
)