Package-level declarations

Types

Link copied to clipboard

API for AWS Elemental MediaLive

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Inherited functions

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun MediaLiveClient.batchDelete(crossinline block: BatchDeleteRequest.Builder.() -> Unit): BatchDeleteResponse

Starts delete of resources.

Link copied to clipboard
inline suspend fun MediaLiveClient.batchStart(crossinline block: BatchStartRequest.Builder.() -> Unit): BatchStartResponse

Starts existing resources

Link copied to clipboard
inline suspend fun MediaLiveClient.batchStop(crossinline block: BatchStopRequest.Builder.() -> Unit): BatchStopResponse

Stops running resources

Link copied to clipboard

Update a channel schedule

Link copied to clipboard

Cancel an input device transfer that you have requested.

Link copied to clipboard
inline suspend fun MediaLiveClient.claimDevice(crossinline block: ClaimDeviceRequest.Builder.() -> Unit): ClaimDeviceResponse

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 copied to clipboard

Creates a new channel

Link copied to clipboard

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 copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Create a new Cluster.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun MediaLiveClient.createInput(crossinline block: CreateInputRequest.Builder.() -> Unit): CreateInputResponse

Create an input

Link copied to clipboard

Creates a Input Security Group

Link copied to clipboard

Create a new multiplex.

Link copied to clipboard

Create a new program in the multiplex.

Link copied to clipboard

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 copied to clipboard
inline suspend fun MediaLiveClient.createNode(crossinline block: CreateNodeRequest.Builder.() -> Unit): CreateNodeResponse

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 copied to clipboard

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 copied to clipboard

Create a partner input

Link copied to clipboard

Create an SdiSource for each video source that uses the SDI protocol. You will reference the SdiSource when you create an SDI input in MediaLive. You will also reference it in an SdiSourceMapping, in order to create a connection between the logical SdiSource and the physical SDI card and port that the physical SDI source uses.

Link copied to clipboard

Initiates the creation of a new signal map. Will discover a new mediaResourceMap based on the provided discoveryEntryPointArn.

Link copied to clipboard
inline suspend fun MediaLiveClient.createTags(crossinline block: CreateTagsRequest.Builder.() -> Unit): CreateTagsResponse

Create tags for a resource

Link copied to clipboard

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

Link copied to clipboard

Delete the specified ChannelPlacementGroup that exists in the specified Cluster.

Link copied to clipboard

Deletes a cloudwatch alarm template.

Link copied to clipboard

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 copied to clipboard

Delete a Cluster. The Cluster must be idle.

Link copied to clipboard

Deletes an eventbridge rule template.

Link copied to clipboard

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 copied to clipboard
inline suspend fun MediaLiveClient.deleteInput(crossinline block: DeleteInputRequest.Builder.() -> Unit): DeleteInputResponse

Deletes the input end point

Link copied to clipboard

Deletes an Input Security Group

Link copied to clipboard

Delete a multiplex. The multiplex must be idle.

Link copied to clipboard

Delete a program from a multiplex.

Link copied to clipboard

Delete a Network. The Network must have no resources associated with it.

Link copied to clipboard
inline suspend fun MediaLiveClient.deleteNode(crossinline block: DeleteNodeRequest.Builder.() -> Unit): DeleteNodeResponse

Delete a Node. The Node must be IDLE.

Link copied to clipboard

Delete an expired reservation.

Link copied to clipboard

Delete all schedule actions on a channel.

Link copied to clipboard

Delete an SdiSource. The SdiSource must not be part of any SidSourceMapping and must not be attached to any input.

Link copied to clipboard

Deletes the specified signal map.

Link copied to clipboard
inline suspend fun MediaLiveClient.deleteTags(crossinline block: DeleteTagsRequest.Builder.() -> Unit): DeleteTagsResponse

Removes tags for a resource

Link copied to clipboard
Link copied to clipboard

Gets details about a channel

Link copied to clipboard

Get details about a ChannelPlacementGroup.

Link copied to clipboard

Get details about a Cluster.

Link copied to clipboard

Produces details about an input

Link copied to clipboard

Gets the details for the input device

Link copied to clipboard

Produces a summary of an Input Security Group

Link copied to clipboard

Gets details about a multiplex.

Link copied to clipboard

Get the details for a program in a multiplex.

Link copied to clipboard

Get details about a Network.

Link copied to clipboard

Get details about a Node in the specified Cluster.

Link copied to clipboard

Get details for an offering.

Link copied to clipboard

Get details for a reservation.

Link copied to clipboard

Get a channel schedule

Link copied to clipboard

Gets details about a SdiSource.

Link copied to clipboard

Describe the latest thumbnails data.

Link copied to clipboard

Retrieves the specified cloudwatch alarm template.

Link copied to clipboard

Retrieves the specified cloudwatch alarm template group.

Link copied to clipboard

Retrieves the specified eventbridge rule template.

Link copied to clipboard

Retrieves the specified eventbridge rule template group.

Link copied to clipboard

Retrieves the specified signal map.

Link copied to clipboard

Retrieve the list of ChannelPlacementGroups in the specified Cluster.

Link copied to clipboard

Produces list of channels that have been created

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Retrieve the list of Clusters.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

List input devices

Link copied to clipboard

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 copied to clipboard
inline suspend fun MediaLiveClient.listInputs(crossinline block: ListInputsRequest.Builder.() -> Unit): ListInputsResponse

Produces list of inputs that have been created

Link copied to clipboard

Produces a list of Input Security Groups for an account

Link copied to clipboard

Retrieve a list of the existing multiplexes.

Link copied to clipboard

List the programs that currently exist for a specific multiplex.

Link copied to clipboard

Retrieve the list of Networks.

Link copied to clipboard
inline suspend fun MediaLiveClient.listNodes(crossinline block: ListNodesRequest.Builder.() -> Unit): ListNodesResponse

Retrieve the list of Nodes.

Link copied to clipboard

List offerings available for purchase.

Link copied to clipboard

List purchased reservations.

Link copied to clipboard

List all the SdiSources in the AWS account.

Link copied to clipboard

Lists signal maps.

Link copied to clipboard

Produces list of tags that have been created for a resource

Link copied to clipboard

Retrieves an array of all the encoder engine versions that are available in this AWS account.

Link copied to clipboard

Purchase an offering and create a reservation.

Link copied to clipboard

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 copied to clipboard

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

Link copied to clipboard

Restart pipelines in one channel that is currently running.

Link copied to clipboard

Starts an existing channel

Link copied to clipboard

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

Link copied to clipboard

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 copied to clipboard

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 copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Initiates an update for the specified signal map. Will discover a new signal map if a changed discoveryEntryPointArn is provided.

Link copied to clipboard
inline suspend fun MediaLiveClient.stopChannel(crossinline block: StopChannelRequest.Builder.() -> Unit): StopChannelResponse

Stops a running channel

Link copied to clipboard

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 copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

Updates a channel.

Link copied to clipboard

Changes the class of the channel.

Link copied to clipboard

Change the settings for a ChannelPlacementGroup.

Link copied to clipboard

Updates the specified cloudwatch alarm template.

Link copied to clipboard

Updates the specified cloudwatch alarm template group.

Link copied to clipboard

Change the settings for a Cluster.

Link copied to clipboard

Updates the specified eventbridge rule template.

Link copied to clipboard

Updates the specified eventbridge rule template group.

Link copied to clipboard
inline suspend fun MediaLiveClient.updateInput(crossinline block: UpdateInputRequest.Builder.() -> Unit): UpdateInputResponse

Updates an input.

Link copied to clipboard

Updates the parameters for the input device.

Link copied to clipboard

Update an Input Security Group's Whilelists.

Link copied to clipboard

Updates a multiplex.

Link copied to clipboard

Update a program in a multiplex.

Link copied to clipboard

Change the settings for a Network.

Link copied to clipboard
inline suspend fun MediaLiveClient.updateNode(crossinline block: UpdateNodeRequest.Builder.() -> Unit): UpdateNodeResponse

Change the settings for a Node.

Link copied to clipboard

Update the state of a node.

Link copied to clipboard

Update reservation.

Link copied to clipboard

Change some of the settings in an SdiSource.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.