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

*************
stop_workflow
*************



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

  

  Stop an ongoing migration workflow.

  

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


  **Request Syntax**
  ::

    response = client.stop_workflow(
        id='string'
    )
    
  :type id: string
  :param id: **[REQUIRED]** 

    The ID of the migration workflow.

    

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

    
    ::

      {
          'id': 'string',
          'arn': 'string',
          'status': 'CREATING'|'NOT_STARTED'|'CREATION_FAILED'|'STARTING'|'IN_PROGRESS'|'WORKFLOW_FAILED'|'PAUSED'|'PAUSING'|'PAUSING_FAILED'|'USER_ATTENTION_REQUIRED'|'DELETING'|'DELETION_FAILED'|'DELETED'|'COMPLETED',
          'statusMessage': 'string',
          'lastStopTime': datetime(2015, 1, 1)
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **id** *(string) --* 

        The ID of the migration workflow.

        
      

      - **arn** *(string) --* 

        The Amazon Resource Name (ARN) of the migration workflow.

        
      

      - **status** *(string) --* 

        The status of the migration workflow.

        
      

      - **statusMessage** *(string) --* 

        The status message of the migration workflow.

        
      

      - **lastStopTime** *(datetime) --* 

        The time at which the migration workflow was stopped.

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

  