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

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

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

Retrieves multiple steps in a single request. This is a batch version of the `GetStep` API.

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

## Response `200`

Success

- BatchGetStepResponse
  - `steps` BatchGetStepItem[], required — A list of steps that were successfully retrieved.
    - `farmId` string, required — The farm ID of the step.
    - `queueId` string, required — The queue ID of the step.
    - `jobId` string, required — The job ID of the step.
    - `stepId` string, required — The step ID.
    - `name` string, required — The name of the step.
    - `lifecycleStatus` 'CREATE_COMPLETE' | 'UPDATE_IN_PROGRESS' | 'UPDATE_FAILED' | 'UPDATE_SUCCEEDED', required — The life cycle status of the step.
    - `lifecycleStatusMessage` string — A message that communicates the status of the life cycle.
    - `taskRunStatus` 'PENDING' | 'READY' | 'ASSIGNED' | 'STARTING' | 'SCHEDULED' | 'INTERRUPTING' | 'RUNNING' | 'SUSPENDED' | 'CANCELED' | 'FAILED' | 'SUCCEEDED' | 'NOT_COMPATIBLE', required — The task run status for the step.
    - `taskRunStatusCounts` object, required — The number of tasks for each run status for the step.
    - `taskFailureRetryCount` integer — The number of times that tasks failed and were retried.
    - `targetTaskRunStatus` 'READY' | 'FAILED' | 'SUCCEEDED' | 'CANCELED' | 'SUSPENDED' | 'PENDING' — The task status to start with on the step.
    - `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.
    - `dependencyCounts` object — The number of dependencies for the step.
      - `dependenciesResolved` integer, required — The number of resolved dependencies.
      - `dependenciesUnresolved` integer, required — The number of unresolved dependencies.
      - `consumersResolved` integer, required — The number of consumers resolved.
      - `consumersUnresolved` integer, required — The number of unresolved consumers.
    - `requiredCapabilities` object — The required capabilities for the step.
      - `attributes` StepAttributeCapability[], required — The capability attributes that the step requires.
        - `name` string, required — The name of the step attribute.
        - `anyOf` AttributeCapabilityValue[] — Requires any of the step attributes in a given list.
        - `allOf` AttributeCapabilityValue[] — Requires all of the step attribute values.
      - `amounts` StepAmountCapability[], required — The capability amounts that the step requires.
        - `name` string, required — The name of the step.
        - `min` number, double — The minimum amount.
        - `max` number, double — The maximum amount.
        - `value` number, double — The amount value.
    - `parameterSpace` object — The parameter space for the step.
      - `parameters` StepParameter[], required — The parameters to search for.
        - `name` string, required — The name of the parameter.
        - `type` 'INT' | 'FLOAT' | 'STRING' | 'PATH' | 'CHUNK_INT', required — The data type of the parameter.
        - `chunks` object — The configuration for task chunking.
          - `defaultTaskCount` integer, required — The number of tasks to combine into a single chunk by default.
          - `targetRuntimeSeconds` integer — The number of seconds to aim for when forming chunks.
          - `rangeConstraint` 'CONTIGUOUS' | 'NONCONTIGUOUS', required — Specifies whether the chunked ranges must be contiguous or can have gaps between them.
      - `combination` string — The combination expression to use in the search.
    - `description` string, password — The description of the step.
  - `errors` BatchGetStepError[], required — A list of errors for steps that could not be retrieved.
    - `farmId` string, required — The farm ID of the step that could not be retrieved.
    - `queueId` string, required — The queue ID of the step that could not be retrieved.
    - `jobId` string, required — The job ID of the step that could not be retrieved.
    - `stepId` string, required — The step ID of the step 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)