elementalinference/aws.sdk.kotlin.services.elementalinference

Package-level declarations

Types

interface ElementalInferenceClient : SdkClient

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

associateFeed

inline suspend fun ElementalInferenceClient.associateFeed(crossinline block: AssociateFeedRequest.Builder.() -> Unit): AssociateFeedResponse

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.

createDictionary

inline suspend fun ElementalInferenceClient.createDictionary(crossinline block: CreateDictionaryRequest.Builder.() -> Unit): CreateDictionaryResponse

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.

createFeed

inline suspend fun ElementalInferenceClient.createFeed(crossinline block: CreateFeedRequest.Builder.() -> Unit): 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.

deleteDictionary

inline suspend fun ElementalInferenceClient.deleteDictionary(crossinline block: DeleteDictionaryRequest.Builder.() -> Unit): DeleteDictionaryResponse

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.

deleteFeed

inline suspend fun ElementalInferenceClient.deleteFeed(crossinline block: DeleteFeedRequest.Builder.() -> Unit): 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.

disassociateFeed

inline suspend fun ElementalInferenceClient.disassociateFeed(crossinline block: DisassociateFeedRequest.Builder.() -> Unit): DisassociateFeedResponse

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

exportDictionaryEntries

inline suspend fun ElementalInferenceClient.exportDictionaryEntries(crossinline block: ExportDictionaryEntriesRequest.Builder.() -> Unit): ExportDictionaryEntriesResponse

Exports the entries from the specified dictionary.

getDictionary

inline suspend fun ElementalInferenceClient.getDictionary(crossinline block: GetDictionaryRequest.Builder.() -> Unit): GetDictionaryResponse

Retrieves information about the specified dictionary.

getFeed

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

Retrieves information about the specified feed.

listDictionaries

inline suspend fun ElementalInferenceClient.listDictionaries(crossinline block: ListDictionariesRequest.Builder.() -> Unit): ListDictionariesResponse

Lists the dictionaries in your account.

listFeeds

inline suspend fun ElementalInferenceClient.listFeeds(crossinline block: ListFeedsRequest.Builder.() -> Unit): ListFeedsResponse

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

listTagsForResource

inline suspend fun ElementalInferenceClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

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

tagResource

inline suspend fun ElementalInferenceClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): 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.

untagResource

inline suspend fun ElementalInferenceClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

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

updateDictionary

inline suspend fun ElementalInferenceClient.updateDictionary(crossinline block: UpdateDictionaryRequest.Builder.() -> Unit): UpdateDictionaryResponse

Updates the specified dictionary.

updateFeed

inline suspend fun ElementalInferenceClient.updateFeed(crossinline block: UpdateFeedRequest.Builder.() -> Unit): UpdateFeedResponse

Updates the name and/or outputs in a feed.

withConfig

fun ElementalInferenceClient.withConfig(block: ElementalInferenceClient.Config.Builder.() -> Unit): ElementalInferenceClient

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.