:doc:`LookoutEquipment <../../lookoutequipment>` / Client / describe_label

**************
describe_label
**************



.. py:method:: LookoutEquipment.Client.describe_label(**kwargs)

  

  Returns the name of the label.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/DescribeLabel>`_  


  **Request Syntax**
  ::

    response = client.describe_label(
        LabelGroupName='string',
        LabelId='string'
    )
    
  :type LabelGroupName: string
  :param LabelGroupName: **[REQUIRED]** 

    Returns the name of the group containing the label.

    

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

    Returns the ID of the label.

    

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

    
    ::

      {
          'LabelGroupName': 'string',
          'LabelGroupArn': 'string',
          'LabelId': 'string',
          'StartTime': datetime(2015, 1, 1),
          'EndTime': datetime(2015, 1, 1),
          'Rating': 'ANOMALY'|'NO_ANOMALY'|'NEUTRAL',
          'FaultCode': 'string',
          'Notes': 'string',
          'Equipment': 'string',
          'CreatedAt': datetime(2015, 1, 1)
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **LabelGroupName** *(string) --* 

        The name of the requested label group.

        
      

      - **LabelGroupArn** *(string) --* 

        The Amazon Resource Name (ARN) of the requested label group.

        
      

      - **LabelId** *(string) --* 

        The ID of the requested label.

        
      

      - **StartTime** *(datetime) --* 

        The start time of the requested label.

        
      

      - **EndTime** *(datetime) --* 

        The end time of the requested label.

        
      

      - **Rating** *(string) --* 

        Indicates whether a labeled event represents an anomaly.

        
      

      - **FaultCode** *(string) --* 

        Indicates the type of anomaly associated with the label.

         

        Data in this field will be retained for service usage. Follow best practices for the security of your data.

        
      

      - **Notes** *(string) --* 

        Metadata providing additional information about the label.

         

        Data in this field will be retained for service usage. Follow best practices for the security of your data.

        
      

      - **Equipment** *(string) --* 

        Indicates that a label pertains to a particular piece of equipment.

        
      

      - **CreatedAt** *(datetime) --* 

        The time at which the label was created.

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

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

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

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

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

  