:doc:`AugmentedAIRuntime <../../sagemaker-a2i-runtime>` / Client / list_human_loops

****************
list_human_loops
****************



.. py:method:: AugmentedAIRuntime.Client.list_human_loops(**kwargs)

  

  Returns information about human loops, given the specified parameters. If a human loop was deleted, it will not be included.

  

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


  **Request Syntax**
  ::

    response = client.list_human_loops(
        CreationTimeAfter=datetime(2015, 1, 1),
        CreationTimeBefore=datetime(2015, 1, 1),
        FlowDefinitionArn='string',
        SortOrder='Ascending'|'Descending',
        NextToken='string',
        MaxResults=123
    )
    
  :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 NextToken: string
  :param NextToken: 

    A token to display the next page of results.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The total number of items to return. If the total number of available items is more than the value specified in ``MaxResults``, then a ``NextToken`` is returned in the output. You can use this token to display the next page of results.

    

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

    
    ::

      {
          'HumanLoopSummaries': [
              {
                  'HumanLoopName': 'string',
                  'HumanLoopStatus': 'InProgress'|'Failed'|'Completed'|'Stopped'|'Stopping',
                  'CreationTime': datetime(2015, 1, 1),
                  'FailureReason': 'string',
                  'FlowDefinitionArn': 'string'
              },
          ],
          'NextToken': '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.

            
      
    
      

      - **NextToken** *(string) --* 

        A token to display the next page of results.

        
  
  **Exceptions**
  
  *   :py:class:`AugmentedAIRuntime.Client.exceptions.ValidationException`

  
  *   :py:class:`AugmentedAIRuntime.Client.exceptions.ResourceNotFoundException`

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

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

  