stop_schedule_execution

SchedulesApi.stop_schedule_execution(role_id, id, executionid, operation=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Stop or retrigger a schedule execution

Default behavior stops a running execution for supported job types (glue/etl/ingestion, data-pipelines, data-quality-checks) when the execution is in an active state. For event-trigger / external-trigger schedules, stop is not supported; pass operation=re-trigger to retrigger a failed (ERROR) execution when the schedule is ENABLED.

Parameters:

  • role_id (str) – Amorphic role ID used for authorization. (required)

  • id (str) – Schedule ID. (required)

  • executionid (str) – Execution ID to stop or retrigger. (required)

  • operation (str) – For event/external-trigger schedules only. Set to re-trigger to retrigger a failed execution. Omit for stop on job schedules.

  • _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:

ScheduleExecutionActionResponse

Returns:

Returns the result object.

Request and Response Examples

HTTP: PUT /schedules/{id}/executions/{executionid}

Parameter examples

Name

In

Example

role_id

header

"role-admin"

id

path

"sch-11111111-aaaa-bbbb-cccc-222222222222"

executionid

path

"exe-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"

operation

query

"re-trigger"

Success (HTTP 200)

Stop or retrigger accepted.

stopped

{
  "Message": "Successfully stopped the job run"
}

retriggered

{
  "Message": "Event execution retriggered successfully"
}

Errors

HTTP 400

Validation or authorization failure.

badState

{
  "Message": "Schedule execution cannot be stopped in SUCCEEDED state"
}

unsupportedStop

{
  "Message": "This schedule type is not supported for stop operation"
}

HTTP 500

Unexpected server error while stopping or retriggering.