@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonTranscribeClient extends AmazonWebServiceClient implements AmazonTranscribe
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
static AmazonTranscribeClientBuilder |
builder() |
CreateCallAnalyticsCategoryResult |
createCallAnalyticsCategory(CreateCallAnalyticsCategoryRequest request)
Creates a new Call Analytics category.
|
CreateLanguageModelResult |
createLanguageModel(CreateLanguageModelRequest request)
Creates a new custom language model.
|
CreateMedicalVocabularyResult |
createMedicalVocabulary(CreateMedicalVocabularyRequest request)
Creates a new custom medical vocabulary.
|
CreateVocabularyResult |
createVocabulary(CreateVocabularyRequest request)
Creates a new custom vocabulary.
|
CreateVocabularyFilterResult |
createVocabularyFilter(CreateVocabularyFilterRequest request)
Creates a new custom vocabulary filter.
|
DeleteCallAnalyticsCategoryResult |
deleteCallAnalyticsCategory(DeleteCallAnalyticsCategoryRequest request)
Deletes a Call Analytics category.
|
DeleteCallAnalyticsJobResult |
deleteCallAnalyticsJob(DeleteCallAnalyticsJobRequest request)
Deletes a Call Analytics job.
|
DeleteLanguageModelResult |
deleteLanguageModel(DeleteLanguageModelRequest request)
Deletes a custom language model.
|
DeleteMedicalTranscriptionJobResult |
deleteMedicalTranscriptionJob(DeleteMedicalTranscriptionJobRequest request)
Deletes a medical transcription job.
|
DeleteMedicalVocabularyResult |
deleteMedicalVocabulary(DeleteMedicalVocabularyRequest request)
Deletes a custom medical vocabulary.
|
DeleteTranscriptionJobResult |
deleteTranscriptionJob(DeleteTranscriptionJobRequest request)
Deletes a transcription job.
|
DeleteVocabularyResult |
deleteVocabulary(DeleteVocabularyRequest request)
Deletes a custom vocabulary.
|
DeleteVocabularyFilterResult |
deleteVocabularyFilter(DeleteVocabularyFilterRequest request)
Deletes a custom vocabulary filter.
|
DescribeLanguageModelResult |
describeLanguageModel(DescribeLanguageModelRequest request)
Provides information about the specified custom language model.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetCallAnalyticsCategoryResult |
getCallAnalyticsCategory(GetCallAnalyticsCategoryRequest request)
Provides information about the specified Call Analytics category.
|
GetCallAnalyticsJobResult |
getCallAnalyticsJob(GetCallAnalyticsJobRequest request)
Provides information about the specified Call Analytics job.
|
GetMedicalTranscriptionJobResult |
getMedicalTranscriptionJob(GetMedicalTranscriptionJobRequest request)
Provides information about the specified medical transcription job.
|
GetMedicalVocabularyResult |
getMedicalVocabulary(GetMedicalVocabularyRequest request)
Provides information about the specified custom medical vocabulary.
|
GetTranscriptionJobResult |
getTranscriptionJob(GetTranscriptionJobRequest request)
Provides information about the specified transcription job.
|
GetVocabularyResult |
getVocabulary(GetVocabularyRequest request)
Provides information about the specified custom vocabulary.
|
GetVocabularyFilterResult |
getVocabularyFilter(GetVocabularyFilterRequest request)
Provides information about the specified custom vocabulary filter.
|
ListCallAnalyticsCategoriesResult |
listCallAnalyticsCategories(ListCallAnalyticsCategoriesRequest request)
Provides a list of Call Analytics categories, including all rules that make up each category.
|
ListCallAnalyticsJobsResult |
listCallAnalyticsJobs(ListCallAnalyticsJobsRequest request)
Provides a list of Call Analytics jobs that match the specified criteria.
|
ListLanguageModelsResult |
listLanguageModels(ListLanguageModelsRequest request)
Provides a list of custom language models that match the specified criteria.
|
ListMedicalTranscriptionJobsResult |
listMedicalTranscriptionJobs(ListMedicalTranscriptionJobsRequest request)
Provides a list of medical transcription jobs that match the specified criteria.
|
ListMedicalVocabulariesResult |
listMedicalVocabularies(ListMedicalVocabulariesRequest request)
Provides a list of custom medical vocabularies that match the specified criteria.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists all tags associated with the specified transcription job, vocabulary, model, or resource.
|
ListTranscriptionJobsResult |
listTranscriptionJobs(ListTranscriptionJobsRequest request)
Provides a list of transcription jobs that match the specified criteria.
|
ListVocabulariesResult |
listVocabularies(ListVocabulariesRequest request)
Provides a list of custom vocabularies that match the specified criteria.
|
ListVocabularyFiltersResult |
listVocabularyFilters(ListVocabularyFiltersRequest request)
Provides a list of custom vocabulary filters that match the specified criteria.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartCallAnalyticsJobResult |
startCallAnalyticsJob(StartCallAnalyticsJobRequest request)
Transcribes the audio from a customer service call and applies any additional Request Parameters you choose to
include in your request.
|
StartMedicalTranscriptionJobResult |
startMedicalTranscriptionJob(StartMedicalTranscriptionJobRequest request)
Transcribes the audio from a medical dictation or conversation and applies any additional Request Parameters you
choose to include in your request.
|
StartTranscriptionJobResult |
startTranscriptionJob(StartTranscriptionJobRequest request)
Transcribes the audio from a media file and applies any additional Request Parameters you choose to include in
your request.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds one or more custom tags, each in the form of a key:value pair, to the specified resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes the specified tags from the specified Amazon Transcribe resource.
|
UpdateCallAnalyticsCategoryResult |
updateCallAnalyticsCategory(UpdateCallAnalyticsCategoryRequest request)
Updates the specified Call Analytics category with new rules.
|
UpdateMedicalVocabularyResult |
updateMedicalVocabulary(UpdateMedicalVocabularyRequest request)
Updates an existing custom medical vocabulary with new values.
|
UpdateVocabularyResult |
updateVocabulary(UpdateVocabularyRequest request)
Updates an existing custom vocabulary with new values.
|
UpdateVocabularyFilterResult |
updateVocabularyFilter(UpdateVocabularyFilterRequest request)
Updates an existing custom vocabulary filter with a new list of words.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetpublic static AmazonTranscribeClientBuilder builder()
public CreateCallAnalyticsCategoryResult createCallAnalyticsCategory(CreateCallAnalyticsCategoryRequest request)
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 batch
category (POST_CALL) or a streaming category (REAL_TIME). Batch categories can only be
applied to batch transcriptions and streaming categories can only be applied to streaming transcriptions. If you
do not include InputType, your category is created as a batch 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 batch transcriptions and Creating categories for streaming transcriptions.
createCallAnalyticsCategory in interface AmazonTranscribecreateCallAnalyticsCategoryRequest - BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.ConflictException - A resource already exists with this name. Resource names must be unique within an Amazon Web Services
account.public CreateLanguageModelResult createLanguageModel(CreateLanguageModelRequest request)
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
createLanguageModel in interface AmazonTranscribecreateLanguageModelRequest - BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.ConflictException - A resource already exists with this name. Resource names must be unique within an Amazon Web Services
account.public CreateMedicalVocabularyResult createMedicalVocabulary(CreateMedicalVocabularyRequest request)
Creates a new custom medical vocabulary.
Before creating a new custom medical vocabulary, you must first upload a text file that contains your new
entries, phrases, and terms 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.
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.
createMedicalVocabulary in interface AmazonTranscribecreateMedicalVocabularyRequest - BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.ConflictException - A resource already exists with this name. Resource names must be unique within an Amazon Web Services
account.public CreateVocabularyResult createVocabulary(CreateVocabularyRequest request)
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.
createVocabulary in interface AmazonTranscribecreateVocabularyRequest - BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.ConflictException - A resource already exists with this name. Resource names must be unique within an Amazon Web Services
account.public CreateVocabularyFilterResult createVocabularyFilter(CreateVocabularyFilterRequest request)
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.
createVocabularyFilter in interface AmazonTranscribecreateVocabularyFilterRequest - BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.ConflictException - A resource already exists with this name. Resource names must be unique within an Amazon Web Services
account.public DeleteCallAnalyticsCategoryResult deleteCallAnalyticsCategory(DeleteCallAnalyticsCategoryRequest request)
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.
deleteCallAnalyticsCategory in interface AmazonTranscribedeleteCallAnalyticsCategoryRequest - NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request
again.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.public DeleteCallAnalyticsJobResult deleteCallAnalyticsJob(DeleteCallAnalyticsJobRequest request)
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.
deleteCallAnalyticsJob in interface AmazonTranscribedeleteCallAnalyticsJobRequest - LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.public DeleteLanguageModelResult deleteLanguageModel(DeleteLanguageModelRequest request)
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.
deleteLanguageModel in interface AmazonTranscribedeleteLanguageModelRequest - BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.public DeleteMedicalTranscriptionJobResult deleteMedicalTranscriptionJob(DeleteMedicalTranscriptionJobRequest request)
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.
deleteMedicalTranscriptionJob in interface AmazonTranscribedeleteMedicalTranscriptionJobRequest - LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.public DeleteMedicalVocabularyResult deleteMedicalVocabulary(DeleteMedicalVocabularyRequest request)
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.
deleteMedicalVocabulary in interface AmazonTranscribedeleteMedicalVocabularyRequest - NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request
again.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.public DeleteTranscriptionJobResult deleteTranscriptionJob(DeleteTranscriptionJobRequest request)
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.
deleteTranscriptionJob in interface AmazonTranscribedeleteTranscriptionJobRequest - LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.public DeleteVocabularyResult deleteVocabulary(DeleteVocabularyRequest request)
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.
deleteVocabulary in interface AmazonTranscribedeleteVocabularyRequest - NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request
again.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.public DeleteVocabularyFilterResult deleteVocabularyFilter(DeleteVocabularyFilterRequest request)
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.
deleteVocabularyFilter in interface AmazonTranscribedeleteVocabularyFilterRequest - NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request
again.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.public DescribeLanguageModelResult describeLanguageModel(DescribeLanguageModelRequest request)
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.
describeLanguageModel in interface AmazonTranscribedescribeLanguageModelRequest - BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request
again.public GetCallAnalyticsCategoryResult getCallAnalyticsCategory(GetCallAnalyticsCategoryRequest request)
Provides information about the specified Call Analytics category.
To get a list of your Call Analytics categories, use the operation.
getCallAnalyticsCategory in interface AmazonTranscribegetCallAnalyticsCategoryRequest - NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request
again.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.public GetCallAnalyticsJobResult getCallAnalyticsJob(GetCallAnalyticsJobRequest request)
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.
getCallAnalyticsJob in interface AmazonTranscribegetCallAnalyticsJobRequest - BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request
again.public GetMedicalTranscriptionJobResult getMedicalTranscriptionJob(GetMedicalTranscriptionJobRequest request)
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.
getMedicalTranscriptionJob in interface AmazonTranscribegetMedicalTranscriptionJobRequest - BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request
again.public GetMedicalVocabularyResult getMedicalVocabulary(GetMedicalVocabularyRequest request)
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.
getMedicalVocabulary in interface AmazonTranscribegetMedicalVocabularyRequest - NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request
again.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.public GetTranscriptionJobResult getTranscriptionJob(GetTranscriptionJobRequest request)
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.
getTranscriptionJob in interface AmazonTranscribegetTranscriptionJobRequest - BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request
again.public GetVocabularyResult getVocabulary(GetVocabularyRequest request)
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.
getVocabulary in interface AmazonTranscribegetVocabularyRequest - NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request
again.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.public GetVocabularyFilterResult getVocabularyFilter(GetVocabularyFilterRequest request)
Provides information about the specified custom vocabulary filter.
To get a list of your custom vocabulary filters, use the operation.
getVocabularyFilter in interface AmazonTranscribegetVocabularyFilterRequest - NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request
again.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.public ListCallAnalyticsCategoriesResult listCallAnalyticsCategories(ListCallAnalyticsCategoriesRequest request)
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.
listCallAnalyticsCategories in interface AmazonTranscribelistCallAnalyticsCategoriesRequest - BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.public ListCallAnalyticsJobsResult listCallAnalyticsJobs(ListCallAnalyticsJobsRequest request)
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.
listCallAnalyticsJobs in interface AmazonTranscribelistCallAnalyticsJobsRequest - BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.public ListLanguageModelsResult listLanguageModels(ListLanguageModelsRequest request)
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.
listLanguageModels in interface AmazonTranscribelistLanguageModelsRequest - BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.public ListMedicalTranscriptionJobsResult listMedicalTranscriptionJobs(ListMedicalTranscriptionJobsRequest request)
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.
listMedicalTranscriptionJobs in interface AmazonTranscribelistMedicalTranscriptionJobsRequest - BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.public ListMedicalVocabulariesResult listMedicalVocabularies(ListMedicalVocabulariesRequest request)
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.
listMedicalVocabularies in interface AmazonTranscribelistMedicalVocabulariesRequest - BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
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.
listTagsForResource in interface AmazonTranscribelistTagsForResourceRequest - BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request
again.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.public ListTranscriptionJobsResult listTranscriptionJobs(ListTranscriptionJobsRequest request)
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.
listTranscriptionJobs in interface AmazonTranscribelistTranscriptionJobsRequest - BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.public ListVocabulariesResult listVocabularies(ListVocabulariesRequest request)
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.
listVocabularies in interface AmazonTranscribelistVocabulariesRequest - BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.public ListVocabularyFiltersResult listVocabularyFilters(ListVocabularyFiltersRequest request)
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.
listVocabularyFilters in interface AmazonTranscribelistVocabularyFiltersRequest - BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.public StartCallAnalyticsJobResult startCallAnalyticsJob(StartCallAnalyticsJobRequest request)
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 batch transcriptions and Creating categories for streaming 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.
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.
startCallAnalyticsJob in interface AmazonTranscribestartCallAnalyticsJobRequest - BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.ConflictException - A resource already exists with this name. Resource names must be unique within an Amazon Web Services
account.public StartMedicalTranscriptionJobResult startMedicalTranscriptionJob(StartMedicalTranscriptionJobRequest request)
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.
startMedicalTranscriptionJob in interface AmazonTranscribestartMedicalTranscriptionJobRequest - BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.ConflictException - A resource already exists with this name. Resource names must be unique within an Amazon Web Services
account.public StartTranscriptionJobResult startTranscriptionJob(StartTranscriptionJobRequest request)
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.
startTranscriptionJob in interface AmazonTranscribestartTranscriptionJobRequest - BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.ConflictException - A resource already exists with this name. Resource names must be unique within an Amazon Web Services
account.public TagResourceResult tagResource(TagResourceRequest request)
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.
tagResource in interface AmazonTranscribetagResourceRequest - BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.ConflictException - A resource already exists with this name. Resource names must be unique within an Amazon Web Services
account.NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request
again.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes the specified tags from the specified Amazon Transcribe resource.
If you include UntagResource in your request, you must also include ResourceArn and
TagKeys.
untagResource in interface AmazonTranscribeuntagResourceRequest - LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.ConflictException - A resource already exists with this name. Resource names must be unique within an Amazon Web Services
account.NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request
again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.public UpdateCallAnalyticsCategoryResult updateCallAnalyticsCategory(UpdateCallAnalyticsCategoryRequest request)
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 .
updateCallAnalyticsCategory in interface AmazonTranscribeupdateCallAnalyticsCategoryRequest - BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request
again.ConflictException - A resource already exists with this name. Resource names must be unique within an Amazon Web Services
account.public UpdateMedicalVocabularyResult updateMedicalVocabulary(UpdateMedicalVocabularyRequest request)
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.
updateMedicalVocabulary in interface AmazonTranscribeupdateMedicalVocabularyRequest - BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request
again.ConflictException - A resource already exists with this name. Resource names must be unique within an Amazon Web Services
account.public UpdateVocabularyResult updateVocabulary(UpdateVocabularyRequest request)
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.
updateVocabulary in interface AmazonTranscribeupdateVocabularyRequest - BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request
again.ConflictException - A resource already exists with this name. Resource names must be unique within an Amazon Web Services
account.public UpdateVocabularyFilterResult updateVocabularyFilter(UpdateVocabularyFilterRequest request)
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.
updateVocabularyFilter in interface AmazonTranscribeupdateVocabularyFilterRequest - BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to
delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the
exception message field for more information.LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request,
or use a smaller file and try your request again.InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request
again.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AmazonTranscriberequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AmazonTranscribeshutdown in class AmazonWebServiceClient