Package-level declarations

Types

Link copied to clipboard

Welcome to the Elemental MediaConnect API reference.

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

Adds outputs to an existing bridge.

Link copied to clipboard

Adds sources to an existing bridge.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Adds sources to a flow.

Link copied to clipboard

Adds VPC interfaces to a flow.

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun MediaConnectClient.createFlow(crossinline block: CreateFlowRequest.Builder.() -> Unit): CreateFlowResponse

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun MediaConnectClient.deleteFlow(crossinline block: DeleteFlowRequest.Builder.() -> Unit): DeleteFlowResponse

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Displays the details of a bridge.

Link copied to clipboard

Displays 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, outputs, and entitlements.

Link copied to clipboard

The DescribeFlowSourceMetadata API is used to view information about the flow's source transport stream and programs. This API displays status messages about the flow's source as well as details about the program's video, audio, and other data.

Link copied to clipboard

Describes the thumbnail for the flow source.

Link copied to clipboard

Displays 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.

Link copied to clipboard

Displays the details of an instance.

Link copied to clipboard

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

Link copied to clipboard

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).

Link copied to clipboard

Grants entitlements to an existing flow.

Link copied to clipboard

Displays a list of bridges that are associated with this account and an optionally specified Amazon Resource Name (ARN). This request returns a paginated result.

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun MediaConnectClient.listFlows(crossinline block: ListFlowsRequest.Builder.() -> Unit): ListFlowsResponse

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

Link copied to clipboard

Displays a list of instances associated with the Amazon Web Services 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).

Link copied to clipboard

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

Link copied to clipboard

Displays 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 you've purchased an offering that has already started and hasn't expired yet), your account isn't eligible for other offerings.

Link copied to clipboard

Displays 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 all states (such as active and expired).

Link copied to clipboard

List all tags on a MediaConnect resource.

Link copied to clipboard

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

Link copied to clipboard

Removes an output from a bridge.

Link copied to clipboard

Removes a source from a bridge.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun MediaConnectClient.startFlow(crossinline block: StartFlowRequest.Builder.() -> Unit): StartFlowResponse

Starts a flow.

Link copied to clipboard
inline suspend fun MediaConnectClient.stopFlow(crossinline block: StopFlowRequest.Builder.() -> Unit): StopFlowResponse

Stops a flow.

Link copied to clipboard

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.

Link copied to clipboard

Deletes specified tags from a resource.

Link copied to clipboard

Updates the bridge.

Link copied to clipboard

Updates an existing bridge output.

Link copied to clipboard

Updates an existing bridge source.

Link copied to clipboard

Updates the bridge state.

Link copied to clipboard
inline suspend fun MediaConnectClient.updateFlow(crossinline block: UpdateFlowRequest.Builder.() -> Unit): UpdateFlowResponse

Updates an existing flow.

Link copied to clipboard

Updates an entitlement. 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.

Link copied to clipboard

Updates an existing media stream.

Link copied to clipboard

Updates an existing flow output.

Link copied to clipboard

Updates the source of a flow.

Link copied to clipboard

Updates an existing gateway instance.

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.