GetStream - Amazon Interactive Video Service

GetStream

Gets information about the active (live) stream on a specified channel.

Request Syntax

POST /GetStream HTTP/1.1 Content-type: application/json { "channelArn": "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 for stream to be accessed.

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

Response Syntax

HTTP/1.1 200 Content-type: application/json { "stream": { "channelArn": "string", "health": "string", "playbackUrl": "string", "startTime": number, "state": "string", "viewerCount": number } }

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.

stream

Type: Stream object

Errors

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

AccessDeniedException

HTTP Status Code: 403

ChannelNotBroadcasting

HTTP Status Code: 404

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: