:doc:`Appflow <../../appflow>` / Client / stop_flow

*********
stop_flow
*********



.. py:method:: Appflow.Client.stop_flow(**kwargs)

  

  Deactivates the existing flow. For on-demand flows, this operation returns an ``unsupportedOperationException`` error message. For schedule and event-triggered flows, this operation deactivates the flow.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/StopFlow>`_  


  **Request Syntax**
  ::

    response = client.stop_flow(
        flowName='string'
    )
    
  :type flowName: string
  :param flowName: **[REQUIRED]** 

    The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

    

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

    
    ::

      {
          'flowArn': 'string',
          'flowStatus': 'Active'|'Deprecated'|'Deleted'|'Draft'|'Errored'|'Suspended'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **flowArn** *(string) --* 

        The flow's Amazon Resource Name (ARN).

        
      

      - **flowStatus** *(string) --* 

        Indicates the current status of the flow.

        
  
  **Exceptions**
  
  *   :py:class:`Appflow.Client.exceptions.ConflictException`

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

  
  *   :py:class:`Appflow.Client.exceptions.UnsupportedOperationException`

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

  