Interface ChimeSdkMediaPipelinesAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aChimeSdkMediaPipelinesAsyncClient
.create()
Create aChimeSdkMediaPipelinesAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createMediaCapturePipeline
(Consumer<CreateMediaCapturePipelineRequest.Builder> createMediaCapturePipelineRequest) Creates a media pipeline.createMediaCapturePipeline
(CreateMediaCapturePipelineRequest createMediaCapturePipelineRequest) Creates a media pipeline.createMediaConcatenationPipeline
(Consumer<CreateMediaConcatenationPipelineRequest.Builder> createMediaConcatenationPipelineRequest) Creates a media concatenation pipeline.createMediaConcatenationPipeline
(CreateMediaConcatenationPipelineRequest createMediaConcatenationPipelineRequest) Creates a media concatenation pipeline.createMediaInsightsPipeline
(Consumer<CreateMediaInsightsPipelineRequest.Builder> createMediaInsightsPipelineRequest) Creates a media insights pipeline.createMediaInsightsPipeline
(CreateMediaInsightsPipelineRequest createMediaInsightsPipelineRequest) Creates a media insights pipeline.createMediaInsightsPipelineConfiguration
(Consumer<CreateMediaInsightsPipelineConfigurationRequest.Builder> createMediaInsightsPipelineConfigurationRequest) A structure that contains the static configurations for a media insights pipeline.createMediaInsightsPipelineConfiguration
(CreateMediaInsightsPipelineConfigurationRequest createMediaInsightsPipelineConfigurationRequest) A structure that contains the static configurations for a media insights pipeline.createMediaLiveConnectorPipeline
(Consumer<CreateMediaLiveConnectorPipelineRequest.Builder> createMediaLiveConnectorPipelineRequest) Creates a media live connector pipeline in an Amazon Chime SDK meeting.createMediaLiveConnectorPipeline
(CreateMediaLiveConnectorPipelineRequest createMediaLiveConnectorPipelineRequest) Creates a media live connector pipeline in an Amazon Chime SDK meeting.createMediaPipelineKinesisVideoStreamPool
(Consumer<CreateMediaPipelineKinesisVideoStreamPoolRequest.Builder> createMediaPipelineKinesisVideoStreamPoolRequest) Creates an Kinesis video stream pool for the media pipeline.createMediaPipelineKinesisVideoStreamPool
(CreateMediaPipelineKinesisVideoStreamPoolRequest createMediaPipelineKinesisVideoStreamPoolRequest) Creates an Kinesis video stream pool for the media pipeline.createMediaStreamPipeline
(Consumer<CreateMediaStreamPipelineRequest.Builder> createMediaStreamPipelineRequest) Creates a streaming media pipeline.createMediaStreamPipeline
(CreateMediaStreamPipelineRequest createMediaStreamPipelineRequest) Creates a streaming media pipeline.deleteMediaCapturePipeline
(Consumer<DeleteMediaCapturePipelineRequest.Builder> deleteMediaCapturePipelineRequest) Deletes the media pipeline.deleteMediaCapturePipeline
(DeleteMediaCapturePipelineRequest deleteMediaCapturePipelineRequest) Deletes the media pipeline.deleteMediaInsightsPipelineConfiguration
(Consumer<DeleteMediaInsightsPipelineConfigurationRequest.Builder> deleteMediaInsightsPipelineConfigurationRequest) Deletes the specified configuration settings.deleteMediaInsightsPipelineConfiguration
(DeleteMediaInsightsPipelineConfigurationRequest deleteMediaInsightsPipelineConfigurationRequest) Deletes the specified configuration settings.deleteMediaPipeline
(Consumer<DeleteMediaPipelineRequest.Builder> deleteMediaPipelineRequest) Deletes the media pipeline.deleteMediaPipeline
(DeleteMediaPipelineRequest deleteMediaPipelineRequest) Deletes the media pipeline.deleteMediaPipelineKinesisVideoStreamPool
(Consumer<DeleteMediaPipelineKinesisVideoStreamPoolRequest.Builder> deleteMediaPipelineKinesisVideoStreamPoolRequest) Deletes an Kinesis video stream pool.deleteMediaPipelineKinesisVideoStreamPool
(DeleteMediaPipelineKinesisVideoStreamPoolRequest deleteMediaPipelineKinesisVideoStreamPoolRequest) Deletes an Kinesis video stream pool.getMediaCapturePipeline
(Consumer<GetMediaCapturePipelineRequest.Builder> getMediaCapturePipelineRequest) Gets an existing media pipeline.getMediaCapturePipeline
(GetMediaCapturePipelineRequest getMediaCapturePipelineRequest) Gets an existing media pipeline.getMediaInsightsPipelineConfiguration
(Consumer<GetMediaInsightsPipelineConfigurationRequest.Builder> getMediaInsightsPipelineConfigurationRequest) Gets the configuration settings for a media insights pipeline.getMediaInsightsPipelineConfiguration
(GetMediaInsightsPipelineConfigurationRequest getMediaInsightsPipelineConfigurationRequest) Gets the configuration settings for a media insights pipeline.getMediaPipeline
(Consumer<GetMediaPipelineRequest.Builder> getMediaPipelineRequest) Gets an existing media pipeline.getMediaPipeline
(GetMediaPipelineRequest getMediaPipelineRequest) Gets an existing media pipeline.getMediaPipelineKinesisVideoStreamPool
(Consumer<GetMediaPipelineKinesisVideoStreamPoolRequest.Builder> getMediaPipelineKinesisVideoStreamPoolRequest) Gets an Kinesis video stream pool.getMediaPipelineKinesisVideoStreamPool
(GetMediaPipelineKinesisVideoStreamPoolRequest getMediaPipelineKinesisVideoStreamPoolRequest) Gets an Kinesis video stream pool.getSpeakerSearchTask
(Consumer<GetSpeakerSearchTaskRequest.Builder> getSpeakerSearchTaskRequest) Retrieves the details of the specified speaker search task.getSpeakerSearchTask
(GetSpeakerSearchTaskRequest getSpeakerSearchTaskRequest) Retrieves the details of the specified speaker search task.getVoiceToneAnalysisTask
(Consumer<GetVoiceToneAnalysisTaskRequest.Builder> getVoiceToneAnalysisTaskRequest) Retrieves the details of a voice tone analysis task.getVoiceToneAnalysisTask
(GetVoiceToneAnalysisTaskRequest getVoiceToneAnalysisTaskRequest) Retrieves the details of a voice tone analysis task.listMediaCapturePipelines
(Consumer<ListMediaCapturePipelinesRequest.Builder> listMediaCapturePipelinesRequest) Returns a list of media pipelines.listMediaCapturePipelines
(ListMediaCapturePipelinesRequest listMediaCapturePipelinesRequest) Returns a list of media pipelines.listMediaCapturePipelinesPaginator
(Consumer<ListMediaCapturePipelinesRequest.Builder> listMediaCapturePipelinesRequest) This is a variant oflistMediaCapturePipelines(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaCapturePipelinesRequest)
operation.listMediaCapturePipelinesPaginator
(ListMediaCapturePipelinesRequest listMediaCapturePipelinesRequest) This is a variant oflistMediaCapturePipelines(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaCapturePipelinesRequest)
operation.listMediaInsightsPipelineConfigurations
(Consumer<ListMediaInsightsPipelineConfigurationsRequest.Builder> listMediaInsightsPipelineConfigurationsRequest) Lists the available media insights pipeline configurations.listMediaInsightsPipelineConfigurations
(ListMediaInsightsPipelineConfigurationsRequest listMediaInsightsPipelineConfigurationsRequest) Lists the available media insights pipeline configurations.listMediaInsightsPipelineConfigurationsPaginator
(Consumer<ListMediaInsightsPipelineConfigurationsRequest.Builder> listMediaInsightsPipelineConfigurationsRequest) listMediaInsightsPipelineConfigurationsPaginator
(ListMediaInsightsPipelineConfigurationsRequest listMediaInsightsPipelineConfigurationsRequest) listMediaPipelineKinesisVideoStreamPools
(Consumer<ListMediaPipelineKinesisVideoStreamPoolsRequest.Builder> listMediaPipelineKinesisVideoStreamPoolsRequest) Lists the video stream pools in the media pipeline.listMediaPipelineKinesisVideoStreamPools
(ListMediaPipelineKinesisVideoStreamPoolsRequest listMediaPipelineKinesisVideoStreamPoolsRequest) Lists the video stream pools in the media pipeline.listMediaPipelineKinesisVideoStreamPoolsPaginator
(Consumer<ListMediaPipelineKinesisVideoStreamPoolsRequest.Builder> listMediaPipelineKinesisVideoStreamPoolsRequest) listMediaPipelineKinesisVideoStreamPoolsPaginator
(ListMediaPipelineKinesisVideoStreamPoolsRequest listMediaPipelineKinesisVideoStreamPoolsRequest) listMediaPipelines
(Consumer<ListMediaPipelinesRequest.Builder> listMediaPipelinesRequest) Returns a list of media pipelines.listMediaPipelines
(ListMediaPipelinesRequest listMediaPipelinesRequest) Returns a list of media pipelines.default ListMediaPipelinesPublisher
listMediaPipelinesPaginator
(Consumer<ListMediaPipelinesRequest.Builder> listMediaPipelinesRequest) This is a variant oflistMediaPipelines(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaPipelinesRequest)
operation.default ListMediaPipelinesPublisher
listMediaPipelinesPaginator
(ListMediaPipelinesRequest listMediaPipelinesRequest) This is a variant oflistMediaPipelines(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaPipelinesRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags available for a media pipeline.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags available for a media pipeline.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartSpeakerSearchTask
(Consumer<StartSpeakerSearchTaskRequest.Builder> startSpeakerSearchTaskRequest) Starts a speaker search task.startSpeakerSearchTask
(StartSpeakerSearchTaskRequest startSpeakerSearchTaskRequest) Starts a speaker search task.startVoiceToneAnalysisTask
(Consumer<StartVoiceToneAnalysisTaskRequest.Builder> startVoiceToneAnalysisTaskRequest) Starts a voice tone analysis task.startVoiceToneAnalysisTask
(StartVoiceToneAnalysisTaskRequest startVoiceToneAnalysisTaskRequest) Starts a voice tone analysis task.stopSpeakerSearchTask
(Consumer<StopSpeakerSearchTaskRequest.Builder> stopSpeakerSearchTaskRequest) Stops a speaker search task.stopSpeakerSearchTask
(StopSpeakerSearchTaskRequest stopSpeakerSearchTaskRequest) Stops a speaker search task.stopVoiceToneAnalysisTask
(Consumer<StopVoiceToneAnalysisTaskRequest.Builder> stopVoiceToneAnalysisTaskRequest) Stops a voice tone analysis task.stopVoiceToneAnalysisTask
(StopVoiceToneAnalysisTaskRequest stopVoiceToneAnalysisTaskRequest) Stops a voice tone analysis task.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) The ARN of the media pipeline that you want to tag.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) The ARN of the media pipeline that you want to tag.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes any tags from a media pipeline.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes any tags from a media pipeline.updateMediaInsightsPipelineConfiguration
(Consumer<UpdateMediaInsightsPipelineConfigurationRequest.Builder> updateMediaInsightsPipelineConfigurationRequest) Updates the media insights pipeline's configuration settings.updateMediaInsightsPipelineConfiguration
(UpdateMediaInsightsPipelineConfigurationRequest updateMediaInsightsPipelineConfigurationRequest) Updates the media insights pipeline's configuration settings.updateMediaInsightsPipelineStatus
(Consumer<UpdateMediaInsightsPipelineStatusRequest.Builder> updateMediaInsightsPipelineStatusRequest) Updates the status of a media insights pipeline.updateMediaInsightsPipelineStatus
(UpdateMediaInsightsPipelineStatusRequest updateMediaInsightsPipelineStatusRequest) Updates the status of a media insights pipeline.updateMediaPipelineKinesisVideoStreamPool
(Consumer<UpdateMediaPipelineKinesisVideoStreamPoolRequest.Builder> updateMediaPipelineKinesisVideoStreamPoolRequest) Updates an Kinesis video stream pool in a media pipeline.updateMediaPipelineKinesisVideoStreamPool
(UpdateMediaPipelineKinesisVideoStreamPoolRequest updateMediaPipelineKinesisVideoStreamPoolRequest) Updates an Kinesis video stream pool in a media pipeline.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createMediaCapturePipeline
default CompletableFuture<CreateMediaCapturePipelineResponse> createMediaCapturePipeline(CreateMediaCapturePipelineRequest createMediaCapturePipelineRequest) Creates a media pipeline.
- Parameters:
createMediaCapturePipelineRequest
-- Returns:
- A Java Future containing the result of the CreateMediaCapturePipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMediaCapturePipeline
default CompletableFuture<CreateMediaCapturePipelineResponse> createMediaCapturePipeline(Consumer<CreateMediaCapturePipelineRequest.Builder> createMediaCapturePipelineRequest) Creates a media pipeline.
This is a convenience which creates an instance of the
CreateMediaCapturePipelineRequest.Builder
avoiding the need to create one manually viaCreateMediaCapturePipelineRequest.builder()
- Parameters:
createMediaCapturePipelineRequest
- AConsumer
that will call methods onCreateMediaCapturePipelineRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateMediaCapturePipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMediaConcatenationPipeline
default CompletableFuture<CreateMediaConcatenationPipelineResponse> createMediaConcatenationPipeline(CreateMediaConcatenationPipelineRequest createMediaConcatenationPipelineRequest) Creates a media concatenation pipeline.
- Parameters:
createMediaConcatenationPipelineRequest
-- Returns:
- A Java Future containing the result of the CreateMediaConcatenationPipeline operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMediaConcatenationPipeline
default CompletableFuture<CreateMediaConcatenationPipelineResponse> createMediaConcatenationPipeline(Consumer<CreateMediaConcatenationPipelineRequest.Builder> createMediaConcatenationPipelineRequest) Creates a media concatenation pipeline.
This is a convenience which creates an instance of the
CreateMediaConcatenationPipelineRequest.Builder
avoiding the need to create one manually viaCreateMediaConcatenationPipelineRequest.builder()
- Parameters:
createMediaConcatenationPipelineRequest
- AConsumer
that will call methods onCreateMediaConcatenationPipelineRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateMediaConcatenationPipeline operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMediaInsightsPipeline
default CompletableFuture<CreateMediaInsightsPipelineResponse> createMediaInsightsPipeline(CreateMediaInsightsPipelineRequest createMediaInsightsPipelineRequest) Creates a media insights pipeline.
- Parameters:
createMediaInsightsPipelineRequest
-- Returns:
- A Java Future containing the result of the CreateMediaInsightsPipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMediaInsightsPipeline
default CompletableFuture<CreateMediaInsightsPipelineResponse> createMediaInsightsPipeline(Consumer<CreateMediaInsightsPipelineRequest.Builder> createMediaInsightsPipelineRequest) Creates a media insights pipeline.
This is a convenience which creates an instance of the
CreateMediaInsightsPipelineRequest.Builder
avoiding the need to create one manually viaCreateMediaInsightsPipelineRequest.builder()
- Parameters:
createMediaInsightsPipelineRequest
- AConsumer
that will call methods onCreateMediaInsightsPipelineRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateMediaInsightsPipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMediaInsightsPipelineConfiguration
default CompletableFuture<CreateMediaInsightsPipelineConfigurationResponse> createMediaInsightsPipelineConfiguration(CreateMediaInsightsPipelineConfigurationRequest createMediaInsightsPipelineConfigurationRequest) A structure that contains the static configurations for a media insights pipeline.
- Parameters:
createMediaInsightsPipelineConfigurationRequest
-- Returns:
- A Java Future containing the result of the CreateMediaInsightsPipelineConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMediaInsightsPipelineConfiguration
default CompletableFuture<CreateMediaInsightsPipelineConfigurationResponse> createMediaInsightsPipelineConfiguration(Consumer<CreateMediaInsightsPipelineConfigurationRequest.Builder> createMediaInsightsPipelineConfigurationRequest) A structure that contains the static configurations for a media insights pipeline.
This is a convenience which creates an instance of the
CreateMediaInsightsPipelineConfigurationRequest.Builder
avoiding the need to create one manually viaCreateMediaInsightsPipelineConfigurationRequest.builder()
- Parameters:
createMediaInsightsPipelineConfigurationRequest
- AConsumer
that will call methods onCreateMediaInsightsPipelineConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateMediaInsightsPipelineConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMediaLiveConnectorPipeline
default CompletableFuture<CreateMediaLiveConnectorPipelineResponse> createMediaLiveConnectorPipeline(CreateMediaLiveConnectorPipelineRequest createMediaLiveConnectorPipelineRequest) Creates a media live connector pipeline in an Amazon Chime SDK meeting.
- Parameters:
createMediaLiveConnectorPipelineRequest
-- Returns:
- A Java Future containing the result of the CreateMediaLiveConnectorPipeline operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMediaLiveConnectorPipeline
default CompletableFuture<CreateMediaLiveConnectorPipelineResponse> createMediaLiveConnectorPipeline(Consumer<CreateMediaLiveConnectorPipelineRequest.Builder> createMediaLiveConnectorPipelineRequest) Creates a media live connector pipeline in an Amazon Chime SDK meeting.
This is a convenience which creates an instance of the
CreateMediaLiveConnectorPipelineRequest.Builder
avoiding the need to create one manually viaCreateMediaLiveConnectorPipelineRequest.builder()
- Parameters:
createMediaLiveConnectorPipelineRequest
- AConsumer
that will call methods onCreateMediaLiveConnectorPipelineRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateMediaLiveConnectorPipeline operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMediaPipelineKinesisVideoStreamPool
default CompletableFuture<CreateMediaPipelineKinesisVideoStreamPoolResponse> createMediaPipelineKinesisVideoStreamPool(CreateMediaPipelineKinesisVideoStreamPoolRequest createMediaPipelineKinesisVideoStreamPoolRequest) Creates an Kinesis video stream pool for the media pipeline.
- Parameters:
createMediaPipelineKinesisVideoStreamPoolRequest
-- Returns:
- A Java Future containing the result of the CreateMediaPipelineKinesisVideoStreamPool operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMediaPipelineKinesisVideoStreamPool
default CompletableFuture<CreateMediaPipelineKinesisVideoStreamPoolResponse> createMediaPipelineKinesisVideoStreamPool(Consumer<CreateMediaPipelineKinesisVideoStreamPoolRequest.Builder> createMediaPipelineKinesisVideoStreamPoolRequest) Creates an Kinesis video stream pool for the media pipeline.
This is a convenience which creates an instance of the
CreateMediaPipelineKinesisVideoStreamPoolRequest.Builder
avoiding the need to create one manually viaCreateMediaPipelineKinesisVideoStreamPoolRequest.builder()
- Parameters:
createMediaPipelineKinesisVideoStreamPoolRequest
- AConsumer
that will call methods onCreateMediaPipelineKinesisVideoStreamPoolRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateMediaPipelineKinesisVideoStreamPool operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMediaStreamPipeline
default CompletableFuture<CreateMediaStreamPipelineResponse> createMediaStreamPipeline(CreateMediaStreamPipelineRequest createMediaStreamPipelineRequest) Creates a streaming media pipeline.
- Parameters:
createMediaStreamPipelineRequest
-- Returns:
- A Java Future containing the result of the CreateMediaStreamPipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMediaStreamPipeline
default CompletableFuture<CreateMediaStreamPipelineResponse> createMediaStreamPipeline(Consumer<CreateMediaStreamPipelineRequest.Builder> createMediaStreamPipelineRequest) Creates a streaming media pipeline.
This is a convenience which creates an instance of the
CreateMediaStreamPipelineRequest.Builder
avoiding the need to create one manually viaCreateMediaStreamPipelineRequest.builder()
- Parameters:
createMediaStreamPipelineRequest
- AConsumer
that will call methods onCreateMediaStreamPipelineRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateMediaStreamPipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMediaCapturePipeline
default CompletableFuture<DeleteMediaCapturePipelineResponse> deleteMediaCapturePipeline(DeleteMediaCapturePipelineRequest deleteMediaCapturePipelineRequest) Deletes the media pipeline.
- Parameters:
deleteMediaCapturePipelineRequest
-- Returns:
- A Java Future containing the result of the DeleteMediaCapturePipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMediaCapturePipeline
default CompletableFuture<DeleteMediaCapturePipelineResponse> deleteMediaCapturePipeline(Consumer<DeleteMediaCapturePipelineRequest.Builder> deleteMediaCapturePipelineRequest) Deletes the media pipeline.
This is a convenience which creates an instance of the
DeleteMediaCapturePipelineRequest.Builder
avoiding the need to create one manually viaDeleteMediaCapturePipelineRequest.builder()
- Parameters:
deleteMediaCapturePipelineRequest
- AConsumer
that will call methods onDeleteMediaCapturePipelineRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteMediaCapturePipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMediaInsightsPipelineConfiguration
default CompletableFuture<DeleteMediaInsightsPipelineConfigurationResponse> deleteMediaInsightsPipelineConfiguration(DeleteMediaInsightsPipelineConfigurationRequest deleteMediaInsightsPipelineConfigurationRequest) Deletes the specified configuration settings.
- Parameters:
deleteMediaInsightsPipelineConfigurationRequest
-- Returns:
- A Java Future containing the result of the DeleteMediaInsightsPipelineConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMediaInsightsPipelineConfiguration
default CompletableFuture<DeleteMediaInsightsPipelineConfigurationResponse> deleteMediaInsightsPipelineConfiguration(Consumer<DeleteMediaInsightsPipelineConfigurationRequest.Builder> deleteMediaInsightsPipelineConfigurationRequest) Deletes the specified configuration settings.
This is a convenience which creates an instance of the
DeleteMediaInsightsPipelineConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteMediaInsightsPipelineConfigurationRequest.builder()
- Parameters:
deleteMediaInsightsPipelineConfigurationRequest
- AConsumer
that will call methods onDeleteMediaInsightsPipelineConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteMediaInsightsPipelineConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMediaPipeline
default CompletableFuture<DeleteMediaPipelineResponse> deleteMediaPipeline(DeleteMediaPipelineRequest deleteMediaPipelineRequest) Deletes the media pipeline.
- Parameters:
deleteMediaPipelineRequest
-- Returns:
- A Java Future containing the result of the DeleteMediaPipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMediaPipeline
default CompletableFuture<DeleteMediaPipelineResponse> deleteMediaPipeline(Consumer<DeleteMediaPipelineRequest.Builder> deleteMediaPipelineRequest) Deletes the media pipeline.
This is a convenience which creates an instance of the
DeleteMediaPipelineRequest.Builder
avoiding the need to create one manually viaDeleteMediaPipelineRequest.builder()
- Parameters:
deleteMediaPipelineRequest
- AConsumer
that will call methods onDeleteMediaPipelineRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteMediaPipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMediaPipelineKinesisVideoStreamPool
default CompletableFuture<DeleteMediaPipelineKinesisVideoStreamPoolResponse> deleteMediaPipelineKinesisVideoStreamPool(DeleteMediaPipelineKinesisVideoStreamPoolRequest deleteMediaPipelineKinesisVideoStreamPoolRequest) Deletes an Kinesis video stream pool.
- Parameters:
deleteMediaPipelineKinesisVideoStreamPoolRequest
-- Returns:
- A Java Future containing the result of the DeleteMediaPipelineKinesisVideoStreamPool operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMediaPipelineKinesisVideoStreamPool
default CompletableFuture<DeleteMediaPipelineKinesisVideoStreamPoolResponse> deleteMediaPipelineKinesisVideoStreamPool(Consumer<DeleteMediaPipelineKinesisVideoStreamPoolRequest.Builder> deleteMediaPipelineKinesisVideoStreamPoolRequest) Deletes an Kinesis video stream pool.
This is a convenience which creates an instance of the
DeleteMediaPipelineKinesisVideoStreamPoolRequest.Builder
avoiding the need to create one manually viaDeleteMediaPipelineKinesisVideoStreamPoolRequest.builder()
- Parameters:
deleteMediaPipelineKinesisVideoStreamPoolRequest
- AConsumer
that will call methods onDeleteMediaPipelineKinesisVideoStreamPoolRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteMediaPipelineKinesisVideoStreamPool operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMediaCapturePipeline
default CompletableFuture<GetMediaCapturePipelineResponse> getMediaCapturePipeline(GetMediaCapturePipelineRequest getMediaCapturePipelineRequest) Gets an existing media pipeline.
- Parameters:
getMediaCapturePipelineRequest
-- Returns:
- A Java Future containing the result of the GetMediaCapturePipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMediaCapturePipeline
default CompletableFuture<GetMediaCapturePipelineResponse> getMediaCapturePipeline(Consumer<GetMediaCapturePipelineRequest.Builder> getMediaCapturePipelineRequest) Gets an existing media pipeline.
This is a convenience which creates an instance of the
GetMediaCapturePipelineRequest.Builder
avoiding the need to create one manually viaGetMediaCapturePipelineRequest.builder()
- Parameters:
getMediaCapturePipelineRequest
- AConsumer
that will call methods onGetMediaCapturePipelineRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetMediaCapturePipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMediaInsightsPipelineConfiguration
default CompletableFuture<GetMediaInsightsPipelineConfigurationResponse> getMediaInsightsPipelineConfiguration(GetMediaInsightsPipelineConfigurationRequest getMediaInsightsPipelineConfigurationRequest) Gets the configuration settings for a media insights pipeline.
- Parameters:
getMediaInsightsPipelineConfigurationRequest
-- Returns:
- A Java Future containing the result of the GetMediaInsightsPipelineConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMediaInsightsPipelineConfiguration
default CompletableFuture<GetMediaInsightsPipelineConfigurationResponse> getMediaInsightsPipelineConfiguration(Consumer<GetMediaInsightsPipelineConfigurationRequest.Builder> getMediaInsightsPipelineConfigurationRequest) Gets the configuration settings for a media insights pipeline.
This is a convenience which creates an instance of the
GetMediaInsightsPipelineConfigurationRequest.Builder
avoiding the need to create one manually viaGetMediaInsightsPipelineConfigurationRequest.builder()
- Parameters:
getMediaInsightsPipelineConfigurationRequest
- AConsumer
that will call methods onGetMediaInsightsPipelineConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetMediaInsightsPipelineConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMediaPipeline
default CompletableFuture<GetMediaPipelineResponse> getMediaPipeline(GetMediaPipelineRequest getMediaPipelineRequest) Gets an existing media pipeline.
- Parameters:
getMediaPipelineRequest
-- Returns:
- A Java Future containing the result of the GetMediaPipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMediaPipeline
default CompletableFuture<GetMediaPipelineResponse> getMediaPipeline(Consumer<GetMediaPipelineRequest.Builder> getMediaPipelineRequest) Gets an existing media pipeline.
This is a convenience which creates an instance of the
GetMediaPipelineRequest.Builder
avoiding the need to create one manually viaGetMediaPipelineRequest.builder()
- Parameters:
getMediaPipelineRequest
- AConsumer
that will call methods onGetMediaPipelineRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetMediaPipeline operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMediaPipelineKinesisVideoStreamPool
default CompletableFuture<GetMediaPipelineKinesisVideoStreamPoolResponse> getMediaPipelineKinesisVideoStreamPool(GetMediaPipelineKinesisVideoStreamPoolRequest getMediaPipelineKinesisVideoStreamPoolRequest) Gets an Kinesis video stream pool.
- Parameters:
getMediaPipelineKinesisVideoStreamPoolRequest
-- Returns:
- A Java Future containing the result of the GetMediaPipelineKinesisVideoStreamPool operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMediaPipelineKinesisVideoStreamPool
default CompletableFuture<GetMediaPipelineKinesisVideoStreamPoolResponse> getMediaPipelineKinesisVideoStreamPool(Consumer<GetMediaPipelineKinesisVideoStreamPoolRequest.Builder> getMediaPipelineKinesisVideoStreamPoolRequest) Gets an Kinesis video stream pool.
This is a convenience which creates an instance of the
GetMediaPipelineKinesisVideoStreamPoolRequest.Builder
avoiding the need to create one manually viaGetMediaPipelineKinesisVideoStreamPoolRequest.builder()
- Parameters:
getMediaPipelineKinesisVideoStreamPoolRequest
- AConsumer
that will call methods onGetMediaPipelineKinesisVideoStreamPoolRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetMediaPipelineKinesisVideoStreamPool operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSpeakerSearchTask
default CompletableFuture<GetSpeakerSearchTaskResponse> getSpeakerSearchTask(GetSpeakerSearchTaskRequest getSpeakerSearchTaskRequest) Retrieves the details of the specified speaker search task.
- Parameters:
getSpeakerSearchTaskRequest
-- Returns:
- A Java Future containing the result of the GetSpeakerSearchTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSpeakerSearchTask
default CompletableFuture<GetSpeakerSearchTaskResponse> getSpeakerSearchTask(Consumer<GetSpeakerSearchTaskRequest.Builder> getSpeakerSearchTaskRequest) Retrieves the details of the specified speaker search task.
This is a convenience which creates an instance of the
GetSpeakerSearchTaskRequest.Builder
avoiding the need to create one manually viaGetSpeakerSearchTaskRequest.builder()
- Parameters:
getSpeakerSearchTaskRequest
- AConsumer
that will call methods onGetSpeakerSearchTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSpeakerSearchTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getVoiceToneAnalysisTask
default CompletableFuture<GetVoiceToneAnalysisTaskResponse> getVoiceToneAnalysisTask(GetVoiceToneAnalysisTaskRequest getVoiceToneAnalysisTaskRequest) Retrieves the details of a voice tone analysis task.
- Parameters:
getVoiceToneAnalysisTaskRequest
-- Returns:
- A Java Future containing the result of the GetVoiceToneAnalysisTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getVoiceToneAnalysisTask
default CompletableFuture<GetVoiceToneAnalysisTaskResponse> getVoiceToneAnalysisTask(Consumer<GetVoiceToneAnalysisTaskRequest.Builder> getVoiceToneAnalysisTaskRequest) Retrieves the details of a voice tone analysis task.
This is a convenience which creates an instance of the
GetVoiceToneAnalysisTaskRequest.Builder
avoiding the need to create one manually viaGetVoiceToneAnalysisTaskRequest.builder()
- Parameters:
getVoiceToneAnalysisTaskRequest
- AConsumer
that will call methods onGetVoiceToneAnalysisTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetVoiceToneAnalysisTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMediaCapturePipelines
default CompletableFuture<ListMediaCapturePipelinesResponse> listMediaCapturePipelines(ListMediaCapturePipelinesRequest listMediaCapturePipelinesRequest) Returns a list of media pipelines.
- Parameters:
listMediaCapturePipelinesRequest
-- Returns:
- A Java Future containing the result of the ListMediaCapturePipelines operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMediaCapturePipelines
default CompletableFuture<ListMediaCapturePipelinesResponse> listMediaCapturePipelines(Consumer<ListMediaCapturePipelinesRequest.Builder> listMediaCapturePipelinesRequest) Returns a list of media pipelines.
This is a convenience which creates an instance of the
ListMediaCapturePipelinesRequest.Builder
avoiding the need to create one manually viaListMediaCapturePipelinesRequest.builder()
- Parameters:
listMediaCapturePipelinesRequest
- AConsumer
that will call methods onListMediaCapturePipelinesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListMediaCapturePipelines operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMediaCapturePipelinesPaginator
default ListMediaCapturePipelinesPublisher listMediaCapturePipelinesPaginator(ListMediaCapturePipelinesRequest listMediaCapturePipelinesRequest) This is a variant of
listMediaCapturePipelines(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaCapturePipelinesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmediapipelines.paginators.ListMediaCapturePipelinesPublisher publisher = client.listMediaCapturePipelinesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmediapipelines.paginators.ListMediaCapturePipelinesPublisher publisher = client.listMediaCapturePipelinesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaCapturePipelinesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaCapturePipelinesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMediaCapturePipelines(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaCapturePipelinesRequest)
operation.- Parameters:
listMediaCapturePipelinesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMediaCapturePipelinesPaginator
default ListMediaCapturePipelinesPublisher listMediaCapturePipelinesPaginator(Consumer<ListMediaCapturePipelinesRequest.Builder> listMediaCapturePipelinesRequest) This is a variant of
listMediaCapturePipelines(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaCapturePipelinesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmediapipelines.paginators.ListMediaCapturePipelinesPublisher publisher = client.listMediaCapturePipelinesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmediapipelines.paginators.ListMediaCapturePipelinesPublisher publisher = client.listMediaCapturePipelinesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaCapturePipelinesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaCapturePipelinesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMediaCapturePipelines(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaCapturePipelinesRequest)
operation.
This is a convenience which creates an instance of the
ListMediaCapturePipelinesRequest.Builder
avoiding the need to create one manually viaListMediaCapturePipelinesRequest.builder()
- Parameters:
listMediaCapturePipelinesRequest
- AConsumer
that will call methods onListMediaCapturePipelinesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMediaInsightsPipelineConfigurations
default CompletableFuture<ListMediaInsightsPipelineConfigurationsResponse> listMediaInsightsPipelineConfigurations(ListMediaInsightsPipelineConfigurationsRequest listMediaInsightsPipelineConfigurationsRequest) Lists the available media insights pipeline configurations.
- Parameters:
listMediaInsightsPipelineConfigurationsRequest
-- Returns:
- A Java Future containing the result of the ListMediaInsightsPipelineConfigurations operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMediaInsightsPipelineConfigurations
default CompletableFuture<ListMediaInsightsPipelineConfigurationsResponse> listMediaInsightsPipelineConfigurations(Consumer<ListMediaInsightsPipelineConfigurationsRequest.Builder> listMediaInsightsPipelineConfigurationsRequest) Lists the available media insights pipeline configurations.
This is a convenience which creates an instance of the
ListMediaInsightsPipelineConfigurationsRequest.Builder
avoiding the need to create one manually viaListMediaInsightsPipelineConfigurationsRequest.builder()
- Parameters:
listMediaInsightsPipelineConfigurationsRequest
- AConsumer
that will call methods onListMediaInsightsPipelineConfigurationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListMediaInsightsPipelineConfigurations operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMediaInsightsPipelineConfigurationsPaginator
default ListMediaInsightsPipelineConfigurationsPublisher listMediaInsightsPipelineConfigurationsPaginator(ListMediaInsightsPipelineConfigurationsRequest listMediaInsightsPipelineConfigurationsRequest) This is a variant of
listMediaInsightsPipelineConfigurations(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaInsightsPipelineConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmediapipelines.paginators.ListMediaInsightsPipelineConfigurationsPublisher publisher = client.listMediaInsightsPipelineConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmediapipelines.paginators.ListMediaInsightsPipelineConfigurationsPublisher publisher = client.listMediaInsightsPipelineConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaInsightsPipelineConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaInsightsPipelineConfigurationsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMediaInsightsPipelineConfigurations(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaInsightsPipelineConfigurationsRequest)
operation.- Parameters:
listMediaInsightsPipelineConfigurationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMediaInsightsPipelineConfigurationsPaginator
default ListMediaInsightsPipelineConfigurationsPublisher listMediaInsightsPipelineConfigurationsPaginator(Consumer<ListMediaInsightsPipelineConfigurationsRequest.Builder> listMediaInsightsPipelineConfigurationsRequest) This is a variant of
listMediaInsightsPipelineConfigurations(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaInsightsPipelineConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmediapipelines.paginators.ListMediaInsightsPipelineConfigurationsPublisher publisher = client.listMediaInsightsPipelineConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmediapipelines.paginators.ListMediaInsightsPipelineConfigurationsPublisher publisher = client.listMediaInsightsPipelineConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaInsightsPipelineConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaInsightsPipelineConfigurationsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMediaInsightsPipelineConfigurations(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaInsightsPipelineConfigurationsRequest)
operation.
This is a convenience which creates an instance of the
ListMediaInsightsPipelineConfigurationsRequest.Builder
avoiding the need to create one manually viaListMediaInsightsPipelineConfigurationsRequest.builder()
- Parameters:
listMediaInsightsPipelineConfigurationsRequest
- AConsumer
that will call methods onListMediaInsightsPipelineConfigurationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMediaPipelineKinesisVideoStreamPools
default CompletableFuture<ListMediaPipelineKinesisVideoStreamPoolsResponse> listMediaPipelineKinesisVideoStreamPools(ListMediaPipelineKinesisVideoStreamPoolsRequest listMediaPipelineKinesisVideoStreamPoolsRequest) Lists the video stream pools in the media pipeline.
- Parameters:
listMediaPipelineKinesisVideoStreamPoolsRequest
-- Returns:
- A Java Future containing the result of the ListMediaPipelineKinesisVideoStreamPools operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMediaPipelineKinesisVideoStreamPools
default CompletableFuture<ListMediaPipelineKinesisVideoStreamPoolsResponse> listMediaPipelineKinesisVideoStreamPools(Consumer<ListMediaPipelineKinesisVideoStreamPoolsRequest.Builder> listMediaPipelineKinesisVideoStreamPoolsRequest) Lists the video stream pools in the media pipeline.
This is a convenience which creates an instance of the
ListMediaPipelineKinesisVideoStreamPoolsRequest.Builder
avoiding the need to create one manually viaListMediaPipelineKinesisVideoStreamPoolsRequest.builder()
- Parameters:
listMediaPipelineKinesisVideoStreamPoolsRequest
- AConsumer
that will call methods onListMediaPipelineKinesisVideoStreamPoolsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListMediaPipelineKinesisVideoStreamPools operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMediaPipelineKinesisVideoStreamPoolsPaginator
default ListMediaPipelineKinesisVideoStreamPoolsPublisher listMediaPipelineKinesisVideoStreamPoolsPaginator(ListMediaPipelineKinesisVideoStreamPoolsRequest listMediaPipelineKinesisVideoStreamPoolsRequest) This is a variant of
listMediaPipelineKinesisVideoStreamPools(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaPipelineKinesisVideoStreamPoolsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmediapipelines.paginators.ListMediaPipelineKinesisVideoStreamPoolsPublisher publisher = client.listMediaPipelineKinesisVideoStreamPoolsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmediapipelines.paginators.ListMediaPipelineKinesisVideoStreamPoolsPublisher publisher = client.listMediaPipelineKinesisVideoStreamPoolsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaPipelineKinesisVideoStreamPoolsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaPipelineKinesisVideoStreamPoolsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMediaPipelineKinesisVideoStreamPools(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaPipelineKinesisVideoStreamPoolsRequest)
operation.- Parameters:
listMediaPipelineKinesisVideoStreamPoolsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMediaPipelineKinesisVideoStreamPoolsPaginator
default ListMediaPipelineKinesisVideoStreamPoolsPublisher listMediaPipelineKinesisVideoStreamPoolsPaginator(Consumer<ListMediaPipelineKinesisVideoStreamPoolsRequest.Builder> listMediaPipelineKinesisVideoStreamPoolsRequest) This is a variant of
listMediaPipelineKinesisVideoStreamPools(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaPipelineKinesisVideoStreamPoolsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmediapipelines.paginators.ListMediaPipelineKinesisVideoStreamPoolsPublisher publisher = client.listMediaPipelineKinesisVideoStreamPoolsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmediapipelines.paginators.ListMediaPipelineKinesisVideoStreamPoolsPublisher publisher = client.listMediaPipelineKinesisVideoStreamPoolsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaPipelineKinesisVideoStreamPoolsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaPipelineKinesisVideoStreamPoolsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMediaPipelineKinesisVideoStreamPools(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaPipelineKinesisVideoStreamPoolsRequest)
operation.
This is a convenience which creates an instance of the
ListMediaPipelineKinesisVideoStreamPoolsRequest.Builder
avoiding the need to create one manually viaListMediaPipelineKinesisVideoStreamPoolsRequest.builder()
- Parameters:
listMediaPipelineKinesisVideoStreamPoolsRequest
- AConsumer
that will call methods onListMediaPipelineKinesisVideoStreamPoolsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMediaPipelines
default CompletableFuture<ListMediaPipelinesResponse> listMediaPipelines(ListMediaPipelinesRequest listMediaPipelinesRequest) Returns a list of media pipelines.
- Parameters:
listMediaPipelinesRequest
-- Returns:
- A Java Future containing the result of the ListMediaPipelines operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMediaPipelines
default CompletableFuture<ListMediaPipelinesResponse> listMediaPipelines(Consumer<ListMediaPipelinesRequest.Builder> listMediaPipelinesRequest) Returns a list of media pipelines.
This is a convenience which creates an instance of the
ListMediaPipelinesRequest.Builder
avoiding the need to create one manually viaListMediaPipelinesRequest.builder()
- Parameters:
listMediaPipelinesRequest
- AConsumer
that will call methods onListMediaPipelinesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListMediaPipelines operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMediaPipelinesPaginator
default ListMediaPipelinesPublisher listMediaPipelinesPaginator(ListMediaPipelinesRequest listMediaPipelinesRequest) This is a variant of
listMediaPipelines(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaPipelinesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmediapipelines.paginators.ListMediaPipelinesPublisher publisher = client.listMediaPipelinesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmediapipelines.paginators.ListMediaPipelinesPublisher publisher = client.listMediaPipelinesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaPipelinesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaPipelinesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMediaPipelines(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaPipelinesRequest)
operation.- Parameters:
listMediaPipelinesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMediaPipelinesPaginator
default ListMediaPipelinesPublisher listMediaPipelinesPaginator(Consumer<ListMediaPipelinesRequest.Builder> listMediaPipelinesRequest) This is a variant of
listMediaPipelines(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaPipelinesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.chimesdkmediapipelines.paginators.ListMediaPipelinesPublisher publisher = client.listMediaPipelinesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.chimesdkmediapipelines.paginators.ListMediaPipelinesPublisher publisher = client.listMediaPipelinesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaPipelinesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaPipelinesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMediaPipelines(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaPipelinesRequest)
operation.
This is a convenience which creates an instance of the
ListMediaPipelinesRequest.Builder
avoiding the need to create one manually viaListMediaPipelinesRequest.builder()
- Parameters:
listMediaPipelinesRequest
- AConsumer
that will call methods onListMediaPipelinesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ResourceLimitExceededException The request exceeds the resource limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags available for a media pipeline.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException One or more of the resources in the request does not exist in the system.
- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags available for a media pipeline.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException One or more of the resources in the request does not exist in the system.
- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startSpeakerSearchTask
default CompletableFuture<StartSpeakerSearchTaskResponse> startSpeakerSearchTask(StartSpeakerSearchTaskRequest startSpeakerSearchTaskRequest) Starts a speaker search task.
Before starting any speaker search tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.
- Parameters:
startSpeakerSearchTaskRequest
-- Returns:
- A Java Future containing the result of the StartSpeakerSearchTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startSpeakerSearchTask
default CompletableFuture<StartSpeakerSearchTaskResponse> startSpeakerSearchTask(Consumer<StartSpeakerSearchTaskRequest.Builder> startSpeakerSearchTaskRequest) Starts a speaker search task.
Before starting any speaker search tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.
This is a convenience which creates an instance of the
StartSpeakerSearchTaskRequest.Builder
avoiding the need to create one manually viaStartSpeakerSearchTaskRequest.builder()
- Parameters:
startSpeakerSearchTaskRequest
- AConsumer
that will call methods onStartSpeakerSearchTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartSpeakerSearchTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startVoiceToneAnalysisTask
default CompletableFuture<StartVoiceToneAnalysisTaskResponse> startVoiceToneAnalysisTask(StartVoiceToneAnalysisTaskRequest startVoiceToneAnalysisTaskRequest) 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.
Before starting any voice tone analysis tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.
- Parameters:
startVoiceToneAnalysisTaskRequest
-- Returns:
- A Java Future containing the result of the StartVoiceToneAnalysisTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startVoiceToneAnalysisTask
default CompletableFuture<StartVoiceToneAnalysisTaskResponse> startVoiceToneAnalysisTask(Consumer<StartVoiceToneAnalysisTaskRequest.Builder> startVoiceToneAnalysisTaskRequest) 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.
Before starting any voice tone analysis tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.
This is a convenience which creates an instance of the
StartVoiceToneAnalysisTaskRequest.Builder
avoiding the need to create one manually viaStartVoiceToneAnalysisTaskRequest.builder()
- Parameters:
startVoiceToneAnalysisTaskRequest
- AConsumer
that will call methods onStartVoiceToneAnalysisTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartVoiceToneAnalysisTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopSpeakerSearchTask
default CompletableFuture<StopSpeakerSearchTaskResponse> stopSpeakerSearchTask(StopSpeakerSearchTaskRequest stopSpeakerSearchTaskRequest) Stops a speaker search task.
- Parameters:
stopSpeakerSearchTaskRequest
-- Returns:
- A Java Future containing the result of the StopSpeakerSearchTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopSpeakerSearchTask
default CompletableFuture<StopSpeakerSearchTaskResponse> stopSpeakerSearchTask(Consumer<StopSpeakerSearchTaskRequest.Builder> stopSpeakerSearchTaskRequest) Stops a speaker search task.
This is a convenience which creates an instance of the
StopSpeakerSearchTaskRequest.Builder
avoiding the need to create one manually viaStopSpeakerSearchTaskRequest.builder()
- Parameters:
stopSpeakerSearchTaskRequest
- AConsumer
that will call methods onStopSpeakerSearchTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopSpeakerSearchTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopVoiceToneAnalysisTask
default CompletableFuture<StopVoiceToneAnalysisTaskResponse> stopVoiceToneAnalysisTask(StopVoiceToneAnalysisTaskRequest stopVoiceToneAnalysisTaskRequest) Stops a voice tone analysis task.
- Parameters:
stopVoiceToneAnalysisTaskRequest
-- Returns:
- A Java Future containing the result of the StopVoiceToneAnalysisTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopVoiceToneAnalysisTask
default CompletableFuture<StopVoiceToneAnalysisTaskResponse> stopVoiceToneAnalysisTask(Consumer<StopVoiceToneAnalysisTaskRequest.Builder> stopVoiceToneAnalysisTaskRequest) Stops a voice tone analysis task.
This is a convenience which creates an instance of the
StopVoiceToneAnalysisTaskRequest.Builder
avoiding the need to create one manually viaStopVoiceToneAnalysisTaskRequest.builder()
- Parameters:
stopVoiceToneAnalysisTaskRequest
- AConsumer
that will call methods onStopVoiceToneAnalysisTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopVoiceToneAnalysisTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
The ARN of the media pipeline that you want to tag. Consists of the pipeline's endpoint region, resource ID, and pipeline ID.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException One or more of the resources in the request does not exist in the system.
- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) The ARN of the media pipeline that you want to tag. Consists of the pipeline's endpoint region, resource ID, and pipeline ID.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException One or more of the resources in the request does not exist in the system.
- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes any tags from a media pipeline.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException One or more of the resources in the request does not exist in the system.
- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes any tags from a media pipeline.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException One or more of the resources in the request does not exist in the system.
- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateMediaInsightsPipelineConfiguration
default CompletableFuture<UpdateMediaInsightsPipelineConfigurationResponse> updateMediaInsightsPipelineConfiguration(UpdateMediaInsightsPipelineConfigurationRequest updateMediaInsightsPipelineConfigurationRequest) Updates the media insights pipeline's configuration settings.
- Parameters:
updateMediaInsightsPipelineConfigurationRequest
-- Returns:
- A Java Future containing the result of the UpdateMediaInsightsPipelineConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateMediaInsightsPipelineConfiguration
default CompletableFuture<UpdateMediaInsightsPipelineConfigurationResponse> updateMediaInsightsPipelineConfiguration(Consumer<UpdateMediaInsightsPipelineConfigurationRequest.Builder> updateMediaInsightsPipelineConfigurationRequest) Updates the media insights pipeline's configuration settings.
This is a convenience which creates an instance of the
UpdateMediaInsightsPipelineConfigurationRequest.Builder
avoiding the need to create one manually viaUpdateMediaInsightsPipelineConfigurationRequest.builder()
- Parameters:
updateMediaInsightsPipelineConfigurationRequest
- AConsumer
that will call methods onUpdateMediaInsightsPipelineConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateMediaInsightsPipelineConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateMediaInsightsPipelineStatus
default CompletableFuture<UpdateMediaInsightsPipelineStatusResponse> updateMediaInsightsPipelineStatus(UpdateMediaInsightsPipelineStatusRequest updateMediaInsightsPipelineStatusRequest) Updates the status of a media insights pipeline.
- Parameters:
updateMediaInsightsPipelineStatusRequest
-- Returns:
- A Java Future containing the result of the UpdateMediaInsightsPipelineStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateMediaInsightsPipelineStatus
default CompletableFuture<UpdateMediaInsightsPipelineStatusResponse> updateMediaInsightsPipelineStatus(Consumer<UpdateMediaInsightsPipelineStatusRequest.Builder> updateMediaInsightsPipelineStatusRequest) Updates the status of a media insights pipeline.
This is a convenience which creates an instance of the
UpdateMediaInsightsPipelineStatusRequest.Builder
avoiding the need to create one manually viaUpdateMediaInsightsPipelineStatusRequest.builder()
- Parameters:
updateMediaInsightsPipelineStatusRequest
- AConsumer
that will call methods onUpdateMediaInsightsPipelineStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateMediaInsightsPipelineStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- NotFoundException One or more of the resources in the request does not exist in the system.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateMediaPipelineKinesisVideoStreamPool
default CompletableFuture<UpdateMediaPipelineKinesisVideoStreamPoolResponse> updateMediaPipelineKinesisVideoStreamPool(UpdateMediaPipelineKinesisVideoStreamPoolRequest updateMediaPipelineKinesisVideoStreamPoolRequest) Updates an Kinesis video stream pool in a media pipeline.
- Parameters:
updateMediaPipelineKinesisVideoStreamPoolRequest
-- Returns:
- A Java Future containing the result of the UpdateMediaPipelineKinesisVideoStreamPool operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateMediaPipelineKinesisVideoStreamPool
default CompletableFuture<UpdateMediaPipelineKinesisVideoStreamPoolResponse> updateMediaPipelineKinesisVideoStreamPool(Consumer<UpdateMediaPipelineKinesisVideoStreamPoolRequest.Builder> updateMediaPipelineKinesisVideoStreamPoolRequest) Updates an Kinesis video stream pool in a media pipeline.
This is a convenience which creates an instance of the
UpdateMediaPipelineKinesisVideoStreamPoolRequest.Builder
avoiding the need to create one manually viaUpdateMediaPipelineKinesisVideoStreamPoolRequest.builder()
- Parameters:
updateMediaPipelineKinesisVideoStreamPoolRequest
- AConsumer
that will call methods onUpdateMediaPipelineKinesisVideoStreamPoolRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateMediaPipelineKinesisVideoStreamPool operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException The input parameters don't match the service's restrictions.
- ForbiddenException The client is permanently forbidden from making the request.
- NotFoundException One or more of the resources in the request does not exist in the system.
- UnauthorizedClientException The client is not currently authorized to make the request.
- ThrottledClientException The client exceeded its request rate limit.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- ServiceUnavailableException The service is currently unavailable.
- ServiceFailureException The service encountered an unexpected error.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ChimeSdkMediaPipelinesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aChimeSdkMediaPipelinesAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aChimeSdkMediaPipelinesAsyncClient
.
-