@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonChimeSDKMediaPipelinesClient extends AmazonWebServiceClient implements AmazonChimeSDKMediaPipelines
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.
| Modifier and Type | Field and Description |
|---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to this client
|
client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffsetENDPOINT_PREFIXaddRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffsetprotected static final ClientConfigurationFactory configFactory
public static AmazonChimeSDKMediaPipelinesClientBuilder builder()
public CreateMediaCapturePipelineResult createMediaCapturePipeline(CreateMediaCapturePipelineRequest request)
Creates a media pipeline.
createMediaCapturePipeline in interface AmazonChimeSDKMediaPipelinescreateMediaCapturePipelineRequest - 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.public CreateMediaConcatenationPipelineResult createMediaConcatenationPipeline(CreateMediaConcatenationPipelineRequest request)
Creates a media concatenation pipeline.
createMediaConcatenationPipeline in interface AmazonChimeSDKMediaPipelinescreateMediaConcatenationPipelineRequest - 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.public CreateMediaInsightsPipelineResult createMediaInsightsPipeline(CreateMediaInsightsPipelineRequest request)
Creates a media insights pipeline.
createMediaInsightsPipeline in interface AmazonChimeSDKMediaPipelinescreateMediaInsightsPipelineRequest - 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.public CreateMediaInsightsPipelineConfigurationResult createMediaInsightsPipelineConfiguration(CreateMediaInsightsPipelineConfigurationRequest request)
A structure that contains the static configurations for a media insights pipeline.
createMediaInsightsPipelineConfiguration in interface AmazonChimeSDKMediaPipelinescreateMediaInsightsPipelineConfigurationRequest - 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.public CreateMediaLiveConnectorPipelineResult createMediaLiveConnectorPipeline(CreateMediaLiveConnectorPipelineRequest request)
Creates a media live connector pipeline in an Amazon Chime SDK meeting.
createMediaLiveConnectorPipeline in interface AmazonChimeSDKMediaPipelinescreateMediaLiveConnectorPipelineRequest - 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.public DeleteMediaCapturePipelineResult deleteMediaCapturePipeline(DeleteMediaCapturePipelineRequest request)
Deletes the media pipeline.
deleteMediaCapturePipeline in interface AmazonChimeSDKMediaPipelinesdeleteMediaCapturePipelineRequest - 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.public DeleteMediaInsightsPipelineConfigurationResult deleteMediaInsightsPipelineConfiguration(DeleteMediaInsightsPipelineConfigurationRequest request)
Deletes the specified configuration settings.
deleteMediaInsightsPipelineConfiguration in interface AmazonChimeSDKMediaPipelinesdeleteMediaInsightsPipelineConfigurationRequest - 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.public DeleteMediaPipelineResult deleteMediaPipeline(DeleteMediaPipelineRequest request)
Deletes the media pipeline.
deleteMediaPipeline in interface AmazonChimeSDKMediaPipelinesdeleteMediaPipelineRequest - 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.public GetMediaCapturePipelineResult getMediaCapturePipeline(GetMediaCapturePipelineRequest request)
Gets an existing media pipeline.
getMediaCapturePipeline in interface AmazonChimeSDKMediaPipelinesgetMediaCapturePipelineRequest - 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.public GetMediaInsightsPipelineConfigurationResult getMediaInsightsPipelineConfiguration(GetMediaInsightsPipelineConfigurationRequest request)
Gets the configuration settings for a media insights pipeline.
getMediaInsightsPipelineConfiguration in interface AmazonChimeSDKMediaPipelinesgetMediaInsightsPipelineConfigurationRequest - 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.public GetMediaPipelineResult getMediaPipeline(GetMediaPipelineRequest request)
Gets an existing media pipeline.
getMediaPipeline in interface AmazonChimeSDKMediaPipelinesgetMediaPipelineRequest - 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.public GetSpeakerSearchTaskResult getSpeakerSearchTask(GetSpeakerSearchTaskRequest request)
Retrieves the details of the specified speaker search task.
getSpeakerSearchTask in interface AmazonChimeSDKMediaPipelinesgetSpeakerSearchTaskRequest - 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.public GetVoiceToneAnalysisTaskResult getVoiceToneAnalysisTask(GetVoiceToneAnalysisTaskRequest request)
Retrieves the details of a voice tone analysis task.
getVoiceToneAnalysisTask in interface AmazonChimeSDKMediaPipelinesgetVoiceToneAnalysisTaskRequest - 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.public ListMediaCapturePipelinesResult listMediaCapturePipelines(ListMediaCapturePipelinesRequest request)
Returns a list of media pipelines.
listMediaCapturePipelines in interface AmazonChimeSDKMediaPipelineslistMediaCapturePipelinesRequest - 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.public ListMediaInsightsPipelineConfigurationsResult listMediaInsightsPipelineConfigurations(ListMediaInsightsPipelineConfigurationsRequest request)
Lists the available media insights pipeline configurations.
listMediaInsightsPipelineConfigurations in interface AmazonChimeSDKMediaPipelineslistMediaInsightsPipelineConfigurationsRequest - 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.public ListMediaPipelinesResult listMediaPipelines(ListMediaPipelinesRequest request)
Returns a list of media pipelines.
listMediaPipelines in interface AmazonChimeSDKMediaPipelineslistMediaPipelinesRequest - 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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists the tags available for a media pipeline.
listTagsForResource in interface AmazonChimeSDKMediaPipelineslistTagsForResourceRequest - 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.public StartSpeakerSearchTaskResult startSpeakerSearchTask(StartSpeakerSearchTaskRequest request)
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.
startSpeakerSearchTask in interface AmazonChimeSDKMediaPipelinesstartSpeakerSearchTaskRequest - 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.public StartVoiceToneAnalysisTaskResult startVoiceToneAnalysisTask(StartVoiceToneAnalysisTaskRequest request)
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.
startVoiceToneAnalysisTask in interface AmazonChimeSDKMediaPipelinesstartVoiceToneAnalysisTaskRequest - 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.public StopSpeakerSearchTaskResult stopSpeakerSearchTask(StopSpeakerSearchTaskRequest request)
Stops a speaker search task.
stopSpeakerSearchTask in interface AmazonChimeSDKMediaPipelinesstopSpeakerSearchTaskRequest - 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.public StopVoiceToneAnalysisTaskResult stopVoiceToneAnalysisTask(StopVoiceToneAnalysisTaskRequest request)
Stops a voice tone analysis task.
stopVoiceToneAnalysisTask in interface AmazonChimeSDKMediaPipelinesstopVoiceToneAnalysisTaskRequest - 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.public TagResourceResult tagResource(TagResourceRequest request)
The ARN of the media pipeline that you want to tag. Consists of the pipeline's endpoint region, resource ID, and pipeline ID.
tagResource in interface AmazonChimeSDKMediaPipelinestagResourceRequest - 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.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes any tags from a media pipeline.
untagResource in interface AmazonChimeSDKMediaPipelinesuntagResourceRequest - 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.public UpdateMediaInsightsPipelineConfigurationResult updateMediaInsightsPipelineConfiguration(UpdateMediaInsightsPipelineConfigurationRequest request)
Updates the media insights pipeline's configuration settings.
updateMediaInsightsPipelineConfiguration in interface AmazonChimeSDKMediaPipelinesupdateMediaInsightsPipelineConfigurationRequest - 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.public UpdateMediaInsightsPipelineStatusResult updateMediaInsightsPipelineStatus(UpdateMediaInsightsPipelineStatusRequest request)
Updates the status of a media insights pipeline.
updateMediaInsightsPipelineStatus in interface AmazonChimeSDKMediaPipelinesupdateMediaInsightsPipelineStatusRequest - 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AmazonChimeSDKMediaPipelinesrequest - The originally executed requestpublic void shutdown()
AmazonChimeSDKMediaPipelinesshutdown in interface AmazonChimeSDKMediaPipelinesshutdown in class AmazonWebServiceClientCopyright © 2023. All rights reserved.