Array of ARNs, one per channel.

Each error object is related to a specific ARN in the request.

The response's http status code.

Array of ARNs, one per channel.

The response's http status code.

Whether the channel is private (enabled for playback authorization). Default: false.

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.

Channel name.

Recording-configuration ARN. Default: "" (empty string, recording is disabled).

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

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: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. 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. This is the default.
• BASIC: Video is transmuxed: 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 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

The response's http status code.

Recording-configuration name. The value does not need to be unique.

If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

A complex type that contains a destination configuration for where recorded video will be stored.

The response's http status code.

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

ARN of the channel for which to create the stream key.

Stream key used to authenticate an RTMPS stream for ingestion.

The response's http status code.

ARN of the channel to be deleted.

ARN of the key pair to be deleted.

The response's http status code.

ARN of the recording configuration to be deleted.

ARN of the stream key to be deleted.

ARN of the channel for which the configuration is to be retrieved.

The response's http status code.

ARN of the key pair to be returned.

The response's http status code.

ARN of the recording configuration to be retrieved.

The response's http status code.

Channel ARN for stream to be accessed.

The response's http status code.

ARN for the stream key to be retrieved.

The response's http status code.

Unique identifier for a live or previously live stream in the specified channel. If no streamId is provided, this returns the most recent stream session for the channel, if it exists.

ARN of the channel resource

List of stream details.

The response's http status code.

Playback-key-pair name. The value does not need to be unique.

Any tags provided with the request are added to the playback key pair tags. See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

The public portion of a customer-generated key pair.

The response's http status code.

Filters the channel list to match the specified name.

Filters the channel list to match the specified recording-configuration ARN.

Maximum number of channels to return. Default: 100.

The first channel to retrieve. This is used for pagination; see the nextToken response field.

If there are more channels than maxResults, use nextToken in the request to get the next set.

The response's http status code.

List of the matching channels.

Maximum number of key pairs to return. Default: your service quota or 100, whichever is smaller.

The first key pair to retrieve. This is used for pagination; see the nextToken response field.

If there are more key pairs than maxResults, use nextToken in the request to get the next set.

The response's http status code.

List of key pairs.

Maximum number of recording configurations to return. Default: your service quota or 100, whichever is smaller.

The first recording configuration to retrieve. This is used for pagination; see the nextToken response field.

If there are more recording configurations than maxResults, use nextToken in the request to get the next set.

The response's http status code.

List of the matching recording configurations.

Maximum number of streamKeys to return. Default: 1.

The first stream key to retrieve. This is used for pagination; see the nextToken response field.

Channel ARN used to filter the list.

If there are more stream keys than maxResults, use nextToken in the request to get the next set.

The response's http status code.

List of stream keys.

Maximum number of streams to return. Default: 100.

The first stream to retrieve. This is used for pagination; see the nextToken response field.

Channel ARN used to filter the list.

If there are more streams than maxResults, use nextToken in the request to get the next set.

The response's http status code.

List of stream sessions.

Filters the stream list to match the specified criterion.

Maximum number of streams to return. Default: 100.

The first stream to retrieve. This is used for pagination; see the nextToken response field.

If there are more streams than maxResults, use nextToken in the request to get the next set.

The response's http status code.

List of streams.

The ARN of the resource to be retrieved. The ARN must be URL-encoded.

The response's http status code.

ARN of the channel into which metadata is inserted. This channel must have an active stream.

Metadata to insert into the stream. Maximum: 1 KB per request.

ARN of the channel for which the stream is to be stopped.

The response's http status code.

ARN of the resource for which tags are to be added or updated. The ARN must be URL-encoded.

Array of tags to be added or updated. See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

The response's http status code.

ARN of the resource for which tags are to be removed. The ARN must be URL-encoded.

Array of tags to be removed. See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

The response's http status code.

Whether the channel is private (enabled for playback authorization).

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.)

Channel name.

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 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: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. 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. This is the default.
• BASIC: Video is transmuxed: 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 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

ARN of the channel to be updated.

Undocumented member.

The response's http status code.

Number of audio channels.

Codec used for the audio encoding.

Number of audio samples recorded per second.

The expected ingest bitrate (bits per second). This is configured in the encoder.

Channel ARN.

Error code.

Error message, determined by the application.

Channel ARN.

Whether the channel is private (enabled for playback authorization). Default: false.

Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

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.)

Channel name.

Channel playback URL.

Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

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: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. 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. This is the default.
• BASIC: Video is transmuxed: 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 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

Channel ARN.

Whether the channel is private (enabled for playback authorization). Default: false.

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.)

Channel name.

Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

An S3 destination configuration where recorded videos will be stored.

Encoder settings for audio.

Encoder settings for video.

Key-pair ARN.

Key-pair identifier.

Playback-key-pair name. The value does not need to be unique.

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

Key-pair ARN.

Playback-key-pair name. The value does not need to be unique.

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

Recording-configuration name. The value does not need to be unique.

If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

Recording-configuration ARN.

A complex type that contains information about where recorded video will be stored.

Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

Recording-configuration name. The value does not need to be unique.

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

Recording-configuration ARN.

A complex type that contains information about where recorded video will be stored.

Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

Location (S3 bucket name) where recorded videos will be stored.

Channel ARN for the stream.

The stream’s health.

URL of the master playlist, required by the video player to play the HLS stream.

Time of the stream’s start. This is an ISO 8601 timestamp; /note that this is returned as a string/.

The stream’s state.

Unique identifier for a live or previously live stream in the specified channel.

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.

Time when the event occurred. This is an ISO 8601 timestamp; /note that this is returned as a string/.

Name that identifies the stream event within a type.

Logical group for certain events.

The stream’s health.

Stream-key ARN.

Channel ARN for the stream.

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

Stream-key value.

Stream-key ARN.

Channel ARN for the stream.

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

The properties of the channel at the time of going live.

Time when the channel went offline. This is an ISO 8601 timestamp; /note that this is returned as a string/. For live streams, this is NULL.

The properties of the incoming RTMP stream for the stream.

The properties of recording the live stream.

Time when the channel went live. This is an ISO 8601 timestamp; /note that this is returned as a string/.

Unique identifier for a live or previously live stream in the specified channel.

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.

Time when the channel went offline. This is an ISO 8601 timestamp; /note that this is returned as a string/. For live streams, this is NULL.

If true, this stream encountered a quota breach or failure.

Time when the channel went live. This is an ISO 8601 timestamp; /note that this is returned as a string/.

Unique identifier for a live or previously live stream in the specified channel.

Channel ARN for the stream.

The stream’s health.

Time of the stream’s start. This is an ISO 8601 timestamp; /note that this is returned as a string/.

The stream’s state.

Unique identifier for a live or previously live stream in the specified channel.

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.

Thumbnail recording mode. Default: INTERVAL.

The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.

Important: Setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.

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.

Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification.

Codec used for the video encoding.

Software or hardware used to encode the video.

The expected ingest bitrate (bits per second). This is configured in the encoder.

The expected ingest framerate. This is configured in the encoder.

Video-resolution height in pixels.

Video-resolution width in pixels.