ListWorkflowSteps - Migration Hub Orchestrator

ListWorkflowSteps

List the steps in a workflow.

Request Syntax

GET /workflow/workflowId/workflowstepgroups/stepGroupId/workflowsteps?maxResults=maxResults&nextToken=nextToken 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.*

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 { "nextToken": "string", "workflowStepsSummary": [ { "description": "string", "name": "string", "next": [ "string" ], "noOfSrvCompleted": number, "noOfSrvFailed": number, "owner": "string", "previous": [ "string" ], "scriptLocation": "string", "status": "string", "statusMessage": "string", "stepActionType": "string", "stepId": "string", "totalNoOfSrv": number } ] }

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.*

workflowStepsSummary

The summary of steps in a migration workflow.

Type: Array of WorkflowStepSummary 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

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: