Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously.
Parameters:
-
schedule_identifier
(Optional[String], default:
None
)
–
A unique alphanumeric identifier of the schedule to modify.
-
schedule_definitions
(Optional[ScheduleDefinitionList], default:
None
)
–
An updated list of schedule definitions. A schedule definition is made up of schedule expressions, for example, "cron(30 12 *)" or "rate(12 hours)".
Raises:
Source code in docs_src/capo_redshift/_services/redshift.py
| def modify_snapshot_schedule(
self,
*,
config_overrides: Optional[RedshiftClientConfig] = None,
schedule_identifier: Optional["capo_redshift.types.string.String"] = None,
schedule_definitions: Optional[
"capo_redshift.types.schedule_definition_list.ScheduleDefinitionList"
] = None,
) -> "capo_redshift.types.snapshot_schedule.SnapshotSchedule":
"""<p>Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously.</p>
Args:
schedule_identifier: <p>A unique alphanumeric identifier of the schedule to modify.</p>
schedule_definitions: <p>An updated list of schedule definitions. A schedule definition is made up of schedule expressions, for example, "cron(30 12 *)" or "rate(12 hours)".</p>
Raises:
capo_redshift.errors.invalid_schedule_fault.InvalidScheduleFault: <p>The schedule you submitted isn't valid.</p>
capo_redshift.errors.snapshot_schedule_not_found_fault.SnapshotScheduleNotFoundFault: <p>We could not find the specified snapshot schedule. </p>
capo_redshift.errors.snapshot_schedule_update_in_progress_fault.SnapshotScheduleUpdateInProgressFault: <p>The specified snapshot schedule is already being updated.</p>
capo_redshift.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_redshift.types.modify_snapshot_schedule_message.ModifySnapshotScheduleMessage]",
) -> OperationResponse[
"capo_redshift.types.snapshot_schedule.SnapshotSchedule"
]:
import capo_redshift._operations.redshift_service_version20121201.modify_snapshot_schedule
output, http_response = (
capo_redshift._operations.redshift_service_version20121201.modify_snapshot_schedule.modify_snapshot_schedule(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ModifySnapshotSchedule")
)
input_: capo_redshift.types.modify_snapshot_schedule_message.ModifySnapshotScheduleMessage = {}
if schedule_identifier is not None:
input_["schedule_identifier"] = schedule_identifier
if schedule_definitions is not None:
input_["schedule_definitions"] = schedule_definitions
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|