Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateWorkflowStep

Note

AWS Migration Hub will no longer be open to new customers starting November 7, 2025. To continue using the service, sign up prior to November 7, 2025. For capabilities similar to AWS Migration Hub, explore AWS Migration Hub.

Create a step in the migration workflow.

Request Syntax


POST /workflowstep HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "name": "string",
   "next": [ "string" ],
   "outputs": [ 
      { 
         "dataType": "string",
         "name": "string",
         "required": boolean,
         "value": { ... }
      }
   ],
   "previous": [ "string" ],
   "stepActionType": "string",
   "stepGroupId": "string",
   "stepTarget": [ "string" ],
   "workflowId": "string",
   "workflowStepAutomationConfiguration": { 
      "command": { 
         "linux": "string",
         "windows": "string"
      },
      "runEnvironment": "string",
      "scriptLocationS3Bucket": "string",
      "scriptLocationS3Key": { 
         "linux": "string",
         "windows": "string"
      },
      "targetType": "string"
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

description

The description of the step.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Pattern: [-a-zA-Z0-9_.+, ]*

Required: No

name

The name of the step.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*

Required: Yes

next

The next step.

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 500.

Required: No

outputs

The key value pairs added for the expected output.

Type: Array of WorkflowStepOutput objects

Required: No

previous

The previous step.

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 500.

Required: No

stepActionType

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.

Type: String

Valid Values: MANUAL | AUTOMATED

Required: Yes

stepGroupId

The ID of the step group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [a-zA-Z0-9-]+

Required: Yes

stepTarget

The servers on which a step will be run.

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 500.

Required: No

workflowId

The ID of the migration workflow.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [a-zA-Z0-9-]+

Required: Yes

workflowStepAutomationConfiguration

The custom script to run tests on source or target environments.

Type: WorkflowStepAutomationConfiguration object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "id": "string",
   "name": "string",
   "stepGroupId": "string",
   "workflowId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

id

The ID of the step.

Type: String

name

The name of the step.

Type: String

stepGroupId

The ID of the step group.

Type: String

workflowId

The ID of the migration workflow.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An internal error has occurred.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400