/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.transcribe; import java.util.concurrent.Callable; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import java.util.concurrent.Future; import com.amazonaws.AmazonClientException; import com.amazonaws.AmazonServiceException; import com.amazonaws.handlers.AsyncHandler; import com.amazonaws.ClientConfiguration; import com.amazonaws.auth.AWSCredentials; import com.amazonaws.auth.AWSCredentialsProvider; import com.amazonaws.auth.DefaultAWSCredentialsProviderChain; import com.amazonaws.services.transcribe.model.*; /** * Interface for accessing Amazon Transcribe asynchronously. *
* Amazon Transcribe offers three main types of batch transcription: * Standard, Medical, and Call Analytics. *
** Standard transcriptions are the most common option. Refer to for * details. *
** Medical transcriptions are tailored to medical professionals and * incorporate medical terms. A common use case for this service is transcribing * doctor-patient dialogue into after-visit notes. Refer to for details. *
** Call Analytics transcriptions are designed for use with call center * audio on two different channels; if you're looking for insight into customer * service calls, use this option. Refer to for details. *
** All service calls made using this new client object are blocking, and * will not return until the service call completes. * * @see DefaultAWSCredentialsProviderChain */ @Deprecated public AmazonTranscribeAsyncClient() { this(new DefaultAWSCredentialsProviderChain()); } /** * Constructs a new asynchronous client to invoke service methods on Amazon * Transcribe. A credentials provider chain will be used that searches for * credentials in this order: *
* All service calls made using this new client object are blocking, and * will not return until the service call completes. * * @param clientConfiguration The client configuration options controlling * how this client connects to Amazon Transcribe (ex: proxy * settings, retry counts, etc.). * @see DefaultAWSCredentialsProviderChain */ @Deprecated public AmazonTranscribeAsyncClient(ClientConfiguration clientConfiguration) { this(new DefaultAWSCredentialsProviderChain(), clientConfiguration, Executors .newFixedThreadPool(clientConfiguration.getMaxConnections())); } /** * Constructs a new asynchronous client to invoke service methods on Amazon * Transcribe using the specified AWS account credentials. Default client * settings will be used, and a fixed size thread pool will be created for * executing the asynchronous tasks. *
* All calls made using this new client object are non-blocking, and will * immediately return a Java Future object that the caller can later check * to see if the service call has actually completed. * * @param awsCredentials The AWS credentials (access key ID and secret key) * to use when authenticating with AWS services. */ public AmazonTranscribeAsyncClient(AWSCredentials awsCredentials) { this(awsCredentials, Executors.newFixedThreadPool(DEFAULT_THREAD_POOL_SIZE)); } /** * Constructs a new asynchronous client to invoke service methods on Amazon * Transcribe using the specified AWS account credentials and executor * service. Default client settings will be used. *
* All calls made using this new client object are non-blocking, and will * immediately return a Java Future object that the caller can later check * to see if the service call has actually completed. * * @param awsCredentials The AWS credentials (access key ID and secret key) * to use when authenticating with AWS services. * @param executorService The executor service by which all asynchronous * requests will be executed. */ public AmazonTranscribeAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService) { super(awsCredentials); this.executorService = executorService; } /** * Constructs a new asynchronous client to invoke service methods on Amazon * Transcribe using the specified AWS account credentials, executor service, * and client configuration options. *
* All calls made using this new client object are non-blocking, and will * immediately return a Java Future object that the caller can later check * to see if the service call has actually completed. * * @param awsCredentials The AWS credentials (access key ID and secret key) * to use when authenticating with AWS services. * @param clientConfiguration Client configuration options (ex: max retry * limit, proxy settings, etc). * @param executorService The executor service by which all asynchronous * requests will be executed. */ public AmazonTranscribeAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService) { super(awsCredentials, clientConfiguration); this.executorService = executorService; } /** * Constructs a new asynchronous client to invoke service methods on Amazon * Transcribe using the specified AWS account credentials provider. Default * client settings will be used, and a fixed size thread pool will be * created for executing the asynchronous tasks. *
* All calls made using this new client object are non-blocking, and will * immediately return a Java Future object that the caller can later check * to see if the service call has actually completed. * * @param awsCredentialsProvider The AWS credentials provider which will * provide credentials to authenticate requests with AWS * services. */ public AmazonTranscribeAsyncClient(AWSCredentialsProvider awsCredentialsProvider) { this(awsCredentialsProvider, Executors.newFixedThreadPool(DEFAULT_THREAD_POOL_SIZE)); } /** * Constructs a new asynchronous client to invoke service methods on Amazon * Transcribe using the specified AWS account credentials provider and * executor service. Default client settings will be used. *
* All calls made using this new client object are non-blocking, and will * immediately return a Java Future object that the caller can later check * to see if the service call has actually completed. * * @param awsCredentialsProvider The AWS credentials provider which will * provide credentials to authenticate requests with AWS * services. * @param executorService The executor service by which all asynchronous * requests will be executed. */ public AmazonTranscribeAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService) { this(awsCredentialsProvider, new ClientConfiguration(), executorService); } /** * Constructs a new asynchronous client to invoke service methods on Amazon * Transcribe using the specified AWS account credentials provider and * client configuration options. *
* All calls made using this new client object are non-blocking, and will * immediately return a Java Future object that the caller can later check * to see if the service call has actually completed. * * @param awsCredentialsProvider The AWS credentials provider which will * provide credentials to authenticate requests with AWS * services. * @param clientConfiguration Client configuration options (ex: max retry * limit, proxy settings, etc). */ public AmazonTranscribeAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) { this(awsCredentialsProvider, clientConfiguration, Executors .newFixedThreadPool(clientConfiguration.getMaxConnections())); } /** * Constructs a new asynchronous client to invoke service methods on Amazon * Transcribe using the specified AWS account credentials provider, executor * service, and client configuration options. *
* All calls made using this new client object are non-blocking, and will * immediately return a Java Future object that the caller can later check * to see if the service call has actually completed. * * @param awsCredentialsProvider The AWS credentials provider which will * provide credentials to authenticate requests with AWS * services. * @param clientConfiguration Client configuration options (ex: max retry * limit, proxy settings, etc). * @param executorService The executor service by which all asynchronous * requests will be executed. */ public AmazonTranscribeAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService) { super(awsCredentialsProvider, clientConfiguration); this.executorService = executorService; } /** * Returns the executor service used by this async client to execute * requests. * * @return The executor service used by this async client to execute * requests. */ public ExecutorService getExecutorService() { return executorService; } /** * Shuts down the client, releasing all managed resources. This includes * forcibly terminating all pending asynchronous service calls. Clients who * wish to give pending asynchronous service calls time to complete should * call getExecutorService().shutdown() followed by * getExecutorService().awaitTermination() prior to calling this method. */ @Override public void shutdown() { super.shutdown(); executorService.shutdownNow(); } /** *
* Creates a new Call Analytics category. *
** All categories are automatically applied to your Call Analytics * transcriptions. Note that in order to apply categories to your * transcriptions, you must create them before submitting your transcription * request, as categories cannot be applied retroactively. *
*
* When creating a new category, you can use the InputType
* parameter to label the category as a POST_CALL
or a
* REAL_TIME
category. POST_CALL
categories can
* only be applied to post-call transcriptions and REAL_TIME
* categories can only be applied to real-time transcriptions. If you do not
* include InputType
, your category is created as a
* POST_CALL
category by default.
*
* Call Analytics categories are composed of rules. For each category, you * must create between 1 and 20 rules. Rules can include these parameters: , * , , and . *
** To update an existing category, see . *
** To learn more about Call Analytics categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions. *
* * @param createCallAnalyticsCategoryRequest * @return A Java Future object containing the response from the * CreateCallAnalyticsCategory service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws ConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Creates a new Call Analytics category. *
** All categories are automatically applied to your Call Analytics * transcriptions. Note that in order to apply categories to your * transcriptions, you must create them before submitting your transcription * request, as categories cannot be applied retroactively. *
*
* When creating a new category, you can use the InputType
* parameter to label the category as a POST_CALL
or a
* REAL_TIME
category. POST_CALL
categories can
* only be applied to post-call transcriptions and REAL_TIME
* categories can only be applied to real-time transcriptions. If you do not
* include InputType
, your category is created as a
* POST_CALL
category by default.
*
* Call Analytics categories are composed of rules. For each category, you * must create between 1 and 20 rules. Rules can include these parameters: , * , , and . *
** To update an existing category, see . *
** To learn more about Call Analytics categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions. *
* * @param createCallAnalyticsCategoryRequest * @return A Java Future object containing the response from the * CreateCallAnalyticsCategory service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws ConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Creates a new custom language model. *
** When creating a new custom language model, you must specify: *
** If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband * (audio sample rates under 16,000 Hz) base model *
** The location of your training and tuning files (this must be an Amazon S3 * URI) *
** The language of your model *
** A unique name for your model *
** Creates a new custom language model. *
** When creating a new custom language model, you must specify: *
** If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband * (audio sample rates under 16,000 Hz) base model *
** The location of your training and tuning files (this must be an Amazon S3 * URI) *
** The language of your model *
** A unique name for your model *
** Creates a new custom medical vocabulary. *
*
* Before creating a new custom medical vocabulary, you must first upload a
* text file that contains your vocabulary table into an Amazon S3 bucket.
* Note that this differs from , where you can include a list of terms
* within your request using the Phrases
flag;
* CreateMedicalVocabulary
does not support the
* Phrases
flag and only accepts vocabularies in table format.
*
* Each language has a character set that contains all allowed characters * for that specific language. If you use unsupported characters, your * custom vocabulary request fails. Refer to Character Sets for Custom Vocabularies to get the character set for * your language. *
** For more information, see Custom vocabularies. *
* * @param createMedicalVocabularyRequest * @return A Java Future object containing the response from the * CreateMedicalVocabulary service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws ConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Creates a new custom medical vocabulary. *
*
* Before creating a new custom medical vocabulary, you must first upload a
* text file that contains your vocabulary table into an Amazon S3 bucket.
* Note that this differs from , where you can include a list of terms
* within your request using the Phrases
flag;
* CreateMedicalVocabulary
does not support the
* Phrases
flag and only accepts vocabularies in table format.
*
* Each language has a character set that contains all allowed characters * for that specific language. If you use unsupported characters, your * custom vocabulary request fails. Refer to Character Sets for Custom Vocabularies to get the character set for * your language. *
** For more information, see Custom vocabularies. *
* * @param createMedicalVocabularyRequest * @return A Java Future object containing the response from the * CreateMedicalVocabulary service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws ConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Creates a new custom vocabulary. *
*
* When creating a new custom vocabulary, you can either upload a text file
* that contains your new entries, phrases, and terms into an Amazon S3
* bucket and include the URI in your request. Or you can include a list of
* terms directly in your request using the Phrases
flag.
*
* Each language has a character set that contains all allowed characters * for that specific language. If you use unsupported characters, your * custom vocabulary request fails. Refer to Character Sets for Custom Vocabularies to get the character set for * your language. *
** For more information, see Custom vocabularies. *
* * @param createVocabularyRequest * @return A Java Future object containing the response from the * CreateVocabulary service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws ConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Creates a new custom vocabulary. *
*
* When creating a new custom vocabulary, you can either upload a text file
* that contains your new entries, phrases, and terms into an Amazon S3
* bucket and include the URI in your request. Or you can include a list of
* terms directly in your request using the Phrases
flag.
*
* Each language has a character set that contains all allowed characters * for that specific language. If you use unsupported characters, your * custom vocabulary request fails. Refer to Character Sets for Custom Vocabularies to get the character set for * your language. *
** For more information, see Custom vocabularies. *
* * @param createVocabularyRequest * @return A Java Future object containing the response from the * CreateVocabulary service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws ConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Creates a new custom vocabulary filter. *
** You can use custom vocabulary filters to mask, delete, or flag specific * words from your transcript. Custom vocabulary filters are commonly used * to mask profanity in transcripts. *
** Each language has a character set that contains all allowed characters * for that specific language. If you use unsupported characters, your * custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for * your language. *
** For more information, see Vocabulary filtering. *
* * @param createVocabularyFilterRequest * @return A Java Future object containing the response from the * CreateVocabularyFilter service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws ConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Creates a new custom vocabulary filter. *
** You can use custom vocabulary filters to mask, delete, or flag specific * words from your transcript. Custom vocabulary filters are commonly used * to mask profanity in transcripts. *
** Each language has a character set that contains all allowed characters * for that specific language. If you use unsupported characters, your * custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for * your language. *
** For more information, see Vocabulary filtering. *
* * @param createVocabularyFilterRequest * @return A Java Future object containing the response from the * CreateVocabularyFilter service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws ConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future
* Deletes a Call Analytics category. To use this operation, specify the
* name of the category you want to delete using CategoryName
.
* Category names are case sensitive.
*
* Deletes a Call Analytics category. To use this operation, specify the
* name of the category you want to delete using CategoryName
.
* Category names are case sensitive.
*
* Deletes a Call Analytics job. To use this operation, specify the name of
* the job you want to delete using CallAnalyticsJobName
. Job
* names are case sensitive.
*
* Deletes a Call Analytics job. To use this operation, specify the name of
* the job you want to delete using CallAnalyticsJobName
. Job
* names are case sensitive.
*
* Deletes a custom language model. To use this operation, specify the name
* of the language model you want to delete using ModelName
.
* custom language model names are case sensitive.
*
* Deletes a custom language model. To use this operation, specify the name
* of the language model you want to delete using ModelName
.
* custom language model names are case sensitive.
*
* Deletes a medical transcription job. To use this operation, specify the
* name of the job you want to delete using
* MedicalTranscriptionJobName
. Job names are case sensitive.
*
* Deletes a medical transcription job. To use this operation, specify the
* name of the job you want to delete using
* MedicalTranscriptionJobName
. Job names are case sensitive.
*
* Deletes a custom medical vocabulary. To use this operation, specify the
* name of the custom vocabulary you want to delete using
* VocabularyName
. Custom vocabulary names are case sensitive.
*
* Deletes a custom medical vocabulary. To use this operation, specify the
* name of the custom vocabulary you want to delete using
* VocabularyName
. Custom vocabulary names are case sensitive.
*
* Deletes a transcription job. To use this operation, specify the name of
* the job you want to delete using TranscriptionJobName
. Job
* names are case sensitive.
*
* Deletes a transcription job. To use this operation, specify the name of
* the job you want to delete using TranscriptionJobName
. Job
* names are case sensitive.
*
* Deletes a custom vocabulary. To use this operation, specify the name of
* the custom vocabulary you want to delete using
* VocabularyName
. Custom vocabulary names are case sensitive.
*
* Deletes a custom vocabulary. To use this operation, specify the name of
* the custom vocabulary you want to delete using
* VocabularyName
. Custom vocabulary names are case sensitive.
*
* Deletes a custom vocabulary filter. To use this operation, specify the
* name of the custom vocabulary filter you want to delete using
* VocabularyFilterName
. Custom vocabulary filter names are
* case sensitive.
*
* Deletes a custom vocabulary filter. To use this operation, specify the
* name of the custom vocabulary filter you want to delete using
* VocabularyFilterName
. Custom vocabulary filter names are
* case sensitive.
*
* Provides information about the specified custom language model. *
** This operation also shows if the base language model that you used to * create your custom language model has been updated. If Amazon Transcribe * has updated the base model, you can create a new custom language model * using the updated base model. *
*
* If you tried to create a new custom language model and the request wasn't
* successful, you can use DescribeLanguageModel
to help
* identify the reason for this failure.
*
* Provides information about the specified custom language model. *
** This operation also shows if the base language model that you used to * create your custom language model has been updated. If Amazon Transcribe * has updated the base model, you can create a new custom language model * using the updated base model. *
*
* If you tried to create a new custom language model and the request wasn't
* successful, you can use DescribeLanguageModel
to help
* identify the reason for this failure.
*
* Provides information about the specified Call Analytics category. *
** To get a list of your Call Analytics categories, use the operation. *
* * @param getCallAnalyticsCategoryRequest * @return A Java Future object containing the response from the * GetCallAnalyticsCategory service method, as returned by Amazon * Transcribe. * @throws NotFoundException * @throws LimitExceededException * @throws InternalFailureException * @throws BadRequestException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides information about the specified Call Analytics category. *
** To get a list of your Call Analytics categories, use the operation. *
* * @param getCallAnalyticsCategoryRequest * @return A Java Future object containing the response from the * GetCallAnalyticsCategory service method, as returned by Amazon * Transcribe. * @throws NotFoundException * @throws LimitExceededException * @throws InternalFailureException * @throws BadRequestException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides information about the specified Call Analytics job. *
*
* To view the job's status, refer to CallAnalyticsJobStatus
.
* If the status is COMPLETED
, the job is finished. You can
* find your completed transcript at the URI specified in
* TranscriptFileUri
. If the status is FAILED
,
* FailureReason
provides details on why your transcription job
* failed.
*
* If you enabled personally identifiable information (PII) redaction, the
* redacted transcript appears at the location specified in
* RedactedTranscriptFileUri
.
*
* If you chose to redact the audio in your media file, you can find your
* redacted media file at the location specified in
* RedactedMediaFileUri
.
*
* To get a list of your Call Analytics jobs, use the operation. *
* * @param getCallAnalyticsJobRequest * @return A Java Future object containing the response from the * GetCallAnalyticsJob service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws NotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides information about the specified Call Analytics job. *
*
* To view the job's status, refer to CallAnalyticsJobStatus
.
* If the status is COMPLETED
, the job is finished. You can
* find your completed transcript at the URI specified in
* TranscriptFileUri
. If the status is FAILED
,
* FailureReason
provides details on why your transcription job
* failed.
*
* If you enabled personally identifiable information (PII) redaction, the
* redacted transcript appears at the location specified in
* RedactedTranscriptFileUri
.
*
* If you chose to redact the audio in your media file, you can find your
* redacted media file at the location specified in
* RedactedMediaFileUri
.
*
* To get a list of your Call Analytics jobs, use the operation. *
* * @param getCallAnalyticsJobRequest * @return A Java Future object containing the response from the * GetCallAnalyticsJob service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws NotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides information about the specified medical transcription job. *
*
* To view the status of the specified medical transcription job, check the
* TranscriptionJobStatus
field. If the status is
* COMPLETED
, the job is finished. You can find the results at
* the location specified in TranscriptFileUri
. If the status
* is FAILED
, FailureReason
provides details on
* why your transcription job failed.
*
* To get a list of your medical transcription jobs, use the operation. *
* * @param getMedicalTranscriptionJobRequest * @return A Java Future object containing the response from the * GetMedicalTranscriptionJob service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws NotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides information about the specified medical transcription job. *
*
* To view the status of the specified medical transcription job, check the
* TranscriptionJobStatus
field. If the status is
* COMPLETED
, the job is finished. You can find the results at
* the location specified in TranscriptFileUri
. If the status
* is FAILED
, FailureReason
provides details on
* why your transcription job failed.
*
* To get a list of your medical transcription jobs, use the operation. *
* * @param getMedicalTranscriptionJobRequest * @return A Java Future object containing the response from the * GetMedicalTranscriptionJob service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws NotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides information about the specified custom medical vocabulary. *
*
* To view the status of the specified custom medical vocabulary, check the
* VocabularyState
field. If the status is READY
,
* your custom vocabulary is available to use. If the status is
* FAILED
, FailureReason
provides details on why
* your vocabulary failed.
*
* To get a list of your custom medical vocabularies, use the operation. *
* * @param getMedicalVocabularyRequest * @return A Java Future object containing the response from the * GetMedicalVocabulary service method, as returned by Amazon * Transcribe. * @throws NotFoundException * @throws LimitExceededException * @throws InternalFailureException * @throws BadRequestException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides information about the specified custom medical vocabulary. *
*
* To view the status of the specified custom medical vocabulary, check the
* VocabularyState
field. If the status is READY
,
* your custom vocabulary is available to use. If the status is
* FAILED
, FailureReason
provides details on why
* your vocabulary failed.
*
* To get a list of your custom medical vocabularies, use the operation. *
* * @param getMedicalVocabularyRequest * @return A Java Future object containing the response from the * GetMedicalVocabulary service method, as returned by Amazon * Transcribe. * @throws NotFoundException * @throws LimitExceededException * @throws InternalFailureException * @throws BadRequestException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides information about the specified transcription job. *
*
* To view the status of the specified transcription job, check the
* TranscriptionJobStatus
field. If the status is
* COMPLETED
, the job is finished. You can find the results at
* the location specified in TranscriptFileUri
. If the status
* is FAILED
, FailureReason
provides details on
* why your transcription job failed.
*
* If you enabled content redaction, the redacted transcript can be found at
* the location specified in RedactedTranscriptFileUri
.
*
* To get a list of your transcription jobs, use the operation. *
* * @param getTranscriptionJobRequest * @return A Java Future object containing the response from the * GetTranscriptionJob service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws NotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides information about the specified transcription job. *
*
* To view the status of the specified transcription job, check the
* TranscriptionJobStatus
field. If the status is
* COMPLETED
, the job is finished. You can find the results at
* the location specified in TranscriptFileUri
. If the status
* is FAILED
, FailureReason
provides details on
* why your transcription job failed.
*
* If you enabled content redaction, the redacted transcript can be found at
* the location specified in RedactedTranscriptFileUri
.
*
* To get a list of your transcription jobs, use the operation. *
* * @param getTranscriptionJobRequest * @return A Java Future object containing the response from the * GetTranscriptionJob service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws NotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides information about the specified custom vocabulary. *
*
* To view the status of the specified custom vocabulary, check the
* VocabularyState
field. If the status is READY
,
* your custom vocabulary is available to use. If the status is
* FAILED
, FailureReason
provides details on why
* your custom vocabulary failed.
*
* To get a list of your custom vocabularies, use the operation. *
* * @param getVocabularyRequest * @return A Java Future object containing the response from the * GetVocabulary service method, as returned by Amazon Transcribe. * @throws NotFoundException * @throws LimitExceededException * @throws InternalFailureException * @throws BadRequestException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides information about the specified custom vocabulary. *
*
* To view the status of the specified custom vocabulary, check the
* VocabularyState
field. If the status is READY
,
* your custom vocabulary is available to use. If the status is
* FAILED
, FailureReason
provides details on why
* your custom vocabulary failed.
*
* To get a list of your custom vocabularies, use the operation. *
* * @param getVocabularyRequest * @return A Java Future object containing the response from the * GetVocabulary service method, as returned by Amazon Transcribe. * @throws NotFoundException * @throws LimitExceededException * @throws InternalFailureException * @throws BadRequestException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides information about the specified custom vocabulary filter. *
** To get a list of your custom vocabulary filters, use the operation. *
* * @param getVocabularyFilterRequest * @return A Java Future object containing the response from the * GetVocabularyFilter service method, as returned by Amazon * Transcribe. * @throws NotFoundException * @throws LimitExceededException * @throws InternalFailureException * @throws BadRequestException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides information about the specified custom vocabulary filter. *
** To get a list of your custom vocabulary filters, use the operation. *
* * @param getVocabularyFilterRequest * @return A Java Future object containing the response from the * GetVocabularyFilter service method, as returned by Amazon * Transcribe. * @throws NotFoundException * @throws LimitExceededException * @throws InternalFailureException * @throws BadRequestException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides a list of Call Analytics categories, including all rules that * make up each category. *
** To get detailed information about a specific Call Analytics category, use * the operation. *
* * @param listCallAnalyticsCategoriesRequest * @return A Java Future object containing the response from the * ListCallAnalyticsCategories service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides a list of Call Analytics categories, including all rules that * make up each category. *
** To get detailed information about a specific Call Analytics category, use * the operation. *
* * @param listCallAnalyticsCategoriesRequest * @return A Java Future object containing the response from the * ListCallAnalyticsCategories service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides a list of Call Analytics jobs that match the specified criteria. * If no criteria are specified, all Call Analytics jobs are returned. *
** To get detailed information about a specific Call Analytics job, use the * operation. *
* * @param listCallAnalyticsJobsRequest * @return A Java Future object containing the response from the * ListCallAnalyticsJobs service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides a list of Call Analytics jobs that match the specified criteria. * If no criteria are specified, all Call Analytics jobs are returned. *
** To get detailed information about a specific Call Analytics job, use the * operation. *
* * @param listCallAnalyticsJobsRequest * @return A Java Future object containing the response from the * ListCallAnalyticsJobs service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides a list of custom language models that match the specified * criteria. If no criteria are specified, all custom language models are * returned. *
** To get detailed information about a specific custom language model, use * the operation. *
* * @param listLanguageModelsRequest * @return A Java Future object containing the response from the * ListLanguageModels service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides a list of custom language models that match the specified * criteria. If no criteria are specified, all custom language models are * returned. *
** To get detailed information about a specific custom language model, use * the operation. *
* * @param listLanguageModelsRequest * @return A Java Future object containing the response from the * ListLanguageModels service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides a list of medical transcription jobs that match the specified * criteria. If no criteria are specified, all medical transcription jobs * are returned. *
** To get detailed information about a specific medical transcription job, * use the operation. *
* * @param listMedicalTranscriptionJobsRequest * @return A Java Future object containing the response from the * ListMedicalTranscriptionJobs service method, as returned by * Amazon Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides a list of medical transcription jobs that match the specified * criteria. If no criteria are specified, all medical transcription jobs * are returned. *
** To get detailed information about a specific medical transcription job, * use the operation. *
* * @param listMedicalTranscriptionJobsRequest * @return A Java Future object containing the response from the * ListMedicalTranscriptionJobs service method, as returned by * Amazon Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides a list of custom medical vocabularies that match the specified * criteria. If no criteria are specified, all custom medical vocabularies * are returned. *
** To get detailed information about a specific custom medical vocabulary, * use the operation. *
* * @param listMedicalVocabulariesRequest * @return A Java Future object containing the response from the * ListMedicalVocabularies service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides a list of custom medical vocabularies that match the specified * criteria. If no criteria are specified, all custom medical vocabularies * are returned. *
** To get detailed information about a specific custom medical vocabulary, * use the operation. *
* * @param listMedicalVocabulariesRequest * @return A Java Future object containing the response from the * ListMedicalVocabularies service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Lists all tags associated with the specified transcription job, * vocabulary, model, or resource. *
** To learn more about using tags with Amazon Transcribe, refer to Tagging resources. *
* * @param listTagsForResourceRequest * @return A Java Future object containing the response from the * ListTagsForResource service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws NotFoundException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Lists all tags associated with the specified transcription job, * vocabulary, model, or resource. *
** To learn more about using tags with Amazon Transcribe, refer to Tagging resources. *
* * @param listTagsForResourceRequest * @return A Java Future object containing the response from the * ListTagsForResource service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws NotFoundException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides a list of transcription jobs that match the specified criteria. * If no criteria are specified, all transcription jobs are returned. *
** To get detailed information about a specific transcription job, use the * operation. *
* * @param listTranscriptionJobsRequest * @return A Java Future object containing the response from the * ListTranscriptionJobs service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides a list of transcription jobs that match the specified criteria. * If no criteria are specified, all transcription jobs are returned. *
** To get detailed information about a specific transcription job, use the * operation. *
* * @param listTranscriptionJobsRequest * @return A Java Future object containing the response from the * ListTranscriptionJobs service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides a list of custom vocabularies that match the specified criteria. * If no criteria are specified, all custom vocabularies are returned. *
** To get detailed information about a specific custom vocabulary, use the * operation. *
* * @param listVocabulariesRequest * @return A Java Future object containing the response from the * ListVocabularies service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides a list of custom vocabularies that match the specified criteria. * If no criteria are specified, all custom vocabularies are returned. *
** To get detailed information about a specific custom vocabulary, use the * operation. *
* * @param listVocabulariesRequest * @return A Java Future object containing the response from the * ListVocabularies service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides a list of custom vocabulary filters that match the specified * criteria. If no criteria are specified, all custom vocabularies are * returned. *
** To get detailed information about a specific custom vocabulary filter, * use the operation. *
* * @param listVocabularyFiltersRequest * @return A Java Future object containing the response from the * ListVocabularyFilters service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Provides a list of custom vocabulary filters that match the specified * criteria. If no criteria are specified, all custom vocabularies are * returned. *
** To get detailed information about a specific custom vocabulary filter, * use the operation. *
* * @param listVocabularyFiltersRequest * @return A Java Future object containing the response from the * ListVocabularyFilters service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Transcribes the audio from a customer service call and applies any * additional Request Parameters you choose to include in your request. *
** In addition to many standard transcription features, Call Analytics * provides you with call characteristics, call summarization, speaker * sentiment, and optional redaction of your text transcript and your audio * file. You can also apply custom categories to flag specified conditions. * To learn more about these features and insights, refer to Analyzing call center audio with Call Analytics. *
** If you want to apply categories to your Call Analytics job, you must * create them before submitting your job request. Categories cannot be * retroactively applied to a job. To create a new category, use the * operation. To learn more about Call Analytics categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions. *
*
* To make a StartCallAnalyticsJob
request, you must first
* upload your media file into an Amazon S3 bucket; you can then specify the
* Amazon S3 location of the file using the Media
parameter.
*
* Note that job queuing is enabled by default for Call Analytics jobs. *
*
* You must include the following parameters in your
* StartCallAnalyticsJob
request:
*
* region
: The Amazon Web Services Region where you are making
* your request. For a list of Amazon Web Services Regions supported with
* Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.
*
* CallAnalyticsJobName
: A custom name that you create for your
* transcription job that's unique within your Amazon Web Services account.
*
* DataAccessRoleArn
: The Amazon Resource Name (ARN) of an IAM
* role that has permissions to access the Amazon S3 bucket that contains
* your input files.
*
* Media
(MediaFileUri
or
* RedactedMediaFileUri
): The Amazon S3 location of your media
* file.
*
* With Call Analytics, you can redact the audio contained in your media
* file by including RedactedMediaFileUri
, instead of
* MediaFileUri
, to specify the location of your input audio.
* If you choose to redact your audio, you can find your redacted media at
* the location specified in the RedactedMediaFileUri
field of
* your response.
*
* Transcribes the audio from a customer service call and applies any * additional Request Parameters you choose to include in your request. *
** In addition to many standard transcription features, Call Analytics * provides you with call characteristics, call summarization, speaker * sentiment, and optional redaction of your text transcript and your audio * file. You can also apply custom categories to flag specified conditions. * To learn more about these features and insights, refer to Analyzing call center audio with Call Analytics. *
** If you want to apply categories to your Call Analytics job, you must * create them before submitting your job request. Categories cannot be * retroactively applied to a job. To create a new category, use the * operation. To learn more about Call Analytics categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions. *
*
* To make a StartCallAnalyticsJob
request, you must first
* upload your media file into an Amazon S3 bucket; you can then specify the
* Amazon S3 location of the file using the Media
parameter.
*
* Note that job queuing is enabled by default for Call Analytics jobs. *
*
* You must include the following parameters in your
* StartCallAnalyticsJob
request:
*
* region
: The Amazon Web Services Region where you are making
* your request. For a list of Amazon Web Services Regions supported with
* Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.
*
* CallAnalyticsJobName
: A custom name that you create for your
* transcription job that's unique within your Amazon Web Services account.
*
* DataAccessRoleArn
: The Amazon Resource Name (ARN) of an IAM
* role that has permissions to access the Amazon S3 bucket that contains
* your input files.
*
* Media
(MediaFileUri
or
* RedactedMediaFileUri
): The Amazon S3 location of your media
* file.
*
* With Call Analytics, you can redact the audio contained in your media
* file by including RedactedMediaFileUri
, instead of
* MediaFileUri
, to specify the location of your input audio.
* If you choose to redact your audio, you can find your redacted media at
* the location specified in the RedactedMediaFileUri
field of
* your response.
*
* Transcribes the audio from a medical dictation or conversation and * applies any additional Request Parameters you choose to include in your * request. *
** In addition to many standard transcription features, Amazon Transcribe * Medical provides you with a robust medical vocabulary and, optionally, * content identification, which adds flags to personal health information * (PHI). To learn more about these features, refer to How Amazon Transcribe Medical works. *
*
* To make a StartMedicalTranscriptionJob
request, you must
* first upload your media file into an Amazon S3 bucket; you can then
* specify the S3 location of the file using the Media
* parameter.
*
* You must include the following parameters in your
* StartMedicalTranscriptionJob
request:
*
* region
: The Amazon Web Services Region where you are making
* your request. For a list of Amazon Web Services Regions supported with
* Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.
*
* MedicalTranscriptionJobName
: A custom name you create for
* your transcription job that is unique within your Amazon Web Services
* account.
*
* Media
(MediaFileUri
): The Amazon S3 location of
* your media file.
*
* LanguageCode
: This must be en-US
.
*
* OutputBucketName
: The Amazon S3 bucket where you want your
* transcript stored. If you want your output stored in a sub-folder of this
* bucket, you must also include OutputKey
.
*
* Specialty
: This must be PRIMARYCARE
.
*
* Type
: Choose whether your audio is a conversation or a
* dictation.
*
* Transcribes the audio from a medical dictation or conversation and * applies any additional Request Parameters you choose to include in your * request. *
** In addition to many standard transcription features, Amazon Transcribe * Medical provides you with a robust medical vocabulary and, optionally, * content identification, which adds flags to personal health information * (PHI). To learn more about these features, refer to How Amazon Transcribe Medical works. *
*
* To make a StartMedicalTranscriptionJob
request, you must
* first upload your media file into an Amazon S3 bucket; you can then
* specify the S3 location of the file using the Media
* parameter.
*
* You must include the following parameters in your
* StartMedicalTranscriptionJob
request:
*
* region
: The Amazon Web Services Region where you are making
* your request. For a list of Amazon Web Services Regions supported with
* Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.
*
* MedicalTranscriptionJobName
: A custom name you create for
* your transcription job that is unique within your Amazon Web Services
* account.
*
* Media
(MediaFileUri
): The Amazon S3 location of
* your media file.
*
* LanguageCode
: This must be en-US
.
*
* OutputBucketName
: The Amazon S3 bucket where you want your
* transcript stored. If you want your output stored in a sub-folder of this
* bucket, you must also include OutputKey
.
*
* Specialty
: This must be PRIMARYCARE
.
*
* Type
: Choose whether your audio is a conversation or a
* dictation.
*
* Transcribes the audio from a media file and applies any additional * Request Parameters you choose to include in your request. *
*
* To make a StartTranscriptionJob
request, you must first
* upload your media file into an Amazon S3 bucket; you can then specify the
* Amazon S3 location of the file using the Media
parameter.
*
* You must include the following parameters in your
* StartTranscriptionJob
request:
*
* region
: The Amazon Web Services Region where you are making
* your request. For a list of Amazon Web Services Regions supported with
* Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.
*
* TranscriptionJobName
: A custom name you create for your
* transcription job that is unique within your Amazon Web Services account.
*
* Media
(MediaFileUri
): The Amazon S3 location of
* your media file.
*
* One of LanguageCode
, IdentifyLanguage
, or
* IdentifyMultipleLanguages
: If you know the language of your
* media file, specify it using the LanguageCode
parameter; you
* can find all valid language codes in the Supported languages table. If you don't know the languages spoken in
* your media, use either IdentifyLanguage
or
* IdentifyMultipleLanguages
and let Amazon Transcribe identify
* the languages for you.
*
* Transcribes the audio from a media file and applies any additional * Request Parameters you choose to include in your request. *
*
* To make a StartTranscriptionJob
request, you must first
* upload your media file into an Amazon S3 bucket; you can then specify the
* Amazon S3 location of the file using the Media
parameter.
*
* You must include the following parameters in your
* StartTranscriptionJob
request:
*
* region
: The Amazon Web Services Region where you are making
* your request. For a list of Amazon Web Services Regions supported with
* Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.
*
* TranscriptionJobName
: A custom name you create for your
* transcription job that is unique within your Amazon Web Services account.
*
* Media
(MediaFileUri
): The Amazon S3 location of
* your media file.
*
* One of LanguageCode
, IdentifyLanguage
, or
* IdentifyMultipleLanguages
: If you know the language of your
* media file, specify it using the LanguageCode
parameter; you
* can find all valid language codes in the Supported languages table. If you don't know the languages spoken in
* your media, use either IdentifyLanguage
or
* IdentifyMultipleLanguages
and let Amazon Transcribe identify
* the languages for you.
*
* Adds one or more custom tags, each in the form of a key:value pair, to * the specified resource. *
** To learn more about using tags with Amazon Transcribe, refer to Tagging resources. *
* * @param tagResourceRequest * @return A Java Future object containing the response from the TagResource * service method, as returned by Amazon Transcribe. * @throws BadRequestException * @throws ConflictException * @throws NotFoundException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Adds one or more custom tags, each in the form of a key:value pair, to * the specified resource. *
** To learn more about using tags with Amazon Transcribe, refer to Tagging resources. *
* * @param tagResourceRequest * @return A Java Future object containing the response from the TagResource * service method, as returned by Amazon Transcribe. * @throws BadRequestException * @throws ConflictException * @throws NotFoundException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Removes the specified tags from the specified Amazon Transcribe resource. *
*
* If you include UntagResource
in your request, you must also
* include ResourceArn
and TagKeys
.
*
* Removes the specified tags from the specified Amazon Transcribe resource. *
*
* If you include UntagResource
in your request, you must also
* include ResourceArn
and TagKeys
.
*
* Updates the specified Call Analytics category with new rules. Note that
* the UpdateCallAnalyticsCategory
operation overwrites all
* existing rules contained in the specified category. You cannot append
* additional rules onto an existing category.
*
* To create a new category, see . *
* * @param updateCallAnalyticsCategoryRequest * @return A Java Future object containing the response from the * UpdateCallAnalyticsCategory service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws NotFoundException * @throws ConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future
* Updates the specified Call Analytics category with new rules. Note that
* the UpdateCallAnalyticsCategory
operation overwrites all
* existing rules contained in the specified category. You cannot append
* additional rules onto an existing category.
*
* To create a new category, see . *
* * @param updateCallAnalyticsCategoryRequest * @return A Java Future object containing the response from the * UpdateCallAnalyticsCategory service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws NotFoundException * @throws ConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Updates an existing custom medical vocabulary with new values. This * operation overwrites all existing information with your new values; you * cannot append new terms onto an existing custom vocabulary. *
* * @param updateMedicalVocabularyRequest * @return A Java Future object containing the response from the * UpdateMedicalVocabulary service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws NotFoundException * @throws ConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Updates an existing custom medical vocabulary with new values. This * operation overwrites all existing information with your new values; you * cannot append new terms onto an existing custom vocabulary. *
* * @param updateMedicalVocabularyRequest * @return A Java Future object containing the response from the * UpdateMedicalVocabulary service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws NotFoundException * @throws ConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Updates an existing custom vocabulary with new values. This operation * overwrites all existing information with your new values; you cannot * append new terms onto an existing custom vocabulary. *
* * @param updateVocabularyRequest * @return A Java Future object containing the response from the * UpdateVocabulary service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws NotFoundException * @throws ConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Updates an existing custom vocabulary with new values. This operation * overwrites all existing information with your new values; you cannot * append new terms onto an existing custom vocabulary. *
* * @param updateVocabularyRequest * @return A Java Future object containing the response from the * UpdateVocabulary service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws NotFoundException * @throws ConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Updates an existing custom vocabulary filter with a new list of words. * The new list you provide overwrites all previous entries; you cannot * append new terms onto an existing custom vocabulary filter. *
* * @param updateVocabularyFilterRequest * @return A Java Future object containing the response from the * UpdateVocabularyFilter service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws NotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future* Updates an existing custom vocabulary filter with a new list of words. * The new list you provide overwrites all previous entries; you cannot * append new terms onto an existing custom vocabulary filter. *
* * @param updateVocabularyFilterRequest * @return A Java Future object containing the response from the * UpdateVocabularyFilter service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws NotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ public Future