Skip to content

Get Playback Key Pair

ivs_get_playback_key_pair R Documentation

Gets a specified playback authorization key pair and returns the arn and fingerprint

Description

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.

Usage

ivs_get_playback_key_pair(arn)

Arguments

arn

[required] ARN of the key pair to be returned.

Value

A list with the following syntax:

list(
  keyPair = list(
    arn = "string",
    name = "string",
    fingerprint = "string",
    tags = list(
      "string"
    )
  )
)

Request syntax

svc$get_playback_key_pair(
  arn = "string"
)