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

******************
get_flow_execution
******************



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

  

  Retrieves details about a specific flow execution, including its status, start and end times, and any errors that occurred during execution.

  

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


  **Request Syntax**
  ::

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

    The unique identifier of the flow execution to retrieve.

    

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

    
    ::

      {
          'endedAt': datetime(2015, 1, 1),
          'errors': [
              {
                  'error': 'ExecutionTimedOut',
                  'message': 'string',
                  'nodeName': 'string'
              },
          ],
          'executionArn': 'string',
          'flowAliasIdentifier': 'string',
          'flowIdentifier': 'string',
          'flowVersion': 'string',
          'startedAt': datetime(2015, 1, 1),
          'status': 'Running'|'Succeeded'|'Failed'|'TimedOut'|'Aborted'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **endedAt** *(datetime) --* 

        The timestamp when the flow execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.

        
      

      - **errors** *(list) --* 

        A list of errors that occurred during the flow execution. Each error includes an error code, message, and the node where the error occurred, if applicable.

        
        

        - *(dict) --* 

          Contains information about an error that occurred during an flow execution.

           

          .. note::

            

            Flow executions is in preview release for Amazon Bedrock and is subject to change.

            

          
          

          - **error** *(string) --* 

            The error code for the type of error that occurred.

            
          

          - **message** *(string) --* 

            A descriptive message that provides details about the error.

            
          

          - **nodeName** *(string) --* 

            The name of the node in the flow where the error occurred (if applicable).

            
      
    
      

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

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

        
      

      - **flowAliasIdentifier** *(string) --* 

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

        
      

      - **flowIdentifier** *(string) --* 

        The unique identifier of the flow.

        
      

      - **flowVersion** *(string) --* 

        The version of the flow used for the execution.

        
      

      - **startedAt** *(datetime) --* 

        The timestamp when the flow execution started.

        
      

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

        The current status of the flow execution.

         

        Flow executions time out after 24 hours.

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

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

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

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

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

  