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

***********************
list_playback_key_pairs
***********************



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

  

  Gets summary information about playback key pairs. For more information, see `Setting Up Private Channels <https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html>`__ in the *Amazon IVS User Guide*.

  

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


  **Request Syntax**
  ::

    response = client.list_playback_key_pairs(
        maxResults=123,
        nextToken='string'
    )
    
  :type maxResults: integer
  :param maxResults: 

    Maximum number of key pairs to return. Default: your service quota or 100, whichever is smaller.

    

  
  :type nextToken: string
  :param nextToken: 

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

    

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

    
    ::

      {
          'keyPairs': [
              {
                  'arn': 'string',
                  'name': 'string',
                  'tags': {
                      'string': 'string'
                  }
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **keyPairs** *(list) --* 

        List of key pairs.

        
        

        - *(dict) --* 

          Summary information about a playback key pair.

          
          

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

            Key-pair ARN.

            
          

          - **name** *(string) --* 

            Playback-key-pair name. The value does not need to be unique.

            
          

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

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

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

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

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

  