AWS IVS Service Tables

The AWS IVS Service uses the following tables

Tables

AWSIVSAudioConfigurations

NameTypeDescription
AWSIVSStreamSessionConfigIDintegerUnique identifier for the IVS stream session's configuration record related to audio settings.
ConfigIDintegerIdentifier linking this record to a specific configuration context or ingestion batch.
ChannelsbigintNumber of audio channels (e.g., 1 for mono, 2 for stereo) used in the stream.
CodecstringAudio codec used for encoding the audio stream, such as AAC.
SampleRatebigintThe sampling rate (in Hz) used for the audio stream (e.g., 44100 or 48000).
TargetBitratebigintTarget bitrate for the audio stream in bits per second (bps), indicating the desired audio quality and compression level.
TrackstringAudio track label or designation, often used for identifying language or purpose (e.g., main, commentary, es).
BatchDatedatetimeThe date when the audio configuration data was recorded or ingested.
AWSIVSStreamSessionIDintegerIdentifier of the associated IVS stream session this audio configuration applies to.
IDintegerA unique ID for this audio configuration record in the data system.

AWSIVSChannels

NameTypeDescription
ARNstringThe Amazon Resource Name that uniquely identifies the IVS channel.
ConfigIDintegerIdentifier linking this channel to a specific configuration or context in your system.
AuthorizedbitBoolean value indicating whether the channel requires a playback token to view the stream (true for private channels).
ContainerFormatstringThe container format used for the stream, typically FLV for IVS.
IngestEndpointstringThe endpoint where video is sent for ingestion into the IVS service.
InsecureIngestbitBoolean indicating whether insecure ingest (without TLS) is enabled for the channel.
LatencyModestringSpecifies the latency mode for the channel, such as NORMAL or LOW.
MultitrackInputEnabledbitBoolean indicating whether the channel supports multi-track input (e.g., multiple audio tracks or camera angles).
MultitrackInputMaximumResolutionstringThe maximum allowed resolution for multitrack input, such as 1080p of 720p
MultitrackInputPolicystringThe policy determining how multitrack inputs are handled (e.g., how audio/video inputs are prioritized or selected).
NamestringName of the IVS channel for easier identification.
PlaybackURLstringURL used for viewing the live stream associated with the channel.
PresetstringChannel preset configuration that controls default bitrate, resolution, and latency mode (e.g., HIGHER_BANDWIDTH_DELIVERY).
SRTEndpointstringThe SRT (Secure Reliable Transport) ingest endpoint, if SRT ingest is enabled for this channel.
SRTPassphrasestringPassphrase required to authenticate SRT ingest.
TypestringType of the IVS channel, such as STANDARD or BASIC, determining stream quality and limits.
BatchDatedatetimeThe date when this channel data was collected or ingested.
PlaybackRestrictionPolicyARNstringARN of the playback restriction policy associated with the channel, if any.
RecordingConfigurationARNstringARN of the recording configuration attached to the channel for automatic recording of streams.

AWSIVSStreamEvents

NameTypeDescription
AWSIVSStreamSessionConfigIDintegerIdentifier linking the event to a specific IVS stream session configuration.
ConfigIDintegerIdentifier for the configuration or ingestion batch in which the event was recorded.
CodestringThe event code representing the type of event (e.g., StreamStart, StreamEnd, Error, etc.).
EventTimedatetimeThe timestamp (in ISO 8601 format) when the event occurred.
NamestringA human-readable name or label for the event.
TypestringThe category or classification of the event, such as INFO, WARNING, or ERROR.
BatchDatedatetimeThe date on which this stream event data was collected or processed.
AWSIVSStreamSessionIDintegerThe ID of the associated stream session in which the event took place.
IDintegerA unique identifier for the stream event record in your system.

AWSIVSStreams

NameTypeDescription
AWSIVSChannelARNstringThe ARN of the IVS channel associated with the stream.
ConfigIDintegerIdentifier linking this stream to a specific configuration or ingestion context.
HealthstringThe health status of the stream (e.g., HEALTHY, STARVING, DOWN) indicating ingest and playback conditions.
PlaybackURLstringThe URL that viewers can use to watch the live stream.
StartTimedatetimeThe timestamp (in ISO 8601 format) when the stream started.
StatestringThe current state of the stream, such as LIVE or OFFLINE.
ViewerCountbigintThe number of concurrent viewers currently watching the stream.
BatchDatedatetimeThe date on which this stream data was collected or processed.
IDstringA unique identifier for the stream record in your internal system.

AWSIVSStreamSessions

NameTypeDescription
AWSIVSStreamConfigIDintegerIdentifier linking the session to a specific stream configuration.
AWSIVSChannelARNstringARN of the IVS channel associated with this stream session.
ConfigIDintegerIdentifier representing the ingestion or configuration context.
EndTimedatetimeTimestamp (ISO 8601) when the stream session ended.
RecordingConfigurationDestinationS3BucketNamestringName of the Amazon S3 bucket where the recorded video is stored.
RecordingConfigurationNamestringThe user-defined name of the recording configuration used for this session.
RecordingConfigurationRecordingReconnectWindowSecondsintegerDuration (in seconds) within which the stream can reconnect without starting a new recording.
RenditionsJsonstringJSON structure listing the available stream renditions (resolutions/bitrates).
RecordingConfigurationStatestringStatus of the recording configuration at the time of the stream session (e.g., ACTIVE, INACTIVE).
RenditionSelectionstringSelection strategy for renditions recorded, such as ALL, HIGHER, or LOWER.
ThumbnailRecordingModestringWhether thumbnails are recorded during the stream, such as DISABLED or INTERVAL.
ThumbnailResolutionstringResolution setting for thumbnails (e.g., LOW, MEDIUM, HIGH).
ThumbnailStorageJsonstringJSON structure containing information about where and how thumbnails are stored.
ThumbnailTargetIntervalSecondsbigintInterval (in seconds) at which thumbnails are generated.
StartTimedatetimeTimestamp (ISO 8601) when the stream session started.
BatchDatedatetimeDate when the session data was ingested or processed.
AWSIVSStreamIDstringIdentifier linking to the stream associated with this session.
IDintegerA unique internal identifier for the stream session record.
RecordingConfigurationARNstringARN of the recording configuration applied to this session.

AWSIVSVideoConfigurations

NameTypeDescription
AWSIVSStreamSessionConfigIDintegerIdentifier linking the video configuration to a specific stream session configuration.
ConfigIDintegerIdentifier representing the configuration context for the IVS resource.
AvcLevelstringH.264 Advanced Video Coding (AVC) level used for encoding (e.g., 4.1, 5.0).
AvcProfilestringH.264 AVC profile used for encoding (e.g., Baseline, Main, High).
CodecstringCodec used for encoding the video (typically H.264).
EncoderstringSoftware or hardware encoder used in the video stream.
LevelstringCodec-specific level indicating processing complexity or capability (can mirror AvcLevel).
ProfilestringCodec-specific profile used in video encoding (can mirror AvcProfile).
TargetBitratebigintTarget bitrate for the video stream, in bits per second.
TargetFrameratebigintTarget frame rate for the video stream, in frames per second (fps).
TrackstringName or type of the media track (e.g., video, main, etc.).
BatchDatedatetimeThe date when the configuration data was collected or processed.
AWSIVSStreamSessionIDintegerUnique identifier for the stream session associated with this video configuration.
IDintegerUnique identifier for this specific video configuration record.
VideoHeightbigintHeight of the video resolution in pixels.
VideoWidthbigintWidth of the video resolution in pixels.

Did this page help you?