AWaws-samples
AWS Batch

List all AWS Batch jobs owned by the requesting user

Changed on

Lists AWS Batch jobs across all visible job queues (tagged with edh:visibility:<ClusterId> = true). Only jobs with matching soca_JobOwner and soca_ClusterId tags are returned. Optionally filter by a specific job queue or job status.

get/api/containers/batch/jobs

Request

  • The document declares no server URL.
  • Auth
    socaAuth (a scheme the document does not define) and socaToken (a scheme the document does not define)

Query parameters

job_queuestring

ARN or name of a specific job queue to list jobs from. If omitted, jobs from all visible queues are returned.

job_status'SUBMITTED' | 'PENDING' | 'RUNNABLE' | 'STARTING' | 'RUNNING' | 'SUCCEEDED' | 'FAILED'

Filter jobs by status. If omitted, all statuses are returned.

time_rangeinteger

Time range in hours to look back for jobs. Only jobs created within this window are returned. Defaults to 24 hours.

Headers

X-EDH-USERstring required

SOCA username for authentication

X-EDH-TOKENstring required

SOCA authentication token

Response

Jobs retrieved successfully

successboolean required

Example response

{
  "success": true
}

Changes

  • v1058396b8f0f1Revision changes
    • info

      the endpoint scheme security socaAuth AND socaToken was added to the API

    • info

      the endpoint scheme security edhAuth AND edhToken was removed from the API

    • info

      added the new optional query request parameter time_range

  • v16db97cead8dfRevision changes
    • info

      endpoint added