ListStreamKeys - Amazon Interactive Video Service

ListStreamKeys

Gets summary information about stream keys for the specified channel.

Request Syntax

POST /ListStreamKeys HTTP/1.1 Content-type: application/json { "channelArn": "string", "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.

channelArn

Channel ARN used to filter the list.

Type: String

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

Pattern: ^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+$

Required: Yes

maxResults

Maximum number of streamKeys to return.

Type: Integer

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

Required: No

nextToken

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

Type: String

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

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "streamKeys": [ { "arn": "string", "channelArn": "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.

nextToken

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

Type: String

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

streamKeys

List of stream keys.

Type: Array of StreamKeySummary objects

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: