MigrationHubOrchestrator / Paginator / ListWorkflowStepGroups
ListWorkflowStepGroups#
- class MigrationHubOrchestrator.Paginator.ListWorkflowStepGroups#
paginator = client.get_paginator('list_workflow_step_groups')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
MigrationHubOrchestrator.Client.list_workflow_step_groups()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( workflowId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
workflowId (string) –
[REQUIRED]
The ID of the migration workflow.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ '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', ] }, ], 'NextToken': 'string' }
Response Structure
(dict) –
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) –
NextToken (string) –
A token to resume pagination.