AWS.MediaConnect — AWS SDK for JavaScript (original) (raw)

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

addBridgeOutputs(params = {}, callback) ⇒ AWS.Request

Adds outputs to an existing bridge.

addBridgeSources(params = {}, callback) ⇒ AWS.Request

Adds sources to an existing bridge.

addFlowMediaStreams(params = {}, callback) ⇒ AWS.Request

Adds 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 XS or CDI protocol.

addFlowOutputs(params = {}, callback) ⇒ AWS.Request

Adds outputs to an existing flow. You can create up to 50 outputs per flow.

addFlowSources(params = {}, callback) ⇒ AWS.Request

addFlowVpcInterfaces(params = {}, callback) ⇒ AWS.Request

Adds VPC interfaces to flow

createBridge(params = {}, callback) ⇒ AWS.Request

Creates a new bridge. The request must include one source.

createFlow(params = {}, callback) ⇒ AWS.Request

Creates a new flow. The request must include one source. The request optionally can include outputs (up to 50) and entitlements (up to 50).

createGateway(params = {}, callback) ⇒ AWS.Request

Creates a new gateway. The request must include at least one network (up to 4).

deleteBridge(params = {}, callback) ⇒ AWS.Request

Deletes a bridge. Before you can delete a bridge, you must stop the bridge.

deleteFlow(params = {}, callback) ⇒ AWS.Request

Deletes a flow. Before you can delete a flow, you must stop the flow.

deleteGateway(params = {}, callback) ⇒ AWS.Request

Deletes a gateway. Before you can delete a gateway, you must deregister its instances and delete its bridges.

deregisterGatewayInstance(params = {}, callback) ⇒ AWS.Request

Deregisters an instance. Before you deregister an instance, all bridges running on the instance must be stopped. If you want to deregister an instance without stopping the bridges, you must use the --force option.

describeBridge(params = {}, callback) ⇒ AWS.Request

Displays the details of a bridge.

describeFlow(params = {}, callback) ⇒ AWS.Request

Displays the details of a flow. The response includes the flow ARN, name, and Availability Zone, as well as details about the source, outputs, and entitlements.

describeFlowSourceMetadata(params = {}, callback) ⇒ AWS.Request

Displays details of the flow's source stream. The response contains information about the contents of the stream and its programs.

describeFlowSourceThumbnail(params = {}, callback) ⇒ AWS.Request

Displays the thumbnail details of a flow's source stream.

describeGateway(params = {}, callback) ⇒ AWS.Request

Displays the details of a gateway. The response includes the gateway ARN, name, and CIDR blocks, as well as details about the networks.

describeGatewayInstance(params = {}, callback) ⇒ AWS.Request

Displays the details of an instance.

describeOffering(params = {}, callback) ⇒ AWS.Request

Displays the details of an offering. The response includes the offering description, duration, outbound bandwidth, price, and Amazon Resource Name (ARN).

describeReservation(params = {}, callback) ⇒ AWS.Request

Displays 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 the rest of the reservation (such as price, duration, and outbound bandwidth).

grantFlowEntitlements(params = {}, callback) ⇒ AWS.Request

Grants entitlements to an existing flow.

listBridges(params = {}, callback) ⇒ AWS.Request

Displays a list of bridges that are associated with this account and an optionally specified Arn. This request returns a paginated result.

listEntitlements(params = {}, callback) ⇒ AWS.Request

Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page.

listFlows(params = {}, callback) ⇒ AWS.Request

Displays a list of flows that are associated with this account. This request returns a paginated result.

listGatewayInstances(params = {}, callback) ⇒ AWS.Request

Displays a list of instances associated with the AWS account. This request returns a paginated result. You can use the filterArn property to display only the instances associated with the selected Gateway Amazon Resource Name (ARN).

listGateways(params = {}, callback) ⇒ AWS.Request

Displays a list of gateways that are associated with this account. This request returns a paginated result.

listOfferings(params = {}, callback) ⇒ AWS.Request

Displays a list of all offerings that are available to this account in the current AWS Region. If you have an active reservation (which means you've purchased an offering that has already started and hasn't expired yet), your account isn't eligible for other offerings.

listReservations(params = {}, callback) ⇒ AWS.Request

Displays a list of all reservations that have been purchased by this account in the current AWS Region. This list includes all reservations in all states (such as active and expired).

listTagsForResource(params = {}, callback) ⇒ AWS.Request

List all tags on an AWS Elemental MediaConnect resource

purchaseOffering(params = {}, callback) ⇒ AWS.Request

Submits a request to purchase an offering. If you already have an active reservation, you can't purchase another offering.

removeBridgeOutput(params = {}, callback) ⇒ AWS.Request

Removes an output from a bridge.

removeBridgeSource(params = {}, callback) ⇒ AWS.Request

Removes a source from a bridge.

removeFlowMediaStream(params = {}, callback) ⇒ AWS.Request

Removes a media stream from a flow. This action is only available if the media stream is not associated with a source or output.

removeFlowOutput(params = {}, callback) ⇒ AWS.Request

Removes 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 entitlement, you must revoke the entitlement instead. When an entitlement is revoked from a flow, the service automatically removes the associated output.

removeFlowSource(params = {}, callback) ⇒ AWS.Request

Removes a source from an existing flow. This request can be made only if there is more than one source on the flow.

removeFlowVpcInterface(params = {}, callback) ⇒ AWS.Request

Removes 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 the VPC interface is referenced by a Source or Output, you must first delete or update the Source or Output to no longer reference the VPC interface.

revokeFlowEntitlement(params = {}, callback) ⇒ AWS.Request

Revokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to the subscriber and the associated output is removed.

tagResource(params = {}, callback) ⇒ AWS.Request

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.

untagResource(params = {}, callback) ⇒ AWS.Request

Deletes specified tags from a resource.

updateBridgeOutput(params = {}, callback) ⇒ AWS.Request

Updates an existing bridge output.

updateBridgeSource(params = {}, callback) ⇒ AWS.Request

Updates an existing bridge source.

updateBridgeState(params = {}, callback) ⇒ AWS.Request

updateFlowEntitlement(params = {}, callback) ⇒ AWS.Request

You can change an entitlement's description, subscribers, and encryption. If you change the subscribers, the service will remove the outputs that are are used by the subscribers that are removed.

updateFlowMediaStream(params = {}, callback) ⇒ AWS.Request

Updates an existing media stream.

updateFlowOutput(params = {}, callback) ⇒ AWS.Request

Updates an existing flow output.

updateFlowSource(params = {}, callback) ⇒ AWS.Request

Updates the source of a flow.

updateGatewayInstance(params = {}, callback) ⇒ AWS.Request

Updates the configuration of an existing Gateway Instance.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given MediaConnect resource. The final callback or'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.