:doc:`MigrationHubOrchestrator <../../migrationhuborchestrator>` / Paginator / ListWorkflowSteps

*****************
ListWorkflowSteps
*****************



.. py:class:: MigrationHubOrchestrator.Paginator.ListWorkflowSteps

  ::

    
    paginator = client.get_paginator('list_workflow_steps')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`MigrationHubOrchestrator.Client.list_workflow_steps`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/migrationhuborchestrator-2021-08-28/ListWorkflowSteps>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          workflowId='string',
          stepGroupId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type workflowId: string
    :param workflowId: **[REQUIRED]** 

      The ID of the migration workflow.

      

    
    :type stepGroupId: string
    :param stepGroupId: **[REQUIRED]** 

      The ID of the step group.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            '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'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

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

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    