ListPlaybackKeyPairs - Amazon Interactive Video Service

ListPlaybackKeyPairs

Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

Request Syntax

POST /ListPlaybackKeyPairs HTTP/1.1 Content-type: application/json { "maxResults": number, "nextToken": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

maxResults

The first key pair to retrieve. This is used for pagination; see the nextToken response field.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

nextToken

Maximum number of key pairs to return.

Type: String

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

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "keyPairs": [ { "arn": "string", "name": "string", "tags": { "string" : "string" } } ], "nextToken": "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.

keyPairs

List of key pairs.

Type: Array of PlaybackKeyPairSummary objects

nextToken

If there are more key pairs than maxResults, use nextToken in the request to get the next set.

Type: String

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

Errors

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

AccessDeniedException

HTTP Status Code: 403

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: