MigrationHubOrchestrator / Client / list_workflow_step_groups

list_workflow_step_groups#

MigrationHubOrchestrator.Client.list_workflow_step_groups(**kwargs)#

List the step groups in a migration workflow.

Request Syntax

response = client.list_workflow_step_groups(
    nextToken='string',
    maxResults=123,
    workflowId='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.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'workflowStepGroupsSummary': [
        {
            'id': 'string',
            'name': 'string',
            'owner': 'AWS_MANAGED'|'CUSTOM',
            'status': 'AWAITING_DEPENDENCIES'|'READY'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'PAUSED'|'PAUSING'|'USER_ATTENTION_REQUIRED',
            'previous': [
                'string',
            ],
            'next': [
                'string',
            ]
        },
    ]
}

Response Structure

(dict) –
- nextToken (string) –
  
  The pagination token.
- workflowStepGroupsSummary (list) –
  
  The summary of step groups in a migration workflow.
  - (dict) –
    
    The summary of a step group in a workflow.
    - id (string) –
      
      The ID of the step group.
    - name (string) –
      
      The name of the step group.
    - owner (string) –
      
      The owner of the step group.
    - status (string) –
      
      The status of the step group.
    - previous (list) –
      
      The previous step group.
      - (string) –
    - next (list) –
      
      The next step group.
      - (string) –

Exceptions

MigrationHubOrchestrator.Client.exceptions.ThrottlingException
MigrationHubOrchestrator.Client.exceptions.AccessDeniedException
MigrationHubOrchestrator.Client.exceptions.InternalServerException
MigrationHubOrchestrator.Client.exceptions.ValidationException
MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundException