get_playback_key_pair

IVS.Client.get_playback_key_pair(**kwargs)

Gets a specified playback authorization key pair and returns the arn and fingerprint . The privateKey held by the caller can 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.get_playback_key_pair(
    arn='string'
)

Parameters

arn (string) --

[REQUIRED]

ARN of the key pair to be returned.

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 Tagging Amazon Web Services Resources for more information, 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.ResourceNotFoundException
• IVS.Client.exceptions.AccessDeniedException
• IVS.Client.exceptions.ValidationException