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

************************
import_playback_key_pair
************************



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

  

  Imports the public portion of a new key pair and returns its ``arn`` and ``fingerprint``. The ``privateKey`` can then be used to generate viewer authorization tokens, to grant viewers access to private channels. 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/ImportPlaybackKeyPair>`_  


  **Request Syntax**
  ::

    response = client.import_playback_key_pair(
        name='string',
        publicKeyMaterial='string',
        tags={
            'string': 'string'
        }
    )
    
  :type name: string
  :param name: 

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

    

  
  :type publicKeyMaterial: string
  :param publicKeyMaterial: **[REQUIRED]** 

    The public portion of a customer-generated key pair.

    

  
  :type tags: dict
  :param tags: 

    Any tags provided with the request are added to the playback key pair tags. 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) --* 

      


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

    
    ::

      {
          'keyPair': {
              'arn': 'string',
              'fingerprint': 'string',
              'name': 'string',
              'tags': {
                  'string': 'string'
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **keyPair** *(dict) --* 
        

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

          Key-pair ARN.

          
        

        - **fingerprint** *(string) --* 

          Key-pair identifier.

          
        

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

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

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

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

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

  