ivsrealtime/aws.sdk.kotlin.services.ivsrealtime/IvsRealTimeClient

IvsRealTimeClient

Introduction

The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors.

Terminology:

A stage is a virtual space where participants can exchange video in real time.
A participant token is a token that authenticates a participant when they join a stage.
A participant object represents participants (people) in the stage and contains information about them. When a token is created, it includes a participant ID; when a participant uses that token to join a stage, the participant is associated with that participant ID. There is a 1:1 mapping between participant tokens and participants.
Server-side composition: The composition process composites participants of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels). Composition endpoints support this process.
Server-side composition: A composition controls the look of the outputs, including how participants are positioned in the video.

Resources

The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS Real-Time Streaming):

Stage — A stage is a virtual space where participants can exchange video in real time.

Tagging

A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Tagging AWS Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS stages has no service-specific constraints beyond what is documented there.

Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).

The Amazon IVS real-time API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Stage.

At most 50 tags can be applied to a resource.

Stages Endpoints

CreateParticipantToken — Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire.
CreateStage — Creates a new stage (and optionally participant tokens).
DeleteStage — Shuts down and deletes the specified stage (disconnecting all participants).
DisconnectParticipant — Disconnects a specified participant and revokes the participant permanently from a specified stage.
GetParticipant — Gets information about the specified participant token.
GetStage — Gets information for the specified stage.
GetStageSession — Gets information for the specified stage session.
ListParticipantEvents — Lists events for a specified participant that occurred during a specified stage session.
ListParticipants — Lists all participants in a specified stage session.
ListStages — Gets summary information about all stages in your account, in the AWS region where the API request is processed.
ListStageSessions — Gets all sessions for a specified stage.
UpdateStage — Updates a stage’s configuration.

Composition Endpoints

GetComposition — Gets information about the specified Composition resource.
ListCompositions — Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.
StartComposition — Starts a Composition from a stage based on the configuration provided in the request.
StopComposition — Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.

EncoderConfiguration Endpoints

CreateEncoderConfiguration — Creates an EncoderConfiguration object.
DeleteEncoderConfiguration — Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.
GetEncoderConfiguration — Gets information about the specified EncoderConfiguration resource.
ListEncoderConfigurations — Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.

StorageConfiguration Endpoints

CreateStorageConfiguration — Creates a new storage configuration, used to enable recording to Amazon S3.
DeleteStorageConfiguration — Deletes the storage configuration for the specified ARN.
GetStorageConfiguration — Gets the storage configuration for the specified ARN.
ListStorageConfigurations — Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.

Tags Endpoints

ListTagsForResource — Gets information about AWS tags for the specified ARN.
TagResource — Adds or updates tags for the AWS resource with the specified ARN.
UntagResource — Removes tags from the resource with the specified ARN.

Types

Builder

class Builder : AbstractSdkClientBuilder<IvsRealTimeClient.Config, IvsRealTimeClient.Config.Builder, IvsRealTimeClient>

Companion

object Companion : AbstractAwsSdkClientFactory<IvsRealTimeClient.Config, IvsRealTimeClient.Config.Builder, IvsRealTimeClient, IvsRealTimeClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: IvsRealTimeClient.Config

IvsRealTimeClient's configuration

Functions

createEncoderConfiguration

abstract suspend fun createEncoderConfiguration(input: CreateEncoderConfigurationRequest = CreateEncoderConfigurationRequest { }): CreateEncoderConfigurationResponse

Creates an EncoderConfiguration object.

createParticipantToken

abstract suspend fun createParticipantToken(input: CreateParticipantTokenRequest): CreateParticipantTokenResponse

Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire. Tokens always are scoped to the stage for which they are created.

createStage

abstract suspend fun createStage(input: CreateStageRequest = CreateStageRequest { }): CreateStageResponse

Creates a new stage (and optionally participant tokens).

createStorageConfiguration

abstract suspend fun createStorageConfiguration(input: CreateStorageConfigurationRequest): CreateStorageConfigurationResponse

Creates a new storage configuration, used to enable recording to Amazon S3. When a StorageConfiguration is created, IVS will modify the S3 bucketPolicy of the provided bucket. This will ensure that IVS has sufficient permissions to write content to the provided bucket.

