:doc:`XRay <../../xray>` / Client / tag_resource

************
tag_resource
************



.. py:method:: XRay.Client.tag_resource(**kwargs)

  

  Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/TagResource>`_  


  **Request Syntax**
  ::

    response = client.tag_resource(
        ResourceARN='string',
        Tags=[
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    )
    
  :type ResourceARN: string
  :param ResourceARN: **[REQUIRED]** 

    The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.

    

  
  :type Tags: list
  :param Tags: **[REQUIRED]** 

    A map that contains one or more tag keys and tag values to attach to an X-Ray group or sampling rule. For more information about ways to use tags, see `Tagging Amazon Web Services resources <https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html>`__ in the *Amazon Web Services General Reference*.

     

    The following restrictions apply to tags:

     

    
    * Maximum number of user-applied tags per resource: 50
     
    * Maximum tag key length: 128 Unicode characters
     
    * Maximum tag value length: 256 Unicode characters
     
    * Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @
     
    * Tag keys and values are case sensitive.
     
    * Don't use ``aws:`` as a prefix for keys; it's reserved for Amazon Web Services use. You cannot edit or delete system tags.
    

    

  
    - *(dict) --* 

      A map that contains tag keys and tag values to attach to an Amazon Web Services X-Ray group or sampling rule. For more information about ways to use tags, see `Tagging Amazon Web Services resources <https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html>`__ in the *Amazon Web Services General Reference*.

       

      The following restrictions apply to tags:

       

      
      * Maximum number of user-applied tags per resource: 50
       
      * Tag keys and values are case sensitive.
       
      * Don't use ``aws:`` as a prefix for keys; it's reserved for Amazon Web Services use. You cannot edit or delete system tags.
      

      

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

        A tag key, such as ``Stage`` or ``Name``. A tag key cannot be empty. The key can be a maximum of 128 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: ``+ - = . _ : /``

        

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

        An optional tag value, such as ``Production`` or ``test-only``. The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: ``+ - = . _ : /``

        

      
    

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

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`XRay.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`XRay.Client.exceptions.ThrottledException`

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

  
  *   :py:class:`XRay.Client.exceptions.TooManyTagsException`

  