@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonTranscribeAsync extends AmazonTranscribe
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonTranscribeAsync instead.
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.
ENDPOINT_PREFIX createCallAnalyticsCategory, createLanguageModel, createMedicalVocabulary, createVocabulary, createVocabularyFilter, deleteCallAnalyticsCategory, deleteCallAnalyticsJob, deleteLanguageModel, deleteMedicalScribeJob, deleteMedicalTranscriptionJob, deleteMedicalVocabulary, deleteTranscriptionJob, deleteVocabulary, deleteVocabularyFilter, describeLanguageModel, getCachedResponseMetadata, getCallAnalyticsCategory, getCallAnalyticsJob, getMedicalScribeJob, getMedicalTranscriptionJob, getMedicalVocabulary, getTranscriptionJob, getVocabulary, getVocabularyFilter, listCallAnalyticsCategories, listCallAnalyticsJobs, listLanguageModels, listMedicalScribeJobs, listMedicalTranscriptionJobs, listMedicalVocabularies, listTagsForResource, listTranscriptionJobs, listVocabularies, listVocabularyFilters, shutdown, startCallAnalyticsJob, startMedicalScribeJob, startMedicalTranscriptionJob, startTranscriptionJob, tagResource, untagResource, updateCallAnalyticsCategory, updateMedicalVocabulary, updateVocabulary, updateVocabularyFilter Future<CreateCallAnalyticsCategoryResult> createCallAnalyticsCategoryAsync(CreateCallAnalyticsCategoryRequest createCallAnalyticsCategoryRequest)
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.
createCallAnalyticsCategoryRequest - Future<CreateCallAnalyticsCategoryResult> createCallAnalyticsCategoryAsync(CreateCallAnalyticsCategoryRequest createCallAnalyticsCategoryRequest, AsyncHandler<CreateCallAnalyticsCategoryRequest,CreateCallAnalyticsCategoryResult> asyncHandler)
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.
createCallAnalyticsCategoryRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateLanguageModelResult> createLanguageModelAsync(CreateLanguageModelRequest createLanguageModelRequest)
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
createLanguageModelRequest - Future<CreateLanguageModelResult> createLanguageModelAsync(CreateLanguageModelRequest createLanguageModelRequest, AsyncHandler<CreateLanguageModelRequest,CreateLanguageModelResult> asyncHandler)
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
createLanguageModelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateMedicalVocabularyResult> createMedicalVocabularyAsync(CreateMedicalVocabularyRequest createMedicalVocabularyRequest)
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.
createMedicalVocabularyRequest - Future<CreateMedicalVocabularyResult> createMedicalVocabularyAsync(CreateMedicalVocabularyRequest createMedicalVocabularyRequest, AsyncHandler<CreateMedicalVocabularyRequest,CreateMedicalVocabularyResult> asyncHandler)
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.
createMedicalVocabularyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateVocabularyResult> createVocabularyAsync(CreateVocabularyRequest createVocabularyRequest)
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.
createVocabularyRequest - Future<CreateVocabularyResult> createVocabularyAsync(CreateVocabularyRequest createVocabularyRequest, AsyncHandler<CreateVocabularyRequest,CreateVocabularyResult> asyncHandler)
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.
createVocabularyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateVocabularyFilterResult> createVocabularyFilterAsync(CreateVocabularyFilterRequest createVocabularyFilterRequest)
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.
createVocabularyFilterRequest - Future<CreateVocabularyFilterResult> createVocabularyFilterAsync(CreateVocabularyFilterRequest createVocabularyFilterRequest, AsyncHandler<CreateVocabularyFilterRequest,CreateVocabularyFilterResult> asyncHandler)
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.
createVocabularyFilterRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteCallAnalyticsCategoryResult> deleteCallAnalyticsCategoryAsync(DeleteCallAnalyticsCategoryRequest deleteCallAnalyticsCategoryRequest)
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.
deleteCallAnalyticsCategoryRequest - Future<DeleteCallAnalyticsCategoryResult> deleteCallAnalyticsCategoryAsync(DeleteCallAnalyticsCategoryRequest deleteCallAnalyticsCategoryRequest, AsyncHandler<DeleteCallAnalyticsCategoryRequest,DeleteCallAnalyticsCategoryResult> asyncHandler)
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.
deleteCallAnalyticsCategoryRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteCallAnalyticsJobResult> deleteCallAnalyticsJobAsync(DeleteCallAnalyticsJobRequest deleteCallAnalyticsJobRequest)
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.
deleteCallAnalyticsJobRequest - Future<DeleteCallAnalyticsJobResult> deleteCallAnalyticsJobAsync(DeleteCallAnalyticsJobRequest deleteCallAnalyticsJobRequest, AsyncHandler<DeleteCallAnalyticsJobRequest,DeleteCallAnalyticsJobResult> asyncHandler)
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.
deleteCallAnalyticsJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteLanguageModelResult> deleteLanguageModelAsync(DeleteLanguageModelRequest deleteLanguageModelRequest)
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.
deleteLanguageModelRequest - Future<DeleteLanguageModelResult> deleteLanguageModelAsync(DeleteLanguageModelRequest deleteLanguageModelRequest, AsyncHandler<DeleteLanguageModelRequest,DeleteLanguageModelResult> asyncHandler)
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.
deleteLanguageModelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteMedicalScribeJobResult> deleteMedicalScribeJobAsync(DeleteMedicalScribeJobRequest deleteMedicalScribeJobRequest)
Deletes a Medical Scribe job. To use this operation, specify the name of the job you want to delete using
MedicalScribeJobName. Job names are case sensitive.
deleteMedicalScribeJobRequest - Future<DeleteMedicalScribeJobResult> deleteMedicalScribeJobAsync(DeleteMedicalScribeJobRequest deleteMedicalScribeJobRequest, AsyncHandler<DeleteMedicalScribeJobRequest,DeleteMedicalScribeJobResult> asyncHandler)
Deletes a Medical Scribe job. To use this operation, specify the name of the job you want to delete using
MedicalScribeJobName. Job names are case sensitive.
deleteMedicalScribeJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteMedicalTranscriptionJobResult> deleteMedicalTranscriptionJobAsync(DeleteMedicalTranscriptionJobRequest deleteMedicalTranscriptionJobRequest)
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.
deleteMedicalTranscriptionJobRequest - Future<DeleteMedicalTranscriptionJobResult> deleteMedicalTranscriptionJobAsync(DeleteMedicalTranscriptionJobRequest deleteMedicalTranscriptionJobRequest, AsyncHandler<DeleteMedicalTranscriptionJobRequest,DeleteMedicalTranscriptionJobResult> asyncHandler)
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.
deleteMedicalTranscriptionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteMedicalVocabularyResult> deleteMedicalVocabularyAsync(DeleteMedicalVocabularyRequest deleteMedicalVocabularyRequest)
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.
deleteMedicalVocabularyRequest - Future<DeleteMedicalVocabularyResult> deleteMedicalVocabularyAsync(DeleteMedicalVocabularyRequest deleteMedicalVocabularyRequest, AsyncHandler<DeleteMedicalVocabularyRequest,DeleteMedicalVocabularyResult> asyncHandler)
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.
deleteMedicalVocabularyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteTranscriptionJobResult> deleteTranscriptionJobAsync(DeleteTranscriptionJobRequest deleteTranscriptionJobRequest)
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.
deleteTranscriptionJobRequest - Future<DeleteTranscriptionJobResult> deleteTranscriptionJobAsync(DeleteTranscriptionJobRequest deleteTranscriptionJobRequest, AsyncHandler<DeleteTranscriptionJobRequest,DeleteTranscriptionJobResult> asyncHandler)
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.
deleteTranscriptionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteVocabularyResult> deleteVocabularyAsync(DeleteVocabularyRequest deleteVocabularyRequest)
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.
deleteVocabularyRequest - Future<DeleteVocabularyResult> deleteVocabularyAsync(DeleteVocabularyRequest deleteVocabularyRequest, AsyncHandler<DeleteVocabularyRequest,DeleteVocabularyResult> asyncHandler)
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.
deleteVocabularyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteVocabularyFilterResult> deleteVocabularyFilterAsync(DeleteVocabularyFilterRequest deleteVocabularyFilterRequest)
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.
deleteVocabularyFilterRequest - Future<DeleteVocabularyFilterResult> deleteVocabularyFilterAsync(DeleteVocabularyFilterRequest deleteVocabularyFilterRequest, AsyncHandler<DeleteVocabularyFilterRequest,DeleteVocabularyFilterResult> asyncHandler)
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.
deleteVocabularyFilterRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeLanguageModelResult> describeLanguageModelAsync(DescribeLanguageModelRequest describeLanguageModelRequest)
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.
describeLanguageModelRequest - Future<DescribeLanguageModelResult> describeLanguageModelAsync(DescribeLanguageModelRequest describeLanguageModelRequest, AsyncHandler<DescribeLanguageModelRequest,DescribeLanguageModelResult> asyncHandler)
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.
describeLanguageModelRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetCallAnalyticsCategoryResult> getCallAnalyticsCategoryAsync(GetCallAnalyticsCategoryRequest getCallAnalyticsCategoryRequest)
Provides information about the specified Call Analytics category.
To get a list of your Call Analytics categories, use the operation.
getCallAnalyticsCategoryRequest - Future<GetCallAnalyticsCategoryResult> getCallAnalyticsCategoryAsync(GetCallAnalyticsCategoryRequest getCallAnalyticsCategoryRequest, AsyncHandler<GetCallAnalyticsCategoryRequest,GetCallAnalyticsCategoryResult> asyncHandler)
Provides information about the specified Call Analytics category.
To get a list of your Call Analytics categories, use the operation.
getCallAnalyticsCategoryRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetCallAnalyticsJobResult> getCallAnalyticsJobAsync(GetCallAnalyticsJobRequest getCallAnalyticsJobRequest)
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.
getCallAnalyticsJobRequest - Future<GetCallAnalyticsJobResult> getCallAnalyticsJobAsync(GetCallAnalyticsJobRequest getCallAnalyticsJobRequest, AsyncHandler<GetCallAnalyticsJobRequest,GetCallAnalyticsJobResult> asyncHandler)
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.
getCallAnalyticsJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetMedicalScribeJobResult> getMedicalScribeJobAsync(GetMedicalScribeJobRequest getMedicalScribeJobRequest)
Provides information about the specified Medical Scribe job.
To view the status of the specified medical transcription job, check the MedicalScribeJobStatus
field. If the status is COMPLETED, the job is finished. You can find the results at the location
specified in MedicalScribeOutput. If the status is FAILED, FailureReason
provides details on why your Medical Scribe job failed.
To get a list of your Medical Scribe jobs, use the operation.
getMedicalScribeJobRequest - Future<GetMedicalScribeJobResult> getMedicalScribeJobAsync(GetMedicalScribeJobRequest getMedicalScribeJobRequest, AsyncHandler<GetMedicalScribeJobRequest,GetMedicalScribeJobResult> asyncHandler)
Provides information about the specified Medical Scribe job.
To view the status of the specified medical transcription job, check the MedicalScribeJobStatus
field. If the status is COMPLETED, the job is finished. You can find the results at the location
specified in MedicalScribeOutput. If the status is FAILED, FailureReason
provides details on why your Medical Scribe job failed.
To get a list of your Medical Scribe jobs, use the operation.
getMedicalScribeJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetMedicalTranscriptionJobResult> getMedicalTranscriptionJobAsync(GetMedicalTranscriptionJobRequest getMedicalTranscriptionJobRequest)
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.
getMedicalTranscriptionJobRequest - Future<GetMedicalTranscriptionJobResult> getMedicalTranscriptionJobAsync(GetMedicalTranscriptionJobRequest getMedicalTranscriptionJobRequest, AsyncHandler<GetMedicalTranscriptionJobRequest,GetMedicalTranscriptionJobResult> asyncHandler)
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.
getMedicalTranscriptionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetMedicalVocabularyResult> getMedicalVocabularyAsync(GetMedicalVocabularyRequest getMedicalVocabularyRequest)
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.
getMedicalVocabularyRequest - Future<GetMedicalVocabularyResult> getMedicalVocabularyAsync(GetMedicalVocabularyRequest getMedicalVocabularyRequest, AsyncHandler<GetMedicalVocabularyRequest,GetMedicalVocabularyResult> asyncHandler)
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.
getMedicalVocabularyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetTranscriptionJobResult> getTranscriptionJobAsync(GetTranscriptionJobRequest getTranscriptionJobRequest)
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.
getTranscriptionJobRequest - Future<GetTranscriptionJobResult> getTranscriptionJobAsync(GetTranscriptionJobRequest getTranscriptionJobRequest, AsyncHandler<GetTranscriptionJobRequest,GetTranscriptionJobResult> asyncHandler)
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.
getTranscriptionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetVocabularyResult> getVocabularyAsync(GetVocabularyRequest getVocabularyRequest)
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.
getVocabularyRequest - Future<GetVocabularyResult> getVocabularyAsync(GetVocabularyRequest getVocabularyRequest, AsyncHandler<GetVocabularyRequest,GetVocabularyResult> asyncHandler)
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.
getVocabularyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetVocabularyFilterResult> getVocabularyFilterAsync(GetVocabularyFilterRequest getVocabularyFilterRequest)
Provides information about the specified custom vocabulary filter.
To get a list of your custom vocabulary filters, use the operation.
getVocabularyFilterRequest - Future<GetVocabularyFilterResult> getVocabularyFilterAsync(GetVocabularyFilterRequest getVocabularyFilterRequest, AsyncHandler<GetVocabularyFilterRequest,GetVocabularyFilterResult> asyncHandler)
Provides information about the specified custom vocabulary filter.
To get a list of your custom vocabulary filters, use the operation.
getVocabularyFilterRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListCallAnalyticsCategoriesResult> listCallAnalyticsCategoriesAsync(ListCallAnalyticsCategoriesRequest listCallAnalyticsCategoriesRequest)
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.
listCallAnalyticsCategoriesRequest - Future<ListCallAnalyticsCategoriesResult> listCallAnalyticsCategoriesAsync(ListCallAnalyticsCategoriesRequest listCallAnalyticsCategoriesRequest, AsyncHandler<ListCallAnalyticsCategoriesRequest,ListCallAnalyticsCategoriesResult> asyncHandler)
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.
listCallAnalyticsCategoriesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListCallAnalyticsJobsResult> listCallAnalyticsJobsAsync(ListCallAnalyticsJobsRequest listCallAnalyticsJobsRequest)
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.
listCallAnalyticsJobsRequest - Future<ListCallAnalyticsJobsResult> listCallAnalyticsJobsAsync(ListCallAnalyticsJobsRequest listCallAnalyticsJobsRequest, AsyncHandler<ListCallAnalyticsJobsRequest,ListCallAnalyticsJobsResult> asyncHandler)
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.
listCallAnalyticsJobsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListLanguageModelsResult> listLanguageModelsAsync(ListLanguageModelsRequest listLanguageModelsRequest)
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.
listLanguageModelsRequest - Future<ListLanguageModelsResult> listLanguageModelsAsync(ListLanguageModelsRequest listLanguageModelsRequest, AsyncHandler<ListLanguageModelsRequest,ListLanguageModelsResult> asyncHandler)
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.
listLanguageModelsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListMedicalScribeJobsResult> listMedicalScribeJobsAsync(ListMedicalScribeJobsRequest listMedicalScribeJobsRequest)
Provides a list of Medical Scribe jobs that match the specified criteria. If no criteria are specified, all Medical Scribe jobs are returned.
To get detailed information about a specific Medical Scribe job, use the operation.
listMedicalScribeJobsRequest - Future<ListMedicalScribeJobsResult> listMedicalScribeJobsAsync(ListMedicalScribeJobsRequest listMedicalScribeJobsRequest, AsyncHandler<ListMedicalScribeJobsRequest,ListMedicalScribeJobsResult> asyncHandler)
Provides a list of Medical Scribe jobs that match the specified criteria. If no criteria are specified, all Medical Scribe jobs are returned.
To get detailed information about a specific Medical Scribe job, use the operation.
listMedicalScribeJobsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListMedicalTranscriptionJobsResult> listMedicalTranscriptionJobsAsync(ListMedicalTranscriptionJobsRequest listMedicalTranscriptionJobsRequest)
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.
listMedicalTranscriptionJobsRequest - Future<ListMedicalTranscriptionJobsResult> listMedicalTranscriptionJobsAsync(ListMedicalTranscriptionJobsRequest listMedicalTranscriptionJobsRequest, AsyncHandler<ListMedicalTranscriptionJobsRequest,ListMedicalTranscriptionJobsResult> asyncHandler)
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.
listMedicalTranscriptionJobsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListMedicalVocabulariesResult> listMedicalVocabulariesAsync(ListMedicalVocabulariesRequest listMedicalVocabulariesRequest)
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.
listMedicalVocabulariesRequest - Future<ListMedicalVocabulariesResult> listMedicalVocabulariesAsync(ListMedicalVocabulariesRequest listMedicalVocabulariesRequest, AsyncHandler<ListMedicalVocabulariesRequest,ListMedicalVocabulariesResult> asyncHandler)
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.
listMedicalVocabulariesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
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.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
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.
listTagsForResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTranscriptionJobsResult> listTranscriptionJobsAsync(ListTranscriptionJobsRequest listTranscriptionJobsRequest)
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.
listTranscriptionJobsRequest - Future<ListTranscriptionJobsResult> listTranscriptionJobsAsync(ListTranscriptionJobsRequest listTranscriptionJobsRequest, AsyncHandler<ListTranscriptionJobsRequest,ListTranscriptionJobsResult> asyncHandler)
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.
listTranscriptionJobsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListVocabulariesResult> listVocabulariesAsync(ListVocabulariesRequest listVocabulariesRequest)
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.
listVocabulariesRequest - Future<ListVocabulariesResult> listVocabulariesAsync(ListVocabulariesRequest listVocabulariesRequest, AsyncHandler<ListVocabulariesRequest,ListVocabulariesResult> asyncHandler)
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.
listVocabulariesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListVocabularyFiltersResult> listVocabularyFiltersAsync(ListVocabularyFiltersRequest listVocabularyFiltersRequest)
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.
listVocabularyFiltersRequest - Future<ListVocabularyFiltersResult> listVocabularyFiltersAsync(ListVocabularyFiltersRequest listVocabularyFiltersRequest, AsyncHandler<ListVocabularyFiltersRequest,ListVocabularyFiltersResult> asyncHandler)
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.
listVocabularyFiltersRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartCallAnalyticsJobResult> startCallAnalyticsJobAsync(StartCallAnalyticsJobRequest startCallAnalyticsJobRequest)
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.
startCallAnalyticsJobRequest - Future<StartCallAnalyticsJobResult> startCallAnalyticsJobAsync(StartCallAnalyticsJobRequest startCallAnalyticsJobRequest, AsyncHandler<StartCallAnalyticsJobRequest,StartCallAnalyticsJobResult> asyncHandler)
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.
startCallAnalyticsJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartMedicalScribeJobResult> startMedicalScribeJobAsync(StartMedicalScribeJobRequest startMedicalScribeJobRequest)
Transcribes patient-clinician conversations and generates clinical notes.
Amazon Web Services HealthScribe automatically provides rich conversation transcripts, identifies speaker roles, classifies dialogues, extracts medical terms, and generates preliminary clinical notes. To learn more about these features, refer to Amazon Web Services HealthScribe.
To make a StartMedicalScribeJob 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 StartMedicalTranscriptionJob request:
DataAccessRoleArn: The ARN of an IAM role with the these minimum permissions: read permission on
input file Amazon S3 bucket specified in Media, write permission on the Amazon S3 bucket specified
in OutputBucketName, and full permissions on the KMS key specified in
OutputEncryptionKMSKeyId (if set). The role should also allow transcribe.amazonaws.com
to assume it.
Media (MediaFileUri): The Amazon S3 location of your media file.
MedicalScribeJobName: A custom name you create for your MedicalScribe job that is unique within your
Amazon Web Services account.
OutputBucketName: The Amazon S3 bucket where you want your output files stored.
Settings: A MedicalScribeSettings obect that must set exactly one of
ShowSpeakerLabels or ChannelIdentification to true. If ShowSpeakerLabels
is true, MaxSpeakerLabels must also be set.
ChannelDefinitions: A MedicalScribeChannelDefinitions array should be set if and only
if the ChannelIdentification value of Settings is set to true.
startMedicalScribeJobRequest - Future<StartMedicalScribeJobResult> startMedicalScribeJobAsync(StartMedicalScribeJobRequest startMedicalScribeJobRequest, AsyncHandler<StartMedicalScribeJobRequest,StartMedicalScribeJobResult> asyncHandler)
Transcribes patient-clinician conversations and generates clinical notes.
Amazon Web Services HealthScribe automatically provides rich conversation transcripts, identifies speaker roles, classifies dialogues, extracts medical terms, and generates preliminary clinical notes. To learn more about these features, refer to Amazon Web Services HealthScribe.
To make a StartMedicalScribeJob 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 StartMedicalTranscriptionJob request:
DataAccessRoleArn: The ARN of an IAM role with the these minimum permissions: read permission on
input file Amazon S3 bucket specified in Media, write permission on the Amazon S3 bucket specified
in OutputBucketName, and full permissions on the KMS key specified in
OutputEncryptionKMSKeyId (if set). The role should also allow transcribe.amazonaws.com
to assume it.
Media (MediaFileUri): The Amazon S3 location of your media file.
MedicalScribeJobName: A custom name you create for your MedicalScribe job that is unique within your
Amazon Web Services account.
OutputBucketName: The Amazon S3 bucket where you want your output files stored.
Settings: A MedicalScribeSettings obect that must set exactly one of
ShowSpeakerLabels or ChannelIdentification to true. If ShowSpeakerLabels
is true, MaxSpeakerLabels must also be set.
ChannelDefinitions: A MedicalScribeChannelDefinitions array should be set if and only
if the ChannelIdentification value of Settings is set to true.
startMedicalScribeJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartMedicalTranscriptionJobResult> startMedicalTranscriptionJobAsync(StartMedicalTranscriptionJobRequest startMedicalTranscriptionJobRequest)
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 Amazon 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.
startMedicalTranscriptionJobRequest - Future<StartMedicalTranscriptionJobResult> startMedicalTranscriptionJobAsync(StartMedicalTranscriptionJobRequest startMedicalTranscriptionJobRequest, AsyncHandler<StartMedicalTranscriptionJobRequest,StartMedicalTranscriptionJobResult> asyncHandler)
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 Amazon 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.
startMedicalTranscriptionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartTranscriptionJobResult> startTranscriptionJobAsync(StartTranscriptionJobRequest startTranscriptionJobRequest)
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 do not know the languages spoken in your media, use either IdentifyLanguage or
IdentifyMultipleLanguages and let Amazon Transcribe identify the languages for you.
startTranscriptionJobRequest - Future<StartTranscriptionJobResult> startTranscriptionJobAsync(StartTranscriptionJobRequest startTranscriptionJobRequest, AsyncHandler<StartTranscriptionJobRequest,StartTranscriptionJobResult> asyncHandler)
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 do not know the languages spoken in your media, use either IdentifyLanguage or
IdentifyMultipleLanguages and let Amazon Transcribe identify the languages for you.
startTranscriptionJobRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
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.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
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.
tagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes the specified tags from the specified Amazon Transcribe resource.
If you include UntagResource in your request, you must also include ResourceArn and
TagKeys.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes the specified tags from the specified Amazon Transcribe resource.
If you include UntagResource in your request, you must also include ResourceArn and
TagKeys.
untagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateCallAnalyticsCategoryResult> updateCallAnalyticsCategoryAsync(UpdateCallAnalyticsCategoryRequest updateCallAnalyticsCategoryRequest)
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 .
updateCallAnalyticsCategoryRequest - Future<UpdateCallAnalyticsCategoryResult> updateCallAnalyticsCategoryAsync(UpdateCallAnalyticsCategoryRequest updateCallAnalyticsCategoryRequest, AsyncHandler<UpdateCallAnalyticsCategoryRequest,UpdateCallAnalyticsCategoryResult> asyncHandler)
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 .
updateCallAnalyticsCategoryRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateMedicalVocabularyResult> updateMedicalVocabularyAsync(UpdateMedicalVocabularyRequest updateMedicalVocabularyRequest)
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.
updateMedicalVocabularyRequest - Future<UpdateMedicalVocabularyResult> updateMedicalVocabularyAsync(UpdateMedicalVocabularyRequest updateMedicalVocabularyRequest, AsyncHandler<UpdateMedicalVocabularyRequest,UpdateMedicalVocabularyResult> asyncHandler)
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.
updateMedicalVocabularyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateVocabularyResult> updateVocabularyAsync(UpdateVocabularyRequest updateVocabularyRequest)
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.
updateVocabularyRequest - Future<UpdateVocabularyResult> updateVocabularyAsync(UpdateVocabularyRequest updateVocabularyRequest, AsyncHandler<UpdateVocabularyRequest,UpdateVocabularyResult> asyncHandler)
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.
updateVocabularyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateVocabularyFilterResult> updateVocabularyFilterAsync(UpdateVocabularyFilterRequest updateVocabularyFilterRequest)
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.
updateVocabularyFilterRequest - Future<UpdateVocabularyFilterResult> updateVocabularyFilterAsync(UpdateVocabularyFilterRequest updateVocabularyFilterRequest, AsyncHandler<UpdateVocabularyFilterRequest,UpdateVocabularyFilterResult> asyncHandler)
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.
updateVocabularyFilterRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.