get_schedule_execution_details¶

SchedulesApi.get_schedule_execution_details(role_id, id, executionid, projection_expression=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Get a schedule execution

Returns one execution for the schedule.

Parameters:

role_id (str) – Amorphic role ID used for authorization. (required)
id (str) – Schedule ID. (required)
executionid (str) – Execution ID to retrieve. (required)
projection_expression (str) – Comma-separated attribute names to include on the execution object.
_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:

ScheduleExecutionDetail

Returns:

Returns the result object.

Request and Response Examples¶

HTTP: GET /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"`
`projectionExpression`	query	`"ExecutionId,State,StartTime,EndTime"`

Success (HTTP 200)¶

Execution details under `ScheduleExecution`.

executionDetail

{
  "ScheduleExecution": {
    "ScheduleId": "sch-11111111-aaaa-bbbb-cccc-222222222222",
    "ExecutionId": "exe-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "Resource": "my-etl-job",
    "JobType": "etl",
    "State": "SUCCEEDED",
    "Message": "",
    "StartTime": "2024-01-15T10:00:00Z",
    "EndTime": "2024-01-15T10:05:00Z"
  }
}

Errors¶

Documented error codes: IPV-1002.

HTTP 400

Validation or authorization failure.

missingExecution

{
  "Message": "IPV-1002 - Invalid value for parameter - ExecutionId"
}

HTTP 500

Unexpected server error while fetching the execution.