View Source AWS.MediaLive (aws-elixir v1.0.4)
API for AWS Elemental MediaLive
Link to this section Summary
Functions
Accept an incoming input device transfer.
Starts delete of resources.
Starts existing resources
Stops running resources
Update a channel schedule
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.
Creates a new channel
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.
Create a new Cluster.
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 an input
Creates a Input Security Group
Create a new multiplex.
Create a new program in the multiplex.
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.
Create a partner input
Initiates the creation of a new signal map.
Create tags for a resource
Starts deletion of channel.
Delete the specified ChannelPlacementGroup that exists in the specified Cluster.
Deletes a cloudwatch alarm template.
Deletes a cloudwatch alarm template group.
Delete a Cluster.
Deletes an eventbridge rule template.
Deletes an eventbridge rule template group.
Deletes the input end point
Deletes an Input Security Group
Delete a multiplex.
Delete a program from a multiplex.
Delete a Network.
Delete an expired reservation.
Delete all schedule actions on a channel.
Deletes the specified signal map.
Removes tags for a resource
Describe account configuration
Gets details about a channel
Get details about a ChannelPlacementGroup.
Get details about a Cluster.
Produces details about an input
Gets the details for the input device
Get the latest thumbnail data for the input device.
Produces a summary of an Input Security Group
Gets details about a multiplex.
Get the details for a program in a multiplex.
Get details about a Network.
Get details about a Node in the specified Cluster.
Get details for an offering.
Get details for a reservation.
Get a channel schedule
Describe the latest thumbnails data.
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
Lists cloudwatch alarm template groups.
Lists cloudwatch alarm templates.
Retrieve the list of Clusters.
Lists eventbridge rule template groups.
Lists eventbridge rule templates.
List input devices that are currently being transferred.
Produces a list of Input Security Groups for an account
Produces list of inputs that have been created
List the programs that currently exist for a specific multiplex.
Retrieve a list of the existing multiplexes.
Retrieve the list of Networks.
Retrieve the list of Nodes.
List offerings available for purchase.
List purchased reservations.
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.
Starts an existing channel
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.
Start (run) the multiplex.
Initiates an update for the specified signal map.
Stops a running channel
Stop an input device that is attached to a MediaConnect flow.
Stops a running multiplex.
Start an input device transfer to another AWS account.
Update account configuration
Updates a channel.
Changes the class of the channel.
Change the settings for a ChannelPlacementGroup.
Updates the specified cloudwatch alarm template.
Updates the specified cloudwatch alarm template group.
Change the settings for a Cluster.
Updates the specified eventbridge rule template.
Updates the specified eventbridge rule template group.
Updates an input.
Updates the parameters for the input device.
Update an Input Security Group's Whilelists.
Updates a multiplex.
Update a program in a multiplex.
Change the settings for a Network.
Change the settings for a Node.
Update the state of a node.
Update reservation.
Link to this section Functions
accept_input_device_transfer(client, input_device_id, input, options \\ [])
View SourceAccept an incoming input device transfer.
The ownership of the device will transfer to your AWS account.
Starts delete of resources.
Starts existing resources
Stops running resources
Update a channel schedule
cancel_input_device_transfer(client, input_device_id, input, options \\ [])
View SourceCancel 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.
After the request succeeds, you will own the device.
Creates a new channel
create_channel_placement_group(client, cluster_id, input, options \\ [])
View SourceCreate 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.
Creates a cloudwatch alarm template to dynamically generate cloudwatch metric alarms on targeted resource types.
create_cloud_watch_alarm_template_group(client, input, options \\ [])
View SourceCreates a cloudwatch alarm template group to group your cloudwatch alarm templates and to attach to signal maps for dynamically creating alarms.
Create a new Cluster.
Creates an eventbridge rule template to monitor events and send notifications to your targeted resources.
create_event_bridge_rule_template_group(client, input, options \\ [])
View SourceCreates an eventbridge rule template group to group your eventbridge rule templates and to attach to signal maps for dynamically creating notification rules.
Create an input
Creates a Input Security Group
Create a new multiplex.
create_multiplex_program(client, multiplex_id, input, options \\ [])
View SourceCreate a new program in the multiplex.
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.
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.
create_node_registration_script(client, cluster_id, input, options \\ [])
View SourceCreate 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.
Create a partner input
Initiates the creation of a new signal map.
Will discover a new mediaResourceMap based on the provided discoveryEntryPointArn.
Create tags for a resource
Starts deletion of channel.
The associated outputs are also deleted.
delete_channel_placement_group(client, channel_placement_group_id, cluster_id, input, options \\ [])
View SourceDelete the specified ChannelPlacementGroup that exists in the specified Cluster.
delete_cloud_watch_alarm_template(client, identifier, input, options \\ [])
View SourceDeletes a cloudwatch alarm template.
delete_cloud_watch_alarm_template_group(client, identifier, input, options \\ [])
View SourceDeletes 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.
Delete a Cluster.
The Cluster must be idle.
delete_event_bridge_rule_template(client, identifier, input, options \\ [])
View SourceDeletes an eventbridge rule template.
delete_event_bridge_rule_template_group(client, identifier, input, options \\ [])
View SourceDeletes 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.
Deletes the input end point
delete_input_security_group(client, input_security_group_id, input, options \\ [])
View SourceDeletes an Input Security Group
Delete a multiplex.
The multiplex must be idle.
delete_multiplex_program(client, multiplex_id, program_name, input, options \\ [])
View SourceDelete a program from a multiplex.
Delete a Network.
The Network must have no resources associated with it.
Delete a Node.
The Node must be IDLE.
Delete an expired reservation.
Delete all schedule actions on a channel.
Deletes the specified signal map.
Removes tags for a resource
Describe account configuration
Gets details about a channel
describe_channel_placement_group(client, channel_placement_group_id, cluster_id, options \\ [])
View SourceGet details about a ChannelPlacementGroup.
Get details about a Cluster.
Produces details about an input
Gets the details for the input device
describe_input_device_thumbnail(client, input_device_id, accept, options \\ [])
View SourceGet the latest thumbnail data for the input device.
describe_input_security_group(client, input_security_group_id, options \\ [])
View SourceProduces a summary of an Input Security Group
Gets details about a multiplex.
describe_multiplex_program(client, multiplex_id, program_name, options \\ [])
View SourceGet the details for a program in a multiplex.
Get details about a Network.
Get details about a Node in the specified Cluster.
Get details for an offering.
Get details for a reservation.
describe_schedule(client, channel_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceGet a channel schedule
describe_thumbnails(client, channel_id, pipeline_id, thumbnail_type, options \\ [])
View SourceDescribe the latest thumbnails data.
Retrieves the specified cloudwatch alarm template.
get_cloud_watch_alarm_template_group(client, identifier, options \\ [])
View SourceRetrieves the specified cloudwatch alarm template group.
Retrieves the specified eventbridge rule template.
get_event_bridge_rule_template_group(client, identifier, options \\ [])
View SourceRetrieves the specified eventbridge rule template group.
Retrieves the specified signal map.
list_channel_placement_groups(client, cluster_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceRetrieve the list of ChannelPlacementGroups in the specified Cluster.
list_channels(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceProduces list of channels that have been created
list_cloud_watch_alarm_template_groups(client, max_results \\ nil, next_token \\ nil, scope \\ nil, signal_map_identifier \\ nil, options \\ [])
View SourceLists cloudwatch alarm template groups.
list_cloud_watch_alarm_templates(client, group_identifier \\ nil, max_results \\ nil, next_token \\ nil, scope \\ nil, signal_map_identifier \\ nil, options \\ [])
View SourceLists cloudwatch alarm templates.
list_clusters(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceRetrieve the list of Clusters.
list_event_bridge_rule_template_groups(client, max_results \\ nil, next_token \\ nil, signal_map_identifier \\ nil, options \\ [])
View SourceLists eventbridge rule template groups.
list_event_bridge_rule_templates(client, group_identifier \\ nil, max_results \\ nil, next_token \\ nil, signal_map_identifier \\ nil, options \\ [])
View SourceLists eventbridge rule templates.
list_input_device_transfers(client, max_results \\ nil, next_token \\ nil, transfer_type, options \\ [])
View SourceList 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.
list_input_devices(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceList input devices
list_input_security_groups(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceProduces a list of Input Security Groups for an account
list_inputs(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceProduces list of inputs that have been created
list_multiplex_programs(client, multiplex_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceList the programs that currently exist for a specific multiplex.
list_multiplexes(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceRetrieve a list of the existing multiplexes.
list_networks(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceRetrieve the list of Networks.
list_nodes(client, cluster_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceRetrieve the list of Nodes.
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 SourceList offerings available for purchase.
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 SourceList purchased reservations.
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 SourceLists signal maps.
Produces list of tags that have been created for a resource
Purchase an offering and create a reservation.
reboot_input_device(client, input_device_id, input, options \\ [])
View SourceSend 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.
reject_input_device_transfer(client, input_device_id, input, options \\ [])
View SourceReject the transfer of the specified input device to your AWS account.
restart_channel_pipelines(client, channel_id, input, options \\ [])
View SourceRestart pipelines in one channel that is currently running.
Starts an existing channel
start_delete_monitor_deployment(client, identifier, input, options \\ [])
View SourceInitiates a deployment to delete the monitor of the specified signal map.
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.)
start_input_device_maintenance_window(client, input_device_id, input, options \\ [])
View SourceStart 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.
start_monitor_deployment(client, identifier, input, options \\ [])
View SourceInitiates a deployment to deploy the latest monitor of the specified signal map.
Start (run) the multiplex.
Starting the multiplex does not start the channels. You must explicitly start each channel.
Initiates an update for the specified signal map.
Will discover a new signal map if a changed discoveryEntryPointArn is provided.
Stops a running channel
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.)
Stops a running multiplex.
If the multiplex isn't running, this action has no effect.
transfer_input_device(client, input_device_id, input, options \\ [])
View SourceStart an input device transfer to another AWS account.
After you make the request, the other account must accept or reject the transfer.
Update account configuration
Updates a channel.
Changes the class of the channel.
update_channel_placement_group(client, channel_placement_group_id, cluster_id, input, options \\ [])
View SourceChange the settings for a ChannelPlacementGroup.
update_cloud_watch_alarm_template(client, identifier, input, options \\ [])
View SourceUpdates the specified cloudwatch alarm template.
update_cloud_watch_alarm_template_group(client, identifier, input, options \\ [])
View SourceUpdates the specified cloudwatch alarm template group.
Change the settings for a Cluster.
update_event_bridge_rule_template(client, identifier, input, options \\ [])
View SourceUpdates the specified eventbridge rule template.
update_event_bridge_rule_template_group(client, identifier, input, options \\ [])
View SourceUpdates the specified eventbridge rule template group.
Updates an input.
update_input_device(client, input_device_id, input, options \\ [])
View SourceUpdates the parameters for the input device.
update_input_security_group(client, input_security_group_id, input, options \\ [])
View SourceUpdate an Input Security Group's Whilelists.
Updates a multiplex.
update_multiplex_program(client, multiplex_id, program_name, input, options \\ [])
View SourceUpdate a program in a multiplex.
Change the settings for a Network.
Change the settings for a Node.
update_node_state(client, cluster_id, node_id, input, options \\ [])
View SourceUpdate the state of a node.
Update reservation.