ChannelSummary
Summary information about a channel.
Contents
- arn
-
Channel ARN.
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
- authorized
-
Whether the channel is authorized. Default:
false
Type: Boolean
Required: No
- latencyMode
-
Channel latency mode. Use
NORMAL
to broadcast and deliver live video up to Full HD. UseLOW
for near-real-time interaction with viewers. Default:LOW
. (Note: In the Amazon IVS console,LOW
andNORMAL
correspond to Ultra-low and Standard, respectively.)Type: String
Valid Values:
NORMAL | LOW
Required: No
- name
-
Channel name.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern:
^[a-zA-Z0-9-_]*$
Required: No
- tags
-
Array of 1-50 maps, each of the form
string:string (key:value)
.Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Maximum length of 256.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: