com.amazonaws.services.transcribe

Interface AmazonTranscribe

All Known Subinterfaces:

AmazonTranscribeAsync

All Known Implementing Classes:

AbstractAmazonTranscribe, AbstractAmazonTranscribeAsync, AmazonTranscribeAsyncClient, AmazonTranscribeClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonTranscribe

Interface for accessing Amazon Transcribe Service.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonTranscribe instead.

Operations and objects for transcribing speech to text.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateCallAnalyticsCategoryResult	createCallAnalyticsCategory(CreateCallAnalyticsCategoryRequest createCallAnalyticsCategoryRequest) Creates a call analytics category.
CreateLanguageModelResult	createLanguageModel(CreateLanguageModelRequest createLanguageModelRequest) Creates a new custom language model.
CreateMedicalVocabularyResult	createMedicalVocabulary(CreateMedicalVocabularyRequest createMedicalVocabularyRequest) Creates a new custom medical vocabulary.
CreateVocabularyResult	createVocabulary(CreateVocabularyRequest createVocabularyRequest) Creates a new custom vocabulary.
CreateVocabularyFilterResult	createVocabularyFilter(CreateVocabularyFilterRequest createVocabularyFilterRequest) Creates a new vocabulary filter that you can use to filter words from your transcription output.
DeleteCallAnalyticsCategoryResult	deleteCallAnalyticsCategory(DeleteCallAnalyticsCategoryRequest deleteCallAnalyticsCategoryRequest) Deletes a call analytics category.
DeleteCallAnalyticsJobResult	deleteCallAnalyticsJob(DeleteCallAnalyticsJobRequest deleteCallAnalyticsJobRequest) Deletes a call analytics job.
DeleteLanguageModelResult	deleteLanguageModel(DeleteLanguageModelRequest deleteLanguageModelRequest) Deletes a custom language model.
DeleteMedicalTranscriptionJobResult	deleteMedicalTranscriptionJob(DeleteMedicalTranscriptionJobRequest deleteMedicalTranscriptionJobRequest) Deletes a medical transcription job, along with any related information.
DeleteMedicalVocabularyResult	deleteMedicalVocabulary(DeleteMedicalVocabularyRequest deleteMedicalVocabularyRequest) Deletes a custom medical vocabulary.
DeleteTranscriptionJobResult	deleteTranscriptionJob(DeleteTranscriptionJobRequest deleteTranscriptionJobRequest) Deletes a transcription job, along with any related information.
DeleteVocabularyResult	deleteVocabulary(DeleteVocabularyRequest deleteVocabularyRequest) Deletes a custom vocabulary.
DeleteVocabularyFilterResult	deleteVocabularyFilter(DeleteVocabularyFilterRequest deleteVocabularyFilterRequest) Deletes a vocabulary filter.
DescribeLanguageModelResult	describeLanguageModel(DescribeLanguageModelRequest describeLanguageModelRequest) Provides information about a specific custom language model in your Amazon Web Services account.
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 getCallAnalyticsCategoryRequest) Retrieves information about a call analytics category.
GetCallAnalyticsJobResult	getCallAnalyticsJob(GetCallAnalyticsJobRequest getCallAnalyticsJobRequest) Retrieves information about a call analytics job.
GetMedicalTranscriptionJobResult	getMedicalTranscriptionJob(GetMedicalTranscriptionJobRequest getMedicalTranscriptionJobRequest) Retrieves information about a medical transcription job.
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.
ListCallAnalyticsCategoriesResult	listCallAnalyticsCategories(ListCallAnalyticsCategoriesRequest listCallAnalyticsCategoriesRequest) Provides more information about the call analytics categories that you've created.
ListCallAnalyticsJobsResult	listCallAnalyticsJobs(ListCallAnalyticsJobsRequest listCallAnalyticsJobsRequest) List call analytics jobs with a specified status or substring that matches their names.
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.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags associated with a given transcription job, vocabulary, or resource.
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.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartCallAnalyticsJobResult	startCallAnalyticsJob(StartCallAnalyticsJobRequest startCallAnalyticsJobRequest) 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 startMedicalTranscriptionJobRequest) Starts a batch job to transcribe medical speech to text.
StartTranscriptionJobResult	startTranscriptionJob(StartTranscriptionJobRequest startTranscriptionJobRequest) Starts an asynchronous job to transcribe speech to text.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Tags an Amazon Transcribe resource with the given list of tags.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes specified tags from a specified Amazon Transcribe resource.
UpdateCallAnalyticsCategoryResult	updateCallAnalyticsCategory(UpdateCallAnalyticsCategoryRequest updateCallAnalyticsCategoryRequest) Updates the call analytics category with new values.
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.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createCallAnalyticsCategory

CreateCallAnalyticsCategoryResult createCallAnalyticsCategory(CreateCallAnalyticsCategoryRequest createCallAnalyticsCategoryRequest)

Creates a call analytics category. Amazon Transcribe applies the conditions specified by your call analytics categories to your call analytics jobs. For each analytics category, you must create between 1 and 20 rules. For example, you can create a 'greeting' category with a rule that flags calls in which your agent does not use a specified phrase (for example: "Please note this call may be recorded.") in the first 15 seconds of the call. When you start a call analytics job, Amazon Transcribe applies all your existing call analytics categories to that job.

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

CreateLanguageModelResult createLanguageModel(CreateLanguageModelRequest createLanguageModelRequest)

Creates a new custom language model. When creating a new language model, you must specify if you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband (audio sample rates under 16,000 Hz) base model. You then include the S3 URI location of your training and tuning files, the language for the model, a unique name, and any tags you want associated with your model.

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

CreateMedicalVocabularyResult createMedicalVocabulary(CreateMedicalVocabularyRequest createMedicalVocabularyRequest)

Creates a new custom medical vocabulary.

When creating a new medical vocabulary, you must upload a text file that contains your new entries, phrases, and terms into an S3 bucket. Note that this differs from , where you can include a list of terms within your request using the Phrases flag, as CreateMedicalVocabulary does not support the Phrases flag.

For more information on creating a custom vocabulary text file, see Creating a custom vocabulary.

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

CreateVocabularyResult createVocabulary(CreateVocabularyRequest createVocabularyRequest)

Creates a new custom vocabulary.

When creating a new medical vocabulary, you can either upload a text file that contains your new entries, phrases, and terms into an S3 bucket or include a list of terms directly in your request using the Phrases flag.

For more information on creating a custom vocabulary, see Creating a custom vocabulary.

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

CreateVocabularyFilterResult createVocabularyFilter(CreateVocabularyFilterRequest createVocabularyFilterRequest)

Creates a new vocabulary filter that you can use to filter words from your transcription output. For example, you can use this operation to remove profanity from your transcript.

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

DeleteCallAnalyticsCategoryResult deleteCallAnalyticsCategory(DeleteCallAnalyticsCategoryRequest deleteCallAnalyticsCategoryRequest)

Deletes a call analytics category. To use this operation, specify the name of the category you want to delete using CategoryName.

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

DeleteCallAnalyticsJobResult deleteCallAnalyticsJob(DeleteCallAnalyticsJobRequest deleteCallAnalyticsJobRequest)

Deletes a call analytics job. To use this operation, specify the name of the job you want to delete using CallAnalyticsJobName.

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

DeleteLanguageModelResult deleteLanguageModel(DeleteLanguageModelRequest deleteLanguageModelRequest)

Deletes a custom language model. To use this operation, specify the name of the language model you want to delete using ModelName.

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

DeleteMedicalTranscriptionJobResult deleteMedicalTranscriptionJob(DeleteMedicalTranscriptionJobRequest deleteMedicalTranscriptionJobRequest)

Deletes a medical transcription job, along with any related information. To use this operation, specify the name of the job you want to delete using MedicalTranscriptionJobName.

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

DeleteMedicalVocabularyResult deleteMedicalVocabulary(DeleteMedicalVocabularyRequest deleteMedicalVocabularyRequest)

Deletes a custom medical vocabulary. To use this operation, specify the name of the vocabulary you want to delete using VocabularyName.

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

DeleteTranscriptionJobResult deleteTranscriptionJob(DeleteTranscriptionJobRequest deleteTranscriptionJobRequest)

Deletes a transcription job, along with any related information. To use this operation, specify the name of the job you want to delete using TranscriptionJobName.

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

DeleteVocabularyResult deleteVocabulary(DeleteVocabularyRequest deleteVocabularyRequest)

Deletes a custom vocabulary. To use this operation, specify the name of the vocabulary you want to delete using VocabularyName.

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

DeleteVocabularyFilterResult deleteVocabularyFilter(DeleteVocabularyFilterRequest deleteVocabularyFilterRequest)

Deletes a vocabulary filter. To use this operation, specify the name of the vocabulary filter you want to delete using VocabularyFilterName.

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

DescribeLanguageModelResult describeLanguageModel(DescribeLanguageModelRequest describeLanguageModelRequest)

Provides information about a specific custom language model in your Amazon Web Services account.

This operation also shows if the base language model you used to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a new custom language model using the updated base model.

If you tried to create a new custom language model and the request wasn't successful, you can use this operation to help identify the reason.

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

GetCallAnalyticsCategoryResult getCallAnalyticsCategory(GetCallAnalyticsCategoryRequest getCallAnalyticsCategoryRequest)

Retrieves information about a call analytics category.

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

GetCallAnalyticsJobResult getCallAnalyticsJob(GetCallAnalyticsJobRequest getCallAnalyticsJobRequest)

Retrieves information about a call analytics job.

To view the job's status, refer to the CallAnalyticsJobStatus field. If the status is COMPLETED, the job is finished. You can then find your transcript at the URI specified in the TranscriptFileUri field. If you enabled personally identifiable information (PII) redaction, the redacted transcript appears in the RedactedTranscriptFileUri field.

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

GetMedicalTranscriptionJobResult getMedicalTranscriptionJob(GetMedicalTranscriptionJobRequest getMedicalTranscriptionJobRequest)

Retrieves information about a medical transcription job.

To view the job's status, refer to the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. You can then find your transcript at the URI specified in the TranscriptFileUri field.

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

GetMedicalVocabularyResult getMedicalVocabulary(GetMedicalVocabularyRequest getMedicalVocabularyRequest)

Retrieves information about a medical vocabulary.

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

GetTranscriptionJobResult getTranscriptionJob(GetTranscriptionJobRequest getTranscriptionJobRequest)

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.

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

GetVocabularyResult getVocabulary(GetVocabularyRequest getVocabularyRequest)

Gets information about a vocabulary.

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

GetVocabularyFilterResult getVocabularyFilter(GetVocabularyFilterRequest getVocabularyFilterRequest)

Returns information about a vocabulary filter.

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

ListCallAnalyticsCategoriesResult listCallAnalyticsCategories(ListCallAnalyticsCategoriesRequest listCallAnalyticsCategoriesRequest)

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.

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

ListCallAnalyticsJobsResult listCallAnalyticsJobs(ListCallAnalyticsJobsRequest listCallAnalyticsJobsRequest)

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

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

ListLanguageModelsResult listLanguageModels(ListLanguageModelsRequest listLanguageModelsRequest)

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.

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

ListMedicalTranscriptionJobsResult listMedicalTranscriptionJobs(ListMedicalTranscriptionJobsRequest listMedicalTranscriptionJobsRequest)

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

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

ListMedicalVocabulariesResult listMedicalVocabularies(ListMedicalVocabulariesRequest listMedicalVocabulariesRequest)

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.

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

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

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

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

ListTranscriptionJobsResult listTranscriptionJobs(ListTranscriptionJobsRequest listTranscriptionJobsRequest)

Lists transcription jobs with the specified status.

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

ListVocabulariesResult listVocabularies(ListVocabulariesRequest listVocabulariesRequest)

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

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

ListVocabularyFiltersResult listVocabularyFilters(ListVocabularyFiltersRequest listVocabularyFiltersRequest)

Gets information about vocabulary filters.

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

StartCallAnalyticsJobResult startCallAnalyticsJob(StartCallAnalyticsJobRequest startCallAnalyticsJobRequest)

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.

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

StartMedicalTranscriptionJobResult startMedicalTranscriptionJob(StartMedicalTranscriptionJobRequest startMedicalTranscriptionJobRequest)

Starts a batch job to transcribe medical speech to text.

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

StartTranscriptionJobResult startTranscriptionJob(StartTranscriptionJobRequest startTranscriptionJobRequest)

Starts an asynchronous job to transcribe speech to text.

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

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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

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

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes specified tags from a specified Amazon Transcribe resource.

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

UpdateCallAnalyticsCategoryResult updateCallAnalyticsCategory(UpdateCallAnalyticsCategoryRequest updateCallAnalyticsCategoryRequest)

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.

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

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. The UpdateMedicalVocabulary operation overwrites all of the existing information with the values that you provide in the request.

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

UpdateVocabularyResult updateVocabulary(UpdateVocabularyRequest updateVocabularyRequest)

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.

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

UpdateVocabularyFilterResult updateVocabularyFilter(UpdateVocabularyFilterRequest updateVocabularyFilterRequest)

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

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

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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