GetWorkflowStepGroup
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
Get the step group of a migration workflow.
Request Syntax
GET /workflowstepgroup/id?workflowId=workflowId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- id
-
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,
"id": "string",
"lastModifiedTime": number,
"name": "string",
"next": [ "string" ],
"owner": "string",
"previous": [ "string" ],
"status": "string",
"tools": [
{
"name": "string",
"url": "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.
- creationTime
-
The time at which the step group was created.
Type: Timestamp
- description
-
The description of the step group.
Type: String
- endTime
-
The time at which the step group ended.
Type: Timestamp
- id
-
The ID of the step group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[a-zA-Z0-9-]+ - lastModifiedTime
-
The time at which the step group was last modified.
Type: Timestamp
- name
-
The name of the step group.
Type: String
- next
-
The next step group.
Type: Array of strings
Length Constraints: Minimum length of 0. Maximum length of 500.
- owner
-
The owner of the step group.
Type: String
Valid Values:
AWS_MANAGED | CUSTOM - previous
-
The previous step group.
Type: Array of strings
Length Constraints: Minimum length of 0. Maximum length of 500.
- status
-
The status of the step group.
Type: String
Valid Values:
AWAITING_DEPENDENCIES | READY | IN_PROGRESS | COMPLETED | FAILED | PAUSED | PAUSING | USER_ATTENTION_REQUIRED - tools
-
List of AWS services utilized in a migration workflow.
Type: Array of Tool objects
- 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
- ResourceNotFoundException
-
The resource is not available.
HTTP Status Code: 404
- 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:
