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

*************************
list_workflow_step_groups
*************************



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

  

  List the step groups in a migration workflow.

  

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


  **Request Syntax**
  ::

    response = client.list_workflow_step_groups(
        nextToken='string',
        maxResults=123,
        workflowId='string'
    )
    
  :type nextToken: string
  :param nextToken: 

    The pagination token.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results that can be returned.

    

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

    The ID of the migration workflow.

    

  
  
  :rtype: 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**
  
  *   :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`

  