:doc:`MachineLearning <../../machinelearning>` / Client / describe_tags

*************
describe_tags
*************



.. py:method:: MachineLearning.Client.describe_tags(**kwargs)

  

  Describes one or more of the tags for your Amazon ML object.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/machinelearning-2014-12-12/DescribeTags>`_  


  **Request Syntax**
  ::

    response = client.describe_tags(
        ResourceId='string',
        ResourceType='BatchPrediction'|'DataSource'|'Evaluation'|'MLModel'
    )
    
  :type ResourceId: string
  :param ResourceId: **[REQUIRED]** 

    The ID of the ML object. For example, ``exampleModelId``.

    

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

    The type of the ML object.

    

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

    
    ::

      {
          'ResourceId': 'string',
          'ResourceType': 'BatchPrediction'|'DataSource'|'Evaluation'|'MLModel',
          'Tags': [
              {
                  'Key': 'string',
                  'Value': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Amazon ML returns the following elements.

      
      

      - **ResourceId** *(string) --* 

        The ID of the tagged ML object.

        
      

      - **ResourceType** *(string) --* 

        The type of the tagged ML object.

        
      

      - **Tags** *(list) --* 

        A list of tags associated with the ML object.

        
        

        - *(dict) --* 

          A custom key-value pair associated with an ML object, such as an ML model.

          
          

          - **Key** *(string) --* 

            A unique identifier for the tag. Valid characters include Unicode letters, digits, white space, _, ., /, =, +, -, %, and @.

            
          

          - **Value** *(string) --* 

            An optional string, typically used to describe or define the tag. Valid characters include Unicode letters, digits, white space, _, ., /, =, +, -, %, and @.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`MachineLearning.Client.exceptions.InvalidInputException`

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

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

  