Edit on GitHub

Medialive

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

Index

Documentation

Main.Medialive.accept_input_device_transfer — Method
accept_input_device_transfer(input_device_id)
accept_input_device_transfer(input_device_id, params::Dict{String,<:Any})

Accept an incoming input device transfer. The ownership of the device will transfer to your AWS account.

Arguments

  • input_device_id: The unique ID of the input device to accept. For example, hd-123456789abcdef.
source
Main.Medialive.batch_delete — Method
batch_delete()
batch_delete(params::Dict{String,<:Any})

Starts delete of resources.

Optional Parameters

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

  • "channelIds": List of channel IDs
  • "inputIds": List of input IDs
  • "inputSecurityGroupIds": List of input security group IDs
  • "multiplexIds": List of multiplex IDs
source
Main.Medialive.batch_start — Method
batch_start()
batch_start(params::Dict{String,<:Any})

Starts existing resources

Optional Parameters

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

  • "channelIds": List of channel IDs
  • "multiplexIds": List of multiplex IDs
source
Main.Medialive.batch_stop — Method
batch_stop()
batch_stop(params::Dict{String,<:Any})

Stops running resources

Optional Parameters

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

  • "channelIds": List of channel IDs
  • "multiplexIds": List of multiplex IDs
source
Main.Medialive.batch_update_schedule — Method
batch_update_schedule(channel_id)
batch_update_schedule(channel_id, params::Dict{String,<:Any})

Update a channel schedule

Arguments

  • channel_id: Id of the channel whose schedule is being updated.

Optional Parameters

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

  • "creates": Schedule actions to create in the schedule.
  • "deletes": Schedule actions to delete from the schedule.
source
Main.Medialive.cancel_input_device_transfer — Method
cancel_input_device_transfer(input_device_id)
cancel_input_device_transfer(input_device_id, params::Dict{String,<:Any})

Cancel an input device transfer that you have requested.

Arguments

  • input_device_id: The unique ID of the input device to cancel. For example, hd-123456789abcdef.
source
Main.Medialive.create_channel — Method
create_channel()
create_channel(params::Dict{String,<:Any})

Creates a new channel

Optional Parameters

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

  • "cdiInputSpecification": Specification of CDI inputs for this channel
  • "channelClass": The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.
  • "destinations":
  • "encoderSettings":
  • "inputAttachments": List of input attachments for channel.
  • "inputSpecification": Specification of network and file inputs for this channel
  • "logLevel": The log level to write to CloudWatch Logs.
  • "name": Name of channel.
  • "requestId": Unique request ID to be specified. This is needed to prevent retries from

creating multiple resources.

  • "reserved": Deprecated field that's only usable by whitelisted customers.
  • "roleArn": An optional Amazon Resource Name (ARN) of the role to assume when running the Channel.
  • "tags": A collection of key-value pairs.
  • "vpc": Settings for VPC output
source
Main.Medialive.create_input — Method
create_input()
create_input(params::Dict{String,<:Any})

Create an input

Optional Parameters

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

  • "destinations": Destination settings for PUSH type inputs.
  • "inputDevices": Settings for the devices.
  • "inputSecurityGroups": A list of security groups referenced by IDs to attach to the input.
  • "mediaConnectFlows": A list of the MediaConnect Flows that you want to use in this input. You can specify as few as one

Flow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a separate Availability Zone as this ensures your EML input is redundant to AZ issues.

  • "name": Name of the input.
  • "requestId": Unique identifier of the request to ensure the request is handled

exactly once in case of retries.

  • "roleArn": The Amazon Resource Name (ARN) of the role this input assumes during and after creation.
  • "sources": The source URLs for a PULL-type input. Every PULL type input needs

exactly two source URLs for redundancy. Only specify sources for PULL type Inputs. Leave Destinations empty.

  • "tags": A collection of key-value pairs.
  • "type":
  • "vpc":
source
Main.Medialive.create_input_security_group — Method
create_input_security_group()
create_input_security_group(params::Dict{String,<:Any})

Creates a Input Security Group

Optional Parameters

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

  • "tags": A collection of key-value pairs.
  • "whitelistRules": List of IPv4 CIDR addresses to whitelist
source
Main.Medialive.create_multiplex — Method
create_multiplex(availability_zones, multiplex_settings, name, request_id)
create_multiplex(availability_zones, multiplex_settings, name, request_id, params::Dict{String,<:Any})

Create a new multiplex.

Arguments

  • availability_zones: A list of availability zones for the multiplex. You must specify exactly two.
  • multiplex_settings: Configuration for a multiplex event.
  • name: Name of multiplex.
  • request_id: Unique request ID. This prevents retries from creating multiple

resources.

Optional Parameters

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

  • "tags": A collection of key-value pairs.
source
Main.Medialive.create_multiplex_program — Method
create_multiplex_program(multiplex_id, multiplex_program_settings, program_name, request_id)
create_multiplex_program(multiplex_id, multiplex_program_settings, program_name, request_id, params::Dict{String,<:Any})

Create a new program in the multiplex.

Arguments

  • multiplex_id: ID of the multiplex where the program is to be created.
  • multiplex_program_settings: The settings for this multiplex program.
  • program_name: Name of multiplex program.
  • request_id: Unique request ID. This prevents retries from creating multiple

resources.

source
Main.Medialive.create_partner_input — Method
create_partner_input(input_id)
create_partner_input(input_id, params::Dict{String,<:Any})

Create a partner input

Arguments

  • input_id: Unique ID of the input.

Optional Parameters

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

  • "requestId": Unique identifier of the request to ensure the request is handled

exactly once in case of retries.

  • "tags": A collection of key-value pairs.
source
Main.Medialive.create_tags — Method
create_tags(resource-arn)
create_tags(resource-arn, params::Dict{String,<:Any})

Create tags for a resource

Arguments

  • resource-arn:

Optional Parameters

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

  • "tags":
source
Main.Medialive.delete_channel — Method
delete_channel(channel_id)
delete_channel(channel_id, params::Dict{String,<:Any})

Starts deletion of channel. The associated outputs are also deleted.

Arguments

  • channel_id: Unique ID of the channel.
source
Main.Medialive.delete_input — Method
delete_input(input_id)
delete_input(input_id, params::Dict{String,<:Any})

Deletes the input end point

Arguments

  • input_id: Unique ID of the input
source
Main.Medialive.delete_input_security_group — Method
delete_input_security_group(input_security_group_id)
delete_input_security_group(input_security_group_id, params::Dict{String,<:Any})

Deletes an Input Security Group

Arguments

  • input_security_group_id: The Input Security Group to delete
source
Main.Medialive.delete_multiplex — Method
delete_multiplex(multiplex_id)
delete_multiplex(multiplex_id, params::Dict{String,<:Any})

Delete a multiplex. The multiplex must be idle.

Arguments

  • multiplex_id: The ID of the multiplex.
source
Main.Medialive.delete_multiplex_program — Method
delete_multiplex_program(multiplex_id, program_name)
delete_multiplex_program(multiplex_id, program_name, params::Dict{String,<:Any})

Delete a program from a multiplex.

Arguments

  • multiplex_id: The ID of the multiplex that the program belongs to.
  • program_name: The multiplex program name.
source
Main.Medialive.delete_reservation — Method
delete_reservation(reservation_id)
delete_reservation(reservation_id, params::Dict{String,<:Any})

Delete an expired reservation.

Arguments

  • reservation_id: Unique reservation ID, e.g. '1234567'
source
Main.Medialive.delete_schedule — Method
delete_schedule(channel_id)
delete_schedule(channel_id, params::Dict{String,<:Any})

Delete all schedule actions on a channel.

Arguments

  • channel_id: Id of the channel whose schedule is being deleted.
source
Main.Medialive.delete_tags — Method
delete_tags(resource-arn, tag_keys)
delete_tags(resource-arn, tag_keys, params::Dict{String,<:Any})

Removes tags for a resource

Arguments

  • resource-arn:
  • tag_keys: An array of tag keys to delete
source
Main.Medialive.describe_channel — Method
describe_channel(channel_id)
describe_channel(channel_id, params::Dict{String,<:Any})

Gets details about a channel

Arguments

  • channel_id: channel ID
source
Main.Medialive.describe_input — Method
describe_input(input_id)
describe_input(input_id, params::Dict{String,<:Any})

Produces details about an input

Arguments

  • input_id: Unique ID of the input
source
Main.Medialive.describe_input_device — Method
describe_input_device(input_device_id)
describe_input_device(input_device_id, params::Dict{String,<:Any})

Gets the details for the input device

Arguments

  • input_device_id: The unique ID of this input device. For example, hd-123456789abcdef.
source
Main.Medialive.describe_input_device_thumbnail — Method
describe_input_device_thumbnail(accept, input_device_id)
describe_input_device_thumbnail(accept, input_device_id, params::Dict{String,<:Any})

Get the latest thumbnail data for the input device.

Arguments

  • accept: The HTTP Accept header. Indicates the requested type for the thumbnail.
  • input_device_id: The unique ID of this input device. For example, hd-123456789abcdef.
source
Main.Medialive.describe_input_security_group — Method
describe_input_security_group(input_security_group_id)
describe_input_security_group(input_security_group_id, params::Dict{String,<:Any})

Produces a summary of an Input Security Group

Arguments

  • input_security_group_id: The id of the Input Security Group to describe
source
Main.Medialive.describe_multiplex — Method
describe_multiplex(multiplex_id)
describe_multiplex(multiplex_id, params::Dict{String,<:Any})

Gets details about a multiplex.

Arguments

  • multiplex_id: The ID of the multiplex.
source
Main.Medialive.describe_multiplex_program — Method
describe_multiplex_program(multiplex_id, program_name)
describe_multiplex_program(multiplex_id, program_name, params::Dict{String,<:Any})

Get the details for a program in a multiplex.

Arguments

  • multiplex_id: The ID of the multiplex that the program belongs to.
  • program_name: The name of the program.
source
Main.Medialive.describe_offering — Method
describe_offering(offering_id)
describe_offering(offering_id, params::Dict{String,<:Any})

Get details for an offering.

Arguments

  • offering_id: Unique offering ID, e.g. '87654321'
source
Main.Medialive.describe_reservation — Method
describe_reservation(reservation_id)
describe_reservation(reservation_id, params::Dict{String,<:Any})

Get details for a reservation.

Arguments

  • reservation_id: Unique reservation ID, e.g. '1234567'
source
Main.Medialive.describe_schedule — Method
describe_schedule(channel_id)
describe_schedule(channel_id, params::Dict{String,<:Any})

Get a channel schedule

Arguments

  • channel_id: Id of the channel whose schedule is being updated.

Optional Parameters

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

  • "maxResults":
  • "nextToken":
source
Main.Medialive.list_channels — Method
list_channels()
list_channels(params::Dict{String,<:Any})

Produces list of channels that have been created

Optional Parameters

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

  • "maxResults":
  • "nextToken":
source
Main.Medialive.list_input_device_transfers — Method
list_input_device_transfers(transfer_type)
list_input_device_transfers(transfer_type, params::Dict{String,<:Any})

List input devices that are currently being transferred. List input devices that you are transferring from your AWS account or input devices that another AWS account is transferring to you.

Arguments

  • transfer_type:

Optional Parameters

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

  • "maxResults":
  • "nextToken":
source
Main.Medialive.list_input_devices — Method
list_input_devices()
list_input_devices(params::Dict{String,<:Any})

List input devices

Optional Parameters

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

  • "maxResults":
  • "nextToken":
source
Main.Medialive.list_input_security_groups — Method
list_input_security_groups()
list_input_security_groups(params::Dict{String,<:Any})

Produces a list of Input Security Groups for an account

Optional Parameters

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

  • "maxResults":
  • "nextToken":
source
Main.Medialive.list_inputs — Method
list_inputs()
list_inputs(params::Dict{String,<:Any})

Produces list of inputs that have been created

Optional Parameters

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

  • "maxResults":
  • "nextToken":
source
Main.Medialive.list_multiplex_programs — Method
list_multiplex_programs(multiplex_id)
list_multiplex_programs(multiplex_id, params::Dict{String,<:Any})

List the programs that currently exist for a specific multiplex.

Arguments

  • multiplex_id: The ID of the multiplex that the programs belong to.

Optional Parameters

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

  • "maxResults": The maximum number of items to return.
  • "nextToken": The token to retrieve the next page of results.
source
Main.Medialive.list_multiplexes — Method
list_multiplexes()
list_multiplexes(params::Dict{String,<:Any})

Retrieve a list of the existing multiplexes.

Optional Parameters

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

  • "maxResults": The maximum number of items to return.
  • "nextToken": The token to retrieve the next page of results.
source
Main.Medialive.list_offerings — Method
list_offerings()
list_offerings(params::Dict{String,<:Any})

List offerings available for purchase.

Optional Parameters

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

  • "channelClass": Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'
  • "channelConfiguration": Filter to offerings that match the configuration of an existing channel, e.g. '2345678' (a channel ID)
  • "codec": Filter by codec, 'AVC', 'HEVC', 'MPEG2', 'AUDIO', or 'LINK'
  • "duration": Filter by offering duration, e.g. '12'
  • "maxResults":
  • "maximumBitrate": Filter by bitrate, 'MAX10MBPS', 'MAX20MBPS', or 'MAX50MBPS'
  • "maximumFramerate": Filter by framerate, 'MAX30FPS' or 'MAX60FPS'
  • "nextToken":
  • "resolution": Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'
  • "resourceType": Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'
  • "specialFeature": Filter by special feature, 'ADVANCEDAUDIO' or 'AUDIONORMALIZATION'
  • "videoQuality": Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'
source
Main.Medialive.list_reservations — Method
list_reservations()
list_reservations(params::Dict{String,<:Any})

List purchased reservations.

Optional Parameters

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

  • "channelClass": Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'
  • "codec": Filter by codec, 'AVC', 'HEVC', 'MPEG2', 'AUDIO', or 'LINK'
  • "maxResults":
  • "maximumBitrate": Filter by bitrate, 'MAX10MBPS', 'MAX20MBPS', or 'MAX50MBPS'
  • "maximumFramerate": Filter by framerate, 'MAX30FPS' or 'MAX60FPS'
  • "nextToken":
  • "resolution": Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'
  • "resourceType": Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'
  • "specialFeature": Filter by special feature, 'ADVANCEDAUDIO' or 'AUDIONORMALIZATION'
  • "videoQuality": Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'
source
Main.Medialive.list_tags_for_resource — Method
list_tags_for_resource(resource-arn)
list_tags_for_resource(resource-arn, params::Dict{String,<:Any})

Produces list of tags that have been created for a resource

Arguments

  • resource-arn:
source
Main.Medialive.purchase_offering — Method
purchase_offering(count, offering_id)
purchase_offering(count, offering_id, params::Dict{String,<:Any})

Purchase an offering and create a reservation.

Arguments

  • count: Number of resources
  • offering_id: Offering to purchase, e.g. '87654321'

Optional Parameters

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

  • "name": Name for the new reservation
  • "requestId": Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.
  • "start": Requested reservation start time (UTC) in ISO-8601 format. The specified time must be between the first day of the current month and one year from now. If no value is given, the default is now.
  • "tags": A collection of key-value pairs
source
Main.Medialive.reject_input_device_transfer — Method
reject_input_device_transfer(input_device_id)
reject_input_device_transfer(input_device_id, params::Dict{String,<:Any})

Reject the transfer of the specified input device to your AWS account.

Arguments

  • input_device_id: The unique ID of the input device to reject. For example, hd-123456789abcdef.
source
Main.Medialive.start_channel — Method
start_channel(channel_id)
start_channel(channel_id, params::Dict{String,<:Any})

Starts an existing channel

Arguments

  • channel_id: A request to start a channel
source
Main.Medialive.start_multiplex — Method
start_multiplex(multiplex_id)
start_multiplex(multiplex_id, params::Dict{String,<:Any})

Start (run) the multiplex. Starting the multiplex does not start the channels. You must explicitly start each channel.

Arguments

  • multiplex_id: The ID of the multiplex.
source
Main.Medialive.stop_channel — Method
stop_channel(channel_id)
stop_channel(channel_id, params::Dict{String,<:Any})

Stops a running channel

Arguments

  • channel_id: A request to stop a running channel
source
Main.Medialive.stop_multiplex — Method
stop_multiplex(multiplex_id)
stop_multiplex(multiplex_id, params::Dict{String,<:Any})

Stops a running multiplex. If the multiplex isn't running, this action has no effect.

Arguments

  • multiplex_id: The ID of the multiplex.
source
Main.Medialive.transfer_input_device — Method
transfer_input_device(input_device_id)
transfer_input_device(input_device_id, params::Dict{String,<:Any})

Start an input device transfer to another AWS account. After you make the request, the other account must accept or reject the transfer.

Arguments

  • input_device_id: The unique ID of this input device. For example, hd-123456789abcdef.

Optional Parameters

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

  • "targetCustomerId": The AWS account ID (12 digits) for the recipient of the device transfer.
  • "targetRegion": The target AWS region to transfer the device.
  • "transferMessage": An optional message for the recipient. Maximum 280 characters.
source
Main.Medialive.update_channel — Method
update_channel(channel_id)
update_channel(channel_id, params::Dict{String,<:Any})

Updates a channel.

Arguments

  • channel_id: channel ID

Optional Parameters

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

  • "cdiInputSpecification": Specification of CDI inputs for this channel
  • "destinations": A list of output destinations for this channel.
  • "encoderSettings": The encoder settings for this channel.
  • "inputAttachments":
  • "inputSpecification": Specification of network and file inputs for this channel
  • "logLevel": The log level to write to CloudWatch Logs.
  • "name": The name of the channel.
  • "roleArn": An optional Amazon Resource Name (ARN) of the role to assume when running the Channel. If you do not specify this on an update call but the role was previously set that role will be removed.
source
Main.Medialive.update_channel_class — Method
update_channel_class(channel_class, channel_id)
update_channel_class(channel_class, channel_id, params::Dict{String,<:Any})

Changes the class of the channel.

Arguments

  • channel_class: The channel class that you wish to update this channel to use.
  • channel_id: Channel Id of the channel whose class should be updated.

Optional Parameters

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

  • "destinations": A list of output destinations for this channel.
source
Main.Medialive.update_input — Method
update_input(input_id)
update_input(input_id, params::Dict{String,<:Any})

Updates an input.

Arguments

  • input_id: Unique ID of the input.

Optional Parameters

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

  • "destinations": Destination settings for PUSH type inputs.
  • "inputDevices": Settings for the devices.
  • "inputSecurityGroups": A list of security groups referenced by IDs to attach to the input.
  • "mediaConnectFlows": A list of the MediaConnect Flow ARNs that you want to use as the source of the input. You can specify as few as one

Flow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a separate Availability Zone as this ensures your EML input is redundant to AZ issues.

  • "name": Name of the input.
  • "roleArn": The Amazon Resource Name (ARN) of the role this input assumes during and after creation.
  • "sources": The source URLs for a PULL-type input. Every PULL type input needs

exactly two source URLs for redundancy. Only specify sources for PULL type Inputs. Leave Destinations empty.

source
Main.Medialive.update_input_device — Method
update_input_device(input_device_id)
update_input_device(input_device_id, params::Dict{String,<:Any})

Updates the parameters for the input device.

Arguments

  • input_device_id: The unique ID of the input device. For example, hd-123456789abcdef.

Optional Parameters

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

  • "hdDeviceSettings": The settings that you want to apply to the HD input device.
  • "name": The name that you assigned to this input device (not the unique ID).
  • "uhdDeviceSettings": The settings that you want to apply to the UHD input device.
source
Main.Medialive.update_input_security_group — Method
update_input_security_group(input_security_group_id)
update_input_security_group(input_security_group_id, params::Dict{String,<:Any})

Update an Input Security Group's Whilelists.

Arguments

  • input_security_group_id: The id of the Input Security Group to update.

Optional Parameters

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

  • "tags": A collection of key-value pairs.
  • "whitelistRules": List of IPv4 CIDR addresses to whitelist
source
Main.Medialive.update_multiplex — Method
update_multiplex(multiplex_id)
update_multiplex(multiplex_id, params::Dict{String,<:Any})

Updates a multiplex.

Arguments

  • multiplex_id: ID of the multiplex to update.

Optional Parameters

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

  • "multiplexSettings": The new settings for a multiplex.
  • "name": Name of the multiplex.
source
Main.Medialive.update_multiplex_program — Method
update_multiplex_program(multiplex_id, program_name)
update_multiplex_program(multiplex_id, program_name, params::Dict{String,<:Any})

Update a program in a multiplex.

Arguments

  • multiplex_id: The ID of the multiplex of the program to update.
  • program_name: The name of the program to update.

Optional Parameters

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

  • "multiplexProgramSettings": The new settings for a multiplex program.
source
Main.Medialive.update_reservation — Method
update_reservation(reservation_id)
update_reservation(reservation_id, params::Dict{String,<:Any})

Update reservation.

Arguments

  • reservation_id: Unique reservation ID, e.g. '1234567'

Optional Parameters

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

  • "name": Name of the reservation
source