View Source AWS.ElementalInference (aws-elixir v1.0.12)

This is the AWS Elemental Inference REST API Reference.

It provides information on the URL, request contents, and response contents of each AWS Elemental Inference REST operation.

We assume that you have the IAM permissions that you need to use AWS Elemental Inference via the REST API. We also assume that you are familiar with the features and operations of AWS Elemental Inference as described in AWS Elemental Inference User Guide.

Link to this section Summary

Functions

Associates a resource with the feed.

Creates a custom dictionary for improving transcription accuracy.

Deletes the specified dictionary.

Deletes the specified feed.

Releases the resource (the source media) that is associated with this feed.

Exports the entries from the specified dictionary.

Retrieves information about the specified dictionary.

Retrieves information about the specified feed.

Displays a list of feeds that belong to this AWS account.

List all tags that are on an Elemental Inference resource in the current region.

Associates the specified tags to the resource identified by the specified resourceArn in the current region.

Deletes specified tags from the specified resource in the current region.

Updates the specified dictionary.

Updates the name and/or outputs in a feed.

Link to this section Functions

Link to this function

associate_feed(client, id, input, options \\ [])

View Source

Associates a resource with the feed.

The resource provides the input that Elemental Inference needs in order to perform an Elemental Inference feature, such as cropping video. You always provide the resource by associating it with a feed. You can associate only one resource with each feed. With an association, a specific source media is claiming ownership of the feed.

AssociateFeed is a PATCH operation, which means that you can include only parameters that you want to change. Parameters that you don't include will not be affected by the operation.

Specifically:

  • You can add more outputs to the existing outputs. New outputs will be appended.

  • You can't modify an existing output (for example to change its name). Instead, use UpdateFeed.

  • You can't delete an existing output. Instead, use UpdateFeed.

Also note that you can't change the feed name with AssociateFeed. Instead, use UpdateFeed.

Link to this function

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

View Source

Creates a custom dictionary for improving transcription accuracy.

A dictionary contains custom words and phrases that the ASR engine might not recognize, such as brand names, technical terms, or proper nouns. You can reference a dictionary when configuring a smart subtitles output.

Link to this function

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

View Source

Creates a feed.

The feed is the target for the live media stream that is being sent by the calling application. An example of a calling application is AWS Elemental MediaLive.

The key contents of the feed is an array of outputs. Each output represents an Elemental Inference feature. After you create the feed, you must associate a resource with the feed. At that point, you will have a useable feed: resource - feed - output or outputs.

Link to this function

delete_dictionary(client, id, input, options \\ [])

View Source

Deletes the specified dictionary.

You cannot delete a dictionary that is referenced by a feed. You must first remove the dictionary reference from the feed's subtitling configuration.

Link to this function

delete_feed(client, id, input, options \\ [])

View Source

Deletes the specified feed.

You can delete the feed at any time. Elemental Inference doesn't block you from deleting a feed when the calling application is calling PutMedia or GetMetadata on that feed, although both these calls will start to fail. For more information about managing inactive feeds, see the Elemental Inference User Guide.

Link to this function

disassociate_feed(client, id, input, options \\ [])

View Source

Releases the resource (the source media) that is associated with this feed.

The outputs in the feed become DISABLED.

Link to this function

export_dictionary_entries(client, id, options \\ [])

View Source

Exports the entries from the specified dictionary.

Link to this function

get_dictionary(client, id, options \\ [])

View Source

Retrieves information about the specified dictionary.

Link to this function

get_feed(client, id, options \\ [])

View Source

Retrieves information about the specified feed.

Link to this function

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

View Source

Lists the dictionaries in your account.

Link to this function

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

View Source

Displays a list of feeds that belong to this AWS account.

Link to this function

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

View Source

List all tags that are on an Elemental Inference resource in the current region.

Link to this function

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

View Source

Associates the specified tags to the resource identified by the specified resourceArn in the current region.

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 also deleted.

Link to this function

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

View Source

Deletes specified tags from the specified resource in the current region.

Link to this function

update_dictionary(client, id, input, options \\ [])

View Source

Updates the specified dictionary.

Link to this function

update_feed(client, id, input, options \\ [])

View Source

Updates the name and/or outputs in a feed.

UpdateFeed is a PUT operation, which means that the payload that you specify completely overwrites the existing payload.

This means that if you want to touch the array of outputs, you must pass in the full new list. So you must omit outputs you want to delete, and include outputs you want to add or modify.

If you want to patch the array of outputs to make selective additions, use AssociateFeed.