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

********************
list_flow_executions
********************



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

  

  Lists all executions of a flow. Results can be paginated and include summary information about each execution, such as status, start and end times, and the execution's Amazon Resource Name (ARN).

   

  .. note::

    

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

    

  

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


  **Request Syntax**
  ::

    response = client.list_flow_executions(
        flowAliasIdentifier='string',
        flowIdentifier='string',
        maxResults=123,
        nextToken='string'
    )
    
  :type flowAliasIdentifier: string
  :param flowAliasIdentifier: 

    The unique identifier of the flow alias to list executions for.

    

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

    The unique identifier of the flow to list executions for.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of flow executions to return in a single response. If more executions exist than the specified ``maxResults`` value, a token is included in the response so that the remaining results can be retrieved.

    

  
  :type nextToken: string
  :param nextToken: 

    A token to retrieve the next set of results. This value is returned in the response if more results are available.

    

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

    
    ::

      {
          'flowExecutionSummaries': [
              {
                  'createdAt': datetime(2015, 1, 1),
                  'endedAt': datetime(2015, 1, 1),
                  'executionArn': 'string',
                  'flowAliasIdentifier': 'string',
                  'flowIdentifier': 'string',
                  'flowVersion': 'string',
                  'status': 'Running'|'Succeeded'|'Failed'|'TimedOut'|'Aborted'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **flowExecutionSummaries** *(list) --* 

        A list of flow execution summaries. Each summary includes the execution ARN, flow identifier, flow alias identifier, flow version, status, and timestamps.

        
        

        - *(dict) --* 

          Contains summary information about a flow execution, including its status, timestamps, and identifiers.

           

          .. note::

            

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

            

          
          

          - **createdAt** *(datetime) --* 

            The timestamp when the flow execution was created.

            
          

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

            
          

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

            
          

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

            The current status of the flow execution.

             

            Flow executions time out after 24 hours.

            
      
    
      

      - **nextToken** *(string) --* 

        A token to retrieve the next set of results. This value is returned if more results are available.

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

  