:doc:`AgentsforBedrockRuntime <../../bedrock-agent-runtime>` / Client / stop_flow_execution

*******************
stop_flow_execution
*******************



.. py:method:: AgentsforBedrockRuntime.Client.stop_flow_execution(**kwargs)

  

  Stops an Amazon Bedrock flow's execution. This operation prevents further processing of the flow and changes the execution status to ``Aborted``.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/StopFlowExecution>`_  


  **Request Syntax**
  ::

    response = client.stop_flow_execution(
        executionIdentifier='string',
        flowAliasIdentifier='string',
        flowIdentifier='string'
    )
    
  :type executionIdentifier: string
  :param executionIdentifier: **[REQUIRED]** 

    The unique identifier of the flow execution to stop.

    

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

    The unique identifier of the flow alias used for the execution.

    

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

    The unique identifier of the flow.

    

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

    
    ::

      {
          'executionArn': 'string',
          'status': 'Running'|'Succeeded'|'Failed'|'TimedOut'|'Aborted'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **executionArn** *(string) --* 

        The Amazon Resource Name (ARN) that uniquely identifies the flow execution that was stopped.

        
      

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

        The updated status of the flow execution after the stop request. This will typically be ABORTED if the execution was successfully stopped.

        
  
  **Exceptions**
  
  *   :py:class:`AgentsforBedrockRuntime.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`AgentsforBedrockRuntime.Client.exceptions.ConflictException`

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

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

  
  *   :py:class:`AgentsforBedrockRuntime.Client.exceptions.DependencyFailedException`

  
  *   :py:class:`AgentsforBedrockRuntime.Client.exceptions.BadGatewayException`

  
  *   :py:class:`AgentsforBedrockRuntime.Client.exceptions.ThrottlingException`

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

  