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

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

* **/ public interface AmazonTranscribe { /** * Overrides the default endpoint for this client * ("https://transcribe.us-east-1.amazonaws.com"). Callers can use this * method to control which AWS region they want to work with. *

* Callers can pass in just the endpoint (ex: * "transcribe.us-east-1.amazonaws.com") or a full URL, including the * protocol (ex: "https://transcribe.us-east-1.amazonaws.com"). If the * protocol is not specified here, the default protocol from this client's * {@link ClientConfiguration} will be used, which by default is HTTPS. *

* For more information on using AWS regions with the AWS SDK for Java, and * a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= * 3912 *

* This method is not threadsafe. An endpoint should be configured when * the client is created and before any service requests are made. Changing * it afterwards creates inevitable race conditions for any service requests * in transit or retrying. * * @param endpoint The endpoint (ex: "transcribe.us-east-1.amazonaws.com") * or a full URL, including the protocol (ex: * "https://transcribe.us-east-1.amazonaws.com") of the region * specific AWS endpoint this client will communicate with. * @throws IllegalArgumentException If any problems are detected with the * specified endpoint. */ public void setEndpoint(String endpoint) throws java.lang.IllegalArgumentException; /** * An alternative to {@link AmazonTranscribe#setEndpoint(String)}, sets the * regional endpoint for this client's service calls. Callers can use this * method to control which AWS region they want to work with. *

* By default, all service endpoints in all regions use the https protocol. * To use http instead, specify it in the {@link ClientConfiguration} * supplied at construction. *

* This method is not threadsafe. A region should be configured when the * client is created and before any service requests are made. Changing it * afterwards creates inevitable race conditions for any service requests in * transit or retrying. * * @param region The region this client will communicate with. See * {@link Region#getRegion(com.amazonaws.regions.Regions)} for * accessing a given region. * @throws java.lang.IllegalArgumentException If the given region is null, * or if this service isn't available in the given region. See * {@link Region#isServiceSupported(String)} * @see Region#getRegion(com.amazonaws.regions.Regions) * @see Region#createClient(Class, * com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration) */ public void setRegion(Region region) throws java.lang.IllegalArgumentException; /** *

* 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 createCallAnalyticsCategoryResult The response from the * CreateCallAnalyticsCategory service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws ConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ CreateCallAnalyticsCategoryResult createCallAnalyticsCategory( CreateCallAnalyticsCategoryRequest createCallAnalyticsCategoryRequest) throws AmazonClientException, AmazonServiceException; /** *

* Creates a new custom language model. *

*

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

* * * @param createLanguageModelRequest * @return createLanguageModelResult The response from the * CreateLanguageModel service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws ConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ CreateLanguageModelResult createLanguageModel( CreateLanguageModelRequest createLanguageModelRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 createMedicalVocabularyResult The response from the * CreateMedicalVocabulary service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws ConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ CreateMedicalVocabularyResult createMedicalVocabulary( CreateMedicalVocabularyRequest createMedicalVocabularyRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 createVocabularyResult The response from the CreateVocabulary * service method, as returned by Amazon Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws ConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ CreateVocabularyResult createVocabulary(CreateVocabularyRequest createVocabularyRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 createVocabularyFilterResult The response from the * CreateVocabularyFilter service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws ConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ CreateVocabularyFilterResult createVocabularyFilter( CreateVocabularyFilterRequest createVocabularyFilterRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 deleteCallAnalyticsCategoryResult The response from the * DeleteCallAnalyticsCategory service method, as returned by Amazon * Transcribe. * @throws NotFoundException * @throws LimitExceededException * @throws BadRequestException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ DeleteCallAnalyticsCategoryResult deleteCallAnalyticsCategory( DeleteCallAnalyticsCategoryRequest deleteCallAnalyticsCategoryRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 deleteCallAnalyticsJobResult The response from the * DeleteCallAnalyticsJob service method, as returned by Amazon * Transcribe. * @throws LimitExceededException * @throws BadRequestException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ DeleteCallAnalyticsJobResult deleteCallAnalyticsJob( DeleteCallAnalyticsJobRequest deleteCallAnalyticsJobRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ void deleteLanguageModel(DeleteLanguageModelRequest deleteLanguageModelRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 * @throws LimitExceededException * @throws BadRequestException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ void deleteMedicalTranscriptionJob( DeleteMedicalTranscriptionJobRequest deleteMedicalTranscriptionJobRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 * @throws NotFoundException * @throws LimitExceededException * @throws BadRequestException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ void deleteMedicalVocabulary(DeleteMedicalVocabularyRequest deleteMedicalVocabularyRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 * @throws LimitExceededException * @throws BadRequestException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ void deleteTranscriptionJob(DeleteTranscriptionJobRequest deleteTranscriptionJobRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 * @throws NotFoundException * @throws LimitExceededException * @throws BadRequestException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ void deleteVocabulary(DeleteVocabularyRequest deleteVocabularyRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 * @throws NotFoundException * @throws LimitExceededException * @throws BadRequestException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ void deleteVocabularyFilter(DeleteVocabularyFilterRequest deleteVocabularyFilterRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 describeLanguageModelResult The response from the * DescribeLanguageModel service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws NotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ DescribeLanguageModelResult describeLanguageModel( DescribeLanguageModelRequest describeLanguageModelRequest) throws AmazonClientException, AmazonServiceException; /** *

* Provides information about the specified Call Analytics category. *

*

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

* * @param getCallAnalyticsCategoryRequest * @return getCallAnalyticsCategoryResult The response from the * GetCallAnalyticsCategory service method, as returned by Amazon * Transcribe. * @throws NotFoundException * @throws LimitExceededException * @throws InternalFailureException * @throws BadRequestException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ GetCallAnalyticsCategoryResult getCallAnalyticsCategory( GetCallAnalyticsCategoryRequest getCallAnalyticsCategoryRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 getCallAnalyticsJobResult The response from the * GetCallAnalyticsJob service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws NotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ GetCallAnalyticsJobResult getCallAnalyticsJob( GetCallAnalyticsJobRequest getCallAnalyticsJobRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 getMedicalTranscriptionJobResult The response from the * GetMedicalTranscriptionJob service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws NotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ GetMedicalTranscriptionJobResult getMedicalTranscriptionJob( GetMedicalTranscriptionJobRequest getMedicalTranscriptionJobRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 getMedicalVocabularyResult The response from the * GetMedicalVocabulary service method, as returned by Amazon * Transcribe. * @throws NotFoundException * @throws LimitExceededException * @throws InternalFailureException * @throws BadRequestException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ GetMedicalVocabularyResult getMedicalVocabulary( GetMedicalVocabularyRequest getMedicalVocabularyRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 getTranscriptionJobResult The response from the * GetTranscriptionJob service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws NotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ GetTranscriptionJobResult getTranscriptionJob( GetTranscriptionJobRequest getTranscriptionJobRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 getVocabularyResult The response from the GetVocabulary service * method, as returned by Amazon Transcribe. * @throws NotFoundException * @throws LimitExceededException * @throws InternalFailureException * @throws BadRequestException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ GetVocabularyResult getVocabulary(GetVocabularyRequest getVocabularyRequest) throws AmazonClientException, AmazonServiceException; /** *

* Provides information about the specified custom vocabulary filter. *

*

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

* * @param getVocabularyFilterRequest * @return getVocabularyFilterResult The response from the * GetVocabularyFilter service method, as returned by Amazon * Transcribe. * @throws NotFoundException * @throws LimitExceededException * @throws InternalFailureException * @throws BadRequestException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ GetVocabularyFilterResult getVocabularyFilter( GetVocabularyFilterRequest getVocabularyFilterRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 listCallAnalyticsCategoriesResult The response from the * ListCallAnalyticsCategories service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ ListCallAnalyticsCategoriesResult listCallAnalyticsCategories( ListCallAnalyticsCategoriesRequest listCallAnalyticsCategoriesRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 listCallAnalyticsJobsResult The response from the * ListCallAnalyticsJobs service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ ListCallAnalyticsJobsResult listCallAnalyticsJobs( ListCallAnalyticsJobsRequest listCallAnalyticsJobsRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 listLanguageModelsResult The response from the ListLanguageModels * service method, as returned by Amazon Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ ListLanguageModelsResult listLanguageModels(ListLanguageModelsRequest listLanguageModelsRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 listMedicalTranscriptionJobsResult The response from the * ListMedicalTranscriptionJobs service method, as returned by * Amazon Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ ListMedicalTranscriptionJobsResult listMedicalTranscriptionJobs( ListMedicalTranscriptionJobsRequest listMedicalTranscriptionJobsRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 listMedicalVocabulariesResult The response from the * ListMedicalVocabularies service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ ListMedicalVocabulariesResult listMedicalVocabularies( ListMedicalVocabulariesRequest listMedicalVocabulariesRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 listTagsForResourceResult The response from the * ListTagsForResource service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws NotFoundException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ ListTagsForResourceResult listTagsForResource( ListTagsForResourceRequest listTagsForResourceRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 listTranscriptionJobsResult The response from the * ListTranscriptionJobs service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ ListTranscriptionJobsResult listTranscriptionJobs( ListTranscriptionJobsRequest listTranscriptionJobsRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 listVocabulariesResult The response from the ListVocabularies * service method, as returned by Amazon Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ ListVocabulariesResult listVocabularies(ListVocabulariesRequest listVocabulariesRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 listVocabularyFiltersResult The response from the * ListVocabularyFilters service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ ListVocabularyFiltersResult listVocabularyFilters( ListVocabularyFiltersRequest listVocabularyFiltersRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 startCallAnalyticsJobResult The response from the * StartCallAnalyticsJob service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws ConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ StartCallAnalyticsJobResult startCallAnalyticsJob( StartCallAnalyticsJobRequest startCallAnalyticsJobRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 startMedicalTranscriptionJobResult The response from the * StartMedicalTranscriptionJob service method, as returned by * Amazon Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws ConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ StartMedicalTranscriptionJobResult startMedicalTranscriptionJob( StartMedicalTranscriptionJobRequest startMedicalTranscriptionJobRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 startTranscriptionJobResult The response from the * StartTranscriptionJob service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws ConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ StartTranscriptionJobResult startTranscriptionJob( StartTranscriptionJobRequest startTranscriptionJobRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 tagResourceResult The response from the TagResource service * method, as returned by Amazon Transcribe. * @throws BadRequestException * @throws ConflictException * @throws NotFoundException * @throws LimitExceededException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 untagResourceResult The response from the UntagResource service * method, as returned by Amazon Transcribe. * @throws LimitExceededException * @throws BadRequestException * @throws ConflictException * @throws NotFoundException * @throws InternalFailureException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 updateCallAnalyticsCategoryResult The response from the * UpdateCallAnalyticsCategory service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws NotFoundException * @throws ConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ UpdateCallAnalyticsCategoryResult updateCallAnalyticsCategory( UpdateCallAnalyticsCategoryRequest updateCallAnalyticsCategoryRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 updateMedicalVocabularyResult The response from the * UpdateMedicalVocabulary service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws NotFoundException * @throws ConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ UpdateMedicalVocabularyResult updateMedicalVocabulary( UpdateMedicalVocabularyRequest updateMedicalVocabularyRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 updateVocabularyResult The response from the UpdateVocabulary * service method, as returned by Amazon Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws NotFoundException * @throws ConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ UpdateVocabularyResult updateVocabulary(UpdateVocabularyRequest updateVocabularyRequest) throws AmazonClientException, AmazonServiceException; /** *

* 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 updateVocabularyFilterResult The response from the * UpdateVocabularyFilter service method, as returned by Amazon * Transcribe. * @throws BadRequestException * @throws LimitExceededException * @throws InternalFailureException * @throws NotFoundException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Transcribe indicating either a problem with the data in the * request, or a server side issue. */ UpdateVocabularyFilterResult updateVocabularyFilter( UpdateVocabularyFilterRequest updateVocabularyFilterRequest) throws AmazonClientException, AmazonServiceException; /** * 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. */ public 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. */ public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }