Import Playback Key Pair

ivs_import_playback_key_pair

R Documentation

Imports the public portion of a new key pair and returns its arn and fingerprint¶

Description¶

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.

Usage¶

ivs_import_playback_key_pair(publicKeyMaterial, name, tags)

Arguments¶

publicKeyMaterial: [required] The public portion of a customer-generated key pair.
name: Playback-key-pair name. The value does not need to be unique.
tags: Any tags provided with the request are added to the playback key pair tags. 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.

Value¶

A list with the following syntax:

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

Request syntax¶

svc$import_playback_key_pair(
  publicKeyMaterial = "string",
  name = "string",
  tags = list(
    "string"
  )
)