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 .
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
import-playback-key-pair
[--name <value>]
--public-key-material <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--name
(string)
Playback-key-pair name. The value does not need to be unique.
--public-key-material
(string)
The public portion of a customer-generated key pair.
--tags
(map)
Any tags provided with the request are added to the playback key pair tags.
key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To import the public portion of a new key pair
The following import-playback-key-pair
example imports the specified public key (specified as a string in PEM format) and returns the arn and fingerprint of the new key pair.
aws ivs import-playback-key-pair \
--name "my-playback-key" \
--public-key-material "G1lbnQxOTA3BgNVBAMMMFdoeSBhcmUgeW91IGRl..."
Output:
{
"keyPair": {
"arn": "arn:aws:ivs:us-west-2:123456789012:playback-key/abcd1234efgh",
"name": "my-playback-key",
"fingerprint": "0a:1b:2c:ab:cd:ef:34:56:70:b1:b2:71:01:2a:a3:72",
"tags": {}
}
}
For more information, see Setting Up Private Channels in the Amazon Interactive Video Service User Guide.
keyPair -> (structure)
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 -> (map)
Array of 1-50 maps, each of the form
string:string (key:value)
.key -> (string)
value -> (string)