describeClusterVersions method

Future<ClusterVersionsMessage> describeClusterVersions({ String? clusterParameterGroupFamily, String? clusterVersion, String? marker, int? maxRecords, })

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.

Parameter 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

Parameter clusterVersion : The specific cluster version to return.

Example: 1.0

Parameter 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, AWS 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.

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

Implementation

Future<ClusterVersionsMessage> describeClusterVersions({
  String? clusterParameterGroupFamily,
  String? clusterVersion,
  String? marker,
  int? maxRecords,
}) async {
  _s.validateStringLength(
    'clusterParameterGroupFamily',
    clusterParameterGroupFamily,
    0,
    2147483647,
  );
  _s.validateStringLength(
    'clusterVersion',
    clusterVersion,
    0,
    2147483647,
  );
  _s.validateStringLength(
    'marker',
    marker,
    0,
    2147483647,
  );
  final $request = <String, dynamic>{};
  clusterParameterGroupFamily
      ?.also((arg) => $request['ClusterParameterGroupFamily'] = arg);
  clusterVersion?.also((arg) => $request['ClusterVersion'] = arg);
  marker?.also((arg) => $request['Marker'] = arg);
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeClusterVersions',
    version: '2012-12-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeClusterVersionsMessage'],
    shapes: shapes,
    resultWrapper: 'DescribeClusterVersionsResult',
  );
  return ClusterVersionsMessage.fromXml($result);
}