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

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

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

Retrieves multiple sessions in a single request. This is a batch version of the `GetSession` API.

The result of getting each session 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` BatchGetSessionIdentifier[], required — The list of session identifiers to retrieve. You can specify up to 100 identifiers per request.
    - `farmId` string, required — The farm ID of the session.
    - `queueId` string, required — The queue ID of the session.
    - `jobId` string, required — The job ID of the session.
    - `sessionId` string, required — The session ID.

## Response `200`

Success

- BatchGetSessionResponse
  - `sessions` BatchGetSessionItem[], required — A list of sessions that were successfully retrieved.
    - `farmId` string, required — The farm ID of the session.
    - `queueId` string, required — The queue ID of the session.
    - `jobId` string, required — The job ID of the session.
    - `sessionId` string, required — The session ID.
    - `fleetId` string, required — The fleet ID of the session.
    - `workerId` string, required — The worker ID of the session.
    - `startedAt` string, date-time, required — The date and time the resource started running.
    - `lifecycleStatus` 'STARTED' | 'UPDATE_IN_PROGRESS' | 'UPDATE_SUCCEEDED' | 'UPDATE_FAILED' | 'ENDED', required — The life cycle status of the session.
    - `endedAt` string, date-time — The date and time the resource ended running.
    - `targetLifecycleStatus` 'ENDED' — The target life cycle status for the session.
    - `updatedAt` string, date-time — The date and time the resource was updated.
    - `updatedBy` string — The user or system that updated this resource.
    - `log` object, required — The session log.
      - `logDriver` string, required — The log drivers for worker related logs.
      - `options` object — The options for a log driver.
      - `parameters` object — The parameters for the log configuration.
      - `error` string — The log configuration error details.
    - `hostProperties` object — The host properties for the session.
      - `ipAddresses` object — The IP address of the host.
        - `ipV4Addresses` IpV4Address[] — The IpV4 address of the network.
        - `ipV6Addresses` IpV6Address[] — The IpV6 address for the network and node component.
      - `hostName` string — The host name.
      - `ec2InstanceArn` string — The ARN of the host EC2 instance.
      - `ec2InstanceType` string — The instance type of the host EC2 instance.
    - `workerLog` object — The worker log for the session.
      - `logDriver` string, required — The log drivers for worker related logs.
      - `options` object — The options for a log driver.
      - `parameters` object — The parameters for the log configuration.
      - `error` string — The log configuration error details.
  - `errors` BatchGetSessionError[], required — A list of errors for sessions that could not be retrieved.
    - `farmId` string, required — The farm ID of the session that could not be retrieved.
    - `queueId` string, required — The queue ID of the session that could not be retrieved.
    - `jobId` string, required — The job ID of the session that could not be retrieved.
    - `sessionId` string, required — The session ID of the session that could not be retrieved.
    - `code` 'InternalServerErrorException' | 'ResourceNotFoundException' | 'ValidationException', 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)