GetPlaybackKeyPair
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.
Request Syntax
POST /GetPlaybackKeyPair HTTP/1.1
Content-type: application/json
{
"arn": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- arn
-
ARN of the key pair to be returned.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
arn:aws:ivs:[a-z0-9-]+:[0-9]+:playback-key/[a-zA-Z0-9-]+
Required: Yes
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.
- keyPair
-
A key pair used to sign and validate a playback authorization token.
Type: PlaybackKeyPair object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
HTTP Status Code: 403
- ResourceNotFoundException
-
HTTP Status Code: 404
- ValidationException
-
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: