elementalinference/aws.sdk.kotlin.services.elementalinference/ElementalInferenceClient

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.

Types

Builder

class Builder

Companion

object Companion

Config

class Config

Properties

config

abstract val config: ElementalInferenceClient.Config

ElementalInferenceClient's configuration

Functions

associateFeed

abstract suspend fun associateFeed(input: AssociateFeedRequest): AssociateFeedResponse

Associates a resource with the feed. The resource provides the input that Elemental Inference needs 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.

createFeed

abstract suspend fun createFeed(input: CreateFeedRequest): CreateFeedResponse

Creates a feed. The feed is the target for live streams being sent by the calling application. An example of a calling application is AWS Elemental MediaLive. After you create the feed, you can associate a resource with the feed.

deleteFeed

abstract suspend fun deleteFeed(input: DeleteFeedRequest): DeleteFeedResponse

Deletes the specified feed. The feed can be deleted at any time.

disassociateFeed

abstract suspend fun disassociateFeed(input: DisassociateFeedRequest): DisassociateFeedResponse

Releases the resource (for example, an MediaLive channel) that is associated with this feed. The outputs in the feed become disabled.

getFeed

abstract suspend fun getFeed(input: GetFeedRequest): GetFeedResponse

Retrieves information about the specified feed.

listFeeds

abstract suspend fun listFeeds(input: ListFeedsRequest = ListFeedsRequest { }): ListFeedsResponse

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

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

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

tagResource

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.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

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

updateFeed

abstract suspend fun updateFeed(input: UpdateFeedRequest): UpdateFeedResponse

Updates the name and/or outputs in a feed.

Inherited functions

associateFeed

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

createFeed

inline suspend fun ElementalInferenceClient.createFeed(crossinline block: CreateFeedRequest.Builder.() -> Unit): CreateFeedResponse

deleteFeed

inline suspend fun ElementalInferenceClient.deleteFeed(crossinline block: DeleteFeedRequest.Builder.() -> Unit): DeleteFeedResponse

Deletes the specified feed. The feed can be deleted at any time.

disassociateFeed

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

Releases the resource (for example, an MediaLive channel) that is associated with this feed. The outputs in the feed become disabled.

getFeed

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

Retrieves information about the specified feed.

listFeeds

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

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

listFeedsPaginated

fun ElementalInferenceClient.listFeedsPaginated(initialRequest: ListFeedsRequest = ListFeedsRequest { }): Flow<ListFeedsResponse>

fun ElementalInferenceClient.listFeedsPaginated(block: ListFeedsRequest.Builder.() -> Unit): Flow<ListFeedsResponse>

Paginate over ListFeedsResponse results.

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

untagResource

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

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

updateFeed

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

Updates the name and/or outputs in a feed.

waitUntilFeedDeleted

suspend fun ElementalInferenceClient.waitUntilFeedDeleted(block: GetFeedRequest.Builder.() -> Unit): <Error class: unknown class><GetFeedResponse>

suspend fun ElementalInferenceClient.waitUntilFeedDeleted(request: GetFeedRequest, retryStrategy: <Error class: unknown class>? = null): <Error class: unknown class><GetFeedResponse>

Wait until a Feed is deleted

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.