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

****************
list_stream_keys
****************



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

  

  Gets summary information about stream keys for the specified channel.

  

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


  **Request Syntax**
  ::

    response = client.list_stream_keys(
        channelArn='string',
        maxResults=123,
        nextToken='string'
    )
    
  :type channelArn: string
  :param channelArn: **[REQUIRED]** 

    Channel ARN used to filter the list.

    

  
  :type maxResults: integer
  :param maxResults: 

    Maximum number of streamKeys to return. Default: 1.

    

  
  :type nextToken: string
  :param nextToken: 

    The first stream key to retrieve. This is used for pagination; see the ``nextToken`` response field.

    

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

    
    ::

      {
          'nextToken': 'string',
          'streamKeys': [
              {
                  'arn': 'string',
                  'channelArn': 'string',
                  'tags': {
                      'string': 'string'
                  }
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        If there are more stream keys than ``maxResults``, use ``nextToken`` in the request to get the next set.

        
      

      - **streamKeys** *(list) --* 

        List of stream keys.

        
        

        - *(dict) --* 

          Summary information about a stream key.

          
          

          - **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) --* 
        
      
      
    
  
  **Exceptions**
  
  *   :py:class:`IVS.Client.exceptions.ResourceNotFoundException`

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

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

  