Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

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:ivs:[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": "string",
      "state": "string",
      "streamId": "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

exceptionMessage: User does not have sufficient access to perform this action.

HTTP Status Code: 403

ChannelNotBroadcasting

exceptionMessage: The stream is offline for the given channel ARN.

HTTP Status Code: 404

ResourceNotFoundException

exceptionMessage: Request references a resource which does not exist.

HTTP Status Code: 404

ValidationException

exceptionMessage: The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400