Skip to content

/AWS1/CL_IVS=>IMPORTPLAYBACKKEYPAIR()

About ImportPlaybackKeyPair

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.

Method Signature

IMPORTING

Required arguments:

IV_PUBLICKEYMATERIAL TYPE /AWS1/IVSPLAYBACKPUBKEYMATER00 /AWS1/IVSPLAYBACKPUBKEYMATER00

The public portion of a customer-generated key pair.

Optional arguments:

IV_NAME TYPE /AWS1/IVSPLAYBACKKEYPAIRNAME /AWS1/IVSPLAYBACKKEYPAIRNAME

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

IT_TAGS TYPE /AWS1/CL_IVSTAGS_W=>TT_TAGS TT_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.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_IVSIMPPLAYBACKKEYPA01 /AWS1/CL_IVSIMPPLAYBACKKEYPA01