Ivs
This page documents function available when using the Ivs module, created with @service Ivs.
Index
Main.Ivs.batch_get_channelMain.Ivs.batch_get_stream_keyMain.Ivs.create_channelMain.Ivs.create_stream_keyMain.Ivs.delete_channelMain.Ivs.delete_playback_key_pairMain.Ivs.delete_stream_keyMain.Ivs.get_channelMain.Ivs.get_playback_key_pairMain.Ivs.get_streamMain.Ivs.get_stream_keyMain.Ivs.import_playback_key_pairMain.Ivs.list_channelsMain.Ivs.list_playback_key_pairsMain.Ivs.list_stream_keysMain.Ivs.list_streamsMain.Ivs.list_tags_for_resourceMain.Ivs.put_metadataMain.Ivs.stop_streamMain.Ivs.tag_resourceMain.Ivs.untag_resourceMain.Ivs.update_channel
Documentation
Main.Ivs.batch_get_channel — Methodbatch_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_key — Methodbatch_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 channel.
Main.Ivs.create_channel — Methodcreate_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 authorized. Default: false."latencyMode": Channel latency mode. Default: LOW."name": Channel name."tags": See Channeltags."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. Default: STANDARD.
Main.Ivs.create_stream_key — Methodcreate_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": See Channeltags.
Main.Ivs.delete_channel — Methoddelete_channel(arn)
delete_channel(arn, params::Dict{String,<:Any})Deletes the specified channel and its associated stream keys.
Arguments
arn: ARN of the channel to be deleted.
Main.Ivs.delete_playback_key_pair — Methoddelete_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.
Arguments
arn: ARN of the key pair to be deleted.
Main.Ivs.delete_stream_key — Methoddelete_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_channel — Methodget_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_pair — Methodget_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 authorized channels.
Arguments
arn: ARN of the key pair to be returned.
Main.Ivs.get_stream — Methodget_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_key — Methodget_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.import_playback_key_pair — Methodimport_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 authorized channels.
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": 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."tags": Any tags provided with the request are added to the playback key pair tags.
Main.Ivs.list_channels — Methodlist_channels()
list_channels(params::Dict{String,<:Any})Gets summary information about all channels in your account, in the AWS region where the API request is processed. This list can be filtered to match a specified string.
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."maxResults": Maximum number of channels to return."nextToken": The first channel to retrieve. This is used for pagination; see the nextToken response field.
Main.Ivs.list_playback_key_pairs — Methodlist_playback_key_pairs()
list_playback_key_pairs(params::Dict{String,<:Any})Gets summary information about playback key pairs.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The first key pair to retrieve. This is used for pagination; see the nextToken response field."nextToken": Maximum number of key pairs to return.
Main.Ivs.list_stream_keys — Methodlist_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."nextToken": The first stream key to retrieve. This is used for pagination; see the nextToken response field.
Main.Ivs.list_streams — Methodlist_streams()
list_streams(params::Dict{String,<:Any})Gets summary information about live streams in your account, in the AWS 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 streams to return."nextToken": The first stream to retrieve. This is used for pagination; see the nextToken response field.
Main.Ivs.list_tags_for_resource — Methodlist_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})Gets information about AWS tags for the specified ARN.
Arguments
resource_arn: The ARN of the resource to be retrieved.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": Maximum number of tags to return."nextToken": The first tag to retrieve. This is used for pagination; see the nextToken response field.
Main.Ivs.put_metadata — Methodput_metadata(channel_arn, metadata)
put_metadata(channel_arn, metadata, params::Dict{String,<:Any})Inserts metadata into an RTMPS stream for the specified channel. A maximum of 5 requests per second per channel is allowed, each with a maximum 1KB payload.
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_stream — Methodstop_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_resource — Methodtag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})Adds or updates tags for the AWS resource with the specified ARN.
Arguments
resource_arn: ARN of the resource for which tags are to be added or updated.tags: Array of tags to be added or updated.
Main.Ivs.untag_resource — Methoduntag_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.tag_keys: Array of tags to be removed.
Main.Ivs.update_channel — Methodupdate_channel(arn)
update_channel(arn, params::Dict{String,<:Any})Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop 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 authorized. Default: false."latencyMode": Channel latency mode. Default: LOW."name": Channel name."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. Default: STANDARD.