Ivs

This page documents function available when using the Ivs module, created with @service Ivs.

Index

Documentation

Main.Ivs.batch_get_channelMethod
batch_get_channel(arns)
batch_get_channel(arns, params::Dict{String,<:Any})

Performs GetChannel on multiple ARNs simultaneously.

Arguments

  • arns: Array of ARNs, one per channel.
Main.Ivs.batch_get_stream_keyMethod
batch_get_stream_key(arns)
batch_get_stream_key(arns, params::Dict{String,<:Any})

Performs GetStreamKey on multiple ARNs simultaneously.

Arguments

  • arns: Array of ARNs, one per stream key.
Main.Ivs.create_channelMethod
create_channel()
create_channel(params::Dict{String,<:Any})

Creates a new channel and an associated stream key to start streaming.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "authorized": Whether the channel is private (enabled for playback authorization). Default: false.
  • "insecureIngest": Whether the channel allows insecure RTMP ingest. Default: false.
  • "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.
  • "name": Channel name.
  • "preset": Optional transcode preset for the channel. This is selectable only for ADVANCEDHD and ADVANCEDSD channel types. For those channel types, the default preset is HIGHERBANDWIDTHDELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
  • "recordingConfigurationArn": Recording-configuration ARN. Default: "" (empty string, recording is disabled).
  • "tags": 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.
  • "type": Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Some types generate multiple qualities (renditions) from the original input; this automatically gives viewers the best experience for their devices and network conditions. Some types provide transcoded video; transcoding allows higher playback quality across a range of download speeds. Default: STANDARD. Valid values: BASIC: Video is transmuxed: Amazon IVS delivers the original input quality to viewers. The viewer’s video-quality choice is limited to the original input. 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. Original audio is passed through. 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 when you create a channel. ADVANCEDSD: Video is transcoded; multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Input resolution can be up to 1080p and bitrate can be up to 8.5 Mbps; output is capped at SD quality (480p). You can select an optional transcode preset (see below). Audio for all renditions is transcoded, and an audio-only rendition is available. ADVANCEDHD: Video is transcoded; multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Input resolution can be up to 1080p and bitrate can be up to 8.5 Mbps; output is capped at HD quality (720p). You can select an optional transcode preset (see below). Audio for all renditions is transcoded, and an audio-only rendition is available. Optional transcode presets (available for the ADVANCED types) allow you to trade off available download bandwidth and video quality, to optimize the viewing experience. There are two presets: Constrained bandwidth delivery uses a lower bitrate for each quality level. Use it if you have low download bandwidth and/or simple video content (e.g., talking heads) Higher bandwidth delivery uses a higher bitrate for each quality level. Use it if you have high download bandwidth and/or complex video content (e.g., flashes and quick scene changes).
Main.Ivs.create_recording_configurationMethod
create_recording_configuration(destination_configuration)
create_recording_configuration(destination_configuration, params::Dict{String,<:Any})

Creates a new recording configuration, used to enable recording to Amazon S3. Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording configuration, it returns success even if the S3 bucket is in a different region. In this case, the state of the recording configuration is CREATE_FAILED (instead of ACTIVE). (In other regions, the CLI correctly returns failure if the bucket is in a different region.) Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region.

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "name": Recording-configuration name. The value does not need to be unique.
  • "recordingReconnectWindowSeconds": 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.
  • "tags": 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.
  • "thumbnailConfiguration": 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.
Main.Ivs.create_stream_keyMethod
create_stream_key(channel_arn)
create_stream_key(channel_arn, params::Dict{String,<:Any})

Creates a stream key, used to initiate a stream, for the specified channel ARN. Note that CreateChannel creates a stream key. If you subsequently use CreateStreamKey on the same channel, it will fail because a stream key already exists and there is a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey and then CreateStreamKey.

Arguments

  • channel_arn: ARN of the channel for which to create the stream key.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "tags": 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.
Main.Ivs.delete_channelMethod
delete_channel(arn)
delete_channel(arn, params::Dict{String,<:Any})

Deletes the specified channel and its associated stream keys. If you try to delete a live channel, you will get an error (409 ConflictException). To delete a channel that is live, call StopStream, wait for the Amazon EventBridge "Stream End" event (to verify that the stream's state is no longer Live), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)

Arguments

  • arn: ARN of the channel to be deleted.
Main.Ivs.delete_playback_key_pairMethod
delete_playback_key_pair(arn)
delete_playback_key_pair(arn, params::Dict{String,<:Any})

Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

Arguments

  • arn: ARN of the key pair to be deleted.
Main.Ivs.delete_recording_configurationMethod
delete_recording_configuration(arn)
delete_recording_configuration(arn, params::Dict{String,<:Any})

Deletes the recording configuration for the specified ARN. If you try to delete a recording configuration that is associated with a channel, you will get an error (409 ConflictException). To avoid this, for all channels that reference the recording configuration, first use UpdateChannel to set the recordingConfigurationArn field to an empty string, then use DeleteRecordingConfiguration.

Arguments

  • arn: ARN of the recording configuration to be deleted.
Main.Ivs.delete_stream_keyMethod
delete_stream_key(arn)
delete_stream_key(arn, params::Dict{String,<:Any})

Deletes the stream key for the specified ARN, so it can no longer be used to stream.

Arguments

  • arn: ARN of the stream key to be deleted.
Main.Ivs.get_channelMethod
get_channel(arn)
get_channel(arn, params::Dict{String,<:Any})

Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.

Arguments

  • arn: ARN of the channel for which the configuration is to be retrieved.
Main.Ivs.get_playback_key_pairMethod
get_playback_key_pair(arn)
get_playback_key_pair(arn, params::Dict{String,<:Any})

Gets a specified playback authorization key pair and returns the arn and fingerprint. The privateKey held by the caller can be used to generate viewer authorization tokens, to grant viewers access to private channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

Arguments

  • arn: ARN of the key pair to be returned.
Main.Ivs.get_recording_configurationMethod
get_recording_configuration(arn)
get_recording_configuration(arn, params::Dict{String,<:Any})

Gets the recording configuration for the specified ARN.

Arguments

  • arn: ARN of the recording configuration to be retrieved.
Main.Ivs.get_streamMethod
get_stream(channel_arn)
get_stream(channel_arn, params::Dict{String,<:Any})

Gets information about the active (live) stream on a specified channel.

Arguments

  • channel_arn: Channel ARN for stream to be accessed.
Main.Ivs.get_stream_keyMethod
get_stream_key(arn)
get_stream_key(arn, params::Dict{String,<:Any})

Gets stream-key information for a specified ARN.

Arguments

  • arn: ARN for the stream key to be retrieved.
Main.Ivs.get_stream_sessionMethod
get_stream_session(channel_arn)
get_stream_session(channel_arn, params::Dict{String,<:Any})

Gets metadata on a specified stream.

Arguments

  • channel_arn: ARN of the channel resource

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "streamId": 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.
Main.Ivs.import_playback_key_pairMethod
import_playback_key_pair(public_key_material)
import_playback_key_pair(public_key_material, params::Dict{String,<:Any})

Imports the public portion of a new key pair and returns its arn and fingerprint. The privateKey can then be used to generate viewer authorization tokens, to grant viewers access to private channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

Arguments

  • public_key_material: The public portion of a customer-generated key pair.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "name": Playback-key-pair name. The value does not need to be unique.
  • "tags": 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.
Main.Ivs.list_channelsMethod
list_channels()
list_channels(params::Dict{String,<:Any})

Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 ConflictException).

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filterByName": Filters the channel list to match the specified name.
  • "filterByRecordingConfigurationArn": Filters the channel list to match the specified recording-configuration ARN.
  • "maxResults": Maximum number of channels to return. Default: 100.
  • "nextToken": The first channel to retrieve. This is used for pagination; see the nextToken response field.
Main.Ivs.list_playback_key_pairsMethod
list_playback_key_pairs()
list_playback_key_pairs(params::Dict{String,<:Any})

Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": Maximum number of key pairs to return. Default: your service quota or 100, whichever is smaller.
  • "nextToken": The first key pair to retrieve. This is used for pagination; see the nextToken response field.
Main.Ivs.list_recording_configurationsMethod
list_recording_configurations()
list_recording_configurations(params::Dict{String,<:Any})

Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": Maximum number of recording configurations to return. Default: your service quota or 100, whichever is smaller.
  • "nextToken": The first recording configuration to retrieve. This is used for pagination; see the nextToken response field.
Main.Ivs.list_stream_keysMethod
list_stream_keys(channel_arn)
list_stream_keys(channel_arn, params::Dict{String,<:Any})

Gets summary information about stream keys for the specified channel.

Arguments

  • channel_arn: Channel ARN used to filter the list.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": Maximum number of streamKeys to return. Default: 1.
  • "nextToken": The first stream key to retrieve. This is used for pagination; see the nextToken response field.
Main.Ivs.list_stream_sessionsMethod
list_stream_sessions(channel_arn)
list_stream_sessions(channel_arn, params::Dict{String,<:Any})

Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.

Arguments

  • channel_arn: Channel ARN used to filter the list.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": Maximum number of streams to return. Default: 100.
  • "nextToken": The first stream to retrieve. This is used for pagination; see the nextToken response field.
Main.Ivs.list_streamsMethod
list_streams()
list_streams(params::Dict{String,<:Any})

Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filterBy": Filters the stream list to match the specified criterion.
  • "maxResults": Maximum number of streams to return. Default: 100.
  • "nextToken": The first stream to retrieve. This is used for pagination; see the nextToken response field.
Main.Ivs.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Gets information about Amazon Web Services tags for the specified ARN.

Arguments

  • resource_arn: The ARN of the resource to be retrieved. The ARN must be URL-encoded.
Main.Ivs.put_metadataMethod
put_metadata(channel_arn, metadata)
put_metadata(channel_arn, metadata, params::Dict{String,<:Any})

Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed. Also see Embedding Metadata within a Video Stream in the Amazon IVS User Guide.

Arguments

  • channel_arn: ARN of the channel into which metadata is inserted. This channel must have an active stream.
  • metadata: Metadata to insert into the stream. Maximum: 1 KB per request.
Main.Ivs.stop_streamMethod
stop_stream(channel_arn)
stop_stream(channel_arn, params::Dict{String,<:Any})

Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel. Many streaming client-software libraries automatically reconnect a dropped RTMPS session, so to stop the stream permanently, you may want to first revoke the streamKey attached to the channel.

Arguments

  • channel_arn: ARN of the channel for which the stream is to be stopped.
Main.Ivs.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Adds or updates tags for the Amazon Web Services resource with the specified ARN.

Arguments

  • resource_arn: ARN of the resource for which tags are to be added or updated. The ARN must be URL-encoded.
  • tags: Array of tags to be added or updated. Array of 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.
Main.Ivs.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes tags from the resource with the specified ARN.

Arguments

  • resource_arn: ARN of the resource for which tags are to be removed. The ARN must be URL-encoded.
  • tag_keys: Array of tags to be removed. Array of 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.
Main.Ivs.update_channelMethod
update_channel(arn)
update_channel(arn, params::Dict{String,<:Any})

Updates a channel's configuration. Live channels cannot be updated. You must stop the ongoing stream, update the channel, and restart the stream for the changes to take effect.

Arguments

  • arn: ARN of the channel to be updated.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "authorized": Whether the channel is private (enabled for playback authorization).
  • "insecureIngest": Whether the channel allows insecure RTMP ingest. Default: false.
  • "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.)
  • "name": Channel name.
  • "preset": Optional transcode preset for the channel. This is selectable only for ADVANCEDHD and ADVANCEDSD channel types. For those channel types, the default preset is HIGHERBANDWIDTHDELIVERY. For other channel types (BASIC and STANDARD), preset is the empty 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
  • "type": Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Some types generate multiple qualities (renditions) from the original input; this automatically gives viewers the best experience for their devices and network conditions. Some types provide transcoded video; transcoding allows higher playback quality across a range of download speeds. Default: STANDARD. Valid values: BASIC: Video is transmuxed: Amazon IVS delivers the original input quality to viewers. The viewer’s video-quality choice is limited to the original input. 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. Original audio is passed through. 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 when you create a channel. ADVANCEDSD: Video is transcoded; multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Input resolution can be up to 1080p and bitrate can be up to 8.5 Mbps; output is capped at SD quality (480p). You can select an optional transcode preset (see below). Audio for all renditions is transcoded, and an audio-only rendition is available. ADVANCEDHD: Video is transcoded; multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Input resolution can be up to 1080p and bitrate can be up to 8.5 Mbps; output is capped at HD quality (720p). You can select an optional transcode preset (see below). Audio for all renditions is transcoded, and an audio-only rendition is available. Optional transcode presets (available for the ADVANCED types) allow you to trade off available download bandwidth and video quality, to optimize the viewing experience. There are two presets: Constrained bandwidth delivery uses a lower bitrate for each quality level. Use it if you have low download bandwidth and/or simple video content (e.g., talking heads) Higher bandwidth delivery uses a higher bitrate for each quality level. Use it if you have high download bandwidth and/or complex video content (e.g., flashes and quick scene changes).