deleteEncoderConfiguration

abstract suspend fun deleteEncoderConfiguration(input: DeleteEncoderConfigurationRequest): DeleteEncoderConfigurationResponse

Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.

deleteStage

abstract suspend fun deleteStage(input: DeleteStageRequest): DeleteStageResponse

Shuts down and deletes the specified stage (disconnecting all participants).

deleteStorageConfiguration

abstract suspend fun deleteStorageConfiguration(input: DeleteStorageConfigurationRequest): DeleteStorageConfigurationResponse

Deletes the storage configuration for the specified ARN.

disconnectParticipant

abstract suspend fun disconnectParticipant(input: DisconnectParticipantRequest): DisconnectParticipantResponse

Disconnects a specified participant and revokes the participant permanently from a specified stage.

getComposition

abstract suspend fun getComposition(input: GetCompositionRequest): GetCompositionResponse

Get information about the specified Composition resource.

getEncoderConfiguration

abstract suspend fun getEncoderConfiguration(input: GetEncoderConfigurationRequest): GetEncoderConfigurationResponse

Gets information about the specified EncoderConfiguration resource.

getParticipant

abstract suspend fun getParticipant(input: GetParticipantRequest): GetParticipantResponse

Gets information about the specified participant token.

getStage

abstract suspend fun getStage(input: GetStageRequest): GetStageResponse

Gets information for the specified stage.

getStageSession

abstract suspend fun getStageSession(input: GetStageSessionRequest): GetStageSessionResponse

Gets information for the specified stage session.

getStorageConfiguration

abstract suspend fun getStorageConfiguration(input: GetStorageConfigurationRequest): GetStorageConfigurationResponse

Gets the storage configuration for the specified ARN.

listCompositions

abstract suspend fun listCompositions(input: ListCompositionsRequest = ListCompositionsRequest { }): ListCompositionsResponse

Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.

listEncoderConfigurations

abstract suspend fun listEncoderConfigurations(input: ListEncoderConfigurationsRequest = ListEncoderConfigurationsRequest { }): ListEncoderConfigurationsResponse

Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.

listParticipantEvents

abstract suspend fun listParticipantEvents(input: ListParticipantEventsRequest): ListParticipantEventsResponse

Lists events for a specified participant that occurred during a specified stage session.

listParticipants

abstract suspend fun listParticipants(input: ListParticipantsRequest): ListParticipantsResponse

Lists all participants in a specified stage session.

listStages

abstract suspend fun listStages(input: ListStagesRequest = ListStagesRequest { }): ListStagesResponse

Gets summary information about all stages in your account, in the AWS region where the API request is processed.

listStageSessions

abstract suspend fun listStageSessions(input: ListStageSessionsRequest): ListStageSessionsResponse

Gets all sessions for a specified stage.

listStorageConfigurations

abstract suspend fun listStorageConfigurations(input: ListStorageConfigurationsRequest = ListStorageConfigurationsRequest { }): ListStorageConfigurationsResponse

Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Gets information about AWS tags for the specified ARN.

startComposition

abstract suspend fun startComposition(input: StartCompositionRequest): StartCompositionResponse

Starts a Composition from a stage based on the configuration provided in the request.

stopComposition

abstract suspend fun stopComposition(input: StopCompositionRequest): StopCompositionResponse

Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds or updates tags for the AWS resource with the specified ARN.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes tags from the resource with the specified ARN.

updateStage

abstract suspend fun updateStage(input: UpdateStageRequest): UpdateStageResponse

Updates a stage’s configuration.

Inherited functions

expect abstract fun close()

createEncoderConfiguration

inline suspend fun IvsRealTimeClient.createEncoderConfiguration(crossinline block: CreateEncoderConfigurationRequest.Builder.() -> Unit): CreateEncoderConfigurationResponse

Creates an EncoderConfiguration object.

createParticipantToken

inline suspend fun IvsRealTimeClient.createParticipantToken(crossinline block: CreateParticipantTokenRequest.Builder.() -> Unit): CreateParticipantTokenResponse

Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire. Tokens always are scoped to the stage for which they are created.

