String exceptionMessage
User does not have sufficient access to perform this action.
String arn
Channel ARN.
String name
Channel name.
String latencyMode
Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use
LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS
console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
String type
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or
bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:
STANDARD: Multiple qualities are generated from the original input, to automatically give viewers
the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate
can be up to 8.5 Mbps.
BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is
limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.
String recordingConfigurationArn
Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).
String ingestEndpoint
Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
String playbackUrl
Channel playback URL.
Boolean authorized
Whether the channel is private (enabled for playback authorization). Default: false.
Map<K,V> tags
Array of 1-50 maps, each of the form string:string (key:value).
String exceptionMessage
The stream is offline for the given channel ARN.
String arn
Channel ARN.
String name
Channel name.
String latencyMode
Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use
LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS
console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
Boolean authorized
Whether the channel is private (enabled for playback authorization). Default: false.
String recordingConfigurationArn
Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).
Map<K,V> tags
Array of 1-50 maps, each of the form string:string (key:value).
String exceptionMessage
Updating or deleting a resource can cause an inconsistent state.
String name
Channel name.
String latencyMode
Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use
LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console, LOW
and NORMAL correspond to Ultra-low and Standard, respectively.) Default: LOW.
String type
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or
bitrate, the stream probably will disconnect immediately. Default: STANDARD. Valid values:
STANDARD: Multiple qualities are generated from the original input, to automatically give viewers
the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate
can be up to 8.5 Mbps.
BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is
limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.
Boolean authorized
Whether the channel is private (enabled for playback authorization). Default: false.
String recordingConfigurationArn
Recording-configuration ARN. Default: "" (empty string, recording is disabled).
Map<K,V> tags
Array of 1-50 maps, each of the form string:string (key:value).
String name
An arbitrary string (a nickname) that helps the customer identify that resource. The value does not need to be unique.
DestinationConfiguration destinationConfiguration
A complex type that contains a destination configuration for where recorded video will be stored.
Map<K,V> tags
Array of 1-50 maps, each of the form string:string (key:value).
RecordingConfiguration recordingConfiguration
StreamKey streamKey
Stream key used to authenticate an RTMPS stream for ingestion.
String arn
ARN of the channel to be deleted.
String arn
ARN of the key pair to be deleted.
String arn
ARN of the recording configuration to be deleted.
String arn
ARN of the stream key to be deleted.
S3DestinationConfiguration s3
An S3 destination configuration where recorded videos will be stored.
String arn
ARN of the channel for which the configuration is to be retrieved.
Channel channel
String arn
ARN of the key pair to be returned.
PlaybackKeyPair keyPair
String arn
ARN of the recording configuration to be retrieved.
RecordingConfiguration recordingConfiguration
String arn
ARN for the stream key to be retrieved.
StreamKey streamKey
String channelArn
Channel ARN for stream to be accessed.
Stream stream
String publicKeyMaterial
The public portion of a customer-generated key pair.
String name
An arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource. The value does not need to be unique.
Map<K,V> tags
Any tags provided with the request are added to the playback key pair tags.
PlaybackKeyPair keyPair
String exceptionMessage
Unexpected error during processing of request.
String filterByName
Filters the channel list to match the specified name.
String filterByRecordingConfigurationArn
Filters the channel list to match the specified recording-configuration ARN.
String nextToken
The first channel to retrieve. This is used for pagination; see the nextToken response field.
Integer maxResults
Maximum number of channels to return. Default: 50.
String exceptionMessage
Your account is pending verification.
String arn
Key-pair ARN.
String name
An arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource. The value does not need to be unique.
String fingerprint
Key-pair identifier.
Map<K,V> tags
Array of 1-50 maps, each of the form string:string (key:value).
String arn
Recording-configuration ARN.
String name
An arbitrary string (a nickname) assigned to a recording configuration that helps the customer identify that resource. The value does not need to be unique.
DestinationConfiguration destinationConfiguration
A complex type that contains information about where recorded video will be stored.
String state
Indicates the current state of the recording configuration. When the state is ACTIVE, the
configuration is ready for recording a channel stream.
Map<K,V> tags
Array of 1-50 maps, each of the form string:string (key:value).
String arn
Recording-configuration ARN.
String name
An arbitrary string (a nickname) assigned to a recording configuration that helps the customer identify that resource. The value does not need to be unique.
DestinationConfiguration destinationConfiguration
A complex type that contains information about where recorded video will be stored.
String state
Indicates the current state of the recording configuration. When the state is ACTIVE, the
configuration is ready for recording a channel stream.
Map<K,V> tags
Array of 1-50 maps, each of the form string:string (key:value).
String exceptionMessage
Request references a resource which does not exist.
String bucketName
Location (S3 bucket name) where recorded videos will be stored.
String exceptionMessage
Request would cause a service quota to be exceeded.
String channelArn
ARN of the channel for which the stream is to be stopped.
String channelArn
Channel ARN for the stream.
String playbackUrl
URL of the master playlist, required by the video player to play the HLS stream.
Date startTime
ISO-8601 formatted timestamp of the stream’s start.
String state
The stream’s state.
String health
The stream’s health.
Long viewerCount
Number of current viewers of the stream. A value of -1 indicates that the request timed out; in this case, retry.
String channelArn
Channel ARN for the stream.
String state
The stream’s state.
String health
The stream’s health.
Long viewerCount
Number of current viewers of the stream. A value of -1 indicates that the request timed out; in this case, retry.
Date startTime
ISO-8601 formatted timestamp of the stream’s start.
String exceptionMessage
The stream is temporarily unavailable.
String exceptionMessage
Request was denied due to request throttling.
String arn
ARN of the channel to be updated.
String name
Channel name.
String latencyMode
Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use
LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console, LOW
and NORMAL correspond to Ultra-low and Standard, respectively.)
String type
Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values:
STANDARD: Multiple qualities are generated from the original input, to automatically give viewers
the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate
can be up to 8.5 Mbps.
BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is
limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.
Boolean authorized
Whether the channel is private (enabled for playback authorization).
String recordingConfigurationArn
Recording-configuration ARN. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled
Channel channel
String exceptionMessage
The input fails to satisfy the constraints specified by an AWS service.
Copyright © 2021. All rights reserved.