CreateWorkflow
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 workflow to orchestrate your migrations.
Request Syntax
POST /migrationworkflow/ HTTP/1.1
Content-type: application/json
{
"applicationConfigurationId": "string",
"description": "string",
"inputParameters": {
"string" : { ... }
},
"name": "string",
"stepTargets": [ "string" ],
"tags": {
"string" : "string"
},
"templateId": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- applicationConfigurationId
-
The configuration ID of the application configured in Application Discovery Service.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 100.
Pattern:
[-a-zA-Z0-9_.+]*Required: No
- description
-
The description of the migration workflow.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
Pattern:
[-a-zA-Z0-9_.+, ]*Required: No
- inputParameters
-
The input parameters required to create a migration workflow.
Type: String to StepInput object map
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Key Pattern:
[a-zA-Z0-9-_ ()]+Required: Yes
- name
-
The name of the migration workflow.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*Required: Yes
- stepTargets
-
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
-
The tags to add on a migration workflow.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Key Pattern:
[a-zA-Z0-9-_ ()]+Value Length Constraints: Minimum length of 0. Maximum length of 100.
Required: No
- templateId
-
The ID of the template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[-a-zA-Z0-9_.+]+[-a-zA-Z0-9_.+ ]*Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"adsApplicationConfigurationId": "string",
"arn": "string",
"creationTime": number,
"description": "string",
"id": "string",
"name": "string",
"status": "string",
"stepTargets": [ "string" ],
"tags": {
"string" : "string"
},
"templateId": "string",
"workflowInputs": {
"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.
- adsApplicationConfigurationId
-
The configuration ID of the application configured in Application Discovery Service.
Type: String
- arn
-
The Amazon Resource Name (ARN) of the migration workflow.
Type: String
- creationTime
-
The time at which the migration workflow was created.
Type: Timestamp
- description
-
The description of the migration workflow.
Type: String
- id
-
The ID of the migration workflow.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[a-zA-Z0-9-]+ - name
-
The name of the migration workflow.
Type: String
- status
-
The status of the migration workflow.
Type: String
Valid Values:
CREATING | NOT_STARTED | CREATION_FAILED | STARTING | IN_PROGRESS | WORKFLOW_FAILED | PAUSED | PAUSING | PAUSING_FAILED | USER_ATTENTION_REQUIRED | DELETING | DELETION_FAILED | DELETED | COMPLETED - stepTargets
-
The servers on which a step will be run.
Type: Array of strings
Length Constraints: Minimum length of 0. Maximum length of 500.
-
The tags to add on a migration workflow.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Key Pattern:
[a-zA-Z0-9-_ ()]+Value Length Constraints: Minimum length of 0. Maximum length of 100.
- templateId
-
The ID of the template.
Type: String
- workflowInputs
-
The inputs for creating a migration workflow.
Type: String to StepInput object map
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Key Pattern:
[a-zA-Z0-9-_ ()]+
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
