/*
* Copyright 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.
*/
/*
* Do not modify this file. This file is generated from the transcribe-2017-10-26.normal.json service model.
*/
using System;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.TranscribeService.Model;
namespace Amazon.TranscribeService
{
///
/// Interface for accessing TranscribeService
///
/// Amazon Transcribe offers three main types of batch transcription: Standard,
/// Medical, and Call Analytics.
///
/// -
///
/// Standard transcriptions are the most common option. Refer to for details.
///
///
-
///
/// Medical transcriptions are tailored to medical professionals and incorporate
/// medical terms. A common use case for this service is transcribing doctor-patient dialogue
/// into after-visit notes. Refer to for details.
///
///
-
///
/// Call Analytics transcriptions are designed for use with call center audio
/// on two different channels; if you're looking for insight into customer service calls,
/// use this option. Refer to for details.
///
///
///
public partial interface IAmazonTranscribeService : IAmazonService, IDisposable
{
#if BCL45 || AWS_ASYNC_ENUMERABLES_API
///
/// Paginators for the service
///
ITranscribeServicePaginatorFactory Paginators { get; }
#endif
#region CreateCallAnalyticsCategory
///
/// 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.
///
///
/// Container for the necessary parameters to execute the CreateCallAnalyticsCategory service method.
///
/// The response from the CreateCallAnalyticsCategory service method, as returned by TranscribeService.
///
/// 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.
///
///
/// A resource already exists with this name. Resource names must be unique within an
/// Amazon Web Services account.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
/// REST API Reference for CreateCallAnalyticsCategory Operation
CreateCallAnalyticsCategoryResponse CreateCallAnalyticsCategory(CreateCallAnalyticsCategoryRequest request);
///
/// Initiates the asynchronous execution of the CreateCallAnalyticsCategory operation.
///
///
/// Container for the necessary parameters to execute the CreateCallAnalyticsCategory operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateCallAnalyticsCategory
/// operation.
/// REST API Reference for CreateCallAnalyticsCategory Operation
IAsyncResult BeginCreateCallAnalyticsCategory(CreateCallAnalyticsCategoryRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the CreateCallAnalyticsCategory operation.
///
///
/// The IAsyncResult returned by the call to BeginCreateCallAnalyticsCategory.
///
/// Returns a CreateCallAnalyticsCategoryResult from TranscribeService.
/// REST API Reference for CreateCallAnalyticsCategory Operation
CreateCallAnalyticsCategoryResponse EndCreateCallAnalyticsCategory(IAsyncResult asyncResult);
#endregion
#region CreateLanguageModel
///
/// Creates a new custom language model.
///
///
///
/// When creating a new custom language model, you must specify:
///
/// -
///
/// If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband (audio sample
/// rates under 16,000 Hz) base model
///
///
-
///
/// The location of your training and tuning files (this must be an Amazon S3 URI)
///
///
-
///
/// The language of your model
///
///
-
///
/// A unique name for your model
///
///
///
/// Container for the necessary parameters to execute the CreateLanguageModel service method.
///
/// The response from the CreateLanguageModel service method, as returned by TranscribeService.
///
/// 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.
///
///
/// A resource already exists with this name. Resource names must be unique within an
/// Amazon Web Services account.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
/// REST API Reference for CreateLanguageModel Operation
CreateLanguageModelResponse CreateLanguageModel(CreateLanguageModelRequest request);
///
/// Initiates the asynchronous execution of the CreateLanguageModel operation.
///
///
/// Container for the necessary parameters to execute the CreateLanguageModel operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateLanguageModel
/// operation.
/// REST API Reference for CreateLanguageModel Operation
IAsyncResult BeginCreateLanguageModel(CreateLanguageModelRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the CreateLanguageModel operation.
///
///
/// The IAsyncResult returned by the call to BeginCreateLanguageModel.
///
/// Returns a CreateLanguageModelResult from TranscribeService.
/// REST API Reference for CreateLanguageModel Operation
CreateLanguageModelResponse EndCreateLanguageModel(IAsyncResult asyncResult);
#endregion
#region CreateMedicalVocabulary
///
/// 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.
///
///
/// Container for the necessary parameters to execute the CreateMedicalVocabulary service method.
///
/// The response from the CreateMedicalVocabulary service method, as returned by TranscribeService.
///
/// 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.
///
///
/// A resource already exists with this name. Resource names must be unique within an
/// Amazon Web Services account.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
/// REST API Reference for CreateMedicalVocabulary Operation
CreateMedicalVocabularyResponse CreateMedicalVocabulary(CreateMedicalVocabularyRequest request);
///
/// Initiates the asynchronous execution of the CreateMedicalVocabulary operation.
///
///
/// Container for the necessary parameters to execute the CreateMedicalVocabulary operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateMedicalVocabulary
/// operation.
/// REST API Reference for CreateMedicalVocabulary Operation
IAsyncResult BeginCreateMedicalVocabulary(CreateMedicalVocabularyRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the CreateMedicalVocabulary operation.
///
///
/// The IAsyncResult returned by the call to BeginCreateMedicalVocabulary.
///
/// Returns a CreateMedicalVocabularyResult from TranscribeService.
/// REST API Reference for CreateMedicalVocabulary Operation
CreateMedicalVocabularyResponse EndCreateMedicalVocabulary(IAsyncResult asyncResult);
#endregion
#region CreateVocabulary
///
/// 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.
///
///
/// Container for the necessary parameters to execute the CreateVocabulary service method.
///
/// The response from the CreateVocabulary service method, as returned by TranscribeService.
///
/// 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.
///
///
/// A resource already exists with this name. Resource names must be unique within an
/// Amazon Web Services account.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
/// REST API Reference for CreateVocabulary Operation
CreateVocabularyResponse CreateVocabulary(CreateVocabularyRequest request);
///
/// Initiates the asynchronous execution of the CreateVocabulary operation.
///
///
/// Container for the necessary parameters to execute the CreateVocabulary operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateVocabulary
/// operation.
/// REST API Reference for CreateVocabulary Operation
IAsyncResult BeginCreateVocabulary(CreateVocabularyRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the CreateVocabulary operation.
///
///
/// The IAsyncResult returned by the call to BeginCreateVocabulary.
///
/// Returns a CreateVocabularyResult from TranscribeService.
/// REST API Reference for CreateVocabulary Operation
CreateVocabularyResponse EndCreateVocabulary(IAsyncResult asyncResult);
#endregion
#region CreateVocabularyFilter
///
/// 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.
///
///
/// Container for the necessary parameters to execute the CreateVocabularyFilter service method.
///
/// The response from the CreateVocabularyFilter service method, as returned by TranscribeService.
///
/// 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.
///
///
/// A resource already exists with this name. Resource names must be unique within an
/// Amazon Web Services account.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
/// REST API Reference for CreateVocabularyFilter Operation
CreateVocabularyFilterResponse CreateVocabularyFilter(CreateVocabularyFilterRequest request);
///
/// Initiates the asynchronous execution of the CreateVocabularyFilter operation.
///
///
/// Container for the necessary parameters to execute the CreateVocabularyFilter operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateVocabularyFilter
/// operation.
/// REST API Reference for CreateVocabularyFilter Operation
IAsyncResult BeginCreateVocabularyFilter(CreateVocabularyFilterRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the CreateVocabularyFilter operation.
///
///
/// The IAsyncResult returned by the call to BeginCreateVocabularyFilter.
///
/// Returns a CreateVocabularyFilterResult from TranscribeService.
/// REST API Reference for CreateVocabularyFilter Operation
CreateVocabularyFilterResponse EndCreateVocabularyFilter(IAsyncResult asyncResult);
#endregion
#region DeleteCallAnalyticsCategory
///
/// 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.
///
/// Container for the necessary parameters to execute the DeleteCallAnalyticsCategory service method.
///
/// The response from the DeleteCallAnalyticsCategory service method, as returned by TranscribeService.
///
/// 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.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
///
/// We can't find the requested resource. Check that the specified name is correct and
/// try your request again.
///
/// REST API Reference for DeleteCallAnalyticsCategory Operation
DeleteCallAnalyticsCategoryResponse DeleteCallAnalyticsCategory(DeleteCallAnalyticsCategoryRequest request);
///
/// Initiates the asynchronous execution of the DeleteCallAnalyticsCategory operation.
///
///
/// Container for the necessary parameters to execute the DeleteCallAnalyticsCategory operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteCallAnalyticsCategory
/// operation.
/// REST API Reference for DeleteCallAnalyticsCategory Operation
IAsyncResult BeginDeleteCallAnalyticsCategory(DeleteCallAnalyticsCategoryRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DeleteCallAnalyticsCategory operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteCallAnalyticsCategory.
///
/// Returns a DeleteCallAnalyticsCategoryResult from TranscribeService.
/// REST API Reference for DeleteCallAnalyticsCategory Operation
DeleteCallAnalyticsCategoryResponse EndDeleteCallAnalyticsCategory(IAsyncResult asyncResult);
#endregion
#region DeleteCallAnalyticsJob
///
/// 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.
///
/// Container for the necessary parameters to execute the DeleteCallAnalyticsJob service method.
///
/// The response from the DeleteCallAnalyticsJob service method, as returned by TranscribeService.
///
/// 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.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
/// REST API Reference for DeleteCallAnalyticsJob Operation
DeleteCallAnalyticsJobResponse DeleteCallAnalyticsJob(DeleteCallAnalyticsJobRequest request);
///
/// Initiates the asynchronous execution of the DeleteCallAnalyticsJob operation.
///
///
/// Container for the necessary parameters to execute the DeleteCallAnalyticsJob operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteCallAnalyticsJob
/// operation.
/// REST API Reference for DeleteCallAnalyticsJob Operation
IAsyncResult BeginDeleteCallAnalyticsJob(DeleteCallAnalyticsJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DeleteCallAnalyticsJob operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteCallAnalyticsJob.
///
/// Returns a DeleteCallAnalyticsJobResult from TranscribeService.
/// REST API Reference for DeleteCallAnalyticsJob Operation
DeleteCallAnalyticsJobResponse EndDeleteCallAnalyticsJob(IAsyncResult asyncResult);
#endregion
#region DeleteLanguageModel
///
/// 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.
///
/// Container for the necessary parameters to execute the DeleteLanguageModel service method.
///
/// The response from the DeleteLanguageModel service method, as returned by TranscribeService.
///
/// 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.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
/// REST API Reference for DeleteLanguageModel Operation
DeleteLanguageModelResponse DeleteLanguageModel(DeleteLanguageModelRequest request);
///
/// Initiates the asynchronous execution of the DeleteLanguageModel operation.
///
///
/// Container for the necessary parameters to execute the DeleteLanguageModel operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteLanguageModel
/// operation.
/// REST API Reference for DeleteLanguageModel Operation
IAsyncResult BeginDeleteLanguageModel(DeleteLanguageModelRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DeleteLanguageModel operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteLanguageModel.
///
/// Returns a DeleteLanguageModelResult from TranscribeService.
/// REST API Reference for DeleteLanguageModel Operation
DeleteLanguageModelResponse EndDeleteLanguageModel(IAsyncResult asyncResult);
#endregion
#region DeleteMedicalTranscriptionJob
///
/// 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.
///
/// Container for the necessary parameters to execute the DeleteMedicalTranscriptionJob service method.
///
/// The response from the DeleteMedicalTranscriptionJob service method, as returned by TranscribeService.
///
/// 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.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
/// REST API Reference for DeleteMedicalTranscriptionJob Operation
DeleteMedicalTranscriptionJobResponse DeleteMedicalTranscriptionJob(DeleteMedicalTranscriptionJobRequest request);
///
/// Initiates the asynchronous execution of the DeleteMedicalTranscriptionJob operation.
///
///
/// Container for the necessary parameters to execute the DeleteMedicalTranscriptionJob operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteMedicalTranscriptionJob
/// operation.
/// REST API Reference for DeleteMedicalTranscriptionJob Operation
IAsyncResult BeginDeleteMedicalTranscriptionJob(DeleteMedicalTranscriptionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DeleteMedicalTranscriptionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteMedicalTranscriptionJob.
///
/// Returns a DeleteMedicalTranscriptionJobResult from TranscribeService.
/// REST API Reference for DeleteMedicalTranscriptionJob Operation
DeleteMedicalTranscriptionJobResponse EndDeleteMedicalTranscriptionJob(IAsyncResult asyncResult);
#endregion
#region DeleteMedicalVocabulary
///
/// 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.
///
/// Container for the necessary parameters to execute the DeleteMedicalVocabulary service method.
///
/// The response from the DeleteMedicalVocabulary service method, as returned by TranscribeService.
///
/// 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.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
///
/// We can't find the requested resource. Check that the specified name is correct and
/// try your request again.
///
/// REST API Reference for DeleteMedicalVocabulary Operation
DeleteMedicalVocabularyResponse DeleteMedicalVocabulary(DeleteMedicalVocabularyRequest request);
///
/// Initiates the asynchronous execution of the DeleteMedicalVocabulary operation.
///
///
/// Container for the necessary parameters to execute the DeleteMedicalVocabulary operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteMedicalVocabulary
/// operation.
/// REST API Reference for DeleteMedicalVocabulary Operation
IAsyncResult BeginDeleteMedicalVocabulary(DeleteMedicalVocabularyRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DeleteMedicalVocabulary operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteMedicalVocabulary.
///
/// Returns a DeleteMedicalVocabularyResult from TranscribeService.
/// REST API Reference for DeleteMedicalVocabulary Operation
DeleteMedicalVocabularyResponse EndDeleteMedicalVocabulary(IAsyncResult asyncResult);
#endregion
#region DeleteTranscriptionJob
///
/// 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.
///
/// Container for the necessary parameters to execute the DeleteTranscriptionJob service method.
///
/// The response from the DeleteTranscriptionJob service method, as returned by TranscribeService.
///
/// 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.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
/// REST API Reference for DeleteTranscriptionJob Operation
DeleteTranscriptionJobResponse DeleteTranscriptionJob(DeleteTranscriptionJobRequest request);
///
/// Initiates the asynchronous execution of the DeleteTranscriptionJob operation.
///
///
/// Container for the necessary parameters to execute the DeleteTranscriptionJob operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteTranscriptionJob
/// operation.
/// REST API Reference for DeleteTranscriptionJob Operation
IAsyncResult BeginDeleteTranscriptionJob(DeleteTranscriptionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DeleteTranscriptionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteTranscriptionJob.
///
/// Returns a DeleteTranscriptionJobResult from TranscribeService.
/// REST API Reference for DeleteTranscriptionJob Operation
DeleteTranscriptionJobResponse EndDeleteTranscriptionJob(IAsyncResult asyncResult);
#endregion
#region DeleteVocabulary
///
/// 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.
///
/// Container for the necessary parameters to execute the DeleteVocabulary service method.
///
/// The response from the DeleteVocabulary service method, as returned by TranscribeService.
///
/// 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.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
///
/// We can't find the requested resource. Check that the specified name is correct and
/// try your request again.
///
/// REST API Reference for DeleteVocabulary Operation
DeleteVocabularyResponse DeleteVocabulary(DeleteVocabularyRequest request);
///
/// Initiates the asynchronous execution of the DeleteVocabulary operation.
///
///
/// Container for the necessary parameters to execute the DeleteVocabulary operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteVocabulary
/// operation.
/// REST API Reference for DeleteVocabulary Operation
IAsyncResult BeginDeleteVocabulary(DeleteVocabularyRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DeleteVocabulary operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteVocabulary.
///
/// Returns a DeleteVocabularyResult from TranscribeService.
/// REST API Reference for DeleteVocabulary Operation
DeleteVocabularyResponse EndDeleteVocabulary(IAsyncResult asyncResult);
#endregion
#region DeleteVocabularyFilter
///
/// 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.
///
/// Container for the necessary parameters to execute the DeleteVocabularyFilter service method.
///
/// The response from the DeleteVocabularyFilter service method, as returned by TranscribeService.
///
/// 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.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
///
/// We can't find the requested resource. Check that the specified name is correct and
/// try your request again.
///
/// REST API Reference for DeleteVocabularyFilter Operation
DeleteVocabularyFilterResponse DeleteVocabularyFilter(DeleteVocabularyFilterRequest request);
///
/// Initiates the asynchronous execution of the DeleteVocabularyFilter operation.
///
///
/// Container for the necessary parameters to execute the DeleteVocabularyFilter operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteVocabularyFilter
/// operation.
/// REST API Reference for DeleteVocabularyFilter Operation
IAsyncResult BeginDeleteVocabularyFilter(DeleteVocabularyFilterRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DeleteVocabularyFilter operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteVocabularyFilter.
///
/// Returns a DeleteVocabularyFilterResult from TranscribeService.
/// REST API Reference for DeleteVocabularyFilter Operation
DeleteVocabularyFilterResponse EndDeleteVocabularyFilter(IAsyncResult asyncResult);
#endregion
#region DescribeLanguageModel
///
/// 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.
///
///
/// Container for the necessary parameters to execute the DescribeLanguageModel service method.
///
/// The response from the DescribeLanguageModel service method, as returned by TranscribeService.
///
/// 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.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
///
/// We can't find the requested resource. Check that the specified name is correct and
/// try your request again.
///
/// REST API Reference for DescribeLanguageModel Operation
DescribeLanguageModelResponse DescribeLanguageModel(DescribeLanguageModelRequest request);
///
/// Initiates the asynchronous execution of the DescribeLanguageModel operation.
///
///
/// Container for the necessary parameters to execute the DescribeLanguageModel operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeLanguageModel
/// operation.
/// REST API Reference for DescribeLanguageModel Operation
IAsyncResult BeginDescribeLanguageModel(DescribeLanguageModelRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DescribeLanguageModel operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeLanguageModel.
///
/// Returns a DescribeLanguageModelResult from TranscribeService.
/// REST API Reference for DescribeLanguageModel Operation
DescribeLanguageModelResponse EndDescribeLanguageModel(IAsyncResult asyncResult);
#endregion
#region GetCallAnalyticsCategory
///
/// Provides information about the specified Call Analytics category.
///
///
///
/// To get a list of your Call Analytics categories, use the operation.
///
///
/// Container for the necessary parameters to execute the GetCallAnalyticsCategory service method.
///
/// The response from the GetCallAnalyticsCategory service method, as returned by TranscribeService.
///
/// 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.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
///
/// We can't find the requested resource. Check that the specified name is correct and
/// try your request again.
///
/// REST API Reference for GetCallAnalyticsCategory Operation
GetCallAnalyticsCategoryResponse GetCallAnalyticsCategory(GetCallAnalyticsCategoryRequest request);
///
/// Initiates the asynchronous execution of the GetCallAnalyticsCategory operation.
///
///
/// Container for the necessary parameters to execute the GetCallAnalyticsCategory operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetCallAnalyticsCategory
/// operation.
/// REST API Reference for GetCallAnalyticsCategory Operation
IAsyncResult BeginGetCallAnalyticsCategory(GetCallAnalyticsCategoryRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the GetCallAnalyticsCategory operation.
///
///
/// The IAsyncResult returned by the call to BeginGetCallAnalyticsCategory.
///
/// Returns a GetCallAnalyticsCategoryResult from TranscribeService.
/// REST API Reference for GetCallAnalyticsCategory Operation
GetCallAnalyticsCategoryResponse EndGetCallAnalyticsCategory(IAsyncResult asyncResult);
#endregion
#region GetCallAnalyticsJob
///
/// 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.
///
///
/// Container for the necessary parameters to execute the GetCallAnalyticsJob service method.
///
/// The response from the GetCallAnalyticsJob service method, as returned by TranscribeService.
///
/// 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.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
///
/// We can't find the requested resource. Check that the specified name is correct and
/// try your request again.
///
/// REST API Reference for GetCallAnalyticsJob Operation
GetCallAnalyticsJobResponse GetCallAnalyticsJob(GetCallAnalyticsJobRequest request);
///
/// Initiates the asynchronous execution of the GetCallAnalyticsJob operation.
///
///
/// Container for the necessary parameters to execute the GetCallAnalyticsJob operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetCallAnalyticsJob
/// operation.
/// REST API Reference for GetCallAnalyticsJob Operation
IAsyncResult BeginGetCallAnalyticsJob(GetCallAnalyticsJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the GetCallAnalyticsJob operation.
///
///
/// The IAsyncResult returned by the call to BeginGetCallAnalyticsJob.
///
/// Returns a GetCallAnalyticsJobResult from TranscribeService.
/// REST API Reference for GetCallAnalyticsJob Operation
GetCallAnalyticsJobResponse EndGetCallAnalyticsJob(IAsyncResult asyncResult);
#endregion
#region GetMedicalTranscriptionJob
///
/// 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.
///
///
/// Container for the necessary parameters to execute the GetMedicalTranscriptionJob service method.
///
/// The response from the GetMedicalTranscriptionJob service method, as returned by TranscribeService.
///
/// 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.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
///
/// We can't find the requested resource. Check that the specified name is correct and
/// try your request again.
///
/// REST API Reference for GetMedicalTranscriptionJob Operation
GetMedicalTranscriptionJobResponse GetMedicalTranscriptionJob(GetMedicalTranscriptionJobRequest request);
///
/// Initiates the asynchronous execution of the GetMedicalTranscriptionJob operation.
///
///
/// Container for the necessary parameters to execute the GetMedicalTranscriptionJob operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetMedicalTranscriptionJob
/// operation.
/// REST API Reference for GetMedicalTranscriptionJob Operation
IAsyncResult BeginGetMedicalTranscriptionJob(GetMedicalTranscriptionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the GetMedicalTranscriptionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginGetMedicalTranscriptionJob.
///
/// Returns a GetMedicalTranscriptionJobResult from TranscribeService.
/// REST API Reference for GetMedicalTranscriptionJob Operation
GetMedicalTranscriptionJobResponse EndGetMedicalTranscriptionJob(IAsyncResult asyncResult);
#endregion
#region GetMedicalVocabulary
///
/// 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.
///
///
/// Container for the necessary parameters to execute the GetMedicalVocabulary service method.
///
/// The response from the GetMedicalVocabulary service method, as returned by TranscribeService.
///
/// 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.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
///
/// We can't find the requested resource. Check that the specified name is correct and
/// try your request again.
///
/// REST API Reference for GetMedicalVocabulary Operation
GetMedicalVocabularyResponse GetMedicalVocabulary(GetMedicalVocabularyRequest request);
///
/// Initiates the asynchronous execution of the GetMedicalVocabulary operation.
///
///
/// Container for the necessary parameters to execute the GetMedicalVocabulary operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetMedicalVocabulary
/// operation.
/// REST API Reference for GetMedicalVocabulary Operation
IAsyncResult BeginGetMedicalVocabulary(GetMedicalVocabularyRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the GetMedicalVocabulary operation.
///
///
/// The IAsyncResult returned by the call to BeginGetMedicalVocabulary.
///
/// Returns a GetMedicalVocabularyResult from TranscribeService.
/// REST API Reference for GetMedicalVocabulary Operation
GetMedicalVocabularyResponse EndGetMedicalVocabulary(IAsyncResult asyncResult);
#endregion
#region GetTranscriptionJob
///
/// 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.
///
///
/// Container for the necessary parameters to execute the GetTranscriptionJob service method.
///
/// The response from the GetTranscriptionJob service method, as returned by TranscribeService.
///
/// 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.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
///
/// We can't find the requested resource. Check that the specified name is correct and
/// try your request again.
///
/// REST API Reference for GetTranscriptionJob Operation
GetTranscriptionJobResponse GetTranscriptionJob(GetTranscriptionJobRequest request);
///
/// Initiates the asynchronous execution of the GetTranscriptionJob operation.
///
///
/// Container for the necessary parameters to execute the GetTranscriptionJob operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetTranscriptionJob
/// operation.
/// REST API Reference for GetTranscriptionJob Operation
IAsyncResult BeginGetTranscriptionJob(GetTranscriptionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the GetTranscriptionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginGetTranscriptionJob.
///
/// Returns a GetTranscriptionJobResult from TranscribeService.
/// REST API Reference for GetTranscriptionJob Operation
GetTranscriptionJobResponse EndGetTranscriptionJob(IAsyncResult asyncResult);
#endregion
#region GetVocabulary
///
/// 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.
///
///
/// Container for the necessary parameters to execute the GetVocabulary service method.
///
/// The response from the GetVocabulary service method, as returned by TranscribeService.
///
/// 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.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
///
/// We can't find the requested resource. Check that the specified name is correct and
/// try your request again.
///
/// REST API Reference for GetVocabulary Operation
GetVocabularyResponse GetVocabulary(GetVocabularyRequest request);
///
/// Initiates the asynchronous execution of the GetVocabulary operation.
///
///
/// Container for the necessary parameters to execute the GetVocabulary operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetVocabulary
/// operation.
/// REST API Reference for GetVocabulary Operation
IAsyncResult BeginGetVocabulary(GetVocabularyRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the GetVocabulary operation.
///
///
/// The IAsyncResult returned by the call to BeginGetVocabulary.
///
/// Returns a GetVocabularyResult from TranscribeService.
/// REST API Reference for GetVocabulary Operation
GetVocabularyResponse EndGetVocabulary(IAsyncResult asyncResult);
#endregion
#region GetVocabularyFilter
///
/// Provides information about the specified custom vocabulary filter.
///
///
///
/// To get a list of your custom vocabulary filters, use the operation.
///
///
/// Container for the necessary parameters to execute the GetVocabularyFilter service method.
///
/// The response from the GetVocabularyFilter service method, as returned by TranscribeService.
///
/// 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.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
///
/// We can't find the requested resource. Check that the specified name is correct and
/// try your request again.
///
/// REST API Reference for GetVocabularyFilter Operation
GetVocabularyFilterResponse GetVocabularyFilter(GetVocabularyFilterRequest request);
///
/// Initiates the asynchronous execution of the GetVocabularyFilter operation.
///
///
/// Container for the necessary parameters to execute the GetVocabularyFilter operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetVocabularyFilter
/// operation.
/// REST API Reference for GetVocabularyFilter Operation
IAsyncResult BeginGetVocabularyFilter(GetVocabularyFilterRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the GetVocabularyFilter operation.
///
///
/// The IAsyncResult returned by the call to BeginGetVocabularyFilter.
///
/// Returns a GetVocabularyFilterResult from TranscribeService.
/// REST API Reference for GetVocabularyFilter Operation
GetVocabularyFilterResponse EndGetVocabularyFilter(IAsyncResult asyncResult);
#endregion
#region ListCallAnalyticsCategories
///
/// 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.
///
///
/// Container for the necessary parameters to execute the ListCallAnalyticsCategories service method.
///
/// The response from the ListCallAnalyticsCategories service method, as returned by TranscribeService.
///
/// 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.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
/// REST API Reference for ListCallAnalyticsCategories Operation
ListCallAnalyticsCategoriesResponse ListCallAnalyticsCategories(ListCallAnalyticsCategoriesRequest request);
///
/// Initiates the asynchronous execution of the ListCallAnalyticsCategories operation.
///
///
/// Container for the necessary parameters to execute the ListCallAnalyticsCategories operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListCallAnalyticsCategories
/// operation.
/// REST API Reference for ListCallAnalyticsCategories Operation
IAsyncResult BeginListCallAnalyticsCategories(ListCallAnalyticsCategoriesRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListCallAnalyticsCategories operation.
///
///
/// The IAsyncResult returned by the call to BeginListCallAnalyticsCategories.
///
/// Returns a ListCallAnalyticsCategoriesResult from TranscribeService.
/// REST API Reference for ListCallAnalyticsCategories Operation
ListCallAnalyticsCategoriesResponse EndListCallAnalyticsCategories(IAsyncResult asyncResult);
#endregion
#region ListCallAnalyticsJobs
///
/// 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.
///
///
/// Container for the necessary parameters to execute the ListCallAnalyticsJobs service method.
///
/// The response from the ListCallAnalyticsJobs service method, as returned by TranscribeService.
///
/// 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.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
/// REST API Reference for ListCallAnalyticsJobs Operation
ListCallAnalyticsJobsResponse ListCallAnalyticsJobs(ListCallAnalyticsJobsRequest request);
///
/// Initiates the asynchronous execution of the ListCallAnalyticsJobs operation.
///
///
/// Container for the necessary parameters to execute the ListCallAnalyticsJobs operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListCallAnalyticsJobs
/// operation.
/// REST API Reference for ListCallAnalyticsJobs Operation
IAsyncResult BeginListCallAnalyticsJobs(ListCallAnalyticsJobsRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListCallAnalyticsJobs operation.
///
///
/// The IAsyncResult returned by the call to BeginListCallAnalyticsJobs.
///
/// Returns a ListCallAnalyticsJobsResult from TranscribeService.
/// REST API Reference for ListCallAnalyticsJobs Operation
ListCallAnalyticsJobsResponse EndListCallAnalyticsJobs(IAsyncResult asyncResult);
#endregion
#region ListLanguageModels
///
/// 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.
///
///
/// Container for the necessary parameters to execute the ListLanguageModels service method.
///
/// The response from the ListLanguageModels service method, as returned by TranscribeService.
///
/// 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.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
/// REST API Reference for ListLanguageModels Operation
ListLanguageModelsResponse ListLanguageModels(ListLanguageModelsRequest request);
///
/// Initiates the asynchronous execution of the ListLanguageModels operation.
///
///
/// Container for the necessary parameters to execute the ListLanguageModels operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListLanguageModels
/// operation.
/// REST API Reference for ListLanguageModels Operation
IAsyncResult BeginListLanguageModels(ListLanguageModelsRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListLanguageModels operation.
///
///
/// The IAsyncResult returned by the call to BeginListLanguageModels.
///
/// Returns a ListLanguageModelsResult from TranscribeService.
/// REST API Reference for ListLanguageModels Operation
ListLanguageModelsResponse EndListLanguageModels(IAsyncResult asyncResult);
#endregion
#region ListMedicalTranscriptionJobs
///
/// 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.
///
///
/// Container for the necessary parameters to execute the ListMedicalTranscriptionJobs service method.
///
/// The response from the ListMedicalTranscriptionJobs service method, as returned by TranscribeService.
///
/// 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.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
/// REST API Reference for ListMedicalTranscriptionJobs Operation
ListMedicalTranscriptionJobsResponse ListMedicalTranscriptionJobs(ListMedicalTranscriptionJobsRequest request);
///
/// Initiates the asynchronous execution of the ListMedicalTranscriptionJobs operation.
///
///
/// Container for the necessary parameters to execute the ListMedicalTranscriptionJobs operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListMedicalTranscriptionJobs
/// operation.
/// REST API Reference for ListMedicalTranscriptionJobs Operation
IAsyncResult BeginListMedicalTranscriptionJobs(ListMedicalTranscriptionJobsRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListMedicalTranscriptionJobs operation.
///
///
/// The IAsyncResult returned by the call to BeginListMedicalTranscriptionJobs.
///
/// Returns a ListMedicalTranscriptionJobsResult from TranscribeService.
/// REST API Reference for ListMedicalTranscriptionJobs Operation
ListMedicalTranscriptionJobsResponse EndListMedicalTranscriptionJobs(IAsyncResult asyncResult);
#endregion
#region ListMedicalVocabularies
///
/// 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.
///
///
/// Container for the necessary parameters to execute the ListMedicalVocabularies service method.
///
/// The response from the ListMedicalVocabularies service method, as returned by TranscribeService.
///
/// 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.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
/// REST API Reference for ListMedicalVocabularies Operation
ListMedicalVocabulariesResponse ListMedicalVocabularies(ListMedicalVocabulariesRequest request);
///
/// Initiates the asynchronous execution of the ListMedicalVocabularies operation.
///
///
/// Container for the necessary parameters to execute the ListMedicalVocabularies operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListMedicalVocabularies
/// operation.
/// REST API Reference for ListMedicalVocabularies Operation
IAsyncResult BeginListMedicalVocabularies(ListMedicalVocabulariesRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListMedicalVocabularies operation.
///
///
/// The IAsyncResult returned by the call to BeginListMedicalVocabularies.
///
/// Returns a ListMedicalVocabulariesResult from TranscribeService.
/// REST API Reference for ListMedicalVocabularies Operation
ListMedicalVocabulariesResponse EndListMedicalVocabularies(IAsyncResult asyncResult);
#endregion
#region ListTagsForResource
///
/// 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.
///
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// The response from the ListTagsForResource service method, as returned by TranscribeService.
///
/// 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.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
///
/// We can't find the requested resource. Check that the specified name is correct and
/// try your request again.
///
/// REST API Reference for ListTagsForResource Operation
ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request);
///
/// Initiates the asynchronous execution of the ListTagsForResource operation.
///
///
/// Container for the necessary parameters to execute the ListTagsForResource operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTagsForResource
/// operation.
/// REST API Reference for ListTagsForResource Operation
IAsyncResult BeginListTagsForResource(ListTagsForResourceRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListTagsForResource operation.
///
///
/// The IAsyncResult returned by the call to BeginListTagsForResource.
///
/// Returns a ListTagsForResourceResult from TranscribeService.
/// REST API Reference for ListTagsForResource Operation
ListTagsForResourceResponse EndListTagsForResource(IAsyncResult asyncResult);
#endregion
#region ListTranscriptionJobs
///
/// 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.
///
///
/// Container for the necessary parameters to execute the ListTranscriptionJobs service method.
///
/// The response from the ListTranscriptionJobs service method, as returned by TranscribeService.
///
/// 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.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
/// REST API Reference for ListTranscriptionJobs Operation
ListTranscriptionJobsResponse ListTranscriptionJobs(ListTranscriptionJobsRequest request);
///
/// Initiates the asynchronous execution of the ListTranscriptionJobs operation.
///
///
/// Container for the necessary parameters to execute the ListTranscriptionJobs operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTranscriptionJobs
/// operation.
/// REST API Reference for ListTranscriptionJobs Operation
IAsyncResult BeginListTranscriptionJobs(ListTranscriptionJobsRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListTranscriptionJobs operation.
///
///
/// The IAsyncResult returned by the call to BeginListTranscriptionJobs.
///
/// Returns a ListTranscriptionJobsResult from TranscribeService.
/// REST API Reference for ListTranscriptionJobs Operation
ListTranscriptionJobsResponse EndListTranscriptionJobs(IAsyncResult asyncResult);
#endregion
#region ListVocabularies
///
/// 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.
///
///
/// Container for the necessary parameters to execute the ListVocabularies service method.
///
/// The response from the ListVocabularies service method, as returned by TranscribeService.
///
/// 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.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
/// REST API Reference for ListVocabularies Operation
ListVocabulariesResponse ListVocabularies(ListVocabulariesRequest request);
///
/// Initiates the asynchronous execution of the ListVocabularies operation.
///
///
/// Container for the necessary parameters to execute the ListVocabularies operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListVocabularies
/// operation.
/// REST API Reference for ListVocabularies Operation
IAsyncResult BeginListVocabularies(ListVocabulariesRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListVocabularies operation.
///
///
/// The IAsyncResult returned by the call to BeginListVocabularies.
///
/// Returns a ListVocabulariesResult from TranscribeService.
/// REST API Reference for ListVocabularies Operation
ListVocabulariesResponse EndListVocabularies(IAsyncResult asyncResult);
#endregion
#region ListVocabularyFilters
///
/// 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.
///
///
/// Container for the necessary parameters to execute the ListVocabularyFilters service method.
///
/// The response from the ListVocabularyFilters service method, as returned by TranscribeService.
///
/// 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.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
/// REST API Reference for ListVocabularyFilters Operation
ListVocabularyFiltersResponse ListVocabularyFilters(ListVocabularyFiltersRequest request);
///
/// Initiates the asynchronous execution of the ListVocabularyFilters operation.
///
///
/// Container for the necessary parameters to execute the ListVocabularyFilters operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListVocabularyFilters
/// operation.
/// REST API Reference for ListVocabularyFilters Operation
IAsyncResult BeginListVocabularyFilters(ListVocabularyFiltersRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListVocabularyFilters operation.
///
///
/// The IAsyncResult returned by the call to BeginListVocabularyFilters.
///
/// Returns a ListVocabularyFiltersResult from TranscribeService.
/// REST API Reference for ListVocabularyFilters Operation
ListVocabularyFiltersResponse EndListVocabularyFilters(IAsyncResult asyncResult);
#endregion
#region StartCallAnalyticsJob
///
/// 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:
///
/// -
///
///
region
: The Amazon Web Services Region where you are making your request.
/// For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer
/// to Amazon
/// Transcribe endpoints and quotas.
///
/// -
///
///
CallAnalyticsJobName
: A custom name that you create for your transcription
/// job that's unique within your Amazon Web Services account.
///
/// -
///
///
DataAccessRoleArn
: The Amazon Resource Name (ARN) of an IAM role that
/// has permissions to access the Amazon S3 bucket that contains your input files.
///
/// -
///
///
Media
(MediaFileUri
or RedactedMediaFileUri
):
/// The Amazon S3 location of your media file.
///
///
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the StartCallAnalyticsJob service method.
///
/// The response from the StartCallAnalyticsJob service method, as returned by TranscribeService.
///
/// 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.
///
///
/// A resource already exists with this name. Resource names must be unique within an
/// Amazon Web Services account.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
/// REST API Reference for StartCallAnalyticsJob Operation
StartCallAnalyticsJobResponse StartCallAnalyticsJob(StartCallAnalyticsJobRequest request);
///
/// Initiates the asynchronous execution of the StartCallAnalyticsJob operation.
///
///
/// Container for the necessary parameters to execute the StartCallAnalyticsJob operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartCallAnalyticsJob
/// operation.
/// REST API Reference for StartCallAnalyticsJob Operation
IAsyncResult BeginStartCallAnalyticsJob(StartCallAnalyticsJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the StartCallAnalyticsJob operation.
///
///
/// The IAsyncResult returned by the call to BeginStartCallAnalyticsJob.
///
/// Returns a StartCallAnalyticsJobResult from TranscribeService.
/// REST API Reference for StartCallAnalyticsJob Operation
StartCallAnalyticsJobResponse EndStartCallAnalyticsJob(IAsyncResult asyncResult);
#endregion
#region StartMedicalTranscriptionJob
///
/// 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:
///
/// -
///
///
region
: The Amazon Web Services Region where you are making your request.
/// For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer
/// to Amazon
/// Transcribe endpoints and quotas.
///
/// -
///
///
MedicalTranscriptionJobName
: A custom name you create for your transcription
/// job that is unique within your Amazon Web Services account.
///
/// -
///
///
Media
(MediaFileUri
): The Amazon S3 location of your media
/// file.
///
/// -
///
///
LanguageCode
: This must be en-US
.
///
/// -
///
///
OutputBucketName
: The Amazon S3 bucket where you want your transcript
/// stored. If you want your output stored in a sub-folder of this bucket, you must also
/// include OutputKey
.
///
/// -
///
///
Specialty
: This must be PRIMARYCARE
.
///
/// -
///
///
Type
: Choose whether your audio is a conversation or a dictation.
///
///
///
/// Container for the necessary parameters to execute the StartMedicalTranscriptionJob service method.
///
/// The response from the StartMedicalTranscriptionJob service method, as returned by TranscribeService.
///
/// 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.
///
///
/// A resource already exists with this name. Resource names must be unique within an
/// Amazon Web Services account.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
/// REST API Reference for StartMedicalTranscriptionJob Operation
StartMedicalTranscriptionJobResponse StartMedicalTranscriptionJob(StartMedicalTranscriptionJobRequest request);
///
/// Initiates the asynchronous execution of the StartMedicalTranscriptionJob operation.
///
///
/// Container for the necessary parameters to execute the StartMedicalTranscriptionJob operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartMedicalTranscriptionJob
/// operation.
/// REST API Reference for StartMedicalTranscriptionJob Operation
IAsyncResult BeginStartMedicalTranscriptionJob(StartMedicalTranscriptionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the StartMedicalTranscriptionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginStartMedicalTranscriptionJob.
///
/// Returns a StartMedicalTranscriptionJobResult from TranscribeService.
/// REST API Reference for StartMedicalTranscriptionJob Operation
StartMedicalTranscriptionJobResponse EndStartMedicalTranscriptionJob(IAsyncResult asyncResult);
#endregion
#region StartTranscriptionJob
///
/// 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:
///
/// -
///
///
region
: The Amazon Web Services Region where you are making your request.
/// For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer
/// to Amazon
/// Transcribe endpoints and quotas.
///
/// -
///
///
TranscriptionJobName
: A custom name you create for your transcription
/// job that is unique within your Amazon Web Services account.
///
/// -
///
///
Media
(MediaFileUri
): The Amazon S3 location of your media
/// file.
///
/// -
///
/// One of
LanguageCode
, IdentifyLanguage
, or IdentifyMultipleLanguages
:
/// If you know the language of your media file, specify it using the LanguageCode
/// parameter; you can find all valid language codes in the Supported
/// languages table. If you don't know the languages spoken in your media, use either
/// IdentifyLanguage
or IdentifyMultipleLanguages
and let Amazon
/// Transcribe identify the languages for you.
///
///
///
/// Container for the necessary parameters to execute the StartTranscriptionJob service method.
///
/// The response from the StartTranscriptionJob service method, as returned by TranscribeService.
///
/// 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.
///
///
/// A resource already exists with this name. Resource names must be unique within an
/// Amazon Web Services account.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
/// REST API Reference for StartTranscriptionJob Operation
StartTranscriptionJobResponse StartTranscriptionJob(StartTranscriptionJobRequest request);
///
/// Initiates the asynchronous execution of the StartTranscriptionJob operation.
///
///
/// Container for the necessary parameters to execute the StartTranscriptionJob operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartTranscriptionJob
/// operation.
/// REST API Reference for StartTranscriptionJob Operation
IAsyncResult BeginStartTranscriptionJob(StartTranscriptionJobRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the StartTranscriptionJob operation.
///
///
/// The IAsyncResult returned by the call to BeginStartTranscriptionJob.
///
/// Returns a StartTranscriptionJobResult from TranscribeService.
/// REST API Reference for StartTranscriptionJob Operation
StartTranscriptionJobResponse EndStartTranscriptionJob(IAsyncResult asyncResult);
#endregion
#region TagResource
///
/// 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.
///
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// The response from the TagResource service method, as returned by TranscribeService.
///
/// 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.
///
///
/// A resource already exists with this name. Resource names must be unique within an
/// Amazon Web Services account.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
///
/// We can't find the requested resource. Check that the specified name is correct and
/// try your request again.
///
/// REST API Reference for TagResource Operation
TagResourceResponse TagResource(TagResourceRequest request);
///
/// Initiates the asynchronous execution of the TagResource operation.
///
///
/// Container for the necessary parameters to execute the TagResource operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTagResource
/// operation.
/// REST API Reference for TagResource Operation
IAsyncResult BeginTagResource(TagResourceRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the TagResource operation.
///
///
/// The IAsyncResult returned by the call to BeginTagResource.
///
/// Returns a TagResourceResult from TranscribeService.
/// REST API Reference for TagResource Operation
TagResourceResponse EndTagResource(IAsyncResult asyncResult);
#endregion
#region UntagResource
///
/// Removes the specified tags from the specified Amazon Transcribe resource.
///
///
///
/// If you include UntagResource
in your request, you must also include ResourceArn
/// and TagKeys
.
///
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// The response from the UntagResource service method, as returned by TranscribeService.
///
/// 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.
///
///
/// A resource already exists with this name. Resource names must be unique within an
/// Amazon Web Services account.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
///
/// We can't find the requested resource. Check that the specified name is correct and
/// try your request again.
///
/// REST API Reference for UntagResource Operation
UntagResourceResponse UntagResource(UntagResourceRequest request);
///
/// Initiates the asynchronous execution of the UntagResource operation.
///
///
/// Container for the necessary parameters to execute the UntagResource operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUntagResource
/// operation.
/// REST API Reference for UntagResource Operation
IAsyncResult BeginUntagResource(UntagResourceRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the UntagResource operation.
///
///
/// The IAsyncResult returned by the call to BeginUntagResource.
///
/// Returns a UntagResourceResult from TranscribeService.
/// REST API Reference for UntagResource Operation
UntagResourceResponse EndUntagResource(IAsyncResult asyncResult);
#endregion
#region UpdateCallAnalyticsCategory
///
/// 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 .
///
///
/// Container for the necessary parameters to execute the UpdateCallAnalyticsCategory service method.
///
/// The response from the UpdateCallAnalyticsCategory service method, as returned by TranscribeService.
///
/// 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.
///
///
/// A resource already exists with this name. Resource names must be unique within an
/// Amazon Web Services account.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
///
/// We can't find the requested resource. Check that the specified name is correct and
/// try your request again.
///
/// REST API Reference for UpdateCallAnalyticsCategory Operation
UpdateCallAnalyticsCategoryResponse UpdateCallAnalyticsCategory(UpdateCallAnalyticsCategoryRequest request);
///
/// Initiates the asynchronous execution of the UpdateCallAnalyticsCategory operation.
///
///
/// Container for the necessary parameters to execute the UpdateCallAnalyticsCategory operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateCallAnalyticsCategory
/// operation.
/// REST API Reference for UpdateCallAnalyticsCategory Operation
IAsyncResult BeginUpdateCallAnalyticsCategory(UpdateCallAnalyticsCategoryRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the UpdateCallAnalyticsCategory operation.
///
///
/// The IAsyncResult returned by the call to BeginUpdateCallAnalyticsCategory.
///
/// Returns a UpdateCallAnalyticsCategoryResult from TranscribeService.
/// REST API Reference for UpdateCallAnalyticsCategory Operation
UpdateCallAnalyticsCategoryResponse EndUpdateCallAnalyticsCategory(IAsyncResult asyncResult);
#endregion
#region UpdateMedicalVocabulary
///
/// 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.
///
/// Container for the necessary parameters to execute the UpdateMedicalVocabulary service method.
///
/// The response from the UpdateMedicalVocabulary service method, as returned by TranscribeService.
///
/// 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.
///
///
/// A resource already exists with this name. Resource names must be unique within an
/// Amazon Web Services account.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
///
/// We can't find the requested resource. Check that the specified name is correct and
/// try your request again.
///
/// REST API Reference for UpdateMedicalVocabulary Operation
UpdateMedicalVocabularyResponse UpdateMedicalVocabulary(UpdateMedicalVocabularyRequest request);
///
/// Initiates the asynchronous execution of the UpdateMedicalVocabulary operation.
///
///
/// Container for the necessary parameters to execute the UpdateMedicalVocabulary operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateMedicalVocabulary
/// operation.
/// REST API Reference for UpdateMedicalVocabulary Operation
IAsyncResult BeginUpdateMedicalVocabulary(UpdateMedicalVocabularyRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the UpdateMedicalVocabulary operation.
///
///
/// The IAsyncResult returned by the call to BeginUpdateMedicalVocabulary.
///
/// Returns a UpdateMedicalVocabularyResult from TranscribeService.
/// REST API Reference for UpdateMedicalVocabulary Operation
UpdateMedicalVocabularyResponse EndUpdateMedicalVocabulary(IAsyncResult asyncResult);
#endregion
#region UpdateVocabulary
///
/// 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.
///
/// Container for the necessary parameters to execute the UpdateVocabulary service method.
///
/// The response from the UpdateVocabulary service method, as returned by TranscribeService.
///
/// 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.
///
///
/// A resource already exists with this name. Resource names must be unique within an
/// Amazon Web Services account.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
///
/// We can't find the requested resource. Check that the specified name is correct and
/// try your request again.
///
/// REST API Reference for UpdateVocabulary Operation
UpdateVocabularyResponse UpdateVocabulary(UpdateVocabularyRequest request);
///
/// Initiates the asynchronous execution of the UpdateVocabulary operation.
///
///
/// Container for the necessary parameters to execute the UpdateVocabulary operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateVocabulary
/// operation.
/// REST API Reference for UpdateVocabulary Operation
IAsyncResult BeginUpdateVocabulary(UpdateVocabularyRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the UpdateVocabulary operation.
///
///
/// The IAsyncResult returned by the call to BeginUpdateVocabulary.
///
/// Returns a UpdateVocabularyResult from TranscribeService.
/// REST API Reference for UpdateVocabulary Operation
UpdateVocabularyResponse EndUpdateVocabulary(IAsyncResult asyncResult);
#endregion
#region UpdateVocabularyFilter
///
/// 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.
///
/// Container for the necessary parameters to execute the UpdateVocabularyFilter service method.
///
/// The response from the UpdateVocabularyFilter service method, as returned by TranscribeService.
///
/// 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.
///
///
/// There was an internal error. Check the error message, correct the issue, and try your
/// request again.
///
///
/// 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.
///
///
/// We can't find the requested resource. Check that the specified name is correct and
/// try your request again.
///
/// REST API Reference for UpdateVocabularyFilter Operation
UpdateVocabularyFilterResponse UpdateVocabularyFilter(UpdateVocabularyFilterRequest request);
///
/// Initiates the asynchronous execution of the UpdateVocabularyFilter operation.
///
///
/// Container for the necessary parameters to execute the UpdateVocabularyFilter operation on AmazonTranscribeServiceClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateVocabularyFilter
/// operation.
/// REST API Reference for UpdateVocabularyFilter Operation
IAsyncResult BeginUpdateVocabularyFilter(UpdateVocabularyFilterRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the UpdateVocabularyFilter operation.
///
///
/// The IAsyncResult returned by the call to BeginUpdateVocabularyFilter.
///
/// Returns a UpdateVocabularyFilterResult from TranscribeService.
/// REST API Reference for UpdateVocabularyFilter Operation
UpdateVocabularyFilterResponse EndUpdateVocabularyFilter(IAsyncResult asyncResult);
#endregion
}
}