Amazon Web Services, Inc.

AWS MediaConnect

Welcome to the Elemental MediaConnect API reference. MediaConnect is a service that lets you ingest live video content into the cloud and distribute it to…

Developer tools#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

Welcome to the Elemental MediaConnect API reference. MediaConnect is a service that lets you ingest live video content into the cloud and distribute it to destinations all over the world, both inside and outside the Amazon Web Services cloud. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types that are supported by MediaConnect. Use the following links to get started with the MediaConnect API: Actions : An alphabetical list of all MediaConnect API operations. Data types : An alphabetical list of all MediaConnect data types. Common parameters : Parameters that all operations can use. Common errors : Client and server errors that all operations can return.

Endpoints 96

Bridge

  • POSTAdd bridge outputs/v1/bridges/:BridgeArn/outputsAdds outputs to an existing bridge.
  • POSTAdd bridge sources/v1/bridges/:BridgeArn/sourcesAdds sources to an existing bridge.
  • GETList bridges/v1/bridges?filterArn=string&maxResults=0&nextToken=stringDisplays a list of bridges that are associated with this account and an optionally specified Amazon Resource Name (ARN). This request returns a paginated…
  • POSTCreate bridge/v1/bridgesCreates a new bridge. The request must include one source.
  • GETDescribe bridge/v1/bridges/:BridgeArnDisplays the details of a bridge.
  • PUTUpdate bridge/v1/bridges/:BridgeArnUpdates the bridge.
  • DELETEDelete bridge/v1/bridges/:BridgeArnDeletes a bridge. Before you can delete a bridge, you must stop the bridge.
  • PUTUpdate bridge output/v1/bridges/:BridgeArn/outputs/:OutputNameUpdates an existing bridge output.
  • DELETERemove bridge output/v1/bridges/:BridgeArn/outputs/:OutputNameRemoves an output from a bridge.
  • PUTUpdate bridge source/v1/bridges/:BridgeArn/sources/:SourceNameUpdates an existing bridge source.
  • DELETERemove bridge source/v1/bridges/:BridgeArn/sources/:SourceNameRemoves a source from a bridge.
  • PUTUpdate bridge state/v1/bridges/:BridgeArn/stateUpdates the bridge state.

Flow

  • POSTAdd flow media streams/v1/flows/:FlowArn/mediaStreamsAdds media streams to an existing flow. After you add a media stream to a flow, you can associate it with a source and/or an output that uses the ST 2110 JPEG…
  • POSTAdd flow outputs/v1/flows/:FlowArn/outputsAdds outputs to an existing flow. You can create up to 50 outputs per flow.
  • POSTAdd flow sources/v1/flows/:FlowArn/sourceAdds sources to a flow.
  • POSTAdd flow vpc interfaces/v1/flows/:FlowArn/vpcInterfacesAdds VPC interfaces to a flow.
  • GETList flows/v1/flows?maxResults=0&nextToken=stringDisplays a list of flows that are associated with this account. This request returns a paginated result.
  • POSTCreate flow/v1/flowsCreates a new flow. The request must include one source. The request optionally can include outputs (up to 50) and entitlements (up to 50).
  • GETDescribe flow/v1/flows/:FlowArnDisplays the details of a flow. The response includes the flow Amazon Resource Name (ARN), name, and Availability Zone, as well as details about the source,…
  • PUTUpdate flow/v1/flows/:FlowArnUpdates an existing flow. Because UpdateFlowSources and UpdateFlow are separate operations, you can't change both the source type AND the flow size in a…
  • DELETEDelete flow/v1/flows/:FlowArnDeletes a flow. Before you can delete a flow, you must stop the flow.
  • GETDescribe flow source metadata/v1/flows/:FlowArn/source-metadataThe DescribeFlowSourceMetadata API is used to view information about the flow's source transport stream and programs. This API displays status messages about…
  • GETDescribe flow source thumbnail/v1/flows/:FlowArn/source-thumbnailDescribes the thumbnail for the flow source.
  • POSTGrant flow entitlements/v1/flows/:FlowArn/entitlementsGrants entitlements to an existing flow.
  • PUTUpdate flow media stream/v1/flows/:FlowArn/mediaStreams/:MediaStreamNameUpdates an existing media stream.
  • DELETERemove flow media stream/v1/flows/:FlowArn/mediaStreams/:MediaStreamNameRemoves a media stream from a flow. This action is only available if the media stream is not associated with a source or output.
  • PUTUpdate flow output/v1/flows/:FlowArn/outputs/:OutputArnUpdates an existing flow output.
  • DELETERemove flow output/v1/flows/:FlowArn/outputs/:OutputArnRemoves an output from an existing flow. This request can be made only on an output that does not have an entitlement associated with it. If the output has an…
  • PUTUpdate flow source/v1/flows/:FlowArn/source/:SourceArnUpdates the source of a flow. Because UpdateFlowSources and UpdateFlow are separate operations, you can't change both the source type AND the flow size in a…
  • DELETERemove flow source/v1/flows/:FlowArn/source/:SourceArnRemoves a source from an existing flow. This request can be made only if there is more than one source on the flow.
  • DELETERemove flow vpc interface/v1/flows/:FlowArn/vpcInterfaces/:VpcInterfaceNameRemoves a VPC Interface from an existing flow. This request can be made only on a VPC interface that does not have a Source or Output associated with it. If…
  • PUTUpdate flow entitlement/v1/flows/:FlowArn/entitlements/:EntitlementArnUpdates an entitlement. You can change an entitlement's description, subscribers, and encryption. If you change the subscribers, the service will remove the…
  • DELETERevoke flow entitlement/v1/flows/:FlowArn/entitlements/:EntitlementArnRevokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to the subscriber and the associated output is removed.
  • POSTStart flow/v1/flows/start/:FlowArnStarts a flow.
  • POSTStop flow/v1/flows/stop/:FlowArnStops a flow.

Destination endpoint

  • GETBatch get destination endpoint/v1/destinationEndpoints?arns=Retrieves information about multiple destination endpoints in a single request.
  • POSTList destination endpoints/v1/destinationEndpoints?maxResults=0&nextToken=stringRetrieves a list of the destination endpoints in your account. The results are paginated. Use the NextToken value that's returned to retrieve additional…
  • PUTConnect endpoints/v1/connectEndpoints/:DestinationEndpointArnConnects a source endpoint to a destination endpoint.
  • GETGet destination endpoint/v1/destinationEndpoint/:ArnRetrieves information about a destination endpoint.
  • PUTUpdate destination endpoint/v1/destinationEndpoint/:ArnUpdates the configuration of a destination endpoint.
  • DELETEDeregister destination endpoint/v1/destinationEndpoint/:ArnDeregisters a destination endpoint from MediaConnect.
  • PUTDisconnect endpoints/v1/disconnectEndpoints/:DestinationEndpointArnDisconnects a source endpoint from a destination endpoint.
  • POSTRegister destination endpoint/v1/destinationEndpointRegisters a new destination endpoint in MediaConnect.

Router input

  • GETBatch get router input/v1/routerInputs?arns=Retrieves information about multiple router inputs in AWS Elemental MediaConnect.
  • POSTList router inputs/v1/routerInputs?maxResults=0&nextToken=stringRetrieves a list of router inputs in AWS Elemental MediaConnect.
  • POSTCreate router input/v1/routerInputCreates a new router input in AWS Elemental MediaConnect.
  • GETGet router input/v1/routerInput/:ArnRetrieves information about a specific router input in AWS Elemental MediaConnect.
  • PUTUpdate router input/v1/routerInput/:ArnUpdates the configuration of an existing router input in AWS Elemental MediaConnect.
  • DELETEDelete router input/v1/routerInput/:ArnDeletes a router input from AWS Elemental MediaConnect.
  • GETGet router input source metadata/v1/routerInput/:Arn/source-metadataRetrieves detailed metadata information about a specific router input source, including stream details and connection state.
  • GETGet router input thumbnail/v1/routerInput/:Arn/thumbnailRetrieves the thumbnail for a router input in AWS Elemental MediaConnect.
  • POSTRestart router input/v1/routerInput/restart/:ArnRestarts a router input. This operation can be used to recover from errors or refresh the input state.
  • POSTStart router input/v1/routerInput/start/:ArnStarts a router input in AWS Elemental MediaConnect.
  • POSTStop router input/v1/routerInput/stop/:ArnStops a router input in AWS Elemental MediaConnect.

Router network interface

  • GETBatch get router network interface/v1/routerNetworkInterfaces?arns=Retrieves information about multiple router network interfaces in AWS Elemental MediaConnect.
  • POSTList router network interfaces/v1/routerNetworkInterfaces?maxResults=0&nextToken=stringRetrieves a list of router network interfaces in AWS Elemental MediaConnect.
  • POSTCreate router network interface/v1/routerNetworkInterfaceCreates a new router network interface in AWS Elemental MediaConnect.
  • GETGet router network interface/v1/routerNetworkInterface/:ArnRetrieves information about a specific router network interface in AWS Elemental MediaConnect.
  • PUTUpdate router network interface/v1/routerNetworkInterface/:ArnUpdates the configuration of an existing router network interface in AWS Elemental MediaConnect.
  • DELETEDelete router network interface/v1/routerNetworkInterface/:ArnDeletes a router network interface from AWS Elemental MediaConnect.

Router output

  • GETBatch get router output/v1/routerOutputs?arns=Retrieves information about multiple router outputs in AWS Elemental MediaConnect.
  • POSTList router outputs/v1/routerOutputs?maxResults=0&nextToken=stringRetrieves a list of router outputs in AWS Elemental MediaConnect.
  • POSTCreate router output/v1/routerOutputCreates a new router output in AWS Elemental MediaConnect.
  • GETGet router output/v1/routerOutput/:ArnRetrieves information about a specific router output in AWS Elemental MediaConnect.
  • PUTUpdate router output/v1/routerOutput/:ArnUpdates the configuration of an existing router output in AWS Elemental MediaConnect.
  • DELETEDelete router output/v1/routerOutput/:ArnDeletes a router output from AWS Elemental MediaConnect.
  • POSTRestart router output/v1/routerOutput/restart/:ArnRestarts a router output. This operation can be used to recover from errors or refresh the output state.
  • POSTStart router output/v1/routerOutput/start/:ArnStarts a router output in AWS Elemental MediaConnect.
  • POSTStop router output/v1/routerOutput/stop/:ArnStops a router output in AWS Elemental MediaConnect.
  • PUTTake router input/v1/routerOutput/takeRouterInput/:RouterOutputArnAssociates a router input with a router output in AWS Elemental MediaConnect.

Source endpoint

  • GETBatch get source endpoint/v1/sourceEndpoints?arns=Retrieves information about multiple source endpoints in a single request.
  • POSTList source endpoints/v1/sourceEndpoints?maxResults=0&nextToken=stringRetrieves a list of the source endpoints in your account. The results are paginated. Use the NextToken value that's returned to retrieve additional results.
  • GETGet source endpoint/v1/sourceEndpoint/:ArnRetrieves information about a source endpoint.
  • PUTUpdate source endpoint/v1/sourceEndpoint/:ArnUpdates the configuration of a source endpoint.
  • DELETEDeregister source endpoint/v1/sourceEndpoint/:ArnDeregisters a source endpoint from MediaConnect.
  • POSTRegister source endpoint/v1/sourceEndpointRegisters a new source endpoint in MediaConnect.

Gateway

  • GETList gateways/v1/gateways?maxResults=0&nextToken=stringDisplays a list of gateways that are associated with this account. This request returns a paginated result.
  • POSTCreate gateway/v1/gatewaysCreates a new gateway. The request must include at least one network (up to four).
  • GETDescribe gateway/v1/gateways/:GatewayArnDisplays the details of a gateway. The response includes the gateway Amazon Resource Name (ARN), name, and CIDR blocks, as well as details about the networks.
  • DELETEDelete gateway/v1/gateways/:GatewayArnDeletes a gateway. Before you can delete a gateway, you must deregister its instances and delete its bridges.

Gateway instance

  • GETDescribe gateway instance/v1/gateway-instances/:GatewayInstanceArnDisplays the details of an instance.
  • PUTUpdate gateway instance/v1/gateway-instances/:GatewayInstanceArnUpdates an existing gateway instance.
  • DELETEDeregister gateway instance/v1/gateway-instances/:GatewayInstanceArn?force=trueDeregisters an instance. Before you deregister an instance, all bridges running on the instance must be stopped. If you want to deregister an instance without…
  • GETList gateway instances/v1/gateway-instances?filterArn=string&maxResults=0&nextToken=stringDisplays a list of instances associated with the Amazon Web Services account. This request returns a paginated result. You can use the filterArn property to…

Offering

  • GETDescribe offering/v1/offerings/:OfferingArnDisplays the details of an offering. The response includes the offering description, duration, outbound bandwidth, price, and Amazon Resource Name (ARN).
  • GETList offerings/v1/offerings?maxResults=0&nextToken=stringDisplays a list of all offerings that are available to this account in the current Amazon Web Services Region. If you have an active reservation (which means…

Reservation

  • POSTPurchase offering/v1/offerings/:OfferingArnSubmits a request to purchase an offering. If you already have an active reservation, you can't purchase another offering.
  • GETDescribe reservation/v1/reservations/:ReservationArnDisplays the details of a reservation. The response includes the reservation name, state, start date and time, and the details of the offering that make up…
  • GETList reservations/v1/reservations?maxResults=0&nextToken=stringDisplays a list of all reservations that have been purchased by this account in the current Amazon Web Services Region. This list includes all reservations in…
  • GETList entitlements/v1/entitlements?maxResults=0&nextToken=stringDisplays a list of all entitlements that have been granted to this account. This request returns 20 results per page.
  • GETList tags for global resource/tags/global/:ResourceArnLists the tags associated with a global resource in AWS Elemental MediaConnect. The API supports the following global resources: router inputs, router outputs…
  • POSTTag global resource/tags/global/:ResourceArnAdds tags to a global resource in AWS Elemental MediaConnect. The API supports the following global resources: router inputs, router outputs and router…
  • DELETEUntag global resource/tags/global/:ResourceArn?tagKeys=Removes tags from a global resource in AWS Elemental MediaConnect. The API supports the following global resources: router inputs, router outputs and router…
  • GETList tags for resource/tags/:ResourceArnList all tags on a MediaConnect resource in the current region.
  • POSTTag resource/tags/:ResourceArnAssociates the specified tags to a resource with the specified resourceArn in the current region. If existing tags on a resource are not specified in the…
  • DELETEUntag resource/tags/:ResourceArn?tagKeys=Deletes specified tags from a resource in the current region.

API details

Base URL
https://mediaconnect.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
96 operations on 60 pathsPOST 31GET 29PUT 18DELETE 18
Main resources
Flow 23Bridge 12Router input 11Router output 10Destination endpoint 8Router network interface 6Source endpoint 6Gateway 4Gateway instance 4Reservation 3
Description format
AWS Smithy model, API version 2018-11-14

How to test the AWS MediaConnect 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 MediaConnect 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 “Add bridge outputs” (POST /v1/bridges/:BridgeArn/outputs), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS MediaConnect?

Welcome to the Elemental MediaConnect API reference. MediaConnect is a service that lets you ingest live video content into the cloud and distribute it to… It is listed under Developer tools and has 96 endpoints.

Who publishes the AWS MediaConnect?

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 MediaConnect?

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

How do I authenticate with the AWS MediaConnect?

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

How many endpoints does the AWS MediaConnect have?

96 operations on 60 paths (31 POST, 29 GET, 18 PUT, 18 DELETE). The largest groups are Flow, Bridge, Router input, Router output.

Is forking the AWS MediaConnect 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.