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

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonTranscribeClient
extends AmazonWebServiceClient
implements AmazonTranscribe

Client for accessing Amazon Transcribe Service. 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

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonTranscribeClientBuilder	builder()
CreateCallAnalyticsCategoryResult	createCallAnalyticsCategory(CreateCallAnalyticsCategoryRequest request) Creates an analytics category.
CreateLanguageModelResult	createLanguageModel(CreateLanguageModelRequest request) Creates a new custom language model.
CreateMedicalVocabularyResult	createMedicalVocabulary(CreateMedicalVocabularyRequest request) Creates a new custom vocabulary that you can use to modify how Amazon Transcribe Medical transcribes your audio file.
CreateVocabularyResult	createVocabulary(CreateVocabularyRequest request) Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.
CreateVocabularyFilterResult	createVocabularyFilter(CreateVocabularyFilterRequest request) Creates a new vocabulary filter that you can use to filter words, such as profane words, from the output of a transcription job.
DeleteCallAnalyticsCategoryResult	deleteCallAnalyticsCategory(DeleteCallAnalyticsCategoryRequest request) Deletes a call analytics category using its name.
DeleteCallAnalyticsJobResult	deleteCallAnalyticsJob(DeleteCallAnalyticsJobRequest request) Deletes a call analytics job using its name.
DeleteLanguageModelResult	deleteLanguageModel(DeleteLanguageModelRequest request) Deletes a custom language model using its name.
DeleteMedicalTranscriptionJobResult	deleteMedicalTranscriptionJob(DeleteMedicalTranscriptionJobRequest request) Deletes a transcription job generated by Amazon Transcribe Medical and any related information.
DeleteMedicalVocabularyResult	deleteMedicalVocabulary(DeleteMedicalVocabularyRequest request) Deletes a vocabulary from Amazon Transcribe Medical.
DeleteTranscriptionJobResult	deleteTranscriptionJob(DeleteTranscriptionJobRequest request) Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on.
DeleteVocabularyResult	deleteVocabulary(DeleteVocabularyRequest request) Deletes a vocabulary from Amazon Transcribe.
DeleteVocabularyFilterResult	deleteVocabularyFilter(DeleteVocabularyFilterRequest request) Removes a vocabulary filter.
DescribeLanguageModelResult	describeLanguageModel(DescribeLanguageModelRequest request) Gets information about a single custom language model.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetCallAnalyticsCategoryResult	getCallAnalyticsCategory(GetCallAnalyticsCategoryRequest request) Retrieves information about a call analytics category.
GetCallAnalyticsJobResult	getCallAnalyticsJob(GetCallAnalyticsJobRequest request) Returns information about a call analytics job.
GetMedicalTranscriptionJobResult	getMedicalTranscriptionJob(GetMedicalTranscriptionJobRequest request) Returns information about a transcription job from Amazon Transcribe Medical.
GetMedicalVocabularyResult	getMedicalVocabulary(GetMedicalVocabularyRequest request) Retrieves information about a medical vocabulary.
GetTranscriptionJobResult	getTranscriptionJob(GetTranscriptionJobRequest request) Returns information about a transcription job.
GetVocabularyResult	getVocabulary(GetVocabularyRequest request) Gets information about a vocabulary.
GetVocabularyFilterResult	getVocabularyFilter(GetVocabularyFilterRequest request) Returns information about a vocabulary filter.
ListCallAnalyticsCategoriesResult	listCallAnalyticsCategories(ListCallAnalyticsCategoriesRequest request) Provides more information about the call analytics categories that you've created.
ListCallAnalyticsJobsResult	listCallAnalyticsJobs(ListCallAnalyticsJobsRequest request) List call analytics jobs with a specified status or substring that matches their names.
ListLanguageModelsResult	listLanguageModels(ListLanguageModelsRequest request) Provides more information about the custom language models you've created.
ListMedicalTranscriptionJobsResult	listMedicalTranscriptionJobs(ListMedicalTranscriptionJobsRequest request) Lists medical transcription jobs with a specified status or substring that matches their names.
ListMedicalVocabulariesResult	listMedicalVocabularies(ListMedicalVocabulariesRequest request) Returns a list of vocabularies that match the specified criteria.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists all tags associated with a given transcription job, vocabulary, or resource.
ListTranscriptionJobsResult	listTranscriptionJobs(ListTranscriptionJobsRequest request) Lists transcription jobs with the specified status.
ListVocabulariesResult	listVocabularies(ListVocabulariesRequest request) Returns a list of vocabularies that match the specified criteria.
ListVocabularyFiltersResult	listVocabularyFilters(ListVocabularyFiltersRequest request) Gets information about vocabulary filters.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartCallAnalyticsJobResult	startCallAnalyticsJob(StartCallAnalyticsJobRequest request) Starts an asynchronous analytics job that not only transcribes the audio recording of a caller and agent, but also returns additional insights.
StartMedicalTranscriptionJobResult	startMedicalTranscriptionJob(StartMedicalTranscriptionJobRequest request) Starts a batch job to transcribe medical speech to text.
StartTranscriptionJobResult	startTranscriptionJob(StartTranscriptionJobRequest request) Starts an asynchronous job to transcribe speech to text.
TagResourceResult	tagResource(TagResourceRequest request) Tags a Amazon Transcribe resource with the given list of tags.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes specified tags from a specified Amazon Transcribe resource.
UpdateCallAnalyticsCategoryResult	updateCallAnalyticsCategory(UpdateCallAnalyticsCategoryRequest request) Updates the call analytics category with new values.
UpdateMedicalVocabularyResult	updateMedicalVocabulary(UpdateMedicalVocabularyRequest request) 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 request) Updates an existing vocabulary with new values.
UpdateVocabularyFilterResult	updateVocabularyFilter(UpdateVocabularyFilterRequest request) Updates a vocabulary filter with a new list of filtered words.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static AmazonTranscribeClientBuilder builder()

createCallAnalyticsCategory

public CreateCallAnalyticsCategoryResult createCallAnalyticsCategory(CreateCallAnalyticsCategoryRequest request)

Creates an analytics category. Amazon Transcribe applies the conditions specified by your analytics categories to your call analytics jobs. For each analytics category, you specify one or more rules. For example, you can specify a rule that the customer sentiment was neutral or negative within that category. If you start a call analytics job, Amazon Transcribe applies the category to the analytics job that you've specified.

Specified by:

createCallAnalyticsCategory in interface AmazonTranscribe

Parameters:

createCallAnalyticsCategoryRequest -

Returns:

Result of the CreateCallAnalyticsCategory operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

ConflictException - There is already a resource with that name.

See Also:

AWS API Documentation

createLanguageModel

public CreateLanguageModelResult createLanguageModel(CreateLanguageModelRequest request)

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:

Result of the CreateLanguageModel operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

ConflictException - There is already a resource with that name.

See Also:

AWS API Documentation

createMedicalVocabulary

public CreateMedicalVocabularyResult createMedicalVocabulary(CreateMedicalVocabularyRequest request)

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

Specified by:

createMedicalVocabulary in interface AmazonTranscribe

Parameters:

createMedicalVocabularyRequest -

Returns:

Result of the CreateMedicalVocabulary operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

ConflictException - There is already a resource with that name.

See Also:

AWS API Documentation

createVocabulary

public CreateVocabularyResult createVocabulary(CreateVocabularyRequest request)

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:

Result of the CreateVocabulary operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

ConflictException - There is already a resource with that name.

See Also:

AWS API Documentation

createVocabularyFilter

public CreateVocabularyFilterResult createVocabularyFilter(CreateVocabularyFilterRequest request)

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:

Result of the CreateVocabularyFilter operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

ConflictException - There is already a resource with that name.

See Also:

AWS API Documentation

deleteCallAnalyticsCategory

public DeleteCallAnalyticsCategoryResult deleteCallAnalyticsCategory(DeleteCallAnalyticsCategoryRequest request)

Deletes a call analytics category using its name.

Specified by:

deleteCallAnalyticsCategory in interface AmazonTranscribe

Parameters:

deleteCallAnalyticsCategoryRequest -

Returns:

Result of the DeleteCallAnalyticsCategory operation returned by the service.

Throws:

NotFoundException - We can't find the requested resource. Check the name and try your request again.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

InternalFailureException - There was an internal error. Check the error message and try your request again.

See Also:

AWS API Documentation

deleteCallAnalyticsJob

public DeleteCallAnalyticsJobResult deleteCallAnalyticsJob(DeleteCallAnalyticsJobRequest request)

Deletes a call analytics job using its name.

Specified by:

deleteCallAnalyticsJob in interface AmazonTranscribe

Parameters:

deleteCallAnalyticsJobRequest -

Returns:

Result of the DeleteCallAnalyticsJob operation returned by the service.

Throws:

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

InternalFailureException - There was an internal error. Check the error message and try your request again.

See Also:

AWS API Documentation

deleteLanguageModel

public DeleteLanguageModelResult deleteLanguageModel(DeleteLanguageModelRequest request)

Deletes a custom language model using its name.

Specified by:

deleteLanguageModel in interface AmazonTranscribe

Parameters:

deleteLanguageModelRequest -

Returns:

Result of the DeleteLanguageModel operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

See Also:

AWS API Documentation

deleteMedicalTranscriptionJob

public DeleteMedicalTranscriptionJobResult deleteMedicalTranscriptionJob(DeleteMedicalTranscriptionJobRequest request)

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

Specified by:

deleteMedicalTranscriptionJob in interface AmazonTranscribe

Parameters:

deleteMedicalTranscriptionJobRequest -

Returns:

Result of the DeleteMedicalTranscriptionJob operation returned by the service.

Throws:

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

InternalFailureException - There was an internal error. Check the error message and try your request again.

See Also:

AWS API Documentation

deleteMedicalVocabulary

public DeleteMedicalVocabularyResult deleteMedicalVocabulary(DeleteMedicalVocabularyRequest request)

Deletes a vocabulary from Amazon Transcribe Medical.

Specified by:

deleteMedicalVocabulary in interface AmazonTranscribe

Parameters:

deleteMedicalVocabularyRequest -

Returns:

Result of the DeleteMedicalVocabulary operation returned by the service.

Throws:

NotFoundException - We can't find the requested resource. Check the name and try your request again.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

InternalFailureException - There was an internal error. Check the error message and try your request again.

See Also:

AWS API Documentation

deleteTranscriptionJob

public DeleteTranscriptionJobResult deleteTranscriptionJob(DeleteTranscriptionJobRequest request)

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 -

Returns:

Result of the DeleteTranscriptionJob operation returned by the service.

Throws:

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

InternalFailureException - There was an internal error. Check the error message and try your request again.

See Also:

AWS API Documentation

deleteVocabulary

public DeleteVocabularyResult deleteVocabulary(DeleteVocabularyRequest request)

Deletes a vocabulary from Amazon Transcribe.

Specified by:

deleteVocabulary in interface AmazonTranscribe

Parameters:

deleteVocabularyRequest -

Returns:

Result of the DeleteVocabulary operation returned by the service.

Throws:

NotFoundException - We can't find the requested resource. Check the name and try your request again.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

InternalFailureException - There was an internal error. Check the error message and try your request again.

See Also:

AWS API Documentation

deleteVocabularyFilter

public DeleteVocabularyFilterResult deleteVocabularyFilter(DeleteVocabularyFilterRequest request)

Removes a vocabulary filter.

Specified by:

deleteVocabularyFilter in interface AmazonTranscribe

Parameters:

deleteVocabularyFilterRequest -

Returns:

Result of the DeleteVocabularyFilter operation returned by the service.

Throws:

NotFoundException - We can't find the requested resource. Check the name and try your request again.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

InternalFailureException - There was an internal error. Check the error message and try your request again.

See Also:

AWS API Documentation

describeLanguageModel

public DescribeLanguageModelResult describeLanguageModel(DescribeLanguageModelRequest request)

Gets information about a single custom language model. Use this information to see details about the language model in your Amazon Web Services 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:

Result of the DescribeLanguageModel operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

NotFoundException - We can't find the requested resource. Check the name and try your request again.

See Also:

AWS API Documentation

getCallAnalyticsCategory

public GetCallAnalyticsCategoryResult getCallAnalyticsCategory(GetCallAnalyticsCategoryRequest request)

Retrieves information about a call analytics category.

Specified by:

getCallAnalyticsCategory in interface AmazonTranscribe

Parameters:

getCallAnalyticsCategoryRequest -

Returns:

Result of the GetCallAnalyticsCategory operation returned by the service.

Throws:

NotFoundException - We can't find the requested resource. Check the name and try your request again.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

See Also:

AWS API Documentation

getCallAnalyticsJob

public GetCallAnalyticsJobResult getCallAnalyticsJob(GetCallAnalyticsJobRequest request)

Returns information about a call analytics job. To see the status of the job, check the CallAnalyticsJobStatus 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 personally identifiable information (PII) redaction, the redacted transcript appears in the RedactedTranscriptFileUri field.

Specified by:

getCallAnalyticsJob in interface AmazonTranscribe

Parameters:

getCallAnalyticsJobRequest -

Returns:

Result of the GetCallAnalyticsJob operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

NotFoundException - We can't find the requested resource. Check the name and try your request again.

See Also:

AWS API Documentation

getMedicalTranscriptionJob

public GetMedicalTranscriptionJobResult getMedicalTranscriptionJob(GetMedicalTranscriptionJobRequest request)

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:

Result of the GetMedicalTranscriptionJob operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

NotFoundException - We can't find the requested resource. Check the name and try your request again.

See Also:

AWS API Documentation

getMedicalVocabulary

public GetMedicalVocabularyResult getMedicalVocabulary(GetMedicalVocabularyRequest request)

Retrieves information about a medical vocabulary.

Specified by:

getMedicalVocabulary in interface AmazonTranscribe

Parameters:

getMedicalVocabularyRequest -

Returns:

Result of the GetMedicalVocabulary operation returned by the service.

Throws:

NotFoundException - We can't find the requested resource. Check the name and try your request again.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

See Also:

AWS API Documentation

getTranscriptionJob

public GetTranscriptionJobResult getTranscriptionJob(GetTranscriptionJobRequest request)

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:

Result of the GetTranscriptionJob operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

NotFoundException - We can't find the requested resource. Check the name and try your request again.

See Also:

AWS API Documentation

getVocabulary

public GetVocabularyResult getVocabulary(GetVocabularyRequest request)

Gets information about a vocabulary.

Specified by:

getVocabulary in interface AmazonTranscribe

Parameters:

getVocabularyRequest -

Returns:

Result of the GetVocabulary operation returned by the service.

Throws:

NotFoundException - We can't find the requested resource. Check the name and try your request again.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

See Also:

AWS API Documentation

getVocabularyFilter

public GetVocabularyFilterResult getVocabularyFilter(GetVocabularyFilterRequest request)

Returns information about a vocabulary filter.

Specified by:

getVocabularyFilter in interface AmazonTranscribe

Parameters:

getVocabularyFilterRequest -

Returns:

Result of the GetVocabularyFilter operation returned by the service.

Throws:

NotFoundException - We can't find the requested resource. Check the name and try your request again.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

See Also:

AWS API Documentation

listCallAnalyticsCategories

public ListCallAnalyticsCategoriesResult listCallAnalyticsCategories(ListCallAnalyticsCategoriesRequest request)

Provides more information about the call analytics categories that you've created. You can use the information in this list to find a specific category. You can then use the operation to get more information about it.

Specified by:

listCallAnalyticsCategories in interface AmazonTranscribe

Parameters:

listCallAnalyticsCategoriesRequest -

Returns:

Result of the ListCallAnalyticsCategories operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

See Also:

AWS API Documentation

listCallAnalyticsJobs

public ListCallAnalyticsJobsResult listCallAnalyticsJobs(ListCallAnalyticsJobsRequest request)

List call analytics jobs with a specified status or substring that matches their names.

Specified by:

listCallAnalyticsJobs in interface AmazonTranscribe

Parameters:

listCallAnalyticsJobsRequest -

Returns:

Result of the ListCallAnalyticsJobs operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

See Also:

AWS API Documentation

listLanguageModels

public ListLanguageModelsResult listLanguageModels(ListLanguageModelsRequest request)

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:

Result of the ListLanguageModels operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

See Also:

AWS API Documentation

listMedicalTranscriptionJobs

public ListMedicalTranscriptionJobsResult listMedicalTranscriptionJobs(ListMedicalTranscriptionJobsRequest request)

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

Specified by:

listMedicalTranscriptionJobs in interface AmazonTranscribe

Parameters:

listMedicalTranscriptionJobsRequest -

Returns:

Result of the ListMedicalTranscriptionJobs operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

See Also:

AWS API Documentation

listMedicalVocabularies

public ListMedicalVocabulariesResult listMedicalVocabularies(ListMedicalVocabulariesRequest request)

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:

Result of the ListMedicalVocabularies operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists all tags associated with a given transcription job, vocabulary, or resource.

Specified by:

listTagsForResource in interface AmazonTranscribe

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

NotFoundException - We can't find the requested resource. Check the name and try your request again.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

See Also:

AWS API Documentation

listTranscriptionJobs

public ListTranscriptionJobsResult listTranscriptionJobs(ListTranscriptionJobsRequest request)

Lists transcription jobs with the specified status.

Specified by:

listTranscriptionJobs in interface AmazonTranscribe

Parameters:

listTranscriptionJobsRequest -

Returns:

Result of the ListTranscriptionJobs operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

See Also:

AWS API Documentation

listVocabularies

public ListVocabulariesResult listVocabularies(ListVocabulariesRequest request)

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:

Result of the ListVocabularies operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

See Also:

AWS API Documentation

listVocabularyFilters

public ListVocabularyFiltersResult listVocabularyFilters(ListVocabularyFiltersRequest request)

Gets information about vocabulary filters.

Specified by:

listVocabularyFilters in interface AmazonTranscribe

Parameters:

listVocabularyFiltersRequest -

Returns:

Result of the ListVocabularyFilters operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

See Also:

AWS API Documentation

startCallAnalyticsJob

public StartCallAnalyticsJobResult startCallAnalyticsJob(StartCallAnalyticsJobRequest request)

Starts an asynchronous analytics job that not only transcribes the audio recording of a caller and agent, but also returns additional insights. These insights include how quickly or loudly the caller or agent was speaking. To retrieve additional insights with your analytics jobs, create categories. A category is a way to classify analytics jobs based on attributes, such as a customer's sentiment or a particular phrase being used during the call. For more information, see the operation.

Specified by:

startCallAnalyticsJob in interface AmazonTranscribe

Parameters:

startCallAnalyticsJobRequest -

Returns:

Result of the StartCallAnalyticsJob operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

ConflictException - There is already a resource with that name.

See Also:

AWS API Documentation

startMedicalTranscriptionJob

public StartMedicalTranscriptionJobResult startMedicalTranscriptionJob(StartMedicalTranscriptionJobRequest request)

Starts a batch job to transcribe medical speech to text.

Specified by:

startMedicalTranscriptionJob in interface AmazonTranscribe

Parameters:

startMedicalTranscriptionJobRequest -

Returns:

Result of the StartMedicalTranscriptionJob operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

ConflictException - There is already a resource with that name.

See Also:

AWS API Documentation

startTranscriptionJob

public StartTranscriptionJobResult startTranscriptionJob(StartTranscriptionJobRequest request)

Starts an asynchronous job to transcribe speech to text.

Specified by:

startTranscriptionJob in interface AmazonTranscribe

Parameters:

startTranscriptionJobRequest -

Returns:

Result of the StartTranscriptionJob operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

ConflictException - There is already a resource with that name.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Tags a Amazon Transcribe resource with the given list of tags.

Specified by:

tagResource in interface AmazonTranscribe

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

ConflictException - There is already a resource with that name.

NotFoundException - We can't find the requested resource. Check the name and try your request again.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes specified tags from a specified Amazon Transcribe resource.

Specified by:

untagResource in interface AmazonTranscribe

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

ConflictException - There is already a resource with that name.

NotFoundException - We can't find the requested resource. Check the name and try your request again.

InternalFailureException - There was an internal error. Check the error message and try your request again.

See Also:

AWS API Documentation

updateCallAnalyticsCategory

public UpdateCallAnalyticsCategoryResult updateCallAnalyticsCategory(UpdateCallAnalyticsCategoryRequest request)

Updates the call analytics category with new values. The UpdateCallAnalyticsCategory operation overwrites all of the existing information with the values that you provide in the request.

Specified by:

updateCallAnalyticsCategory in interface AmazonTranscribe

Parameters:

updateCallAnalyticsCategoryRequest -

Returns:

Result of the UpdateCallAnalyticsCategory operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

NotFoundException - We can't find the requested resource. Check the name and try your request again.

ConflictException - There is already a resource with that name.

See Also:

AWS API Documentation

updateMedicalVocabulary

public UpdateMedicalVocabularyResult updateMedicalVocabulary(UpdateMedicalVocabularyRequest request)

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:

Result of the UpdateMedicalVocabulary operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

NotFoundException - We can't find the requested resource. Check the name and try your request again.

ConflictException - There is already a resource with that name.

See Also:

AWS API Documentation

updateVocabulary

public UpdateVocabularyResult updateVocabulary(UpdateVocabularyRequest request)

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:

Result of the UpdateVocabulary operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

NotFoundException - We can't find the requested resource. Check the name and try your request again.

ConflictException - There is already a resource with that name.

See Also:

AWS API Documentation

updateVocabularyFilter

public UpdateVocabularyFilterResult updateVocabularyFilter(UpdateVocabularyFilterRequest request)

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

Specified by:

updateVocabularyFilter in interface AmazonTranscribe

Parameters:

updateVocabularyFilterRequest -

Returns:

Result of the UpdateVocabularyFilter operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

NotFoundException - We can't find the requested resource. Check the name and try your request again.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

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.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonTranscribe

Overrides:

shutdown in class AmazonWebServiceClient