:doc:`AgentsforBedrock <../../bedrock-agent>` / Client / list_flows

**********
list_flows
**********



.. py:method:: AgentsforBedrock.Client.list_flows(**kwargs)

  

  Returns a list of flows and information about each flow. For more information, see `Manage a flow in Amazon Bedrock <https://docs.aws.amazon.com/bedrock/latest/userguide/flows-manage.html>`__ in the Amazon Bedrock User Guide.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListFlows>`_  


  **Request Syntax**
  ::

    response = client.list_flows(
        maxResults=123,
        nextToken='string'
    )
    
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the ``nextToken`` field when making another request to return the next batch of results.

    

  
  :type nextToken: string
  :param nextToken: 

    If the total number of results is greater than the ``maxResults`` value provided in the request, enter the token returned in the ``nextToken`` field in the response in this field to return the next batch of results.

    

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

    
    ::

      {
          'flowSummaries': [
              {
                  'name': 'string',
                  'description': 'string',
                  'id': 'string',
                  'arn': 'string',
                  'status': 'Failed'|'Prepared'|'Preparing'|'NotPrepared',
                  'createdAt': datetime(2015, 1, 1),
                  'updatedAt': datetime(2015, 1, 1),
                  'version': 'string'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **flowSummaries** *(list) --* 

        A list, each member of which contains information about a flow.

        
        

        - *(dict) --* 

          Contains the definition of a flow.

          
          

          - **name** *(string) --* 

            The name of the flow.

            
          

          - **description** *(string) --* 

            A description of the flow.

            
          

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

            The unique identifier of the flow.

            
          

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

            The Amazon Resource Name (ARN) of the flow.

            
          

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

            The status of the flow. The following statuses are possible:

             

            
            * NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the ``DRAFT`` version won't contain the latest changes for testing. Send a `PrepareFlow <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PrepareFlow.html>`__ request to package the latest changes into the ``DRAFT`` version.
             
            * Preparing – The flow is being prepared so that the ``DRAFT`` version contains the latest changes for testing.
             
            * Prepared – The flow is prepared and the ``DRAFT`` version contains the latest changes for testing.
             
            * Failed – The last API operation that you invoked on the flow failed. Send a `GetFlow <https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlow.html>`__ request and check the error message in the ``validations`` field.
            

            
          

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

            The time at which the flow was created.

            
          

          - **updatedAt** *(datetime) --* 

            The time at which the flow was last updated.

            
          

          - **version** *(string) --* 

            The latest version of the flow.

            
      
    
      

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

        If the total number of results is greater than the ``maxResults`` value provided in the request, use this token when making another request in the ``nextToken`` field to return the next batch of results.

        
  
  **Exceptions**
  
  *   :py:class:`AgentsforBedrock.Client.exceptions.ThrottlingException`

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

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

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

  