createStage

inline suspend fun IvsRealTimeClient.createStage(crossinline block: CreateStageRequest.Builder.() -> Unit): CreateStageResponse

Creates a new stage (and optionally participant tokens).

createStorageConfiguration

inline suspend fun IvsRealTimeClient.createStorageConfiguration(crossinline block: CreateStorageConfigurationRequest.Builder.() -> Unit): CreateStorageConfigurationResponse

deleteEncoderConfiguration

inline suspend fun IvsRealTimeClient.deleteEncoderConfiguration(crossinline block: DeleteEncoderConfigurationRequest.Builder.() -> Unit): DeleteEncoderConfigurationResponse

Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.

deleteStage

inline suspend fun IvsRealTimeClient.deleteStage(crossinline block: DeleteStageRequest.Builder.() -> Unit): DeleteStageResponse

Shuts down and deletes the specified stage (disconnecting all participants).

deleteStorageConfiguration

inline suspend fun IvsRealTimeClient.deleteStorageConfiguration(crossinline block: DeleteStorageConfigurationRequest.Builder.() -> Unit): DeleteStorageConfigurationResponse

Deletes the storage configuration for the specified ARN.

disconnectParticipant

inline suspend fun IvsRealTimeClient.disconnectParticipant(crossinline block: DisconnectParticipantRequest.Builder.() -> Unit): DisconnectParticipantResponse

Disconnects a specified participant and revokes the participant permanently from a specified stage.

getComposition

inline suspend fun IvsRealTimeClient.getComposition(crossinline block: GetCompositionRequest.Builder.() -> Unit): GetCompositionResponse

Get information about the specified Composition resource.

getEncoderConfiguration

inline suspend fun IvsRealTimeClient.getEncoderConfiguration(crossinline block: GetEncoderConfigurationRequest.Builder.() -> Unit): GetEncoderConfigurationResponse

Gets information about the specified EncoderConfiguration resource.

getParticipant

inline suspend fun IvsRealTimeClient.getParticipant(crossinline block: GetParticipantRequest.Builder.() -> Unit): GetParticipantResponse

Gets information about the specified participant token.

getStage

inline suspend fun IvsRealTimeClient.getStage(crossinline block: GetStageRequest.Builder.() -> Unit): GetStageResponse

Gets information for the specified stage.

getStageSession

inline suspend fun IvsRealTimeClient.getStageSession(crossinline block: GetStageSessionRequest.Builder.() -> Unit): GetStageSessionResponse

Gets information for the specified stage session.

getStorageConfiguration

inline suspend fun IvsRealTimeClient.getStorageConfiguration(crossinline block: GetStorageConfigurationRequest.Builder.() -> Unit): GetStorageConfigurationResponse

Gets the storage configuration for the specified ARN.

listCompositions

inline suspend fun IvsRealTimeClient.listCompositions(crossinline block: ListCompositionsRequest.Builder.() -> Unit): ListCompositionsResponse

Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.

listCompositionsPaginated

fun IvsRealTimeClient.listCompositionsPaginated(initialRequest: ListCompositionsRequest = ListCompositionsRequest { }): Flow<ListCompositionsResponse>

fun IvsRealTimeClient.listCompositionsPaginated(block: ListCompositionsRequest.Builder.() -> Unit): Flow<ListCompositionsResponse>

Paginate over ListCompositionsResponse results.

listEncoderConfigurations

inline suspend fun IvsRealTimeClient.listEncoderConfigurations(crossinline block: ListEncoderConfigurationsRequest.Builder.() -> Unit): ListEncoderConfigurationsResponse

Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.

listEncoderConfigurationsPaginated

fun IvsRealTimeClient.listEncoderConfigurationsPaginated(initialRequest: ListEncoderConfigurationsRequest = ListEncoderConfigurationsRequest { }): Flow<ListEncoderConfigurationsResponse>

fun IvsRealTimeClient.listEncoderConfigurationsPaginated(block: ListEncoderConfigurationsRequest.Builder.() -> Unit): Flow<ListEncoderConfigurationsResponse>

Paginate over ListEncoderConfigurationsResponse results.

listParticipantEvents

inline suspend fun IvsRealTimeClient.listParticipantEvents(crossinline block: ListParticipantEventsRequest.Builder.() -> Unit): ListParticipantEventsResponse

Lists events for a specified participant that occurred during a specified stage session.

listParticipantEventsPaginated

fun IvsRealTimeClient.listParticipantEventsPaginated(initialRequest: ListParticipantEventsRequest): Flow<ListParticipantEventsResponse>

fun IvsRealTimeClient.listParticipantEventsPaginated(block: ListParticipantEventsRequest.Builder.() -> Unit): Flow<ListParticipantEventsResponse>

Paginate over ListParticipantEventsResponse results.

listParticipants

inline suspend fun IvsRealTimeClient.listParticipants(crossinline block: ListParticipantsRequest.Builder.() -> Unit): ListParticipantsResponse

Lists all participants in a specified stage session.

listParticipantsPaginated

fun IvsRealTimeClient.listParticipantsPaginated(initialRequest: ListParticipantsRequest): Flow<ListParticipantsResponse>

fun IvsRealTimeClient.listParticipantsPaginated(block: ListParticipantsRequest.Builder.() -> Unit): Flow<ListParticipantsResponse>

Paginate over ListParticipantsResponse results.

listStages

inline suspend fun IvsRealTimeClient.listStages(crossinline block: ListStagesRequest.Builder.() -> Unit): ListStagesResponse

Gets summary information about all stages in your account, in the AWS region where the API request is processed.

listStageSessions

inline suspend fun IvsRealTimeClient.listStageSessions(crossinline block: ListStageSessionsRequest.Builder.() -> Unit): ListStageSessionsResponse

Gets all sessions for a specified stage.

listStageSessionsPaginated

fun IvsRealTimeClient.listStageSessionsPaginated(initialRequest: ListStageSessionsRequest): Flow<ListStageSessionsResponse>

fun IvsRealTimeClient.listStageSessionsPaginated(block: ListStageSessionsRequest.Builder.() -> Unit): Flow<ListStageSessionsResponse>

Paginate over ListStageSessionsResponse results.

listStagesPaginated

fun IvsRealTimeClient.listStagesPaginated(initialRequest: ListStagesRequest = ListStagesRequest { }): Flow<ListStagesResponse>

fun IvsRealTimeClient.listStagesPaginated(block: ListStagesRequest.Builder.() -> Unit): Flow<ListStagesResponse>

Paginate over ListStagesResponse results.

listStorageConfigurations

inline suspend fun IvsRealTimeClient.listStorageConfigurations(crossinline block: ListStorageConfigurationsRequest.Builder.() -> Unit): ListStorageConfigurationsResponse

Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.

listStorageConfigurationsPaginated

fun IvsRealTimeClient.listStorageConfigurationsPaginated(initialRequest: ListStorageConfigurationsRequest = ListStorageConfigurationsRequest { }): Flow<ListStorageConfigurationsResponse>

fun IvsRealTimeClient.listStorageConfigurationsPaginated(block: ListStorageConfigurationsRequest.Builder.() -> Unit): Flow<ListStorageConfigurationsResponse>

Paginate over ListStorageConfigurationsResponse results.

listTagsForResource

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

Gets information about AWS tags for the specified ARN.

startComposition

inline suspend fun IvsRealTimeClient.startComposition(crossinline block: StartCompositionRequest.Builder.() -> Unit): StartCompositionResponse

Starts a Composition from a stage based on the configuration provided in the request.

stopComposition

inline suspend fun IvsRealTimeClient.stopComposition(crossinline block: StopCompositionRequest.Builder.() -> Unit): StopCompositionResponse

Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.

tagResource

inline suspend fun IvsRealTimeClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds or updates tags for the AWS resource with the specified ARN.

untagResource

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

Removes tags from the resource with the specified ARN.

updateStage

inline suspend fun IvsRealTimeClient.updateStage(crossinline block: UpdateStageRequest.Builder.() -> Unit): UpdateStageResponse

Updates a stage’s configuration.

withConfig

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

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.