JobApi

All URIs are relative to https://your-apigw-id.execute-api.region.amazonaws.com/Prod

Method	HTTP request	Description
GetJob	GET /v1/jobs/{job_id}	Returns the details of a job
GetJobEvents	GET /v1/jobs/{job_id}/events	Lists all events for a job
ListJobs	GET /v1/jobs	Lists all jobs

GetJob

Returns the details of a job

Parameters

Name	Type	Description	Notes
JobId	String	Job ID path parameter	[default to null]

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetJobEvents

Lists all events for a job

Parameters

Name	Type	Description	Notes
JobId	String	Job ID path parameter	[default to null]
StartAt	String	Start at watermark query string parameter	[optional] [default to 0]
PageSize	Integer	Page size query string parameter. Min: 1. Max: 1000	[optional] [default to null]
Filter	oneOf<string,array>	Filters to apply in the format [key][operator][value]. If multiple filters are supplied, they will applied on an AND basis. Supported keys: EventName. Supported Operators: =	[optional] [default to null]

Return type

ListOfJobEvents

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

ListJobs

Lists all jobs

Parameters

Name	Type	Description	Notes
StartAt	String	Start at watermark query string parameter	[optional] [default to 0]
PageSize	Integer	Page size query string parameter. Min: 1. Max: 1000	[optional] [default to null]

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json