/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.transcribe; import javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.transcribe.model.*; /** * Interface for accessing Amazon Transcribe Service. *

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.transcribe.AbstractAmazonTranscribe} instead. *

*

*

* Amazon Transcribe offers three main types of batch transcription: Standard, Medical, and Call * Analytics. *

* */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonTranscribe { /** * 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 RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "transcribe"; /** *

* Creates a new Call Analytics category. *

*

* All categories are automatically applied to your Call Analytics transcriptions. Note that in order to apply * categories to your transcriptions, you must create them before submitting your transcription request, as * categories cannot be applied retroactively. *

*

* When creating a new category, you can use the InputType parameter to label the category as a * POST_CALL or a REAL_TIME category. POST_CALL categories can only be * applied to post-call transcriptions and REAL_TIME categories can only be applied to real-time * transcriptions. If you do not include InputType, your category is created as a * POST_CALL category by default. *

*

* Call Analytics categories are composed of rules. For each category, you must create between 1 and 20 rules. Rules * can include these parameters: , , , and . *

*

* To update an existing category, see . *

*

* To learn more about Call Analytics categories, see Creating categories for * post-call transcriptions and Creating categories for * real-time transcriptions. *

* * @param createCallAnalyticsCategoryRequest * @return Result of the CreateCallAnalyticsCategory operation returned by the service. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @throws ConflictException * A resource already exists with this name. Resource names must be unique within an Amazon Web Services * account. * @sample AmazonTranscribe.CreateCallAnalyticsCategory * @see AWS API Documentation */ CreateCallAnalyticsCategoryResult createCallAnalyticsCategory(CreateCallAnalyticsCategoryRequest createCallAnalyticsCategoryRequest); /** *

* Creates a new custom language model. *

*

* When creating a new custom language model, you must specify: *

* * * @param createLanguageModelRequest * @return Result of the CreateLanguageModel operation returned by the service. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @throws ConflictException * A resource already exists with this name. Resource names must be unique within an Amazon Web Services * account. * @sample AmazonTranscribe.CreateLanguageModel * @see AWS * API Documentation */ CreateLanguageModelResult createLanguageModel(CreateLanguageModelRequest createLanguageModelRequest); /** *

* Creates a new custom medical vocabulary. *

*

* Before creating a new custom medical vocabulary, you must first upload a text file that contains your vocabulary * table into an Amazon S3 bucket. Note that this differs from , where you can include a list of terms within your * request using the Phrases flag; CreateMedicalVocabulary does not support the * Phrases flag and only accepts vocabularies in table format. *

*

* Each language has a character set that contains all allowed characters for that specific language. If you use * unsupported characters, your custom vocabulary request fails. Refer to Character Sets for Custom Vocabularies * to get the character set for your language. *

*

* For more information, see Custom vocabularies. *

* * @param createMedicalVocabularyRequest * @return Result of the CreateMedicalVocabulary operation returned by the service. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @throws ConflictException * A resource already exists with this name. Resource names must be unique within an Amazon Web Services * account. * @sample AmazonTranscribe.CreateMedicalVocabulary * @see AWS API Documentation */ CreateMedicalVocabularyResult createMedicalVocabulary(CreateMedicalVocabularyRequest createMedicalVocabularyRequest); /** *

* Creates a new custom vocabulary. *

*

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

*

* Each language has a character set that contains all allowed characters for that specific language. If you use * unsupported characters, your custom vocabulary request fails. Refer to Character Sets for Custom Vocabularies * to get the character set for your language. *

*

* For more information, see Custom vocabularies. *

* * @param createVocabularyRequest * @return Result of the CreateVocabulary operation returned by the service. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @throws ConflictException * A resource already exists with this name. Resource names must be unique within an Amazon Web Services * account. * @sample AmazonTranscribe.CreateVocabulary * @see AWS * API Documentation */ CreateVocabularyResult createVocabulary(CreateVocabularyRequest createVocabularyRequest); /** *

* Creates a new custom vocabulary filter. *

*

* You can use custom vocabulary filters to mask, delete, or flag specific words from your transcript. Custom * vocabulary filters are commonly used to mask profanity in transcripts. *

*

* Each language has a character set that contains all allowed characters for that specific language. If you use * unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies * to get the character set for your language. *

*

* For more information, see Vocabulary filtering. *

* * @param createVocabularyFilterRequest * @return Result of the CreateVocabularyFilter operation returned by the service. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @throws ConflictException * A resource already exists with this name. Resource names must be unique within an Amazon Web Services * account. * @sample AmazonTranscribe.CreateVocabularyFilter * @see AWS API Documentation */ CreateVocabularyFilterResult createVocabularyFilter(CreateVocabularyFilterRequest createVocabularyFilterRequest); /** *

* Deletes a Call Analytics category. To use this operation, specify the name of the category you want to delete * using CategoryName. Category names are case sensitive. *

* * @param deleteCallAnalyticsCategoryRequest * @return Result of the DeleteCallAnalyticsCategory operation returned by the service. * @throws NotFoundException * We can't find the requested resource. Check that the specified name is correct and try your request * again. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @sample AmazonTranscribe.DeleteCallAnalyticsCategory * @see AWS API Documentation */ DeleteCallAnalyticsCategoryResult deleteCallAnalyticsCategory(DeleteCallAnalyticsCategoryRequest deleteCallAnalyticsCategoryRequest); /** *

* Deletes a Call Analytics job. To use this operation, specify the name of the job you want to delete using * CallAnalyticsJobName. Job names are case sensitive. *

* * @param deleteCallAnalyticsJobRequest * @return Result of the DeleteCallAnalyticsJob operation returned by the service. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @sample AmazonTranscribe.DeleteCallAnalyticsJob * @see AWS API Documentation */ DeleteCallAnalyticsJobResult deleteCallAnalyticsJob(DeleteCallAnalyticsJobRequest deleteCallAnalyticsJobRequest); /** *

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

* * @param deleteLanguageModelRequest * @return Result of the DeleteLanguageModel operation returned by the service. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @sample AmazonTranscribe.DeleteLanguageModel * @see AWS * API Documentation */ DeleteLanguageModelResult deleteLanguageModel(DeleteLanguageModelRequest deleteLanguageModelRequest); /** *

* Deletes a medical transcription job. To use this operation, specify the name of the job you want to delete using * MedicalTranscriptionJobName. Job names are case sensitive. *

* * @param deleteMedicalTranscriptionJobRequest * @return Result of the DeleteMedicalTranscriptionJob operation returned by the service. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @sample AmazonTranscribe.DeleteMedicalTranscriptionJob * @see AWS API Documentation */ DeleteMedicalTranscriptionJobResult deleteMedicalTranscriptionJob(DeleteMedicalTranscriptionJobRequest deleteMedicalTranscriptionJobRequest); /** *

* Deletes a custom medical vocabulary. To use this operation, specify the name of the custom vocabulary you want to * delete using VocabularyName. Custom vocabulary names are case sensitive. *

* * @param deleteMedicalVocabularyRequest * @return Result of the DeleteMedicalVocabulary operation returned by the service. * @throws NotFoundException * We can't find the requested resource. Check that the specified name is correct and try your request * again. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @sample AmazonTranscribe.DeleteMedicalVocabulary * @see AWS API Documentation */ DeleteMedicalVocabularyResult deleteMedicalVocabulary(DeleteMedicalVocabularyRequest deleteMedicalVocabularyRequest); /** *

* Deletes a transcription job. To use this operation, specify the name of the job you want to delete using * TranscriptionJobName. Job names are case sensitive. *

* * @param deleteTranscriptionJobRequest * @return Result of the DeleteTranscriptionJob operation returned by the service. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @sample AmazonTranscribe.DeleteTranscriptionJob * @see AWS API Documentation */ DeleteTranscriptionJobResult deleteTranscriptionJob(DeleteTranscriptionJobRequest deleteTranscriptionJobRequest); /** *

* Deletes a custom vocabulary. To use this operation, specify the name of the custom vocabulary you want to delete * using VocabularyName. Custom vocabulary names are case sensitive. *

* * @param deleteVocabularyRequest * @return Result of the DeleteVocabulary operation returned by the service. * @throws NotFoundException * We can't find the requested resource. Check that the specified name is correct and try your request * again. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @sample AmazonTranscribe.DeleteVocabulary * @see AWS * API Documentation */ DeleteVocabularyResult deleteVocabulary(DeleteVocabularyRequest deleteVocabularyRequest); /** *

* Deletes a custom vocabulary filter. To use this operation, specify the name of the custom vocabulary filter you * want to delete using VocabularyFilterName. Custom vocabulary filter names are case sensitive. *

* * @param deleteVocabularyFilterRequest * @return Result of the DeleteVocabularyFilter operation returned by the service. * @throws NotFoundException * We can't find the requested resource. Check that the specified name is correct and try your request * again. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @sample AmazonTranscribe.DeleteVocabularyFilter * @see AWS API Documentation */ DeleteVocabularyFilterResult deleteVocabularyFilter(DeleteVocabularyFilterRequest deleteVocabularyFilterRequest); /** *

* Provides information about the specified custom language model. *

*

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

*

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

* * @param describeLanguageModelRequest * @return Result of the DescribeLanguageModel operation returned by the service. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @throws NotFoundException * We can't find the requested resource. Check that the specified name is correct and try your request * again. * @sample AmazonTranscribe.DescribeLanguageModel * @see AWS API Documentation */ DescribeLanguageModelResult describeLanguageModel(DescribeLanguageModelRequest describeLanguageModelRequest); /** *

* Provides information about the specified Call Analytics category. *

*

* To get a list of your Call Analytics categories, use the operation. *

* * @param getCallAnalyticsCategoryRequest * @return Result of the GetCallAnalyticsCategory operation returned by the service. * @throws NotFoundException * We can't find the requested resource. Check that the specified name is correct and try your request * again. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @sample AmazonTranscribe.GetCallAnalyticsCategory * @see AWS API Documentation */ GetCallAnalyticsCategoryResult getCallAnalyticsCategory(GetCallAnalyticsCategoryRequest getCallAnalyticsCategoryRequest); /** *

* Provides information about the specified Call Analytics job. *

*

* To view the job's status, refer to CallAnalyticsJobStatus. If the status is COMPLETED, * the job is finished. You can find your completed transcript at the URI specified in * TranscriptFileUri. If the status is FAILED, FailureReason provides details * on why your transcription job failed. *

*

* If you enabled personally identifiable information (PII) redaction, the redacted transcript appears at the * location specified in RedactedTranscriptFileUri. *

*

* If you chose to redact the audio in your media file, you can find your redacted media file at the location * specified in RedactedMediaFileUri. *

*

* To get a list of your Call Analytics jobs, use the operation. *

* * @param getCallAnalyticsJobRequest * @return Result of the GetCallAnalyticsJob operation returned by the service. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @throws NotFoundException * We can't find the requested resource. Check that the specified name is correct and try your request * again. * @sample AmazonTranscribe.GetCallAnalyticsJob * @see AWS * API Documentation */ GetCallAnalyticsJobResult getCallAnalyticsJob(GetCallAnalyticsJobRequest getCallAnalyticsJobRequest); /** *

* Provides information about the specified medical transcription job. *

*

* To view the status of the specified medical transcription job, check the TranscriptionJobStatus * field. If the status is COMPLETED, the job is finished. You can find the results at the location * specified in TranscriptFileUri. If the status is FAILED, FailureReason * provides details on why your transcription job failed. *

*

* To get a list of your medical transcription jobs, use the operation. *

* * @param getMedicalTranscriptionJobRequest * @return Result of the GetMedicalTranscriptionJob operation returned by the service. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @throws NotFoundException * We can't find the requested resource. Check that the specified name is correct and try your request * again. * @sample AmazonTranscribe.GetMedicalTranscriptionJob * @see AWS API Documentation */ GetMedicalTranscriptionJobResult getMedicalTranscriptionJob(GetMedicalTranscriptionJobRequest getMedicalTranscriptionJobRequest); /** *

* Provides information about the specified custom medical vocabulary. *

*

* To view the status of the specified custom medical vocabulary, check the VocabularyState field. If * the status is READY, your custom vocabulary is available to use. If the status is * FAILED, FailureReason provides details on why your vocabulary failed. *

*

* To get a list of your custom medical vocabularies, use the operation. *

* * @param getMedicalVocabularyRequest * @return Result of the GetMedicalVocabulary operation returned by the service. * @throws NotFoundException * We can't find the requested resource. Check that the specified name is correct and try your request * again. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @sample AmazonTranscribe.GetMedicalVocabulary * @see AWS API Documentation */ GetMedicalVocabularyResult getMedicalVocabulary(GetMedicalVocabularyRequest getMedicalVocabularyRequest); /** *

* Provides information about the specified transcription job. *

*

* To view the status of the specified transcription job, check the TranscriptionJobStatus field. If * the status is COMPLETED, the job is finished. You can find the results at the location specified in * TranscriptFileUri. If the status is FAILED, FailureReason provides details * on why your transcription job failed. *

*

* If you enabled content redaction, the redacted transcript can be found at the location specified in * RedactedTranscriptFileUri. *

*

* To get a list of your transcription jobs, use the operation. *

* * @param getTranscriptionJobRequest * @return Result of the GetTranscriptionJob operation returned by the service. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @throws NotFoundException * We can't find the requested resource. Check that the specified name is correct and try your request * again. * @sample AmazonTranscribe.GetTranscriptionJob * @see AWS * API Documentation */ GetTranscriptionJobResult getTranscriptionJob(GetTranscriptionJobRequest getTranscriptionJobRequest); /** *

* Provides information about the specified custom vocabulary. *

*

* To view the status of the specified custom vocabulary, check the VocabularyState field. If the * status is READY, your custom vocabulary is available to use. If the status is FAILED, * FailureReason provides details on why your custom vocabulary failed. *

*

* To get a list of your custom vocabularies, use the operation. *

* * @param getVocabularyRequest * @return Result of the GetVocabulary operation returned by the service. * @throws NotFoundException * We can't find the requested resource. Check that the specified name is correct and try your request * again. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @sample AmazonTranscribe.GetVocabulary * @see AWS API * Documentation */ GetVocabularyResult getVocabulary(GetVocabularyRequest getVocabularyRequest); /** *

* Provides information about the specified custom vocabulary filter. *

*

* To get a list of your custom vocabulary filters, use the operation. *

* * @param getVocabularyFilterRequest * @return Result of the GetVocabularyFilter operation returned by the service. * @throws NotFoundException * We can't find the requested resource. Check that the specified name is correct and try your request * again. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @sample AmazonTranscribe.GetVocabularyFilter * @see AWS * API Documentation */ GetVocabularyFilterResult getVocabularyFilter(GetVocabularyFilterRequest getVocabularyFilterRequest); /** *

* Provides a list of Call Analytics categories, including all rules that make up each category. *

*

* To get detailed information about a specific Call Analytics category, use the operation. *

* * @param listCallAnalyticsCategoriesRequest * @return Result of the ListCallAnalyticsCategories operation returned by the service. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @sample AmazonTranscribe.ListCallAnalyticsCategories * @see AWS API Documentation */ ListCallAnalyticsCategoriesResult listCallAnalyticsCategories(ListCallAnalyticsCategoriesRequest listCallAnalyticsCategoriesRequest); /** *

* Provides a list of Call Analytics jobs that match the specified criteria. If no criteria are specified, all Call * Analytics jobs are returned. *

*

* To get detailed information about a specific Call Analytics job, use the operation. *

* * @param listCallAnalyticsJobsRequest * @return Result of the ListCallAnalyticsJobs operation returned by the service. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @sample AmazonTranscribe.ListCallAnalyticsJobs * @see AWS API Documentation */ ListCallAnalyticsJobsResult listCallAnalyticsJobs(ListCallAnalyticsJobsRequest listCallAnalyticsJobsRequest); /** *

* Provides a list of custom language models that match the specified criteria. If no criteria are specified, all * custom language models are returned. *

*

* To get detailed information about a specific custom language model, use the operation. *

* * @param listLanguageModelsRequest * @return Result of the ListLanguageModels operation returned by the service. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @sample AmazonTranscribe.ListLanguageModels * @see AWS * API Documentation */ ListLanguageModelsResult listLanguageModels(ListLanguageModelsRequest listLanguageModelsRequest); /** *

* Provides a list of medical transcription jobs that match the specified criteria. If no criteria are specified, * all medical transcription jobs are returned. *

*

* To get detailed information about a specific medical transcription job, use the operation. *

* * @param listMedicalTranscriptionJobsRequest * @return Result of the ListMedicalTranscriptionJobs operation returned by the service. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @sample AmazonTranscribe.ListMedicalTranscriptionJobs * @see AWS API Documentation */ ListMedicalTranscriptionJobsResult listMedicalTranscriptionJobs(ListMedicalTranscriptionJobsRequest listMedicalTranscriptionJobsRequest); /** *

* Provides a list of custom medical vocabularies that match the specified criteria. If no criteria are specified, * all custom medical vocabularies are returned. *

*

* To get detailed information about a specific custom medical vocabulary, use the operation. *

* * @param listMedicalVocabulariesRequest * @return Result of the ListMedicalVocabularies operation returned by the service. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @sample AmazonTranscribe.ListMedicalVocabularies * @see AWS API Documentation */ ListMedicalVocabulariesResult listMedicalVocabularies(ListMedicalVocabulariesRequest listMedicalVocabulariesRequest); /** *

* Lists all tags associated with the specified transcription job, vocabulary, model, or resource. *

*

* To learn more about using tags with Amazon Transcribe, refer to Tagging resources. *

* * @param listTagsForResourceRequest * @return Result of the ListTagsForResource operation returned by the service. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws NotFoundException * We can't find the requested resource. Check that the specified name is correct and try your request * again. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @sample AmazonTranscribe.ListTagsForResource * @see AWS * API Documentation */ ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest); /** *

* Provides a list of transcription jobs that match the specified criteria. If no criteria are specified, all * transcription jobs are returned. *

*

* To get detailed information about a specific transcription job, use the operation. *

* * @param listTranscriptionJobsRequest * @return Result of the ListTranscriptionJobs operation returned by the service. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @sample AmazonTranscribe.ListTranscriptionJobs * @see AWS API Documentation */ ListTranscriptionJobsResult listTranscriptionJobs(ListTranscriptionJobsRequest listTranscriptionJobsRequest); /** *

* Provides a list of custom vocabularies that match the specified criteria. If no criteria are specified, all * custom vocabularies are returned. *

*

* To get detailed information about a specific custom vocabulary, use the operation. *

* * @param listVocabulariesRequest * @return Result of the ListVocabularies operation returned by the service. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @sample AmazonTranscribe.ListVocabularies * @see AWS * API Documentation */ ListVocabulariesResult listVocabularies(ListVocabulariesRequest listVocabulariesRequest); /** *

* Provides a list of custom vocabulary filters that match the specified criteria. If no criteria are specified, all * custom vocabularies are returned. *

*

* To get detailed information about a specific custom vocabulary filter, use the operation. *

* * @param listVocabularyFiltersRequest * @return Result of the ListVocabularyFilters operation returned by the service. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @sample AmazonTranscribe.ListVocabularyFilters * @see AWS API Documentation */ ListVocabularyFiltersResult listVocabularyFilters(ListVocabularyFiltersRequest listVocabularyFiltersRequest); /** *

* Transcribes the audio from a customer service call and applies any additional Request Parameters you choose to * include in your request. *

*

* In addition to many standard transcription features, Call Analytics provides you with call characteristics, call * summarization, speaker sentiment, and optional redaction of your text transcript and your audio file. You can * also apply custom categories to flag specified conditions. To learn more about these features and insights, refer * to Analyzing call center audio * with Call Analytics. *

*

* If you want to apply categories to your Call Analytics job, you must create them before submitting your job * request. Categories cannot be retroactively applied to a job. To create a new category, use the operation. To * learn more about Call Analytics categories, see Creating categories for * post-call transcriptions and Creating categories for * real-time transcriptions. *

*

* To make a StartCallAnalyticsJob request, you must first upload your media file into an Amazon S3 * bucket; you can then specify the Amazon S3 location of the file using the Media parameter. *

*

* Note that job queuing is enabled by default for Call Analytics jobs. *

*

* You must include the following parameters in your StartCallAnalyticsJob request: *

* * *

* With Call Analytics, you can redact the audio contained in your media file by including * RedactedMediaFileUri, instead of MediaFileUri, to specify the location of your input * audio. If you choose to redact your audio, you can find your redacted media at the location specified in the * RedactedMediaFileUri field of your response. *

*
* * @param startCallAnalyticsJobRequest * @return Result of the StartCallAnalyticsJob operation returned by the service. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @throws ConflictException * A resource already exists with this name. Resource names must be unique within an Amazon Web Services * account. * @sample AmazonTranscribe.StartCallAnalyticsJob * @see AWS API Documentation */ StartCallAnalyticsJobResult startCallAnalyticsJob(StartCallAnalyticsJobRequest startCallAnalyticsJobRequest); /** *

* Transcribes the audio from a medical dictation or conversation and applies any additional Request Parameters you * choose to include in your request. *

*

* In addition to many standard transcription features, Amazon Transcribe Medical provides you with a robust medical * vocabulary and, optionally, content identification, which adds flags to personal health information (PHI). To * learn more about these features, refer to How Amazon Transcribe Medical * works. *

*

* To make a StartMedicalTranscriptionJob request, you must first upload your media file into an Amazon * S3 bucket; you can then specify the S3 location of the file using the Media parameter. *

*

* You must include the following parameters in your StartMedicalTranscriptionJob request: *

* * * @param startMedicalTranscriptionJobRequest * @return Result of the StartMedicalTranscriptionJob operation returned by the service. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @throws ConflictException * A resource already exists with this name. Resource names must be unique within an Amazon Web Services * account. * @sample AmazonTranscribe.StartMedicalTranscriptionJob * @see AWS API Documentation */ StartMedicalTranscriptionJobResult startMedicalTranscriptionJob(StartMedicalTranscriptionJobRequest startMedicalTranscriptionJobRequest); /** *

* Transcribes the audio from a media file and applies any additional Request Parameters you choose to include in * your request. *

*

* To make a StartTranscriptionJob request, you must first upload your media file into an Amazon S3 * bucket; you can then specify the Amazon S3 location of the file using the Media parameter. *

*

* You must include the following parameters in your StartTranscriptionJob request: *

* * * @param startTranscriptionJobRequest * @return Result of the StartTranscriptionJob operation returned by the service. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @throws ConflictException * A resource already exists with this name. Resource names must be unique within an Amazon Web Services * account. * @sample AmazonTranscribe.StartTranscriptionJob * @see AWS API Documentation */ StartTranscriptionJobResult startTranscriptionJob(StartTranscriptionJobRequest startTranscriptionJobRequest); /** *

* Adds one or more custom tags, each in the form of a key:value pair, to the specified resource. *

*

* To learn more about using tags with Amazon Transcribe, refer to Tagging resources. *

* * @param tagResourceRequest * @return Result of the TagResource operation returned by the service. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws ConflictException * A resource already exists with this name. Resource names must be unique within an Amazon Web Services * account. * @throws NotFoundException * We can't find the requested resource. Check that the specified name is correct and try your request * again. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @sample AmazonTranscribe.TagResource * @see AWS API * Documentation */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest); /** *

* Removes the specified tags from the specified Amazon Transcribe resource. *

*

* If you include UntagResource in your request, you must also include ResourceArn and * TagKeys. *

* * @param untagResourceRequest * @return Result of the UntagResource operation returned by the service. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws ConflictException * A resource already exists with this name. Resource names must be unique within an Amazon Web Services * account. * @throws NotFoundException * We can't find the requested resource. Check that the specified name is correct and try your request * again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @sample AmazonTranscribe.UntagResource * @see AWS API * Documentation */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest); /** *

* Updates the specified Call Analytics category with new rules. Note that the * UpdateCallAnalyticsCategory operation overwrites all existing rules contained in the specified * category. You cannot append additional rules onto an existing category. *

*

* To create a new category, see . *

* * @param updateCallAnalyticsCategoryRequest * @return Result of the UpdateCallAnalyticsCategory operation returned by the service. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @throws NotFoundException * We can't find the requested resource. Check that the specified name is correct and try your request * again. * @throws ConflictException * A resource already exists with this name. Resource names must be unique within an Amazon Web Services * account. * @sample AmazonTranscribe.UpdateCallAnalyticsCategory * @see AWS API Documentation */ UpdateCallAnalyticsCategoryResult updateCallAnalyticsCategory(UpdateCallAnalyticsCategoryRequest updateCallAnalyticsCategoryRequest); /** *

* Updates an existing custom medical vocabulary with new values. This operation overwrites all existing information * with your new values; you cannot append new terms onto an existing custom vocabulary. *

* * @param updateMedicalVocabularyRequest * @return Result of the UpdateMedicalVocabulary operation returned by the service. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @throws NotFoundException * We can't find the requested resource. Check that the specified name is correct and try your request * again. * @throws ConflictException * A resource already exists with this name. Resource names must be unique within an Amazon Web Services * account. * @sample AmazonTranscribe.UpdateMedicalVocabulary * @see AWS API Documentation */ UpdateMedicalVocabularyResult updateMedicalVocabulary(UpdateMedicalVocabularyRequest updateMedicalVocabularyRequest); /** *

* Updates an existing custom vocabulary with new values. This operation overwrites all existing information with * your new values; you cannot append new terms onto an existing custom vocabulary. *

* * @param updateVocabularyRequest * @return Result of the UpdateVocabulary operation returned by the service. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @throws NotFoundException * We can't find the requested resource. Check that the specified name is correct and try your request * again. * @throws ConflictException * A resource already exists with this name. Resource names must be unique within an Amazon Web Services * account. * @sample AmazonTranscribe.UpdateVocabulary * @see AWS * API Documentation */ UpdateVocabularyResult updateVocabulary(UpdateVocabularyRequest updateVocabularyRequest); /** *

* Updates an existing custom vocabulary filter with a new list of words. The new list you provide overwrites all * previous entries; you cannot append new terms onto an existing custom vocabulary filter. *

* * @param updateVocabularyFilterRequest * @return Result of the UpdateVocabularyFilter operation returned by the service. * @throws BadRequestException * Your request didn't pass one or more validation tests. This can occur when the entity you're trying to * delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the * exception message field for more information. * @throws LimitExceededException * You've either sent too many requests or your input file is too long. Wait before retrying your request, * or use a smaller file and try your request again. * @throws InternalFailureException * There was an internal error. Check the error message, correct the issue, and try your request again. * @throws NotFoundException * We can't find the requested resource. Check that the specified name is correct and try your request * again. * @sample AmazonTranscribe.UpdateVocabularyFilter * @see AWS API Documentation */ UpdateVocabularyFilterResult updateVocabularyFilter(UpdateVocabularyFilterRequest updateVocabularyFilterRequest); /** * 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. */ void shutdown(); /** * 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. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }