describe_snapshot_schedules ¶

def describe_snapshot_schedules(
    self,
    *,
    config_overrides: Optional[RedshiftClientConfig] = None,
    cluster_identifier: Optional["capo_redshift.types.string.String"] = None,
    schedule_identifier: Optional["capo_redshift.types.string.String"] = None,
    tag_keys: Optional["capo_redshift.types.tag_key_list.TagKeyList"] = None,
    tag_values: Optional["capo_redshift.types.tag_value_list.TagValueList"] = None,
    marker: Optional["capo_redshift.types.string.String"] = None,
    max_records: Optional[
        "capo_redshift.types.integer_optional.IntegerOptional"
    ] = None,
) -> "capo_redshift.types.describe_snapshot_schedules_output_message.DescribeSnapshotSchedulesOutputMessage":
    """<p>Returns a list of snapshot schedules. </p>

    Args:
        cluster_identifier: <p>The unique identifier for the cluster whose snapshot schedules you want to view.</p>
        schedule_identifier: <p>A unique identifier for a snapshot schedule.</p>
        tag_keys: <p>The key value for a snapshot schedule tag.</p>
        tag_values: <p>The value corresponding to the key of the snapshot schedule tag.</p>
        marker: <p>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 <code>marker</code> parameter and retrying the command. If the <code>marker</code> field is empty, all response records have been retrieved for the request.</p>
        max_records: <p>The maximum number or 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 <code>marker</code> value.</p>

    Raises:
        capo_redshift.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_redshift.types.describe_snapshot_schedules_message.DescribeSnapshotSchedulesMessage]",
    ) -> OperationResponse[
        "capo_redshift.types.describe_snapshot_schedules_output_message.DescribeSnapshotSchedulesOutputMessage"
    ]:
        import capo_redshift._operations.redshift_service_version20121201.describe_snapshot_schedules

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeSnapshotSchedules")
    )
    input_: capo_redshift.types.describe_snapshot_schedules_message.DescribeSnapshotSchedulesMessage = {}
    if cluster_identifier is not None:
        input_["cluster_identifier"] = cluster_identifier
    if schedule_identifier is not None:
        input_["schedule_identifier"] = schedule_identifier
    if tag_keys is not None:
        input_["tag_keys"] = tag_keys
    if tag_values is not None:
        input_["tag_values"] = tag_values
    if marker is not None:
        input_["marker"] = marker
    if max_records is not None:
        input_["max_records"] = max_records

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