:doc:`XRay <../../xray>` / Paginator / ListTagsForResource

*******************
ListTagsForResource
*******************



.. py:class:: XRay.Paginator.ListTagsForResource

  ::

    
    paginator = client.get_paginator('list_tags_for_resource')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`XRay.Client.list_tags_for_resource`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          ResourceARN='string',
          PaginationConfig={
              'MaxItems': 123,
              'StartingToken': 'string'
          }
      )
      
    :type ResourceARN: string
    :param ResourceARN: **[REQUIRED]** 

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

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

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

      
      ::

        {
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

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

          A list of tags, as key and value pairs, that is associated with the specified X-Ray group or sampling rule.

          
          

          - *(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) --* 

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

              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: ``+ - = . _ : /``

              
        
      
    