String exceptionMessage
User does not have sufficient access to perform this action.
String arn
Channel ARN.
Boolean authorized
Whether the channel is private (enabled for playback authorization). Default: false.
String ingestEndpoint
Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
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 name
Channel name.
String playbackUrl
Channel playback URL.
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 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. Resolution can be up to 1080p and bitrate can be up
to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.
BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is
limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
String exceptionMessage
The stream is offline for the given channel ARN.
String arn
Channel ARN.
Boolean authorized
Whether the channel is private (enabled for playback authorization). Default: false.
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 name
Channel name.
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.
Boolean authorized
Whether the channel is private (enabled for playback authorization). Default: false.
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 name
Channel name.
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 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. Resolution can be up to 1080p and bitrate can be up
to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.
BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is
limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
DestinationConfiguration destinationConfiguration
A complex type that contains a destination configuration for where recorded video will be stored.
String name
Recording-configuration name. The value does not need to be unique.
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
StreamSession streamSession
List of stream details.
PlaybackKeyPair keyPair
AudioConfiguration audio
Encoder settings for audio.
VideoConfiguration video
Encoder settings for video.
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.
Integer maxResults
Maximum number of channels to return. Default: 50.
String nextToken
The first channel to retrieve. This is used for pagination; see the nextToken response field.
StreamFilters filterBy
Filters the stream list to match the specified criterion.
Integer maxResults
Maximum number of streams to return. Default: 50.
String nextToken
The first stream to retrieve. This is used for pagination; see the nextToken response field.
String resourceArn
The ARN of the resource to be retrieved.
String exceptionMessage
Your account is pending verification.
String arn
Recording-configuration ARN.
DestinationConfiguration destinationConfiguration
A complex type that contains information about where recorded video will be stored.
String name
Recording-configuration name. The value does not need to be unique.
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.
DestinationConfiguration destinationConfiguration
A complex type that contains information about where recorded video will be stored.
String name
Recording-configuration name. The value does not need to be unique.
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 health
The stream’s health.
String playbackUrl
URL of the master playlist, required by the video player to play the HLS stream.
Date startTime
Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.
String state
The stream’s state.
String streamId
Unique identifier for a live or previously live stream in the specified channel.
Long 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.
String health
The stream’s health.
Channel channel
The properties of the channel at the time of going live.
Date endTime
UTC ISO-8601 formatted timestamp of when the channel went offline. For live streams, this is NULL.
IngestConfiguration ingestConfiguration
The properties of the incoming RTMP stream for the stream.
RecordingConfiguration recordingConfiguration
The properties of recording the live stream.
Date startTime
UTC ISO-8601 formatted timestamp of when the channel went live.
String streamId
Unique identifier for a live or previously live stream in the specified channel.
List<E> truncatedEvents
List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.
Date endTime
UTC ISO-8601 formatted timestamp of when the channel went offline. For live streams, this is NULL.
Boolean hasErrorEvent
If true, this stream encountered a quota breach or failure.
Date startTime
UTC ISO-8601 formatted timestamp of when the channel went live.
String streamId
Unique identifier for a live or previously live stream in the specified channel.
String channelArn
Channel ARN for the stream.
String health
The stream’s health.
Date startTime
Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.
String state
The stream’s state.
String streamId
Unique identifier for a live or previously live stream in the specified channel.
Long 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.
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.
Boolean authorized
Whether the channel is private (enabled for playback authorization).
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 name
Channel name.
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
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. Resolution can be up to 1080p and bitrate can be up
to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.
BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is
limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
Channel channel
String exceptionMessage
The input fails to satisfy the constraints specified by an Amazon Web Services service.
String avcLevel
Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. For details, see the H.264 specification.
String avcProfile
Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification.
String codec
Codec used for the video encoding.
String encoder
Software or hardware used to encode the video.
Long targetBitrate
The expected ingest bitrate (bits per second). This is configured in the encoder.
Long targetFramerate
The expected ingest framerate. This is configured in the encoder.
Long videoHeight
Video-resolution height in pixels.
Long videoWidth
Video-resolution width in pixels.
Copyright © 2022. All rights reserved.