:doc:`Kinesis <../../kinesis>` / Client / list_tags_for_stream

********************
list_tags_for_stream
********************



.. py:method:: Kinesis.Client.list_tags_for_stream(**kwargs)

  

  Lists the tags for the specified Kinesis data stream. This operation has a limit of five transactions per second per account.

   

  .. note::

    

    When invoking this API, you must use either the ``StreamARN`` or the ``StreamName`` parameter, or both. It is recommended that you use the ``StreamARN`` input parameter when you invoke this API.

    

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/ListTagsForStream>`_  


  **Request Syntax**
  ::

    response = client.list_tags_for_stream(
        StreamName='string',
        ExclusiveStartTagKey='string',
        Limit=123,
        StreamARN='string',
        StreamId='string'
    )
    
  :type StreamName: string
  :param StreamName: 

    The name of the stream.

    

  
  :type ExclusiveStartTagKey: string
  :param ExclusiveStartTagKey: 

    The key to use as the starting point for the list of tags. If this parameter is set, ``ListTagsForStream`` gets all tags that occur after ``ExclusiveStartTagKey``.

    

  
  :type Limit: integer
  :param Limit: 

    The number of tags to return. If this number is less than the total number of tags associated with the stream, ``HasMoreTags`` is set to ``true``. To list additional tags, set ``ExclusiveStartTagKey`` to the last key in the response.

    

  
  :type StreamARN: string
  :param StreamARN: 

    The ARN of the stream.

    

  
  :type StreamId: string
  :param StreamId: 

    Not Implemented. Reserved for future use.

    

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

    
    ::

      {
          'Tags': [
              {
                  'Key': 'string',
                  'Value': 'string'
              },
          ],
          'HasMoreTags': True|False
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Represents the output for ``ListTagsForStream``.

      
      

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

        A list of tags associated with ``StreamName``, starting with the first tag after ``ExclusiveStartTagKey`` and up to the specified ``Limit``.

        
        

        - *(dict) --* 

          Metadata assigned to the stream or consumer, consisting of a key-value pair.

          
          

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

            A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

            
          

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

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

            
      
    
      

      - **HasMoreTags** *(boolean) --* 

        If set to ``true``, more tags are available. To request additional tags, set ``ExclusiveStartTagKey`` to the key of the last tag returned.

        
  
  **Exceptions**
  
  *   :py:class:`Kinesis.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`Kinesis.Client.exceptions.InvalidArgumentException`

  
  *   :py:class:`Kinesis.Client.exceptions.LimitExceededException`

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

  