get_schedule_details¶

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

Get a schedule

Returns a job/event/external-trigger schedule by id (read access), or a notebook datalab schedule when DatalabId is provided.

Parameters:

role_id (str) – Amorphic role ID used for authorization. (required)
id (str) – Schedule ID to retrieve. (required)
datalab_id (str) – When set, returns a notebook datalab schedule for this datalab (sagemaker-notebook). Omit for job/event schedules.
projection_expression (str) – Comma-separated attribute names to include (job schedules only).
_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:

ScheduleGetResponse

Returns:

Returns the result object.

Request and Response Examples¶

HTTP: GET /schedules/{id}

Parameter examples¶

Name	In	Example
`role_id`	header	`"role-admin"`
`id`	path	`"sch-11111111-aaaa-bbbb-cccc-222222222222"`
`DatalabId`	query	`"dl-11111111-2222-3333-4444-555555555555"`
`projectionExpression`	query	`"ScheduleId,JobName,State,ScheduleType"`

Success (HTTP 200)¶

Job schedule status, or datalab notebook schedule details when `DatalabId` is set.

Job/time schedule

{
  "ScheduleId": "sch-11111111-aaaa-bbbb-cccc-222222222222",
  "JobName": "nightly-etl",
  "Description": "Nightly ETL",
  "ScheduleType": "time",
  "ScheduleParam": {
    "ScheduleExpression": "cron(0 2 * * ? *)"
  },
  "JobType": "etl",
  "Resource": "my-etl-job",
  "Arguments": [],
  "State": "ENABLED",
  "AccessType": "owner",
  "Keywords": [],
  "AcceptRuntimeArguments": true
}

Errors¶

Documented error codes: IPV-1002.

HTTP 400

Validation or authorization failure.

notFound

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

HTTP 500

Unexpected server error while fetching the schedule.