---
title: "POST /2023-10-12/batch-get-job"
method: POST
path: "/2023-10-12/batch-get-job"
---

# POST /2023-10-12/batch-get-job

`POST /2023-10-12/batch-get-job`

Retrieves multiple jobs in a single request. This is a batch version of the `GetJob` API.

The result of getting each job is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

## Request body

- object
  - `identifiers` BatchGetJobIdentifier[], required — The list of job identifiers to retrieve. You can specify up to 100 identifiers per request.
    - `farmId` string, required — The farm ID of the job.
    - `queueId` string, required — The queue ID of the job.
    - `jobId` string, required — The job ID.

## Response `200`

Success

- BatchGetJobResponse
  - `jobs` BatchGetJobItem[], required — A list of jobs that were successfully retrieved.
    - `farmId` string, required — The farm ID of the job.
    - `queueId` string, required — The queue ID of the job.
    - `jobId` string, required — The job ID.
    - `name` string, required — The name of the job.
    - `lifecycleStatus` 'CREATE_IN_PROGRESS' | 'CREATE_FAILED' | 'CREATE_COMPLETE' | 'UPLOAD_IN_PROGRESS' | 'UPLOAD_FAILED' | 'UPDATE_IN_PROGRESS' | 'UPDATE_FAILED' | 'UPDATE_SUCCEEDED' | 'ARCHIVED', required — The life cycle status of the job.
    - `lifecycleStatusMessage` string, required — A message that communicates the status of the life cycle.
    - `priority` integer, required — The job priority.
    - `createdAt` string, date-time, required — The date and time the resource was created.
    - `createdBy` string, required — The user or system that created this resource.
    - `updatedAt` string, date-time — The date and time the resource was updated.
    - `updatedBy` string — The user or system that updated this resource.
    - `startedAt` string, date-time — The date and time the resource started running.
    - `endedAt` string, date-time — The date and time the resource ended running.
    - `taskRunStatus` 'PENDING' | 'READY' | 'ASSIGNED' | 'STARTING' | 'SCHEDULED' | 'INTERRUPTING' | 'RUNNING' | 'SUSPENDED' | 'CANCELED' | 'FAILED' | 'SUCCEEDED' | 'NOT_COMPATIBLE' — The task run status for the job.
    - `targetTaskRunStatus` 'READY' | 'FAILED' | 'SUCCEEDED' | 'CANCELED' | 'SUSPENDED' | 'PENDING' — The task status to start with on the job.
    - `taskRunStatusCounts` object — The number of tasks for each run status for the job.
    - `taskFailureRetryCount` integer — The number of times that tasks failed and were retried.
    - `storageProfileId` string — The storage profile ID associated with the job.
    - `maxFailedTasksCount` integer — The number of task failures before the job stops running and is marked as <code>FAILED</code>.
    - `maxRetriesPerTask` integer — The maximum number of retries per failed tasks.
    - `parameters` object — The parameters for the job.
    - `attachments` object — The attachments for the job.
      - `manifests` ManifestProperties[], required — The manifest properties for the attachments.
        - `fileSystemLocationName` string — The file system location name.
        - `rootPath` string, required — The file's root path.
        - `rootPathFormat` 'windows' | 'posix', required — The format of the root path.
        - `outputRelativeDirectories` OutputRelativeDirectoriesListMemberString[] — The file path relative to the directory.
        - `inputManifestPath` string — The file path.
        - `inputManifestHash` string — The hash value of the file.
      - `fileSystem` 'COPIED' | 'VIRTUAL' — The file system location for the attachments.
    - `description` string, password — The description of the job.
    - `maxWorkerCount` integer — The maximum number of worker hosts that can concurrently process a job.
    - `sourceJobId` string — The job ID for the source job.
  - `errors` BatchGetJobError[], required — A list of errors for jobs that could not be retrieved.
    - `farmId` string, required — The farm ID of the job that could not be retrieved.
    - `queueId` string, required — The queue ID of the job that could not be retrieved.
    - `jobId` string, required — The job ID of the job that could not be retrieved.
    - `code` 'InternalServerErrorException' | 'ResourceNotFoundException' | 'ValidationException' | 'AccessDeniedException' | 'ThrottlingException', required — The error code.
    - `message` string, required — The error message.

## Other responses

- `480` — AccessDeniedException
- `481` — InternalServerErrorException
- `482` — ThrottlingException
- `483` — ValidationException

---

[API](https://skmtc.net/aws/apis/deadline.md) · [All operations](https://skmtc.net/aws/apis/deadline/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/deadline/versions/259a7ebfefa8/schema)