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:ivs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+Required: No
- health
-
The stream’s health.
Type: String
Valid Values:
HEALTHY | STARVING | UNKNOWNRequired: No
- startTime
-
Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.
Type: Timestamp
Required: No
- state
-
The stream’s state. Do not rely on the
OFFLINEstate, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.Type: String
Valid Values:
LIVE | OFFLINERequired: 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
viewerCountwithin 15 seconds of when video playback starts and a view is removed fromviewerCountwithin 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:
