AWS.MediaConnect (aws-elixir v0.8.0) View Source

API for AWS Elemental MediaConnect

Link to this section Summary

Functions

Adds media streams to an existing flow.

Displays the details of a flow.

Displays the details of an offering.

Displays the details of a reservation.

Grants entitlements to an existing flow.

Displays a list of all entitlements that have been granted to this account.

Displays a list of flows that are associated with this account.

Displays a list of all offerings that are available to this account in the current AWS Region.

Displays a list of all reservations that have been purchased by this account in the current AWS Region.

List all tags on an AWS Elemental MediaConnect resource

Submits a request to purchase an offering.

Associates the specified tags to a resource with the specified resourceArn.

Deletes specified tags from a resource.

You can change an entitlement's description, subscribers, and encryption.

Link to this section Functions

Link to this function

add_flow_media_streams(client, flow_arn, input, options \\ [])

View Source

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 to this function

add_flow_outputs(client, flow_arn, input, options \\ [])

View Source

Adds outputs to an existing flow.

You can create up to 50 outputs per flow.

Link to this function

add_flow_sources(client, flow_arn, input, options \\ [])

View Source

Adds Sources to flow

Link to this function

add_flow_vpc_interfaces(client, flow_arn, input, options \\ [])

View Source

Adds VPC interfaces to flow

Link to this function

create_flow(client, input, options \\ [])

View Source

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 to this function

delete_flow(client, flow_arn, input, options \\ [])

View Source

Deletes a flow.

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

Link to this function

describe_flow(client, flow_arn, options \\ [])

View Source

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.

Link to this function

describe_offering(client, offering_arn, options \\ [])

View Source

Displays the details of an offering.

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

Link to this function

describe_reservation(client, reservation_arn, options \\ [])

View Source

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 to this function

grant_flow_entitlements(client, flow_arn, input, options \\ [])

View Source

Grants entitlements to an existing flow.

Link to this function

list_entitlements(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Displays a list of all entitlements that have been granted to this account.

This request returns 20 results per page.

Link to this function

list_flows(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Displays a list of flows that are associated with this account.

This request returns a paginated result.

Link to this function

list_offerings(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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.

Link to this function

list_reservations(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

List all tags on an AWS Elemental MediaConnect resource

Link to this function

purchase_offering(client, offering_arn, input, options \\ [])

View Source

Submits a request to purchase an offering.

If you already have an active reservation, you can't purchase another offering.

Link to this function

remove_flow_media_stream(client, flow_arn, media_stream_name, input, options \\ [])

View Source

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 to this function

remove_flow_output(client, flow_arn, output_arn, input, options \\ [])

View Source

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 to this function

remove_flow_source(client, flow_arn, source_arn, input, options \\ [])

View Source

Removes a source from an existing flow.

This request can be made only if there is more than one source on the flow.

Link to this function

remove_flow_vpc_interface(client, flow_arn, vpc_interface_name, input, options \\ [])

View Source

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 to this function

revoke_flow_entitlement(client, entitlement_arn, flow_arn, input, options \\ [])

View Source

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 to this function

start_flow(client, flow_arn, input, options \\ [])

View Source

Starts a flow.

Link to this function

stop_flow(client, flow_arn, input, options \\ [])

View Source

Stops a flow.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

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 to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Deletes specified tags from a resource.

Link to this function

update_flow(client, flow_arn, input, options \\ [])

View Source

Updates flow

Link to this function

update_flow_entitlement(client, entitlement_arn, flow_arn, input, options \\ [])

View Source

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 to this function

update_flow_media_stream(client, flow_arn, media_stream_name, input, options \\ [])

View Source

Updates an existing media stream.

Link to this function

update_flow_output(client, flow_arn, output_arn, input, options \\ [])

View Source

Updates an existing flow output.

Link to this function

update_flow_source(client, flow_arn, source_arn, input, options \\ [])

View Source

Updates the source of a flow.