ElementalInferenceClient

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.

Properties

Link copied to clipboard

ElementalInferenceClient's configuration

Functions

Link copied to clipboard

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.

Link copied to clipboard

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 copied to clipboard
abstract suspend fun createFeed(input: CreateFeedRequest): CreateFeedResponse

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.

Link copied to clipboard

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 copied to clipboard
abstract suspend fun deleteFeed(input: DeleteFeedRequest): DeleteFeedResponse

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 copied to clipboard

Releases the resource (the source media) that is associated with this feed. The outputs in the feed become DISABLED.

Link copied to clipboard

Exports the entries from the specified dictionary.

Link copied to clipboard

Retrieves information about the specified dictionary.

Link copied to clipboard
abstract suspend fun getFeed(input: GetFeedRequest): GetFeedResponse

Retrieves information about the specified feed.

Link copied to clipboard
abstract suspend fun listDictionaries(input: ListDictionariesRequest = ListDictionariesRequest { }): ListDictionariesResponse

Lists the dictionaries in your account.

Link copied to clipboard
abstract suspend fun listFeeds(input: ListFeedsRequest = ListFeedsRequest { }): ListFeedsResponse

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

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

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 copied to clipboard

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

Link copied to clipboard

Updates the specified dictionary.

Link copied to clipboard
abstract suspend fun updateFeed(input: UpdateFeedRequest): UpdateFeedResponse

Updates the name and/or outputs in a feed.

Inherited functions

Link copied to clipboard

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.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

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 copied to clipboard

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.

Link copied to clipboard

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 copied to clipboard

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 copied to clipboard

Releases the resource (the source media) that is associated with this feed. The outputs in the feed become DISABLED.

Link copied to clipboard

Exports the entries from the specified dictionary.

Link copied to clipboard

Retrieves information about the specified dictionary.

Link copied to clipboard
inline suspend fun ElementalInferenceClient.getFeed(crossinline block: GetFeedRequest.Builder.() -> Unit): GetFeedResponse

Retrieves information about the specified feed.

Link copied to clipboard

Lists the dictionaries in your account.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

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 copied to clipboard

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

Link copied to clipboard

Updates the specified dictionary.

Link copied to clipboard

Updates the name and/or outputs in a feed.

Link copied to clipboard
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.