Skip to content

describe_cluster_tracks

describe_cluster_tracks(
    *,
    config_overrides: Optional[RedshiftClientConfig] = None,
    maintenance_track_name: Optional[String] = None,
    max_records: Optional[IntegerOptional] = None,
    marker: Optional[String] = None,
) -> TrackListMessage

Returns a list of all the available maintenance tracks.

Parameters:

  • maintenance_track_name (Optional[String], default: None ) –

    The name of the maintenance track.

  • max_records (Optional[IntegerOptional], default: None ) –

    An integer value for the maximum number of maintenance tracks to return.

  • 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 DescribeClusterTracks request exceed the value specified in MaxRecords, Amazon Redshift 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/redshift.py
def describe_cluster_tracks(
    self,
    *,
    config_overrides: Optional[RedshiftClientConfig] = None,
    maintenance_track_name: 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.track_list_message.TrackListMessage":
    """<p>Returns a list of all the available maintenance tracks.</p>

    Args:
        maintenance_track_name: <p>The name of the maintenance track. </p>
        max_records: <p>An integer value for the maximum number of maintenance tracks to return.</p>
        marker: <p>An optional parameter that specifies the starting point to return a set of response records. When the results of a <code>DescribeClusterTracks</code> request exceed the value specified in <code>MaxRecords</code>, Amazon Redshift 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.invalid_cluster_track_fault.InvalidClusterTrackFault: <p>The provided cluster track name is not valid.</p>
        capo_redshift.errors.unauthorized_operation.UnauthorizedOperation: <p>Your account is not authorized to perform the requested operation.</p>
        capo_redshift.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_redshift.types.describe_cluster_tracks_message.DescribeClusterTracksMessage]",
    ) -> OperationResponse[
        "capo_redshift.types.track_list_message.TrackListMessage"
    ]:
        import capo_redshift._operations.redshift_service_version20121201.describe_cluster_tracks

        output, http_response = (
            capo_redshift._operations.redshift_service_version20121201.describe_cluster_tracks.describe_cluster_tracks(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeClusterTracks")
    )
    input_: capo_redshift.types.describe_cluster_tracks_message.DescribeClusterTracksMessage = {}
    if maintenance_track_name is not None:
        input_["maintenance_track_name"] = maintenance_track_name
    if max_records is not None:
        input_["max_records"] = max_records
    if marker is not None:
        input_["marker"] = marker

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output