Amazon Web Services, Inc.

AWS Elemental MediaLive

API for AWS Elemental MediaLive

Media & content#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

API for AWS Elemental MediaLive

Endpoints 123

  • POSTAccept input device transfer/prod/inputDevices/:InputDeviceId/acceptAccept an incoming input device transfer. The ownership of the device will transfer to your AWS account.
  • POSTBatch delete/prod/batch/deleteStarts delete of resources.
  • POSTBatch start/prod/batch/startStarts existing resources
  • POSTBatch stop/prod/batch/stopStops running resources
  • GETDescribe schedule/prod/channels/:ChannelId/schedule?maxResults=0&nextToken=stringGet a channel schedule
  • PUTBatch update schedule/prod/channels/:ChannelId/scheduleUpdate a channel schedule
  • DELETEDelete schedule/prod/channels/:ChannelId/scheduleDelete all schedule actions on a channel.
  • POSTCancel input device transfer/prod/inputDevices/:InputDeviceId/cancelCancel an input device transfer that you have requested.
  • POSTClaim device/prod/claimDeviceSend 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.
  • GETList channels/prod/channels?maxResults=0&nextToken=stringProduces list of channels that have been created
  • POSTCreate channel/prod/channelsCreates a new channel
  • GETList channel placement groups/prod/clusters/:ClusterId/channelplacementgroups?maxResults=0&nextToken=stringRetrieve the list of ChannelPlacementGroups in the specified Cluster.
  • POSTCreate channel placement group/prod/clusters/:ClusterId/channelplacementgroupsCreate 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…
  • GETList cloud watch alarm templates/prod/cloudwatch-alarm-templates?groupIdentifier=string&maxResults=0&nextToken=string&scope=string&signalMapIdentifier=stringLists cloudwatch alarm templates.
  • POSTCreate cloud watch alarm template/prod/cloudwatch-alarm-templatesCreates a cloudwatch alarm template to dynamically generate cloudwatch metric alarms on targeted resource types.
  • GETList cloud watch alarm template groups/prod/cloudwatch-alarm-template-groups?maxResults=0&nextToken=string&scope=string&signalMapIdentifier=stringLists cloudwatch alarm template groups.
  • POSTCreate cloud watch alarm template group/prod/cloudwatch-alarm-template-groupsCreates a cloudwatch alarm template group to group your cloudwatch alarm templates and to attach to signal maps for dynamically creating alarms.
  • GETList clusters/prod/clusters?maxResults=0&nextToken=stringRetrieve the list of Clusters.
  • POSTCreate cluster/prod/clustersCreate a new Cluster.
  • GETList event bridge rule templates/prod/eventbridge-rule-templates?groupIdentifier=string&maxResults=0&nextToken=string&signalMapIdentifier=stringLists eventbridge rule templates.
  • POSTCreate event bridge rule template/prod/eventbridge-rule-templatesCreates an eventbridge rule template to monitor events and send notifications to your targeted resources.
  • GETList event bridge rule template groups/prod/eventbridge-rule-template-groups?maxResults=0&nextToken=string&signalMapIdentifier=stringLists eventbridge rule template groups.
  • POSTCreate event bridge rule template group/prod/eventbridge-rule-template-groupsCreates an eventbridge rule template group to group your eventbridge rule templates and to attach to signal maps for dynamically creating notification rules.
  • GETList inputs/prod/inputs?maxResults=0&nextToken=stringProduces list of inputs that have been created
  • POSTCreate input/prod/inputsCreate an input
  • GETList input security groups/prod/inputSecurityGroups?maxResults=0&nextToken=stringProduces a list of Input Security Groups for an account
  • POSTCreate input security group/prod/inputSecurityGroupsCreates a Input Security Group
  • GETList multiplexes/prod/multiplexes?maxResults=0&nextToken=stringRetrieve a list of the existing multiplexes.
  • POSTCreate multiplex/prod/multiplexesCreate a new multiplex.
  • GETList multiplex programs/prod/multiplexes/:MultiplexId/programs?maxResults=0&nextToken=stringList the programs that currently exist for a specific multiplex.
  • POSTCreate multiplex program/prod/multiplexes/:MultiplexId/programsCreate a new program in the multiplex.
  • GETList networks/prod/networks?maxResults=0&nextToken=stringRetrieve the list of Networks.
  • POSTCreate network/prod/networksCreate as many Networks as you need. You will associate one or more Clusters with each Network.Each Network provides MediaLive Anywhere with required…
  • GETList nodes/prod/clusters/:ClusterId/nodes?maxResults=0&nextToken=stringRetrieve the list of Nodes.
  • POSTCreate node/prod/clusters/:ClusterId/nodesCreate 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.
  • POSTCreate node registration script/prod/clusters/:ClusterId/nodeRegistrationScriptCreate 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…
  • POSTCreate partner input/prod/inputs/:InputId/partnersCreate a partner input
  • GETList sdi sources/prod/sdiSources?maxResults=0&nextToken=stringList all the SdiSources in the AWS account.
  • POSTCreate sdi source/prod/sdiSourcesCreate 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…
  • GETList signal maps/prod/signal-maps?cloudWatchAlarmTemplateGroupIdentifier=string&eventBridgeRuleTemplateGroupIdentifier=string&maxResults=0&nextToken=stringLists signal maps.
  • POSTCreate signal map/prod/signal-mapsInitiates the creation of a new signal map. Will discover a new mediaResourceMap based on the provided discoveryEntryPointArn.
  • GETList tags for resource/prod/tags/:ResourceArnProduces list of tags that have been created for a resource
  • POSTCreate tags/prod/tags/:ResourceArnCreate tags for a resource
  • DELETEDelete tags/prod/tags/:ResourceArn?tagKeys=Removes tags for a resource
  • GETDescribe channel/prod/channels/:ChannelIdGets details about a channel
  • PUTUpdate channel/prod/channels/:ChannelIdUpdates a channel.
  • DELETEDelete channel/prod/channels/:ChannelIdStarts deletion of channel. The associated outputs are also deleted.
  • GETDescribe channel placement group/prod/clusters/:ClusterId/channelplacementgroups/:ChannelPlacementGroupIdGet details about a ChannelPlacementGroup.
  • PUTUpdate channel placement group/prod/clusters/:ClusterId/channelplacementgroups/:ChannelPlacementGroupIdChange the settings for a ChannelPlacementGroup.
  • DELETEDelete channel placement group/prod/clusters/:ClusterId/channelplacementgroups/:ChannelPlacementGroupIdDelete the specified ChannelPlacementGroup that exists in the specified Cluster.
  • GETGet cloud watch alarm template/prod/cloudwatch-alarm-templates/:IdentifierRetrieves the specified cloudwatch alarm template.
  • DELETEDelete cloud watch alarm template/prod/cloudwatch-alarm-templates/:IdentifierDeletes a cloudwatch alarm template.
  • PATCHUpdate cloud watch alarm template/prod/cloudwatch-alarm-templates/:IdentifierUpdates the specified cloudwatch alarm template.
  • GETGet cloud watch alarm template group/prod/cloudwatch-alarm-template-groups/:IdentifierRetrieves the specified cloudwatch alarm template group.
  • DELETEDelete cloud watch alarm template group/prod/cloudwatch-alarm-template-groups/:IdentifierDeletes 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…
  • PATCHUpdate cloud watch alarm template group/prod/cloudwatch-alarm-template-groups/:IdentifierUpdates the specified cloudwatch alarm template group.
  • GETDescribe cluster/prod/clusters/:ClusterIdGet details about a Cluster.
  • PUTUpdate cluster/prod/clusters/:ClusterIdChange the settings for a Cluster.
  • DELETEDelete cluster/prod/clusters/:ClusterIdDelete a Cluster. The Cluster must be idle.
  • GETGet event bridge rule template/prod/eventbridge-rule-templates/:IdentifierRetrieves the specified eventbridge rule template.
  • DELETEDelete event bridge rule template/prod/eventbridge-rule-templates/:IdentifierDeletes an eventbridge rule template.
  • PATCHUpdate event bridge rule template/prod/eventbridge-rule-templates/:IdentifierUpdates the specified eventbridge rule template.
  • GETGet event bridge rule template group/prod/eventbridge-rule-template-groups/:IdentifierRetrieves the specified eventbridge rule template group.
  • DELETEDelete event bridge rule template group/prod/eventbridge-rule-template-groups/:IdentifierDeletes 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…
  • PATCHUpdate event bridge rule template group/prod/eventbridge-rule-template-groups/:IdentifierUpdates the specified eventbridge rule template group.
  • GETDescribe input/prod/inputs/:InputIdProduces details about an input
  • PUTUpdate input/prod/inputs/:InputIdUpdates an input.
  • DELETEDelete input/prod/inputs/:InputIdDeletes the input end point
  • GETDescribe input security group/prod/inputSecurityGroups/:InputSecurityGroupIdProduces a summary of an Input Security Group
  • PUTUpdate input security group/prod/inputSecurityGroups/:InputSecurityGroupIdUpdate an Input Security Group's Whilelists.
  • DELETEDelete input security group/prod/inputSecurityGroups/:InputSecurityGroupIdDeletes an Input Security Group
  • GETDescribe multiplex/prod/multiplexes/:MultiplexIdGets details about a multiplex.
  • PUTUpdate multiplex/prod/multiplexes/:MultiplexIdUpdates a multiplex.
  • DELETEDelete multiplex/prod/multiplexes/:MultiplexIdDelete a multiplex. The multiplex must be idle.
  • GETDescribe multiplex program/prod/multiplexes/:MultiplexId/programs/:ProgramNameGet the details for a program in a multiplex.
  • PUTUpdate multiplex program/prod/multiplexes/:MultiplexId/programs/:ProgramNameUpdate a program in a multiplex.
  • DELETEDelete multiplex program/prod/multiplexes/:MultiplexId/programs/:ProgramNameDelete a program from a multiplex.
  • GETDescribe network/prod/networks/:NetworkIdGet details about a Network.
  • PUTUpdate network/prod/networks/:NetworkIdChange the settings for a Network.
  • DELETEDelete network/prod/networks/:NetworkIdDelete a Network. The Network must have no resources associated with it.
  • GETDescribe node/prod/clusters/:ClusterId/nodes/:NodeIdGet details about a Node in the specified Cluster.
  • PUTUpdate node/prod/clusters/:ClusterId/nodes/:NodeIdChange the settings for a Node.
  • DELETEDelete node/prod/clusters/:ClusterId/nodes/:NodeIdDelete a Node. The Node must be IDLE.
  • GETDescribe reservation/prod/reservations/:ReservationIdGet details for a reservation.
  • PUTUpdate reservation/prod/reservations/:ReservationIdUpdate reservation.
  • DELETEDelete reservation/prod/reservations/:ReservationIdDelete an expired reservation, or cancel an active reservation during the calendar month (UTC) in which you purchased it. You can't cancel an active…
  • GETDescribe sdi source/prod/sdiSources/:SdiSourceIdGets details about a SdiSource.
  • PUTUpdate sdi source/prod/sdiSources/:SdiSourceIdChange some of the settings in an SdiSource.
  • DELETEDelete sdi source/prod/sdiSources/:SdiSourceIdDelete an SdiSource. The SdiSource must not be part of any SidSourceMapping and must not be attached to any input.
  • GETGet signal map/prod/signal-maps/:IdentifierRetrieves the specified signal map.
  • DELETEDelete signal map/prod/signal-maps/:IdentifierDeletes the specified signal map.
  • PATCHStart update signal map/prod/signal-maps/:IdentifierInitiates an update for the specified signal map. Will discover a new signal map if a changed discoveryEntryPointArn is provided.
  • GETDescribe account configuration/prod/accountConfigurationDescribe account configuration
  • PUTUpdate account configuration/prod/accountConfigurationUpdate account configuration
  • GETDescribe input device/prod/inputDevices/:InputDeviceIdGets the details for the input device
  • PUTUpdate input device/prod/inputDevices/:InputDeviceIdUpdates the parameters for the input device.
  • GETDescribe input device thumbnail/prod/inputDevices/:InputDeviceId/thumbnailDataGet the latest thumbnail data for the input device.
  • GETDescribe offering/prod/offerings/:OfferingIdGet details for an offering.
  • GETDescribe thumbnails/prod/channels/:ChannelId/thumbnails?pipelineId=string&thumbnailType=stringDescribe the latest thumbnails data.
  • GETList alerts/prod/channels/:ChannelId/alerts?maxResults=0&nextToken=string&stateFilter=stringList the alerts for a channel with optional filtering based on alert state.
  • GETList cluster alerts/prod/clusters/:ClusterId/alerts?maxResults=0&nextToken=string&stateFilter=stringList the alerts for a cluster with optional filtering based on alert state.
  • GETList input device transfers/prod/inputDeviceTransfers?maxResults=0&nextToken=string&transferType=stringList input devices that are currently being transferred. List input devices that you are transferring from your AWS account or input devices that another AWS…
  • GETList input devices/prod/inputDevices?maxResults=0&nextToken=stringList input devices
  • GETList multiplex alerts/prod/multiplexes/:MultiplexId/alerts?maxResults=0&nextToken=string&stateFilter=stringList the alerts for a multiplex with optional filtering based on alert state.
  • GETList offerings/prod/offerings?channelClass=string&channelConfiguration=string&codec=string&duration=string&maxResults=0&maximumBitrate=string&maximumFramerate=string&nextToken=string&resolution=string&resourceType=string&specialFeature=string&videoQuality=stringList offerings available for purchase.
  • GETList reservations/prod/reservations?channelClass=string&codec=string&maxResults=0&maximumBitrate=string&maximumFramerate=string&nextToken=string&resolution=string&resourceType=string&specialFeature=string&videoQuality=stringList purchased reservations.
  • GETList versions/prod/versionsRetrieves an array of all the encoder engine versions that are available in this AWS account.
  • POSTPurchase offering/prod/offerings/:OfferingId/purchasePurchase an offering and create a reservation.
  • POSTReboot input device/prod/inputDevices/:InputDeviceId/rebootSend 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,…
  • POSTReject input device transfer/prod/inputDevices/:InputDeviceId/rejectReject the transfer of the specified input device to your AWS account.
  • POSTRestart channel pipelines/prod/channels/:ChannelId/restartChannelPipelinesRestart pipelines in one channel that is currently running.
  • POSTStart channel/prod/channels/:ChannelId/startStarts an existing channel
  • POSTStart monitor deployment/prod/signal-maps/:Identifier/monitor-deploymentInitiates a deployment to deploy the latest monitor of the specified signal map.
  • DELETEStart delete monitor deployment/prod/signal-maps/:Identifier/monitor-deploymentInitiates a deployment to delete the monitor of the specified signal map.
  • POSTStart input device/prod/inputDevices/:InputDeviceId/startStart 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…
  • POSTStart input device maintenance window/prod/inputDevices/:InputDeviceId/startInputDeviceMaintenanceWindowStart 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…
  • POSTStart multiplex/prod/multiplexes/:MultiplexId/startStart (run) the multiplex. Starting the multiplex does not start the channels. You must explicitly start each channel.
  • POSTStop channel/prod/channels/:ChannelId/stopStops a running channel
  • POSTStop input device/prod/inputDevices/:InputDeviceId/stopStop 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…
  • POSTStop multiplex/prod/multiplexes/:MultiplexId/stopStops a running multiplex. If the multiplex isn't running, this action has no effect.
  • POSTTransfer input device/prod/inputDevices/:InputDeviceId/transferStart an input device transfer to another AWS account. After you make the request, the other account must accept or reject the transfer.
  • PUTUpdate channel class/prod/channels/:ChannelId/channelClassChanges the class of the channel.
  • PUTUpdate node state/prod/clusters/:ClusterId/nodes/:NodeId/stateUpdate the state of a node.

API details

Base URL
https://medialive.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
123 operations on 69 pathsGET 46POST 37DELETE 19PUT 16PATCH 5
Description format
AWS Smithy model, API version 2017-10-14

How to test the AWS Elemental MediaLive in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Elemental MediaLive collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Accept input device transfer” (POST /prod/inputDevices/:InputDeviceId/accept), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Elemental MediaLive?

API for AWS Elemental MediaLive It is listed under Media & content and has 123 endpoints.

Who publishes the AWS Elemental MediaLive?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS Elemental MediaLive?

Requests go to https://medialive.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Elemental MediaLive?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Elemental MediaLive have?

123 operations on 69 paths (46 GET, 37 POST, 19 DELETE, 16 PUT, 5 PATCH).

Is forking the AWS Elemental MediaLive free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.