GetWorkflowStep
Get a step in the migration workflow.
Request Syntax
GET /workflowstep/id?stepGroupId=stepGroupId&workflowId=workflowId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- id
-
The ID of the step.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[a-zA-Z0-9-]+Required: Yes
- stepGroupId
-
The ID of the step group.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[a-zA-Z0-9-]+Required: Yes
- workflowId
-
The ID of the migration workflow.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[a-zA-Z0-9-]+Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"creationTime": number,
"description": "string",
"endTime": number,
"lastStartTime": number,
"name": "string",
"next": [ "string" ],
"noOfSrvCompleted": number,
"noOfSrvFailed": number,
"outputs": [
{
"dataType": "string",
"name": "string",
"required": boolean,
"value": { ... }
}
],
"owner": "string",
"previous": [ "string" ],
"scriptOutputLocation": "string",
"status": "string",
"statusMessage": "string",
"stepActionType": "string",
"stepGroupId": "string",
"stepId": "string",
"stepTarget": [ "string" ],
"totalNoOfSrv": number,
"workflowId": "string",
"workflowStepAutomationConfiguration": {
"command": {
"linux": "string",
"windows": "string"
},
"runEnvironment": "string",
"scriptLocationS3Bucket": "string",
"scriptLocationS3Key": {
"linux": "string",
"windows": "string"
},
"targetType": "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.
- creationTime
-
The time at which the step was created.
Type: Timestamp
- description
-
The description of the step.
Type: String
- endTime
-
The time at which the step ended.
Type: Timestamp
- lastStartTime
-
The time at which the workflow was last started.
Type: Timestamp
- name
-
The name of the step.
Type: String
- next
-
The next step.
Type: Array of strings
Length Constraints: Minimum length of 0. Maximum length of 500.
- noOfSrvCompleted
-
The number of servers that have been migrated.
Type: Integer
- noOfSrvFailed
-
The number of servers that have failed to migrate.
Type: Integer
- outputs
-
The outputs of the step.
Type: Array of WorkflowStepOutput objects
Array Members: Minimum number of 0 items. Maximum number of 5 items.
- owner
-
The owner of the step.
Type: String
Valid Values:
AWS_MANAGED | CUSTOM - previous
-
The previous step.
Type: Array of strings
Length Constraints: Minimum length of 0. Maximum length of 500.
- scriptOutputLocation
-
The output location of the script.
Type: String
- status
-
The status of the step.
Type: String
Valid Values:
AWAITING_DEPENDENCIES | SKIPPED | READY | IN_PROGRESS | COMPLETED | FAILED | PAUSED | USER_ATTENTION_REQUIRED - statusMessage
-
The status message of the migration workflow.
Type: String
- 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 - stepGroupId
-
The ID of the step group.
Type: String
- stepId
-
The ID of the step.
Type: String
- stepTarget
-
The servers on which a step will be run.
Type: Array of strings
Length Constraints: Minimum length of 0. Maximum length of 500.
- totalNoOfSrv
-
The total number of servers that have been migrated.
Type: Integer
- workflowId
-
The ID of the migration workflow.
Type: String
- workflowStepAutomationConfiguration
-
The custom script to run tests on source or target environments.
Type: WorkflowStepAutomationConfiguration object
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
- ResourceNotFoundException
-
The resource is not available.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
