ivsrealtime/aws.sdk.kotlin.services.ivsrealtime

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

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

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

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

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

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

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

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 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

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.

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.

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.

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.

listParticipantReplicas

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

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

listParticipants

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

Lists all participants in a specified stage session.

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.

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.

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.

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.