MigrationHubOrchestrator / Client / list_workflow_steps
list_workflow_steps#
- MigrationHubOrchestrator.Client.list_workflow_steps(**kwargs)#
List the steps in a workflow.
See also: AWS API Documentation
Request Syntax
response = client.list_workflow_steps( nextToken='string', maxResults=123, workflowId='string', stepGroupId='string' )
- Parameters:
nextToken (string) – The pagination token.
maxResults (integer) – The maximum number of results that can be returned.
workflowId (string) –
[REQUIRED]
The ID of the migration workflow.
stepGroupId (string) –
[REQUIRED]
The ID of the step group.
- Return type:
dict
- Returns:
Response Syntax
{ 'nextToken': 'string', 'workflowStepsSummary': [ { 'stepId': 'string', 'name': 'string', 'stepActionType': 'MANUAL'|'AUTOMATED', 'owner': 'AWS_MANAGED'|'CUSTOM', 'previous': [ 'string', ], 'next': [ 'string', ], 'status': 'AWAITING_DEPENDENCIES'|'SKIPPED'|'READY'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'PAUSED'|'USER_ATTENTION_REQUIRED', 'statusMessage': 'string', 'noOfSrvCompleted': 123, 'noOfSrvFailed': 123, 'totalNoOfSrv': 123, 'description': 'string', 'scriptLocation': 'string' }, ] }
Response Structure
(dict) –
nextToken (string) –
The pagination token.
workflowStepsSummary (list) –
The summary of steps in a migration workflow.
(dict) –
The summary of the step in a migration workflow.
stepId (string) –
The ID of the step.
name (string) –
The name of the step.
stepActionType (string) –
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.
owner (string) –
The owner of the step.
previous (list) –
The previous step.
(string) –
next (list) –
The next step.
(string) –
status (string) –
The status of the step.
statusMessage (string) –
The status message of the migration workflow.
noOfSrvCompleted (integer) –
The number of servers that have been migrated.
noOfSrvFailed (integer) –
The number of servers that have failed to migrate.
totalNoOfSrv (integer) –
The total number of servers that have been migrated.
description (string) –
The description of the step.
scriptLocation (string) –
The location of the script.
Exceptions