:doc:`ApplicationDiscoveryService <../../discovery>` / Client / describe_tags

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



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

  

  Retrieves a list of configuration items that have tags as specified by the key-value pairs, name and value, passed to the optional parameter ``filters``.

   

  There are three valid tag filter names:

   

  
  * tagKey
   
  * tagValue
   
  * configurationId
  

   

  Also, all configuration items associated with your user that have tags can be listed if you call ``DescribeTags`` as is without passing any parameters.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/discovery-2015-11-01/DescribeTags>`_  


  **Request Syntax**
  ::

    response = client.describe_tags(
        filters=[
            {
                'name': 'string',
                'values': [
                    'string',
                ]
            },
        ],
        maxResults=123,
        nextToken='string'
    )
    
  :type filters: list
  :param filters: 

    You can filter the list using a *key*-*value* format. You can separate these items by using logical operators. Allowed filters include ``tagKey``, ``tagValue``, and ``configurationId``.

    

  
    - *(dict) --* 

      The tag filter. Valid names are: ``tagKey``, ``tagValue``, ``configurationId``.

      

    
      - **name** *(string) --* **[REQUIRED]** 

        A name of the tag filter.

        

      
      - **values** *(list) --* **[REQUIRED]** 

        Values for the tag filter.

        

      
        - *(string) --* 

        
    
    

  :type maxResults: integer
  :param maxResults: 

    The total number of items to return in a single page of output. The maximum value is 100.

    

  
  :type nextToken: string
  :param nextToken: 

    A token to start the list. Use this token to get the next set of results.

    

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

    
    ::

      {
          'tags': [
              {
                  'configurationType': 'SERVER'|'PROCESS'|'CONNECTION'|'APPLICATION',
                  'configurationId': 'string',
                  'key': 'string',
                  'value': 'string',
                  'timeOfCreation': datetime(2015, 1, 1)
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **tags** *(list) --* 

        Depending on the input, this is a list of configuration items tagged with a specific tag, or a list of tags for a specific configuration item.

        
        

        - *(dict) --* 

          Tags for a configuration item. Tags are metadata that help you categorize IT assets.

          
          

          - **configurationType** *(string) --* 

            A type of IT asset to tag.

            
          

          - **configurationId** *(string) --* 

            The configuration ID for the item to tag. You can specify a list of keys and values.

            
          

          - **key** *(string) --* 

            A type of tag on which to filter. For example, *serverType*.

            
          

          - **value** *(string) --* 

            A value on which to filter. For example *key = serverType* and *value = web server*.

            
          

          - **timeOfCreation** *(datetime) --* 

            The time the configuration tag was created in Coordinated Universal Time (UTC).

            
      
    
      

      - **nextToken** *(string) --* 

        The call returns a token. Use this token to get the next set of results.

        
  
  **Exceptions**
  
  *   :py:class:`ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorException`

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

  
  *   :py:class:`ApplicationDiscoveryService.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`ApplicationDiscoveryService.Client.exceptions.InvalidParameterValueException`

  
  *   :py:class:`ApplicationDiscoveryService.Client.exceptions.ServerInternalErrorException`

  
  *   :py:class:`ApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetException`

  