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

IvsRealTimeClient

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.

Key Concepts

Stage — A virtual space where participants can exchange video in real time.
Participant token — A token that authenticates a participant when they join a stage.
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.

For server-side composition:

Composition process — Composites participants of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels). Composition operations support this process.
Composition — Controls the look of the outputs, including how participants are positioned in the video.

For participant replication:

Source stage — The stage where the participant originally joined, which is used as the source for replication.
Destination stage — The stage to which the participant is replicated.
Replicated participant — A participant in a stage that is replicated to one or more destination stages.
Replica participant — A participant in a destination stage that is replicated from another stage (the source stage).

For more information about your IVS live stream, also see Getting Started with Amazon IVS Real-Time Streaming.

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 Best practices and strategies in Tagging AWS Resources and Tag Editor for details, 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 operations: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Stage.

At most 50 tags can be applied to a resource.

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.

createIngestConfiguration

abstract suspend fun createIngestConfiguration(input: CreateIngestConfigurationRequest): CreateIngestConfigurationResponse

Creates a new IngestConfiguration resource, used to specify the ingest protocol for a stage.

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.

deleteIngestConfiguration

abstract suspend fun deleteIngestConfiguration(input: DeleteIngestConfigurationRequest): DeleteIngestConfigurationResponse

Deletes a specified IngestConfiguration, so it can no longer be used to broadcast. An IngestConfiguration cannot be deleted if the publisher is actively streaming to a stage, unless force is set to true.

deletePublicKey

abstract suspend fun deletePublicKey(input: DeletePublicKeyRequest): DeletePublicKeyResponse

Deletes the specified public key used to sign stage participant tokens. This invalidates future participant tokens generated using the key pair’s private key.

deleteStage

abstract suspend fun deleteStage(input: DeleteStageRequest): DeleteStageResponse

Shuts down and deletes the specified stage (disconnecting all participants). This operation also removes the stageArn from the associated IngestConfiguration, if there are participants using the IngestConfiguration to publish to the stage.

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 from a specified stage. If the participant is publishing using an IngestConfiguration, DisconnectParticipant also updates the stageArn in the IngestConfiguration to be an empty string.

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.

getIngestConfiguration

abstract suspend fun getIngestConfiguration(input: GetIngestConfigurationRequest): GetIngestConfigurationResponse

Gets information about the specified IngestConfiguration.

getParticipant

abstract suspend fun getParticipant(input: GetParticipantRequest): GetParticipantResponse

Gets information about the specified participant token.

getPublicKey

abstract suspend fun getPublicKey(input: GetPublicKeyRequest): GetPublicKeyResponse

Gets information for the specified public key.

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.

importPublicKey

abstract suspend fun importPublicKey(input: ImportPublicKeyRequest): ImportPublicKeyResponse

Import a public key to be used for signing stage participant tokens.

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.

listIngestConfigurations

abstract suspend fun listIngestConfigurations(input: ListIngestConfigurationsRequest = ListIngestConfigurationsRequest { }): ListIngestConfigurationsResponse

Lists all IngestConfigurations 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.

listParticipantReplicas

abstract suspend fun listParticipantReplicas(input: ListParticipantReplicasRequest): ListParticipantReplicasResponse

Lists all the replicas for a participant from a source stage.

listParticipants

abstract suspend fun listParticipants(input: ListParticipantsRequest): ListParticipantsResponse

Lists all participants in a specified stage session.

listPublicKeys

abstract suspend fun listPublicKeys(input: ListPublicKeysRequest = ListPublicKeysRequest { }): ListPublicKeysResponse

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

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.

startParticipantReplication

abstract suspend fun startParticipantReplication(input: StartParticipantReplicationRequest): StartParticipantReplicationResponse

Starts replicating a publishing participant from a source stage to a destination stage.

stopComposition

abstract suspend fun stopComposition(input: StopCompositionRequest): StopCompositionResponse

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

stopParticipantReplication

abstract suspend fun stopParticipantReplication(input: StopParticipantReplicationRequest): StopParticipantReplicationResponse

Stops a replicated participant session.

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.

updateIngestConfiguration

abstract suspend fun updateIngestConfiguration(input: UpdateIngestConfigurationRequest): UpdateIngestConfigurationResponse

Updates a specified IngestConfiguration. Only the stage ARN attached to the IngestConfiguration can be updated. An IngestConfiguration that is active cannot be updated.

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.

createIngestConfiguration

inline suspend fun IvsRealTimeClient.createIngestConfiguration(crossinline block: CreateIngestConfigurationRequest.Builder.() -> Unit): CreateIngestConfigurationResponse

Creates a new IngestConfiguration resource, used to specify the ingest protocol for a stage.

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.

deleteIngestConfiguration

inline suspend fun IvsRealTimeClient.deleteIngestConfiguration(crossinline block: DeleteIngestConfigurationRequest.Builder.() -> Unit): DeleteIngestConfigurationResponse

deletePublicKey

inline suspend fun IvsRealTimeClient.deletePublicKey(crossinline block: DeletePublicKeyRequest.Builder.() -> Unit): DeletePublicKeyResponse

Deletes the specified public key used to sign stage participant tokens. This invalidates future participant tokens generated using the key pair’s private key.

deleteStage

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

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

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.

getIngestConfiguration

inline suspend fun IvsRealTimeClient.getIngestConfiguration(crossinline block: GetIngestConfigurationRequest.Builder.() -> Unit): GetIngestConfigurationResponse

Gets information about the specified IngestConfiguration.

getParticipant

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

Gets information about the specified participant token.

getPublicKey

inline suspend fun IvsRealTimeClient.getPublicKey(crossinline block: GetPublicKeyRequest.Builder.() -> Unit): GetPublicKeyResponse

Gets information for the specified public key.

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.

importPublicKey

inline suspend fun IvsRealTimeClient.importPublicKey(crossinline block: ImportPublicKeyRequest.Builder.() -> Unit): ImportPublicKeyResponse

Import a public key to be used for signing stage participant tokens.

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.

listIngestConfigurations

inline suspend fun IvsRealTimeClient.listIngestConfigurations(crossinline block: ListIngestConfigurationsRequest.Builder.() -> Unit): ListIngestConfigurationsResponse

Lists all IngestConfigurations in your account, in the AWS region where the API request is processed.

listIngestConfigurationsPaginated

fun IvsRealTimeClient.listIngestConfigurationsPaginated(initialRequest: ListIngestConfigurationsRequest = ListIngestConfigurationsRequest { }): Flow<ListIngestConfigurationsResponse>

fun IvsRealTimeClient.listIngestConfigurationsPaginated(block: ListIngestConfigurationsRequest.Builder.() -> Unit): Flow<ListIngestConfigurationsResponse>

Paginate over ListIngestConfigurationsResponse 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.

listParticipantReplicas

inline suspend fun IvsRealTimeClient.listParticipantReplicas(crossinline block: ListParticipantReplicasRequest.Builder.() -> Unit): ListParticipantReplicasResponse

Lists all the replicas for a participant from a source stage.

listParticipantReplicasPaginated

fun IvsRealTimeClient.listParticipantReplicasPaginated(initialRequest: ListParticipantReplicasRequest): Flow<ListParticipantReplicasResponse>

fun IvsRealTimeClient.listParticipantReplicasPaginated(block: ListParticipantReplicasRequest.Builder.() -> Unit): Flow<ListParticipantReplicasResponse>

Paginate over ListParticipantReplicasResponse 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.

listPublicKeys

inline suspend fun IvsRealTimeClient.listPublicKeys(crossinline block: ListPublicKeysRequest.Builder.() -> Unit): ListPublicKeysResponse

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

listPublicKeysPaginated

fun IvsRealTimeClient.listPublicKeysPaginated(initialRequest: ListPublicKeysRequest = ListPublicKeysRequest { }): Flow<ListPublicKeysResponse>

fun IvsRealTimeClient.listPublicKeysPaginated(block: ListPublicKeysRequest.Builder.() -> Unit): Flow<ListPublicKeysResponse>

Paginate over ListPublicKeysResponse 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.

startParticipantReplication

inline suspend fun IvsRealTimeClient.startParticipantReplication(crossinline block: StartParticipantReplicationRequest.Builder.() -> Unit): StartParticipantReplicationResponse

Starts replicating a publishing participant from a source stage to a destination stage.

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.

stopParticipantReplication

inline suspend fun IvsRealTimeClient.stopParticipantReplication(crossinline block: StopParticipantReplicationRequest.Builder.() -> Unit): StopParticipantReplicationResponse

Stops a replicated participant session.

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.

updateIngestConfiguration

inline suspend fun IvsRealTimeClient.updateIngestConfiguration(crossinline block: UpdateIngestConfigurationRequest.Builder.() -> Unit): UpdateIngestConfigurationResponse

Updates a specified IngestConfiguration. Only the stage ARN attached to the IngestConfiguration can be updated. An IngestConfiguration that is active cannot be updated.

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.