:doc:`AugmentedAIRuntime <../../sagemaker-a2i-runtime>` / Paginator / ListHumanLoops

**************
ListHumanLoops
**************



.. py:class:: AugmentedAIRuntime.Paginator.ListHumanLoops

  ::

    
    paginator = client.get_paginator('list_human_loops')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`AugmentedAIRuntime.Client.list_human_loops`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sagemaker-a2i-runtime-2019-11-07/ListHumanLoops>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          CreationTimeAfter=datetime(2015, 1, 1),
          CreationTimeBefore=datetime(2015, 1, 1),
          FlowDefinitionArn='string',
          SortOrder='Ascending'|'Descending',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type CreationTimeAfter: datetime
    :param CreationTimeAfter: 

      (Optional) The timestamp of the date when you want the human loops to begin in ISO 8601 format. For example, ``2020-02-24``.

      

    
    :type CreationTimeBefore: datetime
    :param CreationTimeBefore: 

      (Optional) The timestamp of the date before which you want the human loops to begin in ISO 8601 format. For example, ``2020-02-24``.

      

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

      The Amazon Resource Name (ARN) of a flow definition.

      

    
    :type SortOrder: string
    :param SortOrder: 

      Optional. The order for displaying results. Valid values: ``Ascending`` and ``Descending``.

      

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

      
      ::

        {
            'HumanLoopSummaries': [
                {
                    'HumanLoopName': 'string',
                    'HumanLoopStatus': 'InProgress'|'Failed'|'Completed'|'Stopped'|'Stopping',
                    'CreationTime': datetime(2015, 1, 1),
                    'FailureReason': 'string',
                    'FlowDefinitionArn': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **HumanLoopSummaries** *(list) --* 

          An array of objects that contain information about the human loops.

          
          

          - *(dict) --* 

            Summary information about the human loop.

            
            

            - **HumanLoopName** *(string) --* 

              The name of the human loop.

              
            

            - **HumanLoopStatus** *(string) --* 

              The status of the human loop.

              
            

            - **CreationTime** *(datetime) --* 

              When Amazon Augmented AI created the human loop.

              
            

            - **FailureReason** *(string) --* 

              The reason why the human loop failed. A failure reason is returned when the status of the human loop is ``Failed``.

              
            

            - **FlowDefinitionArn** *(string) --* 

              The Amazon Resource Name (ARN) of the flow definition used to configure the human loop.

              
        
      
    