:doc:`MigrationHubOrchestrator <../../migrationhuborchestrator>` / Client / list_workflows

**************
list_workflows
**************



.. py:method:: MigrationHubOrchestrator.Client.list_workflows(**kwargs)

  

  List the migration workflows.

  

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


  **Request Syntax**
  ::

    response = client.list_workflows(
        maxResults=123,
        nextToken='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',
        name='string'
    )
    
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results that can be returned.

    

  
  :type nextToken: string
  :param nextToken: 

    The pagination token.

    

  
  :type templateId: string
  :param templateId: 

    The ID of the template.

    

  
  :type adsApplicationConfigurationName: string
  :param adsApplicationConfigurationName: 

    The name of the application configured in Application Discovery Service.

    

  
  :type status: string
  :param status: 

    The status of the migration workflow.

    

  
  :type name: string
  :param name: 

    The name of the migration workflow.

    

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

    
    ::

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

    

    - *(dict) --* 
      

      - **nextToken** *(string) --* 

        The pagination token.

        
      

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

            
      
    
  
  **Exceptions**
  
  *   :py:class:`MigrationHubOrchestrator.Client.exceptions.ThrottlingException`

  
  *   :py:class:`MigrationHubOrchestrator.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`MigrationHubOrchestrator.Client.exceptions.InternalServerException`

  
  *   :py:class:`MigrationHubOrchestrator.Client.exceptions.ValidationException`

  
  *   :py:class:`MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundException`

  