:doc:`AgentsforBedrock <../../bedrock-agent>` / Paginator / ListFlows

*********
ListFlows
*********



.. py:class:: AgentsforBedrock.Paginator.ListFlows

  ::

    
    paginator = client.get_paginator('list_flows')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`AgentsforBedrock.Client.list_flows`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

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

          A token to resume pagination.

          
    