View Source AWS.MediaLive (aws-elixir v1.0.4)

API for AWS Elemental MediaLive

Link to this section Summary

Functions

Starts delete of resources.

Starts existing resources

Cancel an input device transfer that you have requested.

Send a request to claim an AWS Elemental device that you have purchased from a third-party vendor.

Create a ChannelPlacementGroup in the specified Cluster.

Creates a cloudwatch alarm template to dynamically generate cloudwatch metric alarms on targeted resource types.

Creates a cloudwatch alarm template group to group your cloudwatch alarm templates and to attach to signal maps for dynamically creating alarms.

Creates an eventbridge rule template to monitor events and send notifications to your targeted resources.

Creates an eventbridge rule template group to group your eventbridge rule templates and to attach to signal maps for dynamically creating notification rules.

Create as many Networks as you need.

Create a Node in the specified Cluster.

Create the Register Node script for all the nodes intended for a specific Cluster.

Initiates the creation of a new signal map.

Delete the specified ChannelPlacementGroup that exists in the specified Cluster.

Delete all schedule actions on a channel.

Produces details about an input

Get the latest thumbnail data for the input device.

Get details about a Node in the specified Cluster.

Retrieves the specified cloudwatch alarm template.

Retrieves the specified cloudwatch alarm template group.

Retrieves the specified eventbridge rule template.

Retrieves the specified eventbridge rule template group.

Retrieves the specified signal map.

Retrieve the list of ChannelPlacementGroups in the specified Cluster.

Produces list of channels that have been created

Produces list of inputs that have been created

List the programs that currently exist for a specific multiplex.

Produces list of tags that have been created for a resource

Purchase an offering and create a reservation.

Send a reboot command to the specified input device.

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

Restart pipelines in one channel that is currently running.

Initiates a deployment to delete the monitor of the specified signal map.

Start an input device that is attached to a MediaConnect flow.

Start a maintenance window for the specified input device.

Initiates a deployment to deploy the latest monitor of the specified signal map.

Initiates an update for the specified signal map.

Stop an input device that is attached to a MediaConnect flow.

Start an input device transfer to another AWS account.

Updates the specified cloudwatch alarm template.

Updates the specified cloudwatch alarm template group.

Updates the specified eventbridge rule template.

Updates the specified eventbridge rule template group.

Updates the parameters for the input device.

Link to this section Functions

Link to this function

accept_input_device_transfer(client, input_device_id, input, options \\ [])

View Source

Accept an incoming input device transfer.

The ownership of the device will transfer to your AWS account.

Link to this function

batch_delete(client, input, options \\ [])

View Source

Starts delete of resources.

Link to this function

batch_start(client, input, options \\ [])

View Source

Starts existing resources

Link to this function

batch_stop(client, input, options \\ [])

View Source

Stops running resources

Link to this function

batch_update_schedule(client, channel_id, input, options \\ [])

View Source

Update a channel schedule

Link to this function

cancel_input_device_transfer(client, input_device_id, input, options \\ [])

View Source

Cancel an input device transfer that you have requested.

Link to this function

claim_device(client, input, options \\ [])

View Source

Send a request to claim an AWS Elemental device that you have purchased from a third-party vendor.

After the request succeeds, you will own the device.

Link to this function

create_channel(client, input, options \\ [])

View Source

Creates a new channel

Link to this function

create_channel_placement_group(client, cluster_id, input, options \\ [])

View Source

Create a ChannelPlacementGroup in the specified Cluster.

As part of the create operation, you specify the Nodes to attach the group to.After you create a ChannelPlacementGroup, you add Channels to the group (you do this by modifying the Channels to add them to a specific group). You now have an association of Channels to ChannelPlacementGroup, and ChannelPlacementGroup to Nodes. This association means that all the Channels in the group are able to run on any of the Nodes associated with the group.

Link to this function

create_cloud_watch_alarm_template(client, input, options \\ [])

View Source

Creates a cloudwatch alarm template to dynamically generate cloudwatch metric alarms on targeted resource types.

Link to this function

create_cloud_watch_alarm_template_group(client, input, options \\ [])

View Source

Creates a cloudwatch alarm template group to group your cloudwatch alarm templates and to attach to signal maps for dynamically creating alarms.

Link to this function

create_cluster(client, input, options \\ [])

View Source

Create a new Cluster.

Link to this function

create_event_bridge_rule_template(client, input, options \\ [])

View Source

Creates an eventbridge rule template to monitor events and send notifications to your targeted resources.

Link to this function

create_event_bridge_rule_template_group(client, input, options \\ [])

View Source

Creates an eventbridge rule template group to group your eventbridge rule templates and to attach to signal maps for dynamically creating notification rules.

Link to this function

create_input(client, input, options \\ [])

View Source

Create an input

Link to this function

create_input_security_group(client, input, options \\ [])

View Source

Creates a Input Security Group

Link to this function

create_multiplex(client, input, options \\ [])

View Source

Create a new multiplex.

Link to this function

create_multiplex_program(client, multiplex_id, input, options \\ [])

View Source

Create a new program in the multiplex.

Link to this function

create_network(client, input, options \\ [])

View Source

Create as many Networks as you need.

You will associate one or more Clusters with each Network.Each Network provides MediaLive Anywhere with required information about the network in your organization that you are using for video encoding using MediaLive.

Link to this function

create_node(client, cluster_id, input, options \\ [])

View Source

Create a Node in the specified Cluster.

You can also create Nodes using the CreateNodeRegistrationScript. Note that you can't move a Node to another Cluster.

Link to this function

create_node_registration_script(client, cluster_id, input, options \\ [])

View Source

Create the Register Node script for all the nodes intended for a specific Cluster.

You will then run the script on each hardware unit that is intended for that Cluster. The script creates a Node in the specified Cluster. It then binds the Node to this hardware unit, and activates the node hardware for use with MediaLive Anywhere.

Link to this function

create_partner_input(client, input_id, input, options \\ [])

View Source

Create a partner input

Link to this function

create_signal_map(client, input, options \\ [])

View Source

Initiates the creation of a new signal map.

Will discover a new mediaResourceMap based on the provided discoveryEntryPointArn.

Link to this function

create_tags(client, resource_arn, input, options \\ [])

View Source

Create tags for a resource

Link to this function

delete_channel(client, channel_id, input, options \\ [])

View Source

Starts deletion of channel.

The associated outputs are also deleted.

Link to this function

delete_channel_placement_group(client, channel_placement_group_id, cluster_id, input, options \\ [])

View Source

Delete the specified ChannelPlacementGroup that exists in the specified Cluster.

Link to this function

delete_cloud_watch_alarm_template(client, identifier, input, options \\ [])

View Source

Deletes a cloudwatch alarm template.

Link to this function

delete_cloud_watch_alarm_template_group(client, identifier, input, options \\ [])

View Source

Deletes a cloudwatch alarm template group.

You must detach this group from all signal maps and ensure its existing templates are moved to another group or deleted.

Link to this function

delete_cluster(client, cluster_id, input, options \\ [])

View Source

Delete a Cluster.

The Cluster must be idle.

Link to this function

delete_event_bridge_rule_template(client, identifier, input, options \\ [])

View Source

Deletes an eventbridge rule template.

Link to this function

delete_event_bridge_rule_template_group(client, identifier, input, options \\ [])

View Source

Deletes an eventbridge rule template group.

You must detach this group from all signal maps and ensure its existing templates are moved to another group or deleted.

Link to this function

delete_input(client, input_id, input, options \\ [])

View Source

Deletes the input end point

Link to this function

delete_input_security_group(client, input_security_group_id, input, options \\ [])

View Source

Deletes an Input Security Group

Link to this function

delete_multiplex(client, multiplex_id, input, options \\ [])

View Source

Delete a multiplex.

The multiplex must be idle.

Link to this function

delete_multiplex_program(client, multiplex_id, program_name, input, options \\ [])

View Source

Delete a program from a multiplex.

Link to this function

delete_network(client, network_id, input, options \\ [])

View Source

Delete a Network.

The Network must have no resources associated with it.

Link to this function

delete_node(client, cluster_id, node_id, input, options \\ [])

View Source

Delete a Node.

The Node must be IDLE.

Link to this function

delete_reservation(client, reservation_id, input, options \\ [])

View Source

Delete an expired reservation.

Link to this function

delete_schedule(client, channel_id, input, options \\ [])

View Source

Delete all schedule actions on a channel.

Link to this function

delete_signal_map(client, identifier, input, options \\ [])

View Source

Deletes the specified signal map.

Link to this function

delete_tags(client, resource_arn, input, options \\ [])

View Source

Removes tags for a resource

Link to this function

describe_account_configuration(client, options \\ [])

View Source

Describe account configuration

Link to this function

describe_channel(client, channel_id, options \\ [])

View Source

Gets details about a channel

Link to this function

describe_channel_placement_group(client, channel_placement_group_id, cluster_id, options \\ [])

View Source

Get details about a ChannelPlacementGroup.

Link to this function

describe_cluster(client, cluster_id, options \\ [])

View Source

Get details about a Cluster.

Link to this function

describe_input(client, input_id, options \\ [])

View Source

Produces details about an input

Link to this function

describe_input_device(client, input_device_id, options \\ [])

View Source

Gets the details for the input device

Link to this function

describe_input_device_thumbnail(client, input_device_id, accept, options \\ [])

View Source

Get the latest thumbnail data for the input device.

Link to this function

describe_input_security_group(client, input_security_group_id, options \\ [])

View Source

Produces a summary of an Input Security Group

Link to this function

describe_multiplex(client, multiplex_id, options \\ [])

View Source

Gets details about a multiplex.

Link to this function

describe_multiplex_program(client, multiplex_id, program_name, options \\ [])

View Source

Get the details for a program in a multiplex.

Link to this function

describe_network(client, network_id, options \\ [])

View Source

Get details about a Network.

Link to this function

describe_node(client, cluster_id, node_id, options \\ [])

View Source

Get details about a Node in the specified Cluster.

Link to this function

describe_offering(client, offering_id, options \\ [])

View Source

Get details for an offering.

Link to this function

describe_reservation(client, reservation_id, options \\ [])

View Source

Get details for a reservation.

Link to this function

describe_schedule(client, channel_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Get a channel schedule

Link to this function

describe_thumbnails(client, channel_id, pipeline_id, thumbnail_type, options \\ [])

View Source

Describe the latest thumbnails data.

Link to this function

get_cloud_watch_alarm_template(client, identifier, options \\ [])

View Source

Retrieves the specified cloudwatch alarm template.

Link to this function

get_cloud_watch_alarm_template_group(client, identifier, options \\ [])

View Source

Retrieves the specified cloudwatch alarm template group.

Link to this function

get_event_bridge_rule_template(client, identifier, options \\ [])

View Source

Retrieves the specified eventbridge rule template.

Link to this function

get_event_bridge_rule_template_group(client, identifier, options \\ [])

View Source

Retrieves the specified eventbridge rule template group.

Link to this function

get_signal_map(client, identifier, options \\ [])

View Source

Retrieves the specified signal map.

Link to this function

list_channel_placement_groups(client, cluster_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieve the list of ChannelPlacementGroups in the specified Cluster.

Link to this function

list_channels(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Produces list of channels that have been created

Link to this function

list_cloud_watch_alarm_template_groups(client, max_results \\ nil, next_token \\ nil, scope \\ nil, signal_map_identifier \\ nil, options \\ [])

View Source

Lists cloudwatch alarm template groups.

Link to this function

list_cloud_watch_alarm_templates(client, group_identifier \\ nil, max_results \\ nil, next_token \\ nil, scope \\ nil, signal_map_identifier \\ nil, options \\ [])

View Source

Lists cloudwatch alarm templates.

Link to this function

list_clusters(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieve the list of Clusters.

Link to this function

list_event_bridge_rule_template_groups(client, max_results \\ nil, next_token \\ nil, signal_map_identifier \\ nil, options \\ [])

View Source

Lists eventbridge rule template groups.

Link to this function

list_event_bridge_rule_templates(client, group_identifier \\ nil, max_results \\ nil, next_token \\ nil, signal_map_identifier \\ nil, options \\ [])

View Source

Lists eventbridge rule templates.

Link to this function

list_input_device_transfers(client, max_results \\ nil, next_token \\ nil, transfer_type, options \\ [])

View Source

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.

Link to this function

list_input_devices(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

List input devices

Link to this function

list_input_security_groups(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Produces a list of Input Security Groups for an account

Link to this function

list_inputs(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Produces list of inputs that have been created

Link to this function

list_multiplex_programs(client, multiplex_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

List the programs that currently exist for a specific multiplex.

Link to this function

list_multiplexes(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieve a list of the existing multiplexes.

Link to this function

list_networks(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieve the list of Networks.

Link to this function

list_nodes(client, cluster_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieve the list of Nodes.

Link to this function

list_offerings(client, channel_class \\ nil, channel_configuration \\ nil, codec \\ nil, duration \\ nil, max_results \\ nil, maximum_bitrate \\ nil, maximum_framerate \\ nil, next_token \\ nil, resolution \\ nil, resource_type \\ nil, special_feature \\ nil, video_quality \\ nil, options \\ [])

View Source

List offerings available for purchase.

Link to this function

list_reservations(client, channel_class \\ nil, codec \\ nil, max_results \\ nil, maximum_bitrate \\ nil, maximum_framerate \\ nil, next_token \\ nil, resolution \\ nil, resource_type \\ nil, special_feature \\ nil, video_quality \\ nil, options \\ [])

View Source

List purchased reservations.

Link to this function

list_signal_maps(client, cloud_watch_alarm_template_group_identifier \\ nil, event_bridge_rule_template_group_identifier \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists signal maps.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Produces list of tags that have been created for a resource

Link to this function

purchase_offering(client, offering_id, input, options \\ [])

View Source

Purchase an offering and create a reservation.

Link to this function

reboot_input_device(client, input_device_id, input, options \\ [])

View Source

Send a reboot command to the specified input device.

The device will begin rebooting within a few seconds of sending the command. When the reboot is complete, the device’s connection status will change to connected.

Link to this function

reject_input_device_transfer(client, input_device_id, input, options \\ [])

View Source

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

Link to this function

restart_channel_pipelines(client, channel_id, input, options \\ [])

View Source

Restart pipelines in one channel that is currently running.

Link to this function

start_channel(client, channel_id, input, options \\ [])

View Source

Starts an existing channel

Link to this function

start_delete_monitor_deployment(client, identifier, input, options \\ [])

View Source

Initiates a deployment to delete the monitor of the specified signal map.

Link to this function

start_input_device(client, input_device_id, input, options \\ [])

View Source

Start an input device that is attached to a MediaConnect flow.

(There is no need to start a device that is attached to a MediaLive input; MediaLive starts the device when the channel starts.)

Link to this function

start_input_device_maintenance_window(client, input_device_id, input, options \\ [])

View Source

Start a maintenance window for the specified input device.

Starting a maintenance window will give the device up to two hours to install software. If the device was streaming prior to the maintenance, it will resume streaming when the software is fully installed. Devices automatically install updates while they are powered on and their MediaLive channels are stopped. A maintenance window allows you to update a device without having to stop MediaLive channels that use the device. The device must remain powered on and connected to the internet for the duration of the maintenance.

Link to this function

start_monitor_deployment(client, identifier, input, options \\ [])

View Source

Initiates a deployment to deploy the latest monitor of the specified signal map.

Link to this function

start_multiplex(client, multiplex_id, input, options \\ [])

View Source

Start (run) the multiplex.

Starting the multiplex does not start the channels. You must explicitly start each channel.

Link to this function

start_update_signal_map(client, identifier, input, options \\ [])

View Source

Initiates an update for the specified signal map.

Will discover a new signal map if a changed discoveryEntryPointArn is provided.

Link to this function

stop_channel(client, channel_id, input, options \\ [])

View Source

Stops a running channel

Link to this function

stop_input_device(client, input_device_id, input, options \\ [])

View Source

Stop an input device that is attached to a MediaConnect flow.

(There is no need to stop a device that is attached to a MediaLive input; MediaLive automatically stops the device when the channel stops.)

Link to this function

stop_multiplex(client, multiplex_id, input, options \\ [])

View Source

Stops a running multiplex.

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

Link to this function

transfer_input_device(client, input_device_id, input, options \\ [])

View Source

Start an input device transfer to another AWS account.

After you make the request, the other account must accept or reject the transfer.

Link to this function

update_account_configuration(client, input, options \\ [])

View Source

Update account configuration

Link to this function

update_channel(client, channel_id, input, options \\ [])

View Source

Updates a channel.

Link to this function

update_channel_class(client, channel_id, input, options \\ [])

View Source

Changes the class of the channel.

Link to this function

update_channel_placement_group(client, channel_placement_group_id, cluster_id, input, options \\ [])

View Source

Change the settings for a ChannelPlacementGroup.

Link to this function

update_cloud_watch_alarm_template(client, identifier, input, options \\ [])

View Source

Updates the specified cloudwatch alarm template.

Link to this function

update_cloud_watch_alarm_template_group(client, identifier, input, options \\ [])

View Source

Updates the specified cloudwatch alarm template group.

Link to this function

update_cluster(client, cluster_id, input, options \\ [])

View Source

Change the settings for a Cluster.

Link to this function

update_event_bridge_rule_template(client, identifier, input, options \\ [])

View Source

Updates the specified eventbridge rule template.

Link to this function

update_event_bridge_rule_template_group(client, identifier, input, options \\ [])

View Source

Updates the specified eventbridge rule template group.

Link to this function

update_input(client, input_id, input, options \\ [])

View Source

Updates an input.

Link to this function

update_input_device(client, input_device_id, input, options \\ [])

View Source

Updates the parameters for the input device.

Link to this function

update_input_security_group(client, input_security_group_id, input, options \\ [])

View Source

Update an Input Security Group's Whilelists.

Link to this function

update_multiplex(client, multiplex_id, input, options \\ [])

View Source

Updates a multiplex.

Link to this function

update_multiplex_program(client, multiplex_id, program_name, input, options \\ [])

View Source

Update a program in a multiplex.

Link to this function

update_network(client, network_id, input, options \\ [])

View Source

Change the settings for a Network.

Link to this function

update_node(client, cluster_id, node_id, input, options \\ [])

View Source

Change the settings for a Node.

Link to this function

update_node_state(client, cluster_id, node_id, input, options \\ [])

View Source

Update the state of a node.

Link to this function

update_reservation(client, reservation_id, input, options \\ [])

View Source

Update reservation.