chimesdkmediapipelines/aws.sdk.kotlin.services.chimesdkmediapipelines/ChimeSdkMediaPipelinesClient

ChimeSdkMediaPipelinesClient

interface ChimeSdkMediaPipelinesClient : SdkClient

The Amazon Chime SDK media pipeline APIs in this section allow software developers to create Amazon Chime SDK media pipelines that capture, concatenate, or stream your Amazon Chime SDK meetings. For more information about media pipelines, see Amazon Chime SDK media pipelines.

Types

Builder

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

Companion

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

Config

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

Properties

config

abstract override val config: ChimeSdkMediaPipelinesClient.Config

ChimeSdkMediaPipelinesClient's configuration

Functions

createMediaCapturePipeline

abstract suspend fun createMediaCapturePipeline(input: CreateMediaCapturePipelineRequest): CreateMediaCapturePipelineResponse

Creates a media pipeline.

createMediaConcatenationPipeline

abstract suspend fun createMediaConcatenationPipeline(input: CreateMediaConcatenationPipelineRequest): CreateMediaConcatenationPipelineResponse

Creates a media concatenation pipeline.

createMediaInsightsPipeline

abstract suspend fun createMediaInsightsPipeline(input: CreateMediaInsightsPipelineRequest): CreateMediaInsightsPipelineResponse

Creates a media insights pipeline.

createMediaInsightsPipelineConfiguration

abstract suspend fun createMediaInsightsPipelineConfiguration(input: CreateMediaInsightsPipelineConfigurationRequest): CreateMediaInsightsPipelineConfigurationResponse

A structure that contains the static configurations for a media insights pipeline.

createMediaLiveConnectorPipeline

abstract suspend fun createMediaLiveConnectorPipeline(input: CreateMediaLiveConnectorPipelineRequest): CreateMediaLiveConnectorPipelineResponse

Creates a media live connector pipeline in an Amazon Chime SDK meeting.

createMediaPipelineKinesisVideoStreamPool

abstract suspend fun createMediaPipelineKinesisVideoStreamPool(input: CreateMediaPipelineKinesisVideoStreamPoolRequest): CreateMediaPipelineKinesisVideoStreamPoolResponse

Creates an Amazon Kinesis Video Stream pool for use with media stream pipelines.

createMediaStreamPipeline

abstract suspend fun createMediaStreamPipeline(input: CreateMediaStreamPipelineRequest): CreateMediaStreamPipelineResponse

Creates a streaming media pipeline.

deleteMediaCapturePipeline

abstract suspend fun deleteMediaCapturePipeline(input: DeleteMediaCapturePipelineRequest): DeleteMediaCapturePipelineResponse

Deletes the media pipeline.

deleteMediaInsightsPipelineConfiguration

abstract suspend fun deleteMediaInsightsPipelineConfiguration(input: DeleteMediaInsightsPipelineConfigurationRequest): DeleteMediaInsightsPipelineConfigurationResponse

Deletes the specified configuration settings.

deleteMediaPipeline

abstract suspend fun deleteMediaPipeline(input: DeleteMediaPipelineRequest): DeleteMediaPipelineResponse

Deletes the media pipeline.

deleteMediaPipelineKinesisVideoStreamPool

abstract suspend fun deleteMediaPipelineKinesisVideoStreamPool(input: DeleteMediaPipelineKinesisVideoStreamPoolRequest): DeleteMediaPipelineKinesisVideoStreamPoolResponse

Deletes an Amazon Kinesis Video Stream pool.

getMediaCapturePipeline

abstract suspend fun getMediaCapturePipeline(input: GetMediaCapturePipelineRequest): GetMediaCapturePipelineResponse

Gets an existing media pipeline.

getMediaInsightsPipelineConfiguration

abstract suspend fun getMediaInsightsPipelineConfiguration(input: GetMediaInsightsPipelineConfigurationRequest): GetMediaInsightsPipelineConfigurationResponse

Gets the configuration settings for a media insights pipeline.

getMediaPipeline

abstract suspend fun getMediaPipeline(input: GetMediaPipelineRequest): GetMediaPipelineResponse

Gets an existing media pipeline.

getMediaPipelineKinesisVideoStreamPool

abstract suspend fun getMediaPipelineKinesisVideoStreamPool(input: GetMediaPipelineKinesisVideoStreamPoolRequest): GetMediaPipelineKinesisVideoStreamPoolResponse

Gets an Kinesis video stream pool.

getSpeakerSearchTask

abstract suspend fun getSpeakerSearchTask(input: GetSpeakerSearchTaskRequest): GetSpeakerSearchTaskResponse

Retrieves the details of the specified speaker search task.

getVoiceToneAnalysisTask

abstract suspend fun getVoiceToneAnalysisTask(input: GetVoiceToneAnalysisTaskRequest): GetVoiceToneAnalysisTaskResponse

Retrieves the details of a voice tone analysis task.

listMediaCapturePipelines

abstract suspend fun listMediaCapturePipelines(input: ListMediaCapturePipelinesRequest = ListMediaCapturePipelinesRequest { }): ListMediaCapturePipelinesResponse

Returns a list of media pipelines.

listMediaInsightsPipelineConfigurations

abstract suspend fun listMediaInsightsPipelineConfigurations(input: ListMediaInsightsPipelineConfigurationsRequest = ListMediaInsightsPipelineConfigurationsRequest { }): ListMediaInsightsPipelineConfigurationsResponse

Lists the available media insights pipeline configurations.

listMediaPipelineKinesisVideoStreamPools

abstract suspend fun listMediaPipelineKinesisVideoStreamPools(input: ListMediaPipelineKinesisVideoStreamPoolsRequest = ListMediaPipelineKinesisVideoStreamPoolsRequest { }): ListMediaPipelineKinesisVideoStreamPoolsResponse

Lists the video stream pools in the media pipeline.

listMediaPipelines

abstract suspend fun listMediaPipelines(input: ListMediaPipelinesRequest = ListMediaPipelinesRequest { }): ListMediaPipelinesResponse

Returns a list of media pipelines.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists the tags available for a media pipeline.

startSpeakerSearchTask

abstract suspend fun startSpeakerSearchTask(input: StartSpeakerSearchTaskRequest): StartSpeakerSearchTaskResponse

Starts a speaker search task.

startVoiceToneAnalysisTask

abstract suspend fun startVoiceToneAnalysisTask(input: StartVoiceToneAnalysisTaskRequest): StartVoiceToneAnalysisTaskResponse

Starts a voice tone analysis task. For more information about voice tone analysis, see Using Amazon Chime SDK voice analytics in the Amazon Chime SDK Developer Guide.

stopSpeakerSearchTask

abstract suspend fun stopSpeakerSearchTask(input: StopSpeakerSearchTaskRequest): StopSpeakerSearchTaskResponse

Stops a speaker search task.

stopVoiceToneAnalysisTask

abstract suspend fun stopVoiceToneAnalysisTask(input: StopVoiceToneAnalysisTaskRequest): StopVoiceToneAnalysisTaskResponse

Stops a voice tone analysis task.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

The ARN of the media pipeline that you want to tag. Consists of the pipeline's endpoint region, resource ID, and pipeline ID.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes any tags from a media pipeline.

updateMediaInsightsPipelineConfiguration

abstract suspend fun updateMediaInsightsPipelineConfiguration(input: UpdateMediaInsightsPipelineConfigurationRequest): UpdateMediaInsightsPipelineConfigurationResponse

Updates the media insights pipeline's configuration settings.

updateMediaInsightsPipelineStatus

abstract suspend fun updateMediaInsightsPipelineStatus(input: UpdateMediaInsightsPipelineStatusRequest): UpdateMediaInsightsPipelineStatusResponse

Updates the status of a media insights pipeline.

updateMediaPipelineKinesisVideoStreamPool

abstract suspend fun updateMediaPipelineKinesisVideoStreamPool(input: UpdateMediaPipelineKinesisVideoStreamPoolRequest): UpdateMediaPipelineKinesisVideoStreamPoolResponse

Updates an Amazon Kinesis Video Stream pool in a media pipeline.

Inherited functions

expect abstract fun close()

createMediaCapturePipeline

inline suspend fun ChimeSdkMediaPipelinesClient.createMediaCapturePipeline(crossinline block: CreateMediaCapturePipelineRequest.Builder.() -> Unit): CreateMediaCapturePipelineResponse

Creates a media pipeline.

createMediaConcatenationPipeline

inline suspend fun ChimeSdkMediaPipelinesClient.createMediaConcatenationPipeline(crossinline block: CreateMediaConcatenationPipelineRequest.Builder.() -> Unit): CreateMediaConcatenationPipelineResponse

Creates a media concatenation pipeline.

createMediaInsightsPipeline

inline suspend fun ChimeSdkMediaPipelinesClient.createMediaInsightsPipeline(crossinline block: CreateMediaInsightsPipelineRequest.Builder.() -> Unit): CreateMediaInsightsPipelineResponse

Creates a media insights pipeline.

createMediaInsightsPipelineConfiguration

inline suspend fun ChimeSdkMediaPipelinesClient.createMediaInsightsPipelineConfiguration(crossinline block: CreateMediaInsightsPipelineConfigurationRequest.Builder.() -> Unit): CreateMediaInsightsPipelineConfigurationResponse

A structure that contains the static configurations for a media insights pipeline.

createMediaLiveConnectorPipeline

inline suspend fun ChimeSdkMediaPipelinesClient.createMediaLiveConnectorPipeline(crossinline block: CreateMediaLiveConnectorPipelineRequest.Builder.() -> Unit): CreateMediaLiveConnectorPipelineResponse

Creates a media live connector pipeline in an Amazon Chime SDK meeting.

createMediaPipelineKinesisVideoStreamPool

inline suspend fun ChimeSdkMediaPipelinesClient.createMediaPipelineKinesisVideoStreamPool(crossinline block: CreateMediaPipelineKinesisVideoStreamPoolRequest.Builder.() -> Unit): CreateMediaPipelineKinesisVideoStreamPoolResponse

Creates an Amazon Kinesis Video Stream pool for use with media stream pipelines.

createMediaStreamPipeline

inline suspend fun ChimeSdkMediaPipelinesClient.createMediaStreamPipeline(crossinline block: CreateMediaStreamPipelineRequest.Builder.() -> Unit): CreateMediaStreamPipelineResponse

Creates a streaming media pipeline.

deleteMediaCapturePipeline

inline suspend fun ChimeSdkMediaPipelinesClient.deleteMediaCapturePipeline(crossinline block: DeleteMediaCapturePipelineRequest.Builder.() -> Unit): DeleteMediaCapturePipelineResponse

Deletes the media pipeline.

deleteMediaInsightsPipelineConfiguration

inline suspend fun ChimeSdkMediaPipelinesClient.deleteMediaInsightsPipelineConfiguration(crossinline block: DeleteMediaInsightsPipelineConfigurationRequest.Builder.() -> Unit): DeleteMediaInsightsPipelineConfigurationResponse

Deletes the specified configuration settings.

deleteMediaPipeline

inline suspend fun ChimeSdkMediaPipelinesClient.deleteMediaPipeline(crossinline block: DeleteMediaPipelineRequest.Builder.() -> Unit): DeleteMediaPipelineResponse

Deletes the media pipeline.

deleteMediaPipelineKinesisVideoStreamPool

inline suspend fun ChimeSdkMediaPipelinesClient.deleteMediaPipelineKinesisVideoStreamPool(crossinline block: DeleteMediaPipelineKinesisVideoStreamPoolRequest.Builder.() -> Unit): DeleteMediaPipelineKinesisVideoStreamPoolResponse

Deletes an Amazon Kinesis Video Stream pool.

getMediaCapturePipeline

inline suspend fun ChimeSdkMediaPipelinesClient.getMediaCapturePipeline(crossinline block: GetMediaCapturePipelineRequest.Builder.() -> Unit): GetMediaCapturePipelineResponse

Gets an existing media pipeline.

getMediaInsightsPipelineConfiguration

inline suspend fun ChimeSdkMediaPipelinesClient.getMediaInsightsPipelineConfiguration(crossinline block: GetMediaInsightsPipelineConfigurationRequest.Builder.() -> Unit): GetMediaInsightsPipelineConfigurationResponse

Gets the configuration settings for a media insights pipeline.

getMediaPipeline

inline suspend fun ChimeSdkMediaPipelinesClient.getMediaPipeline(crossinline block: GetMediaPipelineRequest.Builder.() -> Unit): GetMediaPipelineResponse

Gets an existing media pipeline.

getMediaPipelineKinesisVideoStreamPool

inline suspend fun ChimeSdkMediaPipelinesClient.getMediaPipelineKinesisVideoStreamPool(crossinline block: GetMediaPipelineKinesisVideoStreamPoolRequest.Builder.() -> Unit): GetMediaPipelineKinesisVideoStreamPoolResponse

Gets an Kinesis video stream pool.

getSpeakerSearchTask

inline suspend fun ChimeSdkMediaPipelinesClient.getSpeakerSearchTask(crossinline block: GetSpeakerSearchTaskRequest.Builder.() -> Unit): GetSpeakerSearchTaskResponse

Retrieves the details of the specified speaker search task.

getVoiceToneAnalysisTask

inline suspend fun ChimeSdkMediaPipelinesClient.getVoiceToneAnalysisTask(crossinline block: GetVoiceToneAnalysisTaskRequest.Builder.() -> Unit): GetVoiceToneAnalysisTaskResponse

Retrieves the details of a voice tone analysis task.

listMediaCapturePipelines

inline suspend fun ChimeSdkMediaPipelinesClient.listMediaCapturePipelines(crossinline block: ListMediaCapturePipelinesRequest.Builder.() -> Unit): ListMediaCapturePipelinesResponse

Returns a list of media pipelines.

listMediaCapturePipelinesPaginated

fun ChimeSdkMediaPipelinesClient.listMediaCapturePipelinesPaginated(initialRequest: ListMediaCapturePipelinesRequest = ListMediaCapturePipelinesRequest { }): Flow<ListMediaCapturePipelinesResponse>

fun ChimeSdkMediaPipelinesClient.listMediaCapturePipelinesPaginated(block: ListMediaCapturePipelinesRequest.Builder.() -> Unit): Flow<ListMediaCapturePipelinesResponse>

Paginate over ListMediaCapturePipelinesResponse results.

listMediaInsightsPipelineConfigurations

inline suspend fun ChimeSdkMediaPipelinesClient.listMediaInsightsPipelineConfigurations(crossinline block: ListMediaInsightsPipelineConfigurationsRequest.Builder.() -> Unit): ListMediaInsightsPipelineConfigurationsResponse

Lists the available media insights pipeline configurations.

listMediaInsightsPipelineConfigurationsPaginated

fun ChimeSdkMediaPipelinesClient.listMediaInsightsPipelineConfigurationsPaginated(initialRequest: ListMediaInsightsPipelineConfigurationsRequest = ListMediaInsightsPipelineConfigurationsRequest { }): Flow<ListMediaInsightsPipelineConfigurationsResponse>

fun ChimeSdkMediaPipelinesClient.listMediaInsightsPipelineConfigurationsPaginated(block: ListMediaInsightsPipelineConfigurationsRequest.Builder.() -> Unit): Flow<ListMediaInsightsPipelineConfigurationsResponse>

Paginate over ListMediaInsightsPipelineConfigurationsResponse results.

listMediaPipelineKinesisVideoStreamPools

inline suspend fun ChimeSdkMediaPipelinesClient.listMediaPipelineKinesisVideoStreamPools(crossinline block: ListMediaPipelineKinesisVideoStreamPoolsRequest.Builder.() -> Unit): ListMediaPipelineKinesisVideoStreamPoolsResponse

Lists the video stream pools in the media pipeline.

listMediaPipelineKinesisVideoStreamPoolsPaginated

fun ChimeSdkMediaPipelinesClient.listMediaPipelineKinesisVideoStreamPoolsPaginated(initialRequest: ListMediaPipelineKinesisVideoStreamPoolsRequest = ListMediaPipelineKinesisVideoStreamPoolsRequest { }): Flow<ListMediaPipelineKinesisVideoStreamPoolsResponse>

fun ChimeSdkMediaPipelinesClient.listMediaPipelineKinesisVideoStreamPoolsPaginated(block: ListMediaPipelineKinesisVideoStreamPoolsRequest.Builder.() -> Unit): Flow<ListMediaPipelineKinesisVideoStreamPoolsResponse>

Paginate over ListMediaPipelineKinesisVideoStreamPoolsResponse results.

listMediaPipelines

inline suspend fun ChimeSdkMediaPipelinesClient.listMediaPipelines(crossinline block: ListMediaPipelinesRequest.Builder.() -> Unit): ListMediaPipelinesResponse

Returns a list of media pipelines.

listMediaPipelinesPaginated

fun ChimeSdkMediaPipelinesClient.listMediaPipelinesPaginated(initialRequest: ListMediaPipelinesRequest = ListMediaPipelinesRequest { }): Flow<ListMediaPipelinesResponse>

fun ChimeSdkMediaPipelinesClient.listMediaPipelinesPaginated(block: ListMediaPipelinesRequest.Builder.() -> Unit): Flow<ListMediaPipelinesResponse>

Paginate over ListMediaPipelinesResponse results.

listTagsForResource

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

Lists the tags available for a media pipeline.

startSpeakerSearchTask

inline suspend fun ChimeSdkMediaPipelinesClient.startSpeakerSearchTask(crossinline block: StartSpeakerSearchTaskRequest.Builder.() -> Unit): StartSpeakerSearchTaskResponse

Starts a speaker search task.

startVoiceToneAnalysisTask

inline suspend fun ChimeSdkMediaPipelinesClient.startVoiceToneAnalysisTask(crossinline block: StartVoiceToneAnalysisTaskRequest.Builder.() -> Unit): StartVoiceToneAnalysisTaskResponse

Starts a voice tone analysis task. For more information about voice tone analysis, see Using Amazon Chime SDK voice analytics in the Amazon Chime SDK Developer Guide.

stopSpeakerSearchTask

inline suspend fun ChimeSdkMediaPipelinesClient.stopSpeakerSearchTask(crossinline block: StopSpeakerSearchTaskRequest.Builder.() -> Unit): StopSpeakerSearchTaskResponse

Stops a speaker search task.

stopVoiceToneAnalysisTask

inline suspend fun ChimeSdkMediaPipelinesClient.stopVoiceToneAnalysisTask(crossinline block: StopVoiceToneAnalysisTaskRequest.Builder.() -> Unit): StopVoiceToneAnalysisTaskResponse

Stops a voice tone analysis task.

tagResource

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

The ARN of the media pipeline that you want to tag. Consists of the pipeline's endpoint region, resource ID, and pipeline ID.

untagResource

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

Removes any tags from a media pipeline.

updateMediaInsightsPipelineConfiguration

inline suspend fun ChimeSdkMediaPipelinesClient.updateMediaInsightsPipelineConfiguration(crossinline block: UpdateMediaInsightsPipelineConfigurationRequest.Builder.() -> Unit): UpdateMediaInsightsPipelineConfigurationResponse

Updates the media insights pipeline's configuration settings.

updateMediaInsightsPipelineStatus

inline suspend fun ChimeSdkMediaPipelinesClient.updateMediaInsightsPipelineStatus(crossinline block: UpdateMediaInsightsPipelineStatusRequest.Builder.() -> Unit): UpdateMediaInsightsPipelineStatusResponse

Updates the status of a media insights pipeline.

updateMediaPipelineKinesisVideoStreamPool

inline suspend fun ChimeSdkMediaPipelinesClient.updateMediaPipelineKinesisVideoStreamPool(crossinline block: UpdateMediaPipelineKinesisVideoStreamPoolRequest.Builder.() -> Unit): UpdateMediaPipelineKinesisVideoStreamPoolResponse

Updates an Amazon Kinesis Video Stream pool in a media pipeline.

withConfig

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

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.