IVS / Client / import_playback_key_pair

import_playback_key_pair#

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 in the Amazon IVS User Guide.

See also: AWS API Documentation

Request Syntax

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

  • name (string) – Playback-key-pair name. The value does not need to be unique.

  • publicKeyMaterial (string) –

    [REQUIRED]

    The public portion of a customer-generated key pair.

  • tags (dict) –

    Any tags provided with the request are added to the playback key pair tags. See Best practices and strategies 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) –

Return type:

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

  • IVS.Client.exceptions.AccessDeniedException

  • IVS.Client.exceptions.ValidationException

  • IVS.Client.exceptions.PendingVerification

  • IVS.Client.exceptions.ConflictException

  • IVS.Client.exceptions.ServiceQuotaExceededException