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

*******************
describe_human_loop
*******************



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

  

  Returns information about the specified human loop. If the human loop was deleted, this operation will return a ``ResourceNotFoundException`` error.

  

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


  **Request Syntax**
  ::

    response = client.describe_human_loop(
        HumanLoopName='string'
    )
    
  :type HumanLoopName: string
  :param HumanLoopName: **[REQUIRED]** 

    The name of the human loop that you want information about.

    

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

    
    ::

      {
          'CreationTime': datetime(2015, 1, 1),
          'FailureReason': 'string',
          'FailureCode': 'string',
          'HumanLoopStatus': 'InProgress'|'Failed'|'Completed'|'Stopped'|'Stopping',
          'HumanLoopName': 'string',
          'HumanLoopArn': 'string',
          'FlowDefinitionArn': 'string',
          'HumanLoopOutput': {
              'OutputS3Uri': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The creation time when Amazon Augmented AI created the human loop.

        
      

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

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

        
      

      - **FailureCode** *(string) --* 

        A failure code that identifies the type of failure.

         

        Possible values: ``ValidationError``, ``Expired``, ``InternalError``

        
      

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

        The status of the human loop.

        
      

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

        The name of the human loop. The name must be lowercase, unique within the Region in your account, and can have up to 63 characters. Valid characters: a-z, 0-9, and - (hyphen).

        
      

      - **HumanLoopArn** *(string) --* 

        The Amazon Resource Name (ARN) of the human loop.

        
      

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

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

        
      

      - **HumanLoopOutput** *(dict) --* 

        An object that contains information about the output of the human loop.

        
        

        - **OutputS3Uri** *(string) --* 

          The location of the Amazon S3 object where Amazon Augmented AI stores your human loop output.

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

  