DescribeClusterVersions - Amazon Redshift
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

DescribeClusterVersions

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.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

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

Type: String

Length Constraints: Maximum length of 2147483647.

Required: No

ClusterVersion

The specific cluster version to return.

Example: 1.0

Type: String

Length Constraints: Maximum length of 2147483647.

Required: No

Marker

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

Type: String

Length Constraints: Maximum length of 2147483647.

Required: No

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.

Type: Integer

Required: No

Response Elements

The following elements are returned by the service.

ClusterVersions.ClusterVersion.N

A list of Version elements.

Type: Array of ClusterVersion objects

Marker

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.

Type: String

Length Constraints: Maximum length of 2147483647.

Errors

For information about the errors that are common to all actions, see Common Errors.

Examples

Example

This example illustrates one usage of DescribeClusterVersions.

Sample Request

https://redshift.us-east-2.amazonaws.com/ ?Action=DescribeClusterVersions &SignatureMethod=HmacSHA256&SignatureVersion=4 &Version=2012-12-01 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIAIOSFODNN7EXAMPLE/20190817/us-east-2/redshift/aws4_request &X-Amz-Date=20190825T160000Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=0aa1234bb5cc678ddddd901ee2ff3aa45678b90c12d345e6ff789012345a6b7b

Sample Response

<DescribeClusterVersionsResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/"> <DescribeClusterVersionsResult> <ClusterVersions> <ClusterVersion> <ClusterParameterGroupFamily>redshift-1.0</ClusterParameterGroupFamily> <Description>release db engine 1.0.54</Description> <ClusterVersion>1.0</ClusterVersion> </ClusterVersion> </ClusterVersions> </DescribeClusterVersionsResult> <ResponseMetadata> <RequestId>be41d43b-283e-11ea-8cc9-43f1872b4b75</RequestId> </ResponseMetadata> </DescribeClusterVersionsResponse>

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: