---
title: "GET /workflowstep/{id}#workflowId&stepGroupId"
method: GET
path: "/workflowstep/{id}#workflowId&stepGroupId"
---

# GET /workflowstep/{id}#workflowId&stepGroupId

`GET /workflowstep/{id}#workflowId&stepGroupId`

Get a step in the migration workflow.

## Path parameters

- `id` string, required

## Query parameters

- `workflowId` string, required
- `stepGroupId` string, required

## Response `200`

Success

- GetWorkflowStepResponse
  - `name` string — The name of the step.
  - `stepGroupId` string — The ID of the step group.
  - `workflowId` string — The ID of the migration workflow.
  - `stepId` string — The ID of the step.
  - `description` string — The description of the step.
  - `stepActionType` 'MANUAL' | 'AUTOMATED' — The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step.
  - `owner` 'AWS_MANAGED' | 'CUSTOM' — The owner of the step.
  - `workflowStepAutomationConfiguration` object — The custom script to run tests on source or target environments.
    - `scriptLocationS3Bucket` string — The Amazon S3 bucket where the script is located.
    - `scriptLocationS3Key` object — The Amazon S3 key for the script location.
      - `linux` string — The script location for Linux.
      - `windows` string — The script location for Windows.
    - `command` object — The command required to run the script.
      - `linux` string — Command for Linux.
      - `windows` string — Command for Windows.
    - `runEnvironment` 'AWS' | 'ONPREMISE' — The source or target environment.
    - `targetType` 'SINGLE' | 'ALL' | 'NONE' — The servers on which to run the script.
  - `stepTarget` StringListMember[] — The servers on which a step will be run.
  - `outputs` WorkflowStepOutput[] — The outputs of the step.
    - `name` string — The name of the step.
    - `dataType` 'STRING' | 'INTEGER' | 'STRINGLIST' | 'STRINGMAP' — The data type of the output.
    - `required` boolean — Determine if an output is required from a step.
    - `value` object — The value of the output.
      - `integerValue` integer — The integer value.
      - `stringValue` string — The string value.
      - `listOfStringValue` MaxStringValue[] — The list of string value.
  - `previous` StringListMember[] — The previous step.
  - `next` StringListMember[] — The next step.
  - `status` 'AWAITING_DEPENDENCIES' | 'SKIPPED' | 'READY' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'PAUSED' | 'USER_ATTENTION_REQUIRED' — The status of the step.
  - `statusMessage` string — The status message of the migration workflow.
  - `scriptOutputLocation` string — The output location of the script.
  - `creationTime` string, date-time — The time at which the step was created.
  - `lastStartTime` string, date-time — The time at which the workflow was last started.
  - `endTime` string, date-time — The time at which the step ended.
  - `noOfSrvCompleted` integer — The number of servers that have been migrated.
  - `noOfSrvFailed` integer — The number of servers that have failed to migrate.
  - `totalNoOfSrv` integer — The total number of servers that have been migrated.

## Other responses

- `480` — ThrottlingException
- `481` — AccessDeniedException
- `482` — InternalServerException
- `483` — ResourceNotFoundException

---

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