StreamSummary - Amazon IVS

StreamSummary

Summary information about a stream.

Contents

channelArn

Channel ARN for the stream.

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: No

health

The stream’s health.

Type: String

Valid Values: HEALTHY | STARVING | UNKNOWN

Required: No

startTime

Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.

Type: Timestamp

Required: No

state

The stream’s state.

Type: String

Valid Values: LIVE | OFFLINE

Required: No

streamId

Unique identifier for a live or previously live stream in the specified channel.

Type: String

Length Constraints: Fixed length of 26.

Pattern: ^st-[a-zA-Z0-9]+$

Required: No

viewerCount

A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.

Type: Long

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: