MigrationHubOrchestrator / Paginator / ListWorkflows

ListWorkflows

class MigrationHubOrchestrator.Paginator.ListWorkflows

paginator = client.get_paginator('list_workflows')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MigrationHubOrchestrator.Client.list_workflows().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    templateId='string',
    adsApplicationConfigurationName='string',
    status='CREATING'|'NOT_STARTED'|'CREATION_FAILED'|'STARTING'|'IN_PROGRESS'|'WORKFLOW_FAILED'|'PAUSED'|'PAUSING'|'PAUSING_FAILED'|'USER_ATTENTION_REQUIRED'|'DELETING'|'DELETION_FAILED'|'DELETED'|'COMPLETED',
    name='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• templateId (string) – The ID of the template.

• adsApplicationConfigurationName (string) – The name of the application configured in Application Discovery Service.

• status (string) – The status of the migration workflow.

• name (string) – The name 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

{
    'migrationWorkflowSummary': [
        {
            'id': 'string',
            'name': 'string',
            'templateId': 'string',
            'adsApplicationConfigurationName': 'string',
            'status': 'CREATING'|'NOT_STARTED'|'CREATION_FAILED'|'STARTING'|'IN_PROGRESS'|'WORKFLOW_FAILED'|'PAUSED'|'PAUSING'|'PAUSING_FAILED'|'USER_ATTENTION_REQUIRED'|'DELETING'|'DELETION_FAILED'|'DELETED'|'COMPLETED',
            'creationTime': datetime(2015, 1, 1),
            'endTime': datetime(2015, 1, 1),
            'statusMessage': 'string',
            'completedSteps': 123,
            'totalSteps': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • migrationWorkflowSummary (list) –

    The summary of the migration workflow.

    • (dict) –

      The summary of a migration workflow.

      • id (string) –

        The ID of the migration workflow.

      • name (string) –

        The name of the migration workflow.

      • templateId (string) –

        The ID of the template.

      • adsApplicationConfigurationName (string) –

        The name of the application configured in Application Discovery Service.

      • status (string) –

        The status of the migration workflow.

      • creationTime (datetime) –

        The time at which the migration workflow was created.

      • endTime (datetime) –

        The time at which the migration workflow ended.

      • statusMessage (string) –

        The status message of the migration workflow.

      • completedSteps (integer) –

        The steps completed in the migration workflow.

      • totalSteps (integer) –

        All the steps in a migration workflow.

  • NextToken (string) –

    A token to resume pagination.