ImportPlaybackKeyPair - Amazon Interactive Video Service


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 authorized channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

Request Syntax

POST /ImportPlaybackKeyPair HTTP/1.1 Content-type: application/json { "name": "string", "publicKeyMaterial": "string", "tags": { "string" : "string" } }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.


An arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource. The value does not need to be unique.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Pattern: ^[a-zA-Z0-9-_]*$

Required: No


The public portion of a customer-generated key pair.

Type: String

Required: Yes


Any tags provided with the request are added to the playback key pair tags.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "keyPair": { "arn": "string", "fingerprint": "string", "name": "string", "tags": { "string" : "string" } } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


Type: PlaybackKeyPair object


For information about the errors that are common to all actions, see Common Errors.


HTTP Status Code: 403


HTTP Status Code: 409


HTTP Status Code: 403


HTTP Status Code: 402


HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: