com.amazonaws.services.transcribe

Class AmazonTranscribeClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.transcribe.AmazonTranscribeClient

All Implemented Interfaces:

AmazonTranscribe

Direct Known Subclasses:

AmazonTranscribeAsyncClient

public class AmazonTranscribeClient
extends AmazonWebServiceClient
implements AmazonTranscribe

Client for accessing Amazon Transcribe. All service calls made using this client are blocking, and will not return until the service call completes.

Operations and objects for transcribing speech to text.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Constructor Summary

Constructors

Constructor and Description
AmazonTranscribeClient() Deprecated.
AmazonTranscribeClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AmazonTranscribe using the specified AWS account credentials.
AmazonTranscribeClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonTranscribe using the specified AWS account credentials and client configuration options.
AmazonTranscribeClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AmazonTranscribe using the specified AWS account credentials provider.
AmazonTranscribeClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonTranscribe using the specified AWS account credentials provider and client configuration options.
AmazonTranscribeClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, HttpClient httpClient) Constructs a new client to invoke service methods on AmazonTranscribe using the specified AWS account credentials provider, client configuration options and request metric collector.
AmazonTranscribeClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, com.amazonaws.metrics.RequestMetricCollector requestMetricCollector) Deprecated.
AmazonTranscribeClient(ClientConfiguration clientConfiguration) Deprecated.

Method Summary

Modifier and Type	Method and Description
CreateLanguageModelResult	createLanguageModel(CreateLanguageModelRequest createLanguageModelRequest) Creates a new custom language model.
CreateMedicalVocabularyResult	createMedicalVocabulary(CreateMedicalVocabularyRequest createMedicalVocabularyRequest) Creates a new custom vocabulary that you can use to change how Amazon Transcribe Medical transcribes your audio file.
CreateVocabularyResult	createVocabulary(CreateVocabularyRequest createVocabularyRequest) Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.
CreateVocabularyFilterResult	createVocabularyFilter(CreateVocabularyFilterRequest createVocabularyFilterRequest) Creates a new vocabulary filter that you can use to filter words, such as profane words, from the output of a transcription job.
void	deleteLanguageModel(DeleteLanguageModelRequest deleteLanguageModelRequest) Deletes a custom language model using its name.
void	deleteMedicalTranscriptionJob(DeleteMedicalTranscriptionJobRequest deleteMedicalTranscriptionJobRequest) Deletes a transcription job generated by Amazon Transcribe Medical and any related information.
void	deleteMedicalVocabulary(DeleteMedicalVocabularyRequest deleteMedicalVocabularyRequest) Deletes a vocabulary from Amazon Transcribe Medical.
void	deleteTranscriptionJob(DeleteTranscriptionJobRequest deleteTranscriptionJobRequest) Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on.
void	deleteVocabulary(DeleteVocabularyRequest deleteVocabularyRequest) Deletes a vocabulary from Amazon Transcribe.
void	deleteVocabularyFilter(DeleteVocabularyFilterRequest deleteVocabularyFilterRequest) Removes a vocabulary filter.
DescribeLanguageModelResult	describeLanguageModel(DescribeLanguageModelRequest describeLanguageModelRequest) Gets information about a single custom language model.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.
GetMedicalTranscriptionJobResult	getMedicalTranscriptionJob(GetMedicalTranscriptionJobRequest getMedicalTranscriptionJobRequest) Returns information about a transcription job from Amazon Transcribe Medical.
GetMedicalVocabularyResult	getMedicalVocabulary(GetMedicalVocabularyRequest getMedicalVocabularyRequest) Retrieves information about a medical vocabulary.
GetTranscriptionJobResult	getTranscriptionJob(GetTranscriptionJobRequest getTranscriptionJobRequest) Returns information about a transcription job.
GetVocabularyResult	getVocabulary(GetVocabularyRequest getVocabularyRequest) Gets information about a vocabulary.
GetVocabularyFilterResult	getVocabularyFilter(GetVocabularyFilterRequest getVocabularyFilterRequest) Returns information about a vocabulary filter.
ListLanguageModelsResult	listLanguageModels(ListLanguageModelsRequest listLanguageModelsRequest) Provides more information about the custom language models you've created.
ListMedicalTranscriptionJobsResult	listMedicalTranscriptionJobs(ListMedicalTranscriptionJobsRequest listMedicalTranscriptionJobsRequest) Lists medical transcription jobs with a specified status or substring that matches their names.
ListMedicalVocabulariesResult	listMedicalVocabularies(ListMedicalVocabulariesRequest listMedicalVocabulariesRequest) Returns a list of vocabularies that match the specified criteria.
ListTranscriptionJobsResult	listTranscriptionJobs(ListTranscriptionJobsRequest listTranscriptionJobsRequest) Lists transcription jobs with the specified status.
ListVocabulariesResult	listVocabularies(ListVocabulariesRequest listVocabulariesRequest) Returns a list of vocabularies that match the specified criteria.
ListVocabularyFiltersResult	listVocabularyFilters(ListVocabularyFiltersRequest listVocabularyFiltersRequest) Gets information about vocabulary filters.
StartMedicalTranscriptionJobResult	startMedicalTranscriptionJob(StartMedicalTranscriptionJobRequest startMedicalTranscriptionJobRequest) Starts a batch job to transcribe medical speech to text.
StartTranscriptionJobResult	startTranscriptionJob(StartTranscriptionJobRequest startTranscriptionJobRequest) Starts an asynchronous job to transcribe speech to text.
UpdateMedicalVocabularyResult	updateMedicalVocabulary(UpdateMedicalVocabularyRequest updateMedicalVocabularyRequest) Updates a vocabulary with new values that you provide in a different text file from the one you used to create the vocabulary.
UpdateVocabularyResult	updateVocabulary(UpdateVocabularyRequest updateVocabularyRequest) Updates an existing vocabulary with new values.
UpdateVocabularyFilterResult	updateVocabularyFilter(UpdateVocabularyFilterRequest updateVocabularyFilterRequest) Updates a vocabulary filter with a new list of filtered words.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, getEndpoint, getEndpointPrefix, getRegions, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.transcribe.AmazonTranscribe

setEndpoint, setRegion, shutdown

Constructor Detail

AmazonTranscribeClient

@Deprecated
public AmazonTranscribeClient()

Deprecated.

Constructs a new client to invoke service methods on AmazonTranscribe. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AmazonTranscribeClient

@Deprecated
public AmazonTranscribeClient(ClientConfiguration clientConfiguration)

Deprecated.

Constructs a new client to invoke service methods on AmazonTranscribe. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AmazonTranscribe (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonTranscribeClient

public AmazonTranscribeClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AmazonTranscribe using the specified AWS account credentials.

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonTranscribeClient client = new AmazonTranscribeClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonTranscribeClient

public AmazonTranscribeClient(AWSCredentials awsCredentials,
                              ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonTranscribe using the specified AWS account credentials and client configuration options.

The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonTranscribeClient client = new AmazonTranscribeClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonTranscribe (ex: proxy settings, retry counts, etc.).

AmazonTranscribeClient

public AmazonTranscribeClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AmazonTranscribe using the specified AWS account credentials provider.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonTranscribeClient client = new AmazonTranscribeClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonTranscribeClient

public AmazonTranscribeClient(AWSCredentialsProvider awsCredentialsProvider,
                              ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonTranscribe using the specified AWS account credentials provider and client configuration options.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonTranscribeClient client = new AmazonTranscribeClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonTranscribe (ex: proxy settings, retry counts, etc.).

AmazonTranscribeClient

@Deprecated
public AmazonTranscribeClient(AWSCredentialsProvider awsCredentialsProvider,
                                          ClientConfiguration clientConfiguration,
                                          com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)

Deprecated.

Constructs a new client to invoke service methods on AmazonTranscribe using the specified AWS account credentials provider, client configuration options and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonTranscribe (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

AmazonTranscribeClient

public AmazonTranscribeClient(AWSCredentialsProvider awsCredentialsProvider,
                              ClientConfiguration clientConfiguration,
                              HttpClient httpClient)

Constructs a new client to invoke service methods on AmazonTranscribe using the specified AWS account credentials provider, client configuration options and request metric collector.

The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonTranscribeClient client = new AmazonTranscribeClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonTranscribe (ex: proxy settings, retry counts, etc.).

httpClient - A http client

Method Detail

createLanguageModel

public CreateLanguageModelResult createLanguageModel(CreateLanguageModelRequest createLanguageModelRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

Creates a new custom language model. Use Amazon S3 prefixes to provide the location of your input files. The time it takes to create your model depends on the size of your training data.

Specified by:

createLanguageModel in interface AmazonTranscribe

Parameters:

createLanguageModelRequest -

Returns:

createLanguageModelResult The response from the CreateLanguageModel service method, as returned by Amazon Transcribe.

Throws:

BadRequestException

LimitExceededException

InternalFailureException

ConflictException

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.

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.

createMedicalVocabulary

public CreateMedicalVocabularyResult createMedicalVocabulary(CreateMedicalVocabularyRequest createMedicalVocabularyRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

Creates a new custom vocabulary that you can use to change how Amazon Transcribe Medical transcribes your audio file.

Specified by:

createMedicalVocabulary in interface AmazonTranscribe

Parameters:

createMedicalVocabularyRequest -

Returns:

createMedicalVocabularyResult The response from the CreateMedicalVocabulary service method, as returned by Amazon Transcribe.

Throws:

BadRequestException

LimitExceededException

InternalFailureException

ConflictException

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.

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.

createVocabulary

public CreateVocabularyResult createVocabulary(CreateVocabularyRequest createVocabularyRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.

Specified by:

createVocabulary in interface AmazonTranscribe

Parameters:

createVocabularyRequest -

Returns:

createVocabularyResult The response from the CreateVocabulary service method, as returned by Amazon Transcribe.

Throws:

BadRequestException

LimitExceededException

InternalFailureException

ConflictException

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.

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.

createVocabularyFilter

public CreateVocabularyFilterResult createVocabularyFilter(CreateVocabularyFilterRequest createVocabularyFilterRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

Creates a new vocabulary filter that you can use to filter words, such as profane words, from the output of a transcription job.

Specified by:

createVocabularyFilter in interface AmazonTranscribe

Parameters:

createVocabularyFilterRequest -

Returns:

createVocabularyFilterResult The response from the CreateVocabularyFilter service method, as returned by Amazon Transcribe.

Throws:

BadRequestException

LimitExceededException

InternalFailureException

ConflictException

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.

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.

deleteLanguageModel

public void deleteLanguageModel(DeleteLanguageModelRequest deleteLanguageModelRequest)
                         throws AmazonServiceException,
                                AmazonClientException

Deletes a custom language model using its name.

Specified by:

deleteLanguageModel in interface AmazonTranscribe

Parameters:

deleteLanguageModelRequest -

Throws:

BadRequestException

LimitExceededException

InternalFailureException

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.

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.

deleteMedicalTranscriptionJob

public void deleteMedicalTranscriptionJob(DeleteMedicalTranscriptionJobRequest deleteMedicalTranscriptionJobRequest)
                                   throws AmazonServiceException,
                                          AmazonClientException

Deletes a transcription job generated by Amazon Transcribe Medical and any related information.

Specified by:

deleteMedicalTranscriptionJob in interface AmazonTranscribe

Parameters:

deleteMedicalTranscriptionJobRequest -

Throws:

LimitExceededException

BadRequestException

InternalFailureException

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.

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.

deleteMedicalVocabulary

public void deleteMedicalVocabulary(DeleteMedicalVocabularyRequest deleteMedicalVocabularyRequest)
                             throws AmazonServiceException,
                                    AmazonClientException

Deletes a vocabulary from Amazon Transcribe Medical.

Specified by:

deleteMedicalVocabulary in interface AmazonTranscribe

Parameters:

deleteMedicalVocabularyRequest -

Throws:

NotFoundException

LimitExceededException

BadRequestException

InternalFailureException

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.

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.

deleteTranscriptionJob

public void deleteTranscriptionJob(DeleteTranscriptionJobRequest deleteTranscriptionJobRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on.

Specified by:

deleteTranscriptionJob in interface AmazonTranscribe

Parameters:

deleteTranscriptionJobRequest -

Throws:

LimitExceededException

BadRequestException

InternalFailureException

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.

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.

deleteVocabulary

public void deleteVocabulary(DeleteVocabularyRequest deleteVocabularyRequest)
                      throws AmazonServiceException,
                             AmazonClientException

Deletes a vocabulary from Amazon Transcribe.

Specified by:

deleteVocabulary in interface AmazonTranscribe

Parameters:

deleteVocabularyRequest -

Throws:

NotFoundException

LimitExceededException

BadRequestException

InternalFailureException

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.

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.

deleteVocabularyFilter

public void deleteVocabularyFilter(DeleteVocabularyFilterRequest deleteVocabularyFilterRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Removes a vocabulary filter.

Specified by:

deleteVocabularyFilter in interface AmazonTranscribe

Parameters:

deleteVocabularyFilterRequest -

Throws:

NotFoundException

LimitExceededException

BadRequestException

InternalFailureException

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.

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.

describeLanguageModel

public DescribeLanguageModelResult describeLanguageModel(DescribeLanguageModelRequest describeLanguageModelRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Gets information about a single custom language model. Use this information to see details about the language model in your AWS account. You can also see whether the base language model 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 the language model wasn't created, you can use this operation to understand why Amazon Transcribe couldn't create it.

Specified by:

describeLanguageModel in interface AmazonTranscribe

Parameters:

describeLanguageModelRequest -

Returns:

describeLanguageModelResult The response from the DescribeLanguageModel service method, as returned by Amazon Transcribe.

Throws:

BadRequestException

LimitExceededException

InternalFailureException

NotFoundException

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.

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.

getMedicalTranscriptionJob

public GetMedicalTranscriptionJobResult getMedicalTranscriptionJob(GetMedicalTranscriptionJobRequest getMedicalTranscriptionJobRequest)
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

Returns information about a transcription job from Amazon Transcribe Medical. To see the status of the job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. You find the results of the completed job in the TranscriptFileUri field.

Specified by:

getMedicalTranscriptionJob in interface AmazonTranscribe

Parameters:

getMedicalTranscriptionJobRequest -

Returns:

getMedicalTranscriptionJobResult The response from the GetMedicalTranscriptionJob service method, as returned by Amazon Transcribe.

Throws:

BadRequestException

LimitExceededException

InternalFailureException

NotFoundException

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.

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.

getMedicalVocabulary

public GetMedicalVocabularyResult getMedicalVocabulary(GetMedicalVocabularyRequest getMedicalVocabularyRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Retrieves information about a medical vocabulary.

Specified by:

getMedicalVocabulary in interface AmazonTranscribe

Parameters:

getMedicalVocabularyRequest -

Returns:

getMedicalVocabularyResult The response from the GetMedicalVocabulary service method, as returned by Amazon Transcribe.

Throws:

NotFoundException

LimitExceededException

InternalFailureException

BadRequestException

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.

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.

getTranscriptionJob

public GetTranscriptionJobResult getTranscriptionJob(GetTranscriptionJobRequest getTranscriptionJobRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

Returns information about a transcription job. To see the status of the job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the location specified in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri.

Specified by:

getTranscriptionJob in interface AmazonTranscribe

Parameters:

getTranscriptionJobRequest -

Returns:

getTranscriptionJobResult The response from the GetTranscriptionJob service method, as returned by Amazon Transcribe.

Throws:

BadRequestException

LimitExceededException

InternalFailureException

NotFoundException

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.

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.

getVocabulary

public GetVocabularyResult getVocabulary(GetVocabularyRequest getVocabularyRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Gets information about a vocabulary.

Specified by:

getVocabulary in interface AmazonTranscribe

Parameters:

getVocabularyRequest -

Returns:

getVocabularyResult The response from the GetVocabulary service method, as returned by Amazon Transcribe.

Throws:

NotFoundException

LimitExceededException

InternalFailureException

BadRequestException

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.

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.

getVocabularyFilter

public GetVocabularyFilterResult getVocabularyFilter(GetVocabularyFilterRequest getVocabularyFilterRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

Returns information about a vocabulary filter.

Specified by:

getVocabularyFilter in interface AmazonTranscribe

Parameters:

getVocabularyFilterRequest -

Returns:

getVocabularyFilterResult The response from the GetVocabularyFilter service method, as returned by Amazon Transcribe.

Throws:

NotFoundException

LimitExceededException

InternalFailureException

BadRequestException

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.

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.

listLanguageModels

public ListLanguageModelsResult listLanguageModels(ListLanguageModelsRequest listLanguageModelsRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

Provides more information about the custom language models you've created. You can use the information in this list to find a specific custom language model. You can then use the operation to get more information about it.

Specified by:

listLanguageModels in interface AmazonTranscribe

Parameters:

listLanguageModelsRequest -

Returns:

listLanguageModelsResult The response from the ListLanguageModels service method, as returned by Amazon Transcribe.

Throws:

BadRequestException

LimitExceededException

InternalFailureException

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.

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.

listMedicalTranscriptionJobs

public ListMedicalTranscriptionJobsResult listMedicalTranscriptionJobs(ListMedicalTranscriptionJobsRequest listMedicalTranscriptionJobsRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Lists medical transcription jobs with a specified status or substring that matches their names.

Specified by:

listMedicalTranscriptionJobs in interface AmazonTranscribe

Parameters:

listMedicalTranscriptionJobsRequest -

Returns:

listMedicalTranscriptionJobsResult The response from the ListMedicalTranscriptionJobs service method, as returned by Amazon Transcribe.

Throws:

BadRequestException

LimitExceededException

InternalFailureException

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.

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.

listMedicalVocabularies

public ListMedicalVocabulariesResult listMedicalVocabularies(ListMedicalVocabulariesRequest listMedicalVocabulariesRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

Returns a list of vocabularies that match the specified criteria. If you don't enter a value in any of the request parameters, returns the entire list of vocabularies.

Specified by:

listMedicalVocabularies in interface AmazonTranscribe

Parameters:

listMedicalVocabulariesRequest -

Returns:

listMedicalVocabulariesResult The response from the ListMedicalVocabularies service method, as returned by Amazon Transcribe.

Throws:

BadRequestException

LimitExceededException

InternalFailureException

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.

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.

listTranscriptionJobs

public ListTranscriptionJobsResult listTranscriptionJobs(ListTranscriptionJobsRequest listTranscriptionJobsRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Lists transcription jobs with the specified status.

Specified by:

listTranscriptionJobs in interface AmazonTranscribe

Parameters:

listTranscriptionJobsRequest -

Returns:

listTranscriptionJobsResult The response from the ListTranscriptionJobs service method, as returned by Amazon Transcribe.

Throws:

BadRequestException

LimitExceededException

InternalFailureException

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.

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.

listVocabularies

public ListVocabulariesResult listVocabularies(ListVocabulariesRequest listVocabulariesRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.

Specified by:

listVocabularies in interface AmazonTranscribe

Parameters:

listVocabulariesRequest -

Returns:

listVocabulariesResult The response from the ListVocabularies service method, as returned by Amazon Transcribe.

Throws:

BadRequestException

LimitExceededException

InternalFailureException

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.

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.

listVocabularyFilters

public ListVocabularyFiltersResult listVocabularyFilters(ListVocabularyFiltersRequest listVocabularyFiltersRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Gets information about vocabulary filters.

Specified by:

listVocabularyFilters in interface AmazonTranscribe

Parameters:

listVocabularyFiltersRequest -

Returns:

listVocabularyFiltersResult The response from the ListVocabularyFilters service method, as returned by Amazon Transcribe.

Throws:

BadRequestException

LimitExceededException

InternalFailureException

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.

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.

startMedicalTranscriptionJob

public StartMedicalTranscriptionJobResult startMedicalTranscriptionJob(StartMedicalTranscriptionJobRequest startMedicalTranscriptionJobRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Starts a batch job to transcribe medical speech to text.

Specified by:

startMedicalTranscriptionJob in interface AmazonTranscribe

Parameters:

startMedicalTranscriptionJobRequest -

Returns:

startMedicalTranscriptionJobResult The response from the StartMedicalTranscriptionJob service method, as returned by Amazon Transcribe.

Throws:

BadRequestException

LimitExceededException

InternalFailureException

ConflictException

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.

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.

startTranscriptionJob

public StartTranscriptionJobResult startTranscriptionJob(StartTranscriptionJobRequest startTranscriptionJobRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Starts an asynchronous job to transcribe speech to text.

Specified by:

startTranscriptionJob in interface AmazonTranscribe

Parameters:

startTranscriptionJobRequest -

Returns:

startTranscriptionJobResult The response from the StartTranscriptionJob service method, as returned by Amazon Transcribe.

Throws:

BadRequestException

LimitExceededException

InternalFailureException

ConflictException

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.

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.

updateMedicalVocabulary

public UpdateMedicalVocabularyResult updateMedicalVocabulary(UpdateMedicalVocabularyRequest updateMedicalVocabularyRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

Updates a vocabulary with new values that you provide in a different text file from the one you used to create the vocabulary. The UpdateMedicalVocabulary operation overwrites all of the existing information with the values that you provide in the request.

Specified by:

updateMedicalVocabulary in interface AmazonTranscribe

Parameters:

updateMedicalVocabularyRequest -

Returns:

updateMedicalVocabularyResult The response from the UpdateMedicalVocabulary service method, as returned by Amazon Transcribe.

Throws:

BadRequestException

LimitExceededException

InternalFailureException

NotFoundException

ConflictException

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.

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.

updateVocabulary

public UpdateVocabularyResult updateVocabulary(UpdateVocabularyRequest updateVocabularyRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Updates an existing vocabulary with new values. The UpdateVocabulary operation overwrites all of the existing information with the values that you provide in the request.

Specified by:

updateVocabulary in interface AmazonTranscribe

Parameters:

updateVocabularyRequest -

Returns:

updateVocabularyResult The response from the UpdateVocabulary service method, as returned by Amazon Transcribe.

Throws:

BadRequestException

LimitExceededException

InternalFailureException

NotFoundException

ConflictException

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.

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.

updateVocabularyFilter

public UpdateVocabularyFilterResult updateVocabularyFilter(UpdateVocabularyFilterRequest updateVocabularyFilterRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

Updates a vocabulary filter with a new list of filtered words.

Specified by:

updateVocabularyFilter in interface AmazonTranscribe

Parameters:

updateVocabularyFilterRequest -

Returns:

updateVocabularyFilterResult The response from the UpdateVocabularyFilter service method, as returned by Amazon Transcribe.

Throws:

BadRequestException

LimitExceededException

InternalFailureException

NotFoundException

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.

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.

getCachedResponseMetadata

@Deprecated
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Specified by:

getCachedResponseMetadata in interface AmazonTranscribe

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.