get_schedule_execution_logs

SchedulesApi.get_schedule_execution_logs(role_id, id, executionid, servicename, logtype=None, serviceloggroup=None, logs=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Download schedule execution logs

Returns a presigned URL (and optional log preview) for a schedule execution. Requires schedule read access. Use servicename=glue with logtype for Glue/ETL-style logs; other services need serviceloggroup.

Parameters:

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

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

  • executionid (str) – Execution ID whose logs to fetch. (required)

  • servicename (str) – Log source service. Common value: glue. For logs=all, allowed values include glue and data-pipelines. (required)

  • logtype (str) – Required for servicename=glue (and for logs=all). Typical values: output, error.

  • serviceloggroup (str) – CloudWatch log group (or service log group key) required when servicename is not glue.

  • logs (str) – Defaults to latest stream download. Set to all to generate or return a packaged log zip (async trigger or PresignedURL when already available).

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

ScheduleExecutionLogsResponse

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /schedules/{id}/executions/{executionid}/logs

Parameter examples

Name

In

Example

role_id

header

"role-admin"

id

path

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

executionid

path

"jr_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

servicename

query

"glue"

logtype

query

"output"

logs

query

"latest"

Success (HTTP 200)

Presigned download URL. Default path returns `url` (and optional `logPreview`/`logTruncated`). `logs=all` may return `PresignedURL` or a generation `Message`.

latestLogs

{
  "url": "https://s3.amazonaws.com/example/presigned",
  "logPreview": "",
  "logTruncated": false
}

allLogsReady

{
  "Message": "Presigned url returned",
  "PresignedURL": "https://s3.amazonaws.com/example/logs.zip"
}

Errors

HTTP 400

Validation or authorization failure.

HTTP 500

Unexpected server error while retrieving logs.