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

ListWorkflowStepGroups

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.

List the step groups in a migration workflow.

Request Syntax


GET /workflowstepgroups?maxResults=maxResults&nextToken=nextToken&workflowId=workflowId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of results that can be returned.

Valid Range: Minimum value of 0. Maximum value of 100.

nextToken

The pagination token.

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

Pattern: .*\S.*

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

{
   "nextToken": "string",
   "workflowStepGroupsSummary": [ 
      { 
         "id": "string",
         "name": "string",
         "next": [ "string" ],
         "owner": "string",
         "previous": [ "string" ],
         "status": "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.

nextToken

The pagination token.

Type: String

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

Pattern: .*\S.*

workflowStepGroupsSummary

The summary of step groups in a migration workflow.

Type: Array of WorkflowStepGroupSummary objects

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