:doc:`IVS <../../ivs>` / Client / get_stream_key

**************
get_stream_key
**************



.. py:method:: IVS.Client.get_stream_key(**kwargs)

  

  Gets stream-key information for a specified ARN.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamKey>`_  


  **Request Syntax**
  ::

    response = client.get_stream_key(
        arn='string'
    )
    
  :type arn: string
  :param arn: **[REQUIRED]** 

    ARN for the stream key to be retrieved.

    

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

    
    ::

      {
          'streamKey': {
              'arn': 'string',
              'channelArn': 'string',
              'tags': {
                  'string': 'string'
              },
              'value': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **streamKey** *(dict) --* 
        

        - **arn** *(string) --* 

          Stream-key ARN.

          
        

        - **channelArn** *(string) --* 

          Channel ARN for the stream.

          
        

        - **tags** *(dict) --* 

          Tags attached to the resource. Array of 1-50 maps, each of the form ``string:string (key:value)``. See `Best practices and strategies <https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html>`__ in *Tagging Amazon Web Services Resources and Tag Editor* for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

          
          

          - *(string) --* 
            

            - *(string) --* 
      
    
        

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

          Stream-key value.

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

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

  
  *   :py:class:`IVS.Client.exceptions.ValidationException`

  