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.
Parameters:
-
cluster_version
(Optional[String], default:
None
)
–
The specific cluster version to return.
Example: 1.0
-
cluster_parameter_group_family
(Optional[String], default:
None
)
–
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
-
max_records
(Optional[IntegerOptional], default:
None
)
–
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
(Optional[String], default:
None
)
–
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.
Raises:
Source code in docs_src/capo_redshift/_services/async_redshift.py
| async def describe_cluster_versions(
self,
*,
config_overrides: Optional[AsyncRedshiftClientConfig] = None,
cluster_version: Optional["capo_redshift.types.string.String"] = None,
cluster_parameter_group_family: Optional[
"capo_redshift.types.string.String"
] = None,
max_records: Optional[
"capo_redshift.types.integer_optional.IntegerOptional"
] = None,
marker: Optional["capo_redshift.types.string.String"] = None,
) -> "capo_redshift.types.cluster_versions_message.ClusterVersionsMessage":
"""<p>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 <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
Args:
cluster_version: <p>The specific cluster version to return.</p> <p>Example: <code>1.0</code> </p>
cluster_parameter_group_family: <p>The name of a specific cluster parameter group family to return details for.</p> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 255 alphanumeric characters</p> </li> <li> <p>First character must be a letter</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens</p> </li> </ul>
max_records: <p>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. </p> <p>Default: <code>100</code> </p> <p>Constraints: minimum 20, maximum 100.</p>
marker: <p>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeClusterVersions</a> request exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. </p>
Raises:
capo_redshift.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_redshift.types.describe_cluster_versions_message.DescribeClusterVersionsMessage]",
) -> AsyncOperationResponse[
"capo_redshift.types.cluster_versions_message.ClusterVersionsMessage"
]:
import capo_redshift._operations.redshift_service_version20121201.describe_cluster_versions
(
output,
http_response,
) = await capo_redshift._operations.redshift_service_version20121201.describe_cluster_versions.async_describe_cluster_versions(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeClusterVersions")
)
input_: capo_redshift.types.describe_cluster_versions_message.DescribeClusterVersionsMessage = {}
if cluster_version is not None:
input_["cluster_version"] = cluster_version
if cluster_parameter_group_family is not None:
input_["cluster_parameter_group_family"] = cluster_parameter_group_family
if max_records is not None:
input_["max_records"] = max_records
if marker is not None:
input_["marker"] = marker
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|