delete_schedule¶
- SchedulesApi.delete_schedule(role_id, id, datalab_id=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶
Delete a schedule
Deletes a job/event/external-trigger schedule (owner access), stopping active runs first. With DatalabId, deletes a notebook datalab schedule. External-trigger schedules also unsubscribe from SNS.
- Parameters:
role_id (str) – Amorphic role ID used for authorization. (required)
id (str) – Schedule ID to delete. (required)
datalab_id (str) – When set, deletes a notebook datalab schedule for this datalab.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Return type:
- Returns:
Returns the result object.
Request and Response Examples¶
HTTP: DELETE /schedules/{id}
Parameter examples¶
Name |
In |
Example |
|---|---|---|
|
header |
|
|
path |
|
|
query |
|
Success (HTTP 200)¶
Schedule deleted.
jobDeleted
{
"Message": "Schedule deleted"
}
Errors¶
HTTP 400
Validation or authorization failure.
HTTP 500
Unexpected server error while deleting the schedule.