Interface TranscribeAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic TranscribeAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aTranscribeAsyncClient
.static TranscribeAsyncClient
create()
Create aTranscribeAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createCallAnalyticsCategory
(Consumer<CreateCallAnalyticsCategoryRequest.Builder> createCallAnalyticsCategoryRequest) Creates a new Call Analytics category.createCallAnalyticsCategory
(CreateCallAnalyticsCategoryRequest createCallAnalyticsCategoryRequest) Creates a new Call Analytics category.createLanguageModel
(Consumer<CreateLanguageModelRequest.Builder> createLanguageModelRequest) Creates a new custom language model.createLanguageModel
(CreateLanguageModelRequest createLanguageModelRequest) Creates a new custom language model.createMedicalVocabulary
(Consumer<CreateMedicalVocabularyRequest.Builder> createMedicalVocabularyRequest) Creates a new custom medical vocabulary.createMedicalVocabulary
(CreateMedicalVocabularyRequest createMedicalVocabularyRequest) Creates a new custom medical vocabulary.createVocabulary
(Consumer<CreateVocabularyRequest.Builder> createVocabularyRequest) Creates a new custom vocabulary.createVocabulary
(CreateVocabularyRequest createVocabularyRequest) Creates a new custom vocabulary.createVocabularyFilter
(Consumer<CreateVocabularyFilterRequest.Builder> createVocabularyFilterRequest) Creates a new custom vocabulary filter.createVocabularyFilter
(CreateVocabularyFilterRequest createVocabularyFilterRequest) Creates a new custom vocabulary filter.deleteCallAnalyticsCategory
(Consumer<DeleteCallAnalyticsCategoryRequest.Builder> deleteCallAnalyticsCategoryRequest) Deletes a Call Analytics category.deleteCallAnalyticsCategory
(DeleteCallAnalyticsCategoryRequest deleteCallAnalyticsCategoryRequest) Deletes a Call Analytics category.deleteCallAnalyticsJob
(Consumer<DeleteCallAnalyticsJobRequest.Builder> deleteCallAnalyticsJobRequest) Deletes a Call Analytics job.deleteCallAnalyticsJob
(DeleteCallAnalyticsJobRequest deleteCallAnalyticsJobRequest) Deletes a Call Analytics job.deleteLanguageModel
(Consumer<DeleteLanguageModelRequest.Builder> deleteLanguageModelRequest) Deletes a custom language model.deleteLanguageModel
(DeleteLanguageModelRequest deleteLanguageModelRequest) Deletes a custom language model.deleteMedicalScribeJob
(Consumer<DeleteMedicalScribeJobRequest.Builder> deleteMedicalScribeJobRequest) Deletes a Medical Scribe job.deleteMedicalScribeJob
(DeleteMedicalScribeJobRequest deleteMedicalScribeJobRequest) Deletes a Medical Scribe job.deleteMedicalTranscriptionJob
(Consumer<DeleteMedicalTranscriptionJobRequest.Builder> deleteMedicalTranscriptionJobRequest) Deletes a medical transcription job.deleteMedicalTranscriptionJob
(DeleteMedicalTranscriptionJobRequest deleteMedicalTranscriptionJobRequest) Deletes a medical transcription job.deleteMedicalVocabulary
(Consumer<DeleteMedicalVocabularyRequest.Builder> deleteMedicalVocabularyRequest) Deletes a custom medical vocabulary.deleteMedicalVocabulary
(DeleteMedicalVocabularyRequest deleteMedicalVocabularyRequest) Deletes a custom medical vocabulary.deleteTranscriptionJob
(Consumer<DeleteTranscriptionJobRequest.Builder> deleteTranscriptionJobRequest) Deletes a transcription job.deleteTranscriptionJob
(DeleteTranscriptionJobRequest deleteTranscriptionJobRequest) Deletes a transcription job.deleteVocabulary
(Consumer<DeleteVocabularyRequest.Builder> deleteVocabularyRequest) Deletes a custom vocabulary.deleteVocabulary
(DeleteVocabularyRequest deleteVocabularyRequest) Deletes a custom vocabulary.deleteVocabularyFilter
(Consumer<DeleteVocabularyFilterRequest.Builder> deleteVocabularyFilterRequest) Deletes a custom vocabulary filter.deleteVocabularyFilter
(DeleteVocabularyFilterRequest deleteVocabularyFilterRequest) Deletes a custom vocabulary filter.describeLanguageModel
(Consumer<DescribeLanguageModelRequest.Builder> describeLanguageModelRequest) Provides information about the specified custom language model.describeLanguageModel
(DescribeLanguageModelRequest describeLanguageModelRequest) Provides information about the specified custom language model.getCallAnalyticsCategory
(Consumer<GetCallAnalyticsCategoryRequest.Builder> getCallAnalyticsCategoryRequest) Provides information about the specified Call Analytics category.getCallAnalyticsCategory
(GetCallAnalyticsCategoryRequest getCallAnalyticsCategoryRequest) Provides information about the specified Call Analytics category.getCallAnalyticsJob
(Consumer<GetCallAnalyticsJobRequest.Builder> getCallAnalyticsJobRequest) Provides information about the specified Call Analytics job.getCallAnalyticsJob
(GetCallAnalyticsJobRequest getCallAnalyticsJobRequest) Provides information about the specified Call Analytics job.getMedicalScribeJob
(Consumer<GetMedicalScribeJobRequest.Builder> getMedicalScribeJobRequest) Provides information about the specified Medical Scribe job.getMedicalScribeJob
(GetMedicalScribeJobRequest getMedicalScribeJobRequest) Provides information about the specified Medical Scribe job.getMedicalTranscriptionJob
(Consumer<GetMedicalTranscriptionJobRequest.Builder> getMedicalTranscriptionJobRequest) Provides information about the specified medical transcription job.getMedicalTranscriptionJob
(GetMedicalTranscriptionJobRequest getMedicalTranscriptionJobRequest) Provides information about the specified medical transcription job.getMedicalVocabulary
(Consumer<GetMedicalVocabularyRequest.Builder> getMedicalVocabularyRequest) Provides information about the specified custom medical vocabulary.getMedicalVocabulary
(GetMedicalVocabularyRequest getMedicalVocabularyRequest) Provides information about the specified custom medical vocabulary.getTranscriptionJob
(Consumer<GetTranscriptionJobRequest.Builder> getTranscriptionJobRequest) Provides information about the specified transcription job.getTranscriptionJob
(GetTranscriptionJobRequest getTranscriptionJobRequest) Provides information about the specified transcription job.default CompletableFuture
<GetVocabularyResponse> getVocabulary
(Consumer<GetVocabularyRequest.Builder> getVocabularyRequest) Provides information about the specified custom vocabulary.default CompletableFuture
<GetVocabularyResponse> getVocabulary
(GetVocabularyRequest getVocabularyRequest) Provides information about the specified custom vocabulary.getVocabularyFilter
(Consumer<GetVocabularyFilterRequest.Builder> getVocabularyFilterRequest) Provides information about the specified custom vocabulary filter.getVocabularyFilter
(GetVocabularyFilterRequest getVocabularyFilterRequest) Provides information about the specified custom vocabulary filter.listCallAnalyticsCategories
(Consumer<ListCallAnalyticsCategoriesRequest.Builder> listCallAnalyticsCategoriesRequest) Provides a list of Call Analytics categories, including all rules that make up each category.listCallAnalyticsCategories
(ListCallAnalyticsCategoriesRequest listCallAnalyticsCategoriesRequest) Provides a list of Call Analytics categories, including all rules that make up each category.listCallAnalyticsCategoriesPaginator
(Consumer<ListCallAnalyticsCategoriesRequest.Builder> listCallAnalyticsCategoriesRequest) This is a variant oflistCallAnalyticsCategories(software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsCategoriesRequest)
operation.listCallAnalyticsCategoriesPaginator
(ListCallAnalyticsCategoriesRequest listCallAnalyticsCategoriesRequest) This is a variant oflistCallAnalyticsCategories(software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsCategoriesRequest)
operation.listCallAnalyticsJobs
(Consumer<ListCallAnalyticsJobsRequest.Builder> listCallAnalyticsJobsRequest) Provides a list of Call Analytics jobs that match the specified criteria.listCallAnalyticsJobs
(ListCallAnalyticsJobsRequest listCallAnalyticsJobsRequest) Provides a list of Call Analytics jobs that match the specified criteria.default ListCallAnalyticsJobsPublisher
listCallAnalyticsJobsPaginator
(Consumer<ListCallAnalyticsJobsRequest.Builder> listCallAnalyticsJobsRequest) This is a variant oflistCallAnalyticsJobs(software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsJobsRequest)
operation.default ListCallAnalyticsJobsPublisher
listCallAnalyticsJobsPaginator
(ListCallAnalyticsJobsRequest listCallAnalyticsJobsRequest) This is a variant oflistCallAnalyticsJobs(software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsJobsRequest)
operation.listLanguageModels
(Consumer<ListLanguageModelsRequest.Builder> listLanguageModelsRequest) Provides a list of custom language models that match the specified criteria.listLanguageModels
(ListLanguageModelsRequest listLanguageModelsRequest) Provides a list of custom language models that match the specified criteria.default ListLanguageModelsPublisher
listLanguageModelsPaginator
(Consumer<ListLanguageModelsRequest.Builder> listLanguageModelsRequest) This is a variant oflistLanguageModels(software.amazon.awssdk.services.transcribe.model.ListLanguageModelsRequest)
operation.default ListLanguageModelsPublisher
listLanguageModelsPaginator
(ListLanguageModelsRequest listLanguageModelsRequest) This is a variant oflistLanguageModels(software.amazon.awssdk.services.transcribe.model.ListLanguageModelsRequest)
operation.listMedicalScribeJobs
(Consumer<ListMedicalScribeJobsRequest.Builder> listMedicalScribeJobsRequest) Provides a list of Medical Scribe jobs that match the specified criteria.listMedicalScribeJobs
(ListMedicalScribeJobsRequest listMedicalScribeJobsRequest) Provides a list of Medical Scribe jobs that match the specified criteria.default ListMedicalScribeJobsPublisher
listMedicalScribeJobsPaginator
(Consumer<ListMedicalScribeJobsRequest.Builder> listMedicalScribeJobsRequest) This is a variant oflistMedicalScribeJobs(software.amazon.awssdk.services.transcribe.model.ListMedicalScribeJobsRequest)
operation.default ListMedicalScribeJobsPublisher
listMedicalScribeJobsPaginator
(ListMedicalScribeJobsRequest listMedicalScribeJobsRequest) This is a variant oflistMedicalScribeJobs(software.amazon.awssdk.services.transcribe.model.ListMedicalScribeJobsRequest)
operation.listMedicalTranscriptionJobs
(Consumer<ListMedicalTranscriptionJobsRequest.Builder> listMedicalTranscriptionJobsRequest) Provides a list of medical transcription jobs that match the specified criteria.listMedicalTranscriptionJobs
(ListMedicalTranscriptionJobsRequest listMedicalTranscriptionJobsRequest) Provides a list of medical transcription jobs that match the specified criteria.listMedicalTranscriptionJobsPaginator
(Consumer<ListMedicalTranscriptionJobsRequest.Builder> listMedicalTranscriptionJobsRequest) This is a variant oflistMedicalTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListMedicalTranscriptionJobsRequest)
operation.listMedicalTranscriptionJobsPaginator
(ListMedicalTranscriptionJobsRequest listMedicalTranscriptionJobsRequest) This is a variant oflistMedicalTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListMedicalTranscriptionJobsRequest)
operation.listMedicalVocabularies
(Consumer<ListMedicalVocabulariesRequest.Builder> listMedicalVocabulariesRequest) Provides a list of custom medical vocabularies that match the specified criteria.listMedicalVocabularies
(ListMedicalVocabulariesRequest listMedicalVocabulariesRequest) Provides a list of custom medical vocabularies that match the specified criteria.default ListMedicalVocabulariesPublisher
listMedicalVocabulariesPaginator
(Consumer<ListMedicalVocabulariesRequest.Builder> listMedicalVocabulariesRequest) This is a variant oflistMedicalVocabularies(software.amazon.awssdk.services.transcribe.model.ListMedicalVocabulariesRequest)
operation.default ListMedicalVocabulariesPublisher
listMedicalVocabulariesPaginator
(ListMedicalVocabulariesRequest listMedicalVocabulariesRequest) This is a variant oflistMedicalVocabularies(software.amazon.awssdk.services.transcribe.model.ListMedicalVocabulariesRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists all tags associated with the specified transcription job, vocabulary, model, or resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags associated with the specified transcription job, vocabulary, model, or resource.Provides a list of transcription jobs that match the specified criteria.listTranscriptionJobs
(Consumer<ListTranscriptionJobsRequest.Builder> listTranscriptionJobsRequest) Provides a list of transcription jobs that match the specified criteria.listTranscriptionJobs
(ListTranscriptionJobsRequest listTranscriptionJobsRequest) Provides a list of transcription jobs that match the specified criteria.default ListTranscriptionJobsPublisher
This is a variant oflistTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsRequest)
operation.default ListTranscriptionJobsPublisher
listTranscriptionJobsPaginator
(Consumer<ListTranscriptionJobsRequest.Builder> listTranscriptionJobsRequest) This is a variant oflistTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsRequest)
operation.default ListTranscriptionJobsPublisher
listTranscriptionJobsPaginator
(ListTranscriptionJobsRequest listTranscriptionJobsRequest) This is a variant oflistTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsRequest)
operation.Provides a list of custom vocabularies that match the specified criteria.listVocabularies
(Consumer<ListVocabulariesRequest.Builder> listVocabulariesRequest) Provides a list of custom vocabularies that match the specified criteria.listVocabularies
(ListVocabulariesRequest listVocabulariesRequest) Provides a list of custom vocabularies that match the specified criteria.default ListVocabulariesPublisher
This is a variant oflistVocabularies(software.amazon.awssdk.services.transcribe.model.ListVocabulariesRequest)
operation.default ListVocabulariesPublisher
listVocabulariesPaginator
(Consumer<ListVocabulariesRequest.Builder> listVocabulariesRequest) This is a variant oflistVocabularies(software.amazon.awssdk.services.transcribe.model.ListVocabulariesRequest)
operation.default ListVocabulariesPublisher
listVocabulariesPaginator
(ListVocabulariesRequest listVocabulariesRequest) This is a variant oflistVocabularies(software.amazon.awssdk.services.transcribe.model.ListVocabulariesRequest)
operation.listVocabularyFilters
(Consumer<ListVocabularyFiltersRequest.Builder> listVocabularyFiltersRequest) Provides a list of custom vocabulary filters that match the specified criteria.listVocabularyFilters
(ListVocabularyFiltersRequest listVocabularyFiltersRequest) Provides a list of custom vocabulary filters that match the specified criteria.default ListVocabularyFiltersPublisher
listVocabularyFiltersPaginator
(Consumer<ListVocabularyFiltersRequest.Builder> listVocabularyFiltersRequest) This is a variant oflistVocabularyFilters(software.amazon.awssdk.services.transcribe.model.ListVocabularyFiltersRequest)
operation.default ListVocabularyFiltersPublisher
listVocabularyFiltersPaginator
(ListVocabularyFiltersRequest listVocabularyFiltersRequest) This is a variant oflistVocabularyFilters(software.amazon.awssdk.services.transcribe.model.ListVocabularyFiltersRequest)
operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartCallAnalyticsJob
(Consumer<StartCallAnalyticsJobRequest.Builder> startCallAnalyticsJobRequest) Transcribes the audio from a customer service call and applies any additional Request Parameters you choose to include in your request.startCallAnalyticsJob
(StartCallAnalyticsJobRequest startCallAnalyticsJobRequest) Transcribes the audio from a customer service call and applies any additional Request Parameters you choose to include in your request.startMedicalScribeJob
(Consumer<StartMedicalScribeJobRequest.Builder> startMedicalScribeJobRequest) Transcribes patient-clinician conversations and generates clinical notes.startMedicalScribeJob
(StartMedicalScribeJobRequest startMedicalScribeJobRequest) Transcribes patient-clinician conversations and generates clinical notes.startMedicalTranscriptionJob
(Consumer<StartMedicalTranscriptionJobRequest.Builder> startMedicalTranscriptionJobRequest) Transcribes the audio from a medical dictation or conversation and applies any additional Request Parameters you choose to include in your request.startMedicalTranscriptionJob
(StartMedicalTranscriptionJobRequest startMedicalTranscriptionJobRequest) Transcribes the audio from a medical dictation or conversation and applies any additional Request Parameters you choose to include in your request.startTranscriptionJob
(Consumer<StartTranscriptionJobRequest.Builder> startTranscriptionJobRequest) Transcribes the audio from a media file and applies any additional Request Parameters you choose to include in your request.startTranscriptionJob
(StartTranscriptionJobRequest startTranscriptionJobRequest) Transcribes the audio from a media file and applies any additional Request Parameters you choose to include in your request.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds one or more custom tags, each in the form of a key:value pair, to the specified resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds one or more custom tags, each in the form of a key:value pair, to the specified resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the specified tags from the specified Amazon Transcribe resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified Amazon Transcribe resource.updateCallAnalyticsCategory
(Consumer<UpdateCallAnalyticsCategoryRequest.Builder> updateCallAnalyticsCategoryRequest) Updates the specified Call Analytics category with new rules.updateCallAnalyticsCategory
(UpdateCallAnalyticsCategoryRequest updateCallAnalyticsCategoryRequest) Updates the specified Call Analytics category with new rules.updateMedicalVocabulary
(Consumer<UpdateMedicalVocabularyRequest.Builder> updateMedicalVocabularyRequest) Updates an existing custom medical vocabulary with new values.updateMedicalVocabulary
(UpdateMedicalVocabularyRequest updateMedicalVocabularyRequest) Updates an existing custom medical vocabulary with new values.updateVocabulary
(Consumer<UpdateVocabularyRequest.Builder> updateVocabularyRequest) Updates an existing custom vocabulary with new values.updateVocabulary
(UpdateVocabularyRequest updateVocabularyRequest) Updates an existing custom vocabulary with new values.updateVocabularyFilter
(Consumer<UpdateVocabularyFilterRequest.Builder> updateVocabularyFilterRequest) Updates an existing custom vocabulary filter with a new list of words.updateVocabularyFilter
(UpdateVocabularyFilterRequest updateVocabularyFilterRequest) Updates an existing custom vocabulary filter with a new list of words.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createCallAnalyticsCategory
default CompletableFuture<CreateCallAnalyticsCategoryResponse> createCallAnalyticsCategory(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 aPOST_CALL
or aREAL_TIME
category.POST_CALL
categories can only be applied to post-call transcriptions andREAL_TIME
categories can only be applied to real-time transcriptions. If you do not includeInputType
, your category is created as aPOST_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.
- Parameters:
createCallAnalyticsCategoryRequest
-- Returns:
- A Java Future containing the result of the CreateCallAnalyticsCategory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
createCallAnalyticsCategory
default CompletableFuture<CreateCallAnalyticsCategoryResponse> createCallAnalyticsCategory(Consumer<CreateCallAnalyticsCategoryRequest.Builder> 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 aPOST_CALL
or aREAL_TIME
category.POST_CALL
categories can only be applied to post-call transcriptions andREAL_TIME
categories can only be applied to real-time transcriptions. If you do not includeInputType
, your category is created as aPOST_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.
This is a convenience which creates an instance of the
CreateCallAnalyticsCategoryRequest.Builder
avoiding the need to create one manually viaCreateCallAnalyticsCategoryRequest.builder()
- Parameters:
createCallAnalyticsCategoryRequest
- AConsumer
that will call methods onCreateCallAnalyticsCategoryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateCallAnalyticsCategory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
createLanguageModel
default CompletableFuture<CreateLanguageModelResponse> createLanguageModel(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
- Parameters:
createLanguageModelRequest
-- Returns:
- A Java Future containing the result of the CreateLanguageModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
-
createLanguageModel
default CompletableFuture<CreateLanguageModelResponse> createLanguageModel(Consumer<CreateLanguageModelRequest.Builder> 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
This is a convenience which creates an instance of the
CreateLanguageModelRequest.Builder
avoiding the need to create one manually viaCreateLanguageModelRequest.builder()
- Parameters:
createLanguageModelRequest
- AConsumer
that will call methods onCreateLanguageModelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateLanguageModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
-
createMedicalVocabulary
default CompletableFuture<CreateMedicalVocabularyResponse> createMedicalVocabulary(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 thePhrases
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.
- Parameters:
createMedicalVocabularyRequest
-- Returns:
- A Java Future containing the result of the CreateMedicalVocabulary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
createMedicalVocabulary
default CompletableFuture<CreateMedicalVocabularyResponse> createMedicalVocabulary(Consumer<CreateMedicalVocabularyRequest.Builder> 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 thePhrases
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.
This is a convenience which creates an instance of the
CreateMedicalVocabularyRequest.Builder
avoiding the need to create one manually viaCreateMedicalVocabularyRequest.builder()
- Parameters:
createMedicalVocabularyRequest
- AConsumer
that will call methods onCreateMedicalVocabularyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateMedicalVocabulary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
createVocabulary
default CompletableFuture<CreateVocabularyResponse> createVocabulary(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.
- Parameters:
createVocabularyRequest
-- Returns:
- A Java Future containing the result of the CreateVocabulary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
createVocabulary
default CompletableFuture<CreateVocabularyResponse> createVocabulary(Consumer<CreateVocabularyRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateVocabularyRequest.Builder
avoiding the need to create one manually viaCreateVocabularyRequest.builder()
- Parameters:
createVocabularyRequest
- AConsumer
that will call methods onCreateVocabularyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateVocabulary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
createVocabularyFilter
default CompletableFuture<CreateVocabularyFilterResponse> createVocabularyFilter(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.
- Parameters:
createVocabularyFilterRequest
-- Returns:
- A Java Future containing the result of the CreateVocabularyFilter operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
createVocabularyFilter
default CompletableFuture<CreateVocabularyFilterResponse> createVocabularyFilter(Consumer<CreateVocabularyFilterRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateVocabularyFilterRequest.Builder
avoiding the need to create one manually viaCreateVocabularyFilterRequest.builder()
- Parameters:
createVocabularyFilterRequest
- AConsumer
that will call methods onCreateVocabularyFilterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateVocabularyFilter operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
deleteCallAnalyticsCategory
default CompletableFuture<DeleteCallAnalyticsCategoryResponse> deleteCallAnalyticsCategory(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.- Parameters:
deleteCallAnalyticsCategoryRequest
-- Returns:
- A Java Future containing the result of the DeleteCallAnalyticsCategory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCallAnalyticsCategory
default CompletableFuture<DeleteCallAnalyticsCategoryResponse> deleteCallAnalyticsCategory(Consumer<DeleteCallAnalyticsCategoryRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteCallAnalyticsCategoryRequest.Builder
avoiding the need to create one manually viaDeleteCallAnalyticsCategoryRequest.builder()
- Parameters:
deleteCallAnalyticsCategoryRequest
- AConsumer
that will call methods onDeleteCallAnalyticsCategoryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteCallAnalyticsCategory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCallAnalyticsJob
default CompletableFuture<DeleteCallAnalyticsJobResponse> deleteCallAnalyticsJob(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.- Parameters:
deleteCallAnalyticsJobRequest
-- Returns:
- A Java Future containing the result of the DeleteCallAnalyticsJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCallAnalyticsJob
default CompletableFuture<DeleteCallAnalyticsJobResponse> deleteCallAnalyticsJob(Consumer<DeleteCallAnalyticsJobRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteCallAnalyticsJobRequest.Builder
avoiding the need to create one manually viaDeleteCallAnalyticsJobRequest.builder()
- Parameters:
deleteCallAnalyticsJobRequest
- AConsumer
that will call methods onDeleteCallAnalyticsJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteCallAnalyticsJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteLanguageModel
default CompletableFuture<DeleteLanguageModelResponse> deleteLanguageModel(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.- Parameters:
deleteLanguageModelRequest
-- Returns:
- A Java Future containing the result of the DeleteLanguageModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
deleteLanguageModel
default CompletableFuture<DeleteLanguageModelResponse> deleteLanguageModel(Consumer<DeleteLanguageModelRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteLanguageModelRequest.Builder
avoiding the need to create one manually viaDeleteLanguageModelRequest.builder()
- Parameters:
deleteLanguageModelRequest
- AConsumer
that will call methods onDeleteLanguageModelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteLanguageModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
deleteMedicalScribeJob
default CompletableFuture<DeleteMedicalScribeJobResponse> deleteMedicalScribeJob(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.- Parameters:
deleteMedicalScribeJobRequest
-- Returns:
- A Java Future containing the result of the DeleteMedicalScribeJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMedicalScribeJob
default CompletableFuture<DeleteMedicalScribeJobResponse> deleteMedicalScribeJob(Consumer<DeleteMedicalScribeJobRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteMedicalScribeJobRequest.Builder
avoiding the need to create one manually viaDeleteMedicalScribeJobRequest.builder()
- Parameters:
deleteMedicalScribeJobRequest
- AConsumer
that will call methods onDeleteMedicalScribeJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteMedicalScribeJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMedicalTranscriptionJob
default CompletableFuture<DeleteMedicalTranscriptionJobResponse> deleteMedicalTranscriptionJob(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.- Parameters:
deleteMedicalTranscriptionJobRequest
-- Returns:
- A Java Future containing the result of the DeleteMedicalTranscriptionJob operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMedicalTranscriptionJob
default CompletableFuture<DeleteMedicalTranscriptionJobResponse> deleteMedicalTranscriptionJob(Consumer<DeleteMedicalTranscriptionJobRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteMedicalTranscriptionJobRequest.Builder
avoiding the need to create one manually viaDeleteMedicalTranscriptionJobRequest.builder()
- Parameters:
deleteMedicalTranscriptionJobRequest
- AConsumer
that will call methods onDeleteMedicalTranscriptionJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteMedicalTranscriptionJob operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMedicalVocabulary
default CompletableFuture<DeleteMedicalVocabularyResponse> deleteMedicalVocabulary(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.- Parameters:
deleteMedicalVocabularyRequest
-- Returns:
- A Java Future containing the result of the DeleteMedicalVocabulary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMedicalVocabulary
default CompletableFuture<DeleteMedicalVocabularyResponse> deleteMedicalVocabulary(Consumer<DeleteMedicalVocabularyRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteMedicalVocabularyRequest.Builder
avoiding the need to create one manually viaDeleteMedicalVocabularyRequest.builder()
- Parameters:
deleteMedicalVocabularyRequest
- AConsumer
that will call methods onDeleteMedicalVocabularyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteMedicalVocabulary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTranscriptionJob
default CompletableFuture<DeleteTranscriptionJobResponse> deleteTranscriptionJob(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.- Parameters:
deleteTranscriptionJobRequest
-- Returns:
- A Java Future containing the result of the DeleteTranscriptionJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTranscriptionJob
default CompletableFuture<DeleteTranscriptionJobResponse> deleteTranscriptionJob(Consumer<DeleteTranscriptionJobRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteTranscriptionJobRequest.Builder
avoiding the need to create one manually viaDeleteTranscriptionJobRequest.builder()
- Parameters:
deleteTranscriptionJobRequest
- AConsumer
that will call methods onDeleteTranscriptionJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteTranscriptionJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteVocabulary
default CompletableFuture<DeleteVocabularyResponse> deleteVocabulary(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.- Parameters:
deleteVocabularyRequest
-- Returns:
- A Java Future containing the result of the DeleteVocabulary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteVocabulary
default CompletableFuture<DeleteVocabularyResponse> deleteVocabulary(Consumer<DeleteVocabularyRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteVocabularyRequest.Builder
avoiding the need to create one manually viaDeleteVocabularyRequest.builder()
- Parameters:
deleteVocabularyRequest
- AConsumer
that will call methods onDeleteVocabularyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteVocabulary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteVocabularyFilter
default CompletableFuture<DeleteVocabularyFilterResponse> deleteVocabularyFilter(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.- Parameters:
deleteVocabularyFilterRequest
-- Returns:
- A Java Future containing the result of the DeleteVocabularyFilter operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteVocabularyFilter
default CompletableFuture<DeleteVocabularyFilterResponse> deleteVocabularyFilter(Consumer<DeleteVocabularyFilterRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteVocabularyFilterRequest.Builder
avoiding the need to create one manually viaDeleteVocabularyFilterRequest.builder()
- Parameters:
deleteVocabularyFilterRequest
- AConsumer
that will call methods onDeleteVocabularyFilterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteVocabularyFilter operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeLanguageModel
default CompletableFuture<DescribeLanguageModelResponse> describeLanguageModel(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.- Parameters:
describeLanguageModelRequest
-- Returns:
- A Java Future containing the result of the DescribeLanguageModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
describeLanguageModel
default CompletableFuture<DescribeLanguageModelResponse> describeLanguageModel(Consumer<DescribeLanguageModelRequest.Builder> 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.
This is a convenience which creates an instance of the
DescribeLanguageModelRequest.Builder
avoiding the need to create one manually viaDescribeLanguageModelRequest.builder()
- Parameters:
describeLanguageModelRequest
- AConsumer
that will call methods onDescribeLanguageModelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeLanguageModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
getCallAnalyticsCategory
default CompletableFuture<GetCallAnalyticsCategoryResponse> getCallAnalyticsCategory(GetCallAnalyticsCategoryRequest getCallAnalyticsCategoryRequest) Provides information about the specified Call Analytics category.
To get a list of your Call Analytics categories, use the operation.
- Parameters:
getCallAnalyticsCategoryRequest
-- Returns:
- A Java Future containing the result of the GetCallAnalyticsCategory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCallAnalyticsCategory
default CompletableFuture<GetCallAnalyticsCategoryResponse> getCallAnalyticsCategory(Consumer<GetCallAnalyticsCategoryRequest.Builder> getCallAnalyticsCategoryRequest) Provides information about the specified Call Analytics category.
To get a list of your Call Analytics categories, use the operation.
This is a convenience which creates an instance of the
GetCallAnalyticsCategoryRequest.Builder
avoiding the need to create one manually viaGetCallAnalyticsCategoryRequest.builder()
- Parameters:
getCallAnalyticsCategoryRequest
- AConsumer
that will call methods onGetCallAnalyticsCategoryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetCallAnalyticsCategory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCallAnalyticsJob
default CompletableFuture<GetCallAnalyticsJobResponse> getCallAnalyticsJob(GetCallAnalyticsJobRequest getCallAnalyticsJobRequest) Provides information about the specified Call Analytics job.
To view the job's status, refer to
CallAnalyticsJobStatus
. If the status isCOMPLETED
, the job is finished. You can find your completed transcript at the URI specified inTranscriptFileUri
. If the status isFAILED
,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.
- Parameters:
getCallAnalyticsJobRequest
-- Returns:
- A Java Future containing the result of the GetCallAnalyticsJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
getCallAnalyticsJob
default CompletableFuture<GetCallAnalyticsJobResponse> getCallAnalyticsJob(Consumer<GetCallAnalyticsJobRequest.Builder> getCallAnalyticsJobRequest) Provides information about the specified Call Analytics job.
To view the job's status, refer to
CallAnalyticsJobStatus
. If the status isCOMPLETED
, the job is finished. You can find your completed transcript at the URI specified inTranscriptFileUri
. If the status isFAILED
,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.
This is a convenience which creates an instance of the
GetCallAnalyticsJobRequest.Builder
avoiding the need to create one manually viaGetCallAnalyticsJobRequest.builder()
- Parameters:
getCallAnalyticsJobRequest
- AConsumer
that will call methods onGetCallAnalyticsJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetCallAnalyticsJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
getMedicalScribeJob
default CompletableFuture<GetMedicalScribeJobResponse> getMedicalScribeJob(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 isCOMPLETED
, the job is finished. You can find the results at the location specified inMedicalScribeOutput
. If the status isFAILED
,FailureReason
provides details on why your Medical Scribe job failed.To get a list of your Medical Scribe jobs, use the operation.
- Parameters:
getMedicalScribeJobRequest
-- Returns:
- A Java Future containing the result of the GetMedicalScribeJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
getMedicalScribeJob
default CompletableFuture<GetMedicalScribeJobResponse> getMedicalScribeJob(Consumer<GetMedicalScribeJobRequest.Builder> 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 isCOMPLETED
, the job is finished. You can find the results at the location specified inMedicalScribeOutput
. If the status isFAILED
,FailureReason
provides details on why your Medical Scribe job failed.To get a list of your Medical Scribe jobs, use the operation.
This is a convenience which creates an instance of the
GetMedicalScribeJobRequest.Builder
avoiding the need to create one manually viaGetMedicalScribeJobRequest.builder()
- Parameters:
getMedicalScribeJobRequest
- AConsumer
that will call methods onGetMedicalScribeJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetMedicalScribeJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
getMedicalTranscriptionJob
default CompletableFuture<GetMedicalTranscriptionJobResponse> getMedicalTranscriptionJob(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 isCOMPLETED
, the job is finished. You can find the results at the location specified inTranscriptFileUri
. If the status isFAILED
,FailureReason
provides details on why your transcription job failed.To get a list of your medical transcription jobs, use the operation.
- Parameters:
getMedicalTranscriptionJobRequest
-- Returns:
- A Java Future containing the result of the GetMedicalTranscriptionJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
getMedicalTranscriptionJob
default CompletableFuture<GetMedicalTranscriptionJobResponse> getMedicalTranscriptionJob(Consumer<GetMedicalTranscriptionJobRequest.Builder> 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 isCOMPLETED
, the job is finished. You can find the results at the location specified inTranscriptFileUri
. If the status isFAILED
,FailureReason
provides details on why your transcription job failed.To get a list of your medical transcription jobs, use the operation.
This is a convenience which creates an instance of the
GetMedicalTranscriptionJobRequest.Builder
avoiding the need to create one manually viaGetMedicalTranscriptionJobRequest.builder()
- Parameters:
getMedicalTranscriptionJobRequest
- AConsumer
that will call methods onGetMedicalTranscriptionJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetMedicalTranscriptionJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
getMedicalVocabulary
default CompletableFuture<GetMedicalVocabularyResponse> getMedicalVocabulary(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 isREADY
, your custom vocabulary is available to use. If the status isFAILED
,FailureReason
provides details on why your vocabulary failed.To get a list of your custom medical vocabularies, use the operation.
- Parameters:
getMedicalVocabularyRequest
-- Returns:
- A Java Future containing the result of the GetMedicalVocabulary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMedicalVocabulary
default CompletableFuture<GetMedicalVocabularyResponse> getMedicalVocabulary(Consumer<GetMedicalVocabularyRequest.Builder> 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 isREADY
, your custom vocabulary is available to use. If the status isFAILED
,FailureReason
provides details on why your vocabulary failed.To get a list of your custom medical vocabularies, use the operation.
This is a convenience which creates an instance of the
GetMedicalVocabularyRequest.Builder
avoiding the need to create one manually viaGetMedicalVocabularyRequest.builder()
- Parameters:
getMedicalVocabularyRequest
- AConsumer
that will call methods onGetMedicalVocabularyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetMedicalVocabulary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTranscriptionJob
default CompletableFuture<GetTranscriptionJobResponse> getTranscriptionJob(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 isCOMPLETED
, the job is finished. You can find the results at the location specified inTranscriptFileUri
. If the status isFAILED
,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.
- Parameters:
getTranscriptionJobRequest
-- Returns:
- A Java Future containing the result of the GetTranscriptionJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
getTranscriptionJob
default CompletableFuture<GetTranscriptionJobResponse> getTranscriptionJob(Consumer<GetTranscriptionJobRequest.Builder> getTranscriptionJobRequest) Provides information about the specified transcription job.
To view the status of the specified transcription job, check the
TranscriptionJobStatus
field. If the status isCOMPLETED
, the job is finished. You can find the results at the location specified inTranscriptFileUri
. If the status isFAILED
,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.
This is a convenience which creates an instance of the
GetTranscriptionJobRequest.Builder
avoiding the need to create one manually viaGetTranscriptionJobRequest.builder()
- Parameters:
getTranscriptionJobRequest
- AConsumer
that will call methods onGetTranscriptionJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetTranscriptionJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
getVocabulary
default CompletableFuture<GetVocabularyResponse> getVocabulary(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 isREADY
, your custom vocabulary is available to use. If the status isFAILED
,FailureReason
provides details on why your custom vocabulary failed.To get a list of your custom vocabularies, use the operation.
- Parameters:
getVocabularyRequest
-- Returns:
- A Java Future containing the result of the GetVocabulary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getVocabulary
default CompletableFuture<GetVocabularyResponse> getVocabulary(Consumer<GetVocabularyRequest.Builder> getVocabularyRequest) Provides information about the specified custom vocabulary.
To view the status of the specified custom vocabulary, check the
VocabularyState
field. If the status isREADY
, your custom vocabulary is available to use. If the status isFAILED
,FailureReason
provides details on why your custom vocabulary failed.To get a list of your custom vocabularies, use the operation.
This is a convenience which creates an instance of the
GetVocabularyRequest.Builder
avoiding the need to create one manually viaGetVocabularyRequest.builder()
- Parameters:
getVocabularyRequest
- AConsumer
that will call methods onGetVocabularyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetVocabulary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getVocabularyFilter
default CompletableFuture<GetVocabularyFilterResponse> getVocabularyFilter(GetVocabularyFilterRequest getVocabularyFilterRequest) Provides information about the specified custom vocabulary filter.
To get a list of your custom vocabulary filters, use the operation.
- Parameters:
getVocabularyFilterRequest
-- Returns:
- A Java Future containing the result of the GetVocabularyFilter operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getVocabularyFilter
default CompletableFuture<GetVocabularyFilterResponse> getVocabularyFilter(Consumer<GetVocabularyFilterRequest.Builder> getVocabularyFilterRequest) Provides information about the specified custom vocabulary filter.
To get a list of your custom vocabulary filters, use the operation.
This is a convenience which creates an instance of the
GetVocabularyFilterRequest.Builder
avoiding the need to create one manually viaGetVocabularyFilterRequest.builder()
- Parameters:
getVocabularyFilterRequest
- AConsumer
that will call methods onGetVocabularyFilterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetVocabularyFilter operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCallAnalyticsCategories
default CompletableFuture<ListCallAnalyticsCategoriesResponse> listCallAnalyticsCategories(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.
- Parameters:
listCallAnalyticsCategoriesRequest
-- Returns:
- A Java Future containing the result of the ListCallAnalyticsCategories operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listCallAnalyticsCategories
default CompletableFuture<ListCallAnalyticsCategoriesResponse> listCallAnalyticsCategories(Consumer<ListCallAnalyticsCategoriesRequest.Builder> 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.
This is a convenience which creates an instance of the
ListCallAnalyticsCategoriesRequest.Builder
avoiding the need to create one manually viaListCallAnalyticsCategoriesRequest.builder()
- Parameters:
listCallAnalyticsCategoriesRequest
- AConsumer
that will call methods onListCallAnalyticsCategoriesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCallAnalyticsCategories operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listCallAnalyticsCategoriesPaginator
default ListCallAnalyticsCategoriesPublisher listCallAnalyticsCategoriesPaginator(ListCallAnalyticsCategoriesRequest listCallAnalyticsCategoriesRequest) This is a variant of
listCallAnalyticsCategories(software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsCategoriesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transcribe.paginators.ListCallAnalyticsCategoriesPublisher publisher = client.listCallAnalyticsCategoriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transcribe.paginators.ListCallAnalyticsCategoriesPublisher publisher = client.listCallAnalyticsCategoriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsCategoriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsCategoriesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCallAnalyticsCategories(software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsCategoriesRequest)
operation.- Parameters:
listCallAnalyticsCategoriesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listCallAnalyticsCategoriesPaginator
default ListCallAnalyticsCategoriesPublisher listCallAnalyticsCategoriesPaginator(Consumer<ListCallAnalyticsCategoriesRequest.Builder> listCallAnalyticsCategoriesRequest) This is a variant of
listCallAnalyticsCategories(software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsCategoriesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transcribe.paginators.ListCallAnalyticsCategoriesPublisher publisher = client.listCallAnalyticsCategoriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transcribe.paginators.ListCallAnalyticsCategoriesPublisher publisher = client.listCallAnalyticsCategoriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsCategoriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsCategoriesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCallAnalyticsCategories(software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsCategoriesRequest)
operation.
This is a convenience which creates an instance of the
ListCallAnalyticsCategoriesRequest.Builder
avoiding the need to create one manually viaListCallAnalyticsCategoriesRequest.builder()
- Parameters:
listCallAnalyticsCategoriesRequest
- AConsumer
that will call methods onListCallAnalyticsCategoriesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listCallAnalyticsJobs
default CompletableFuture<ListCallAnalyticsJobsResponse> listCallAnalyticsJobs(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.
- Parameters:
listCallAnalyticsJobsRequest
-- Returns:
- A Java Future containing the result of the ListCallAnalyticsJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listCallAnalyticsJobs
default CompletableFuture<ListCallAnalyticsJobsResponse> listCallAnalyticsJobs(Consumer<ListCallAnalyticsJobsRequest.Builder> 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.
This is a convenience which creates an instance of the
ListCallAnalyticsJobsRequest.Builder
avoiding the need to create one manually viaListCallAnalyticsJobsRequest.builder()
- Parameters:
listCallAnalyticsJobsRequest
- AConsumer
that will call methods onListCallAnalyticsJobsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCallAnalyticsJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listCallAnalyticsJobsPaginator
default ListCallAnalyticsJobsPublisher listCallAnalyticsJobsPaginator(ListCallAnalyticsJobsRequest listCallAnalyticsJobsRequest) This is a variant of
listCallAnalyticsJobs(software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transcribe.paginators.ListCallAnalyticsJobsPublisher publisher = client.listCallAnalyticsJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transcribe.paginators.ListCallAnalyticsJobsPublisher publisher = client.listCallAnalyticsJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsJobsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCallAnalyticsJobs(software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsJobsRequest)
operation.- Parameters:
listCallAnalyticsJobsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listCallAnalyticsJobsPaginator
default ListCallAnalyticsJobsPublisher listCallAnalyticsJobsPaginator(Consumer<ListCallAnalyticsJobsRequest.Builder> listCallAnalyticsJobsRequest) This is a variant of
listCallAnalyticsJobs(software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transcribe.paginators.ListCallAnalyticsJobsPublisher publisher = client.listCallAnalyticsJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transcribe.paginators.ListCallAnalyticsJobsPublisher publisher = client.listCallAnalyticsJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsJobsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCallAnalyticsJobs(software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsJobsRequest)
operation.
This is a convenience which creates an instance of the
ListCallAnalyticsJobsRequest.Builder
avoiding the need to create one manually viaListCallAnalyticsJobsRequest.builder()
- Parameters:
listCallAnalyticsJobsRequest
- AConsumer
that will call methods onListCallAnalyticsJobsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listLanguageModels
default CompletableFuture<ListLanguageModelsResponse> listLanguageModels(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.
- Parameters:
listLanguageModelsRequest
-- Returns:
- A Java Future containing the result of the ListLanguageModels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listLanguageModels
default CompletableFuture<ListLanguageModelsResponse> listLanguageModels(Consumer<ListLanguageModelsRequest.Builder> 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.
This is a convenience which creates an instance of the
ListLanguageModelsRequest.Builder
avoiding the need to create one manually viaListLanguageModelsRequest.builder()
- Parameters:
listLanguageModelsRequest
- AConsumer
that will call methods onListLanguageModelsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListLanguageModels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listLanguageModelsPaginator
default ListLanguageModelsPublisher listLanguageModelsPaginator(ListLanguageModelsRequest listLanguageModelsRequest) This is a variant of
listLanguageModels(software.amazon.awssdk.services.transcribe.model.ListLanguageModelsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transcribe.paginators.ListLanguageModelsPublisher publisher = client.listLanguageModelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transcribe.paginators.ListLanguageModelsPublisher publisher = client.listLanguageModelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transcribe.model.ListLanguageModelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transcribe.model.ListLanguageModelsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLanguageModels(software.amazon.awssdk.services.transcribe.model.ListLanguageModelsRequest)
operation.- Parameters:
listLanguageModelsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listLanguageModelsPaginator
default ListLanguageModelsPublisher listLanguageModelsPaginator(Consumer<ListLanguageModelsRequest.Builder> listLanguageModelsRequest) This is a variant of
listLanguageModels(software.amazon.awssdk.services.transcribe.model.ListLanguageModelsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transcribe.paginators.ListLanguageModelsPublisher publisher = client.listLanguageModelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transcribe.paginators.ListLanguageModelsPublisher publisher = client.listLanguageModelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transcribe.model.ListLanguageModelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transcribe.model.ListLanguageModelsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLanguageModels(software.amazon.awssdk.services.transcribe.model.ListLanguageModelsRequest)
operation.
This is a convenience which creates an instance of the
ListLanguageModelsRequest.Builder
avoiding the need to create one manually viaListLanguageModelsRequest.builder()
- Parameters:
listLanguageModelsRequest
- AConsumer
that will call methods onListLanguageModelsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listMedicalScribeJobs
default CompletableFuture<ListMedicalScribeJobsResponse> listMedicalScribeJobs(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.
- Parameters:
listMedicalScribeJobsRequest
-- Returns:
- A Java Future containing the result of the ListMedicalScribeJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listMedicalScribeJobs
default CompletableFuture<ListMedicalScribeJobsResponse> listMedicalScribeJobs(Consumer<ListMedicalScribeJobsRequest.Builder> 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.
This is a convenience which creates an instance of the
ListMedicalScribeJobsRequest.Builder
avoiding the need to create one manually viaListMedicalScribeJobsRequest.builder()
- Parameters:
listMedicalScribeJobsRequest
- AConsumer
that will call methods onListMedicalScribeJobsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListMedicalScribeJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listMedicalScribeJobsPaginator
default ListMedicalScribeJobsPublisher listMedicalScribeJobsPaginator(ListMedicalScribeJobsRequest listMedicalScribeJobsRequest) This is a variant of
listMedicalScribeJobs(software.amazon.awssdk.services.transcribe.model.ListMedicalScribeJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transcribe.paginators.ListMedicalScribeJobsPublisher publisher = client.listMedicalScribeJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transcribe.paginators.ListMedicalScribeJobsPublisher publisher = client.listMedicalScribeJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transcribe.model.ListMedicalScribeJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transcribe.model.ListMedicalScribeJobsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMedicalScribeJobs(software.amazon.awssdk.services.transcribe.model.ListMedicalScribeJobsRequest)
operation.- Parameters:
listMedicalScribeJobsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listMedicalScribeJobsPaginator
default ListMedicalScribeJobsPublisher listMedicalScribeJobsPaginator(Consumer<ListMedicalScribeJobsRequest.Builder> listMedicalScribeJobsRequest) This is a variant of
listMedicalScribeJobs(software.amazon.awssdk.services.transcribe.model.ListMedicalScribeJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transcribe.paginators.ListMedicalScribeJobsPublisher publisher = client.listMedicalScribeJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transcribe.paginators.ListMedicalScribeJobsPublisher publisher = client.listMedicalScribeJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transcribe.model.ListMedicalScribeJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transcribe.model.ListMedicalScribeJobsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMedicalScribeJobs(software.amazon.awssdk.services.transcribe.model.ListMedicalScribeJobsRequest)
operation.
This is a convenience which creates an instance of the
ListMedicalScribeJobsRequest.Builder
avoiding the need to create one manually viaListMedicalScribeJobsRequest.builder()
- Parameters:
listMedicalScribeJobsRequest
- AConsumer
that will call methods onListMedicalScribeJobsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listMedicalTranscriptionJobs
default CompletableFuture<ListMedicalTranscriptionJobsResponse> listMedicalTranscriptionJobs(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.
- Parameters:
listMedicalTranscriptionJobsRequest
-- Returns:
- A Java Future containing the result of the ListMedicalTranscriptionJobs operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listMedicalTranscriptionJobs
default CompletableFuture<ListMedicalTranscriptionJobsResponse> listMedicalTranscriptionJobs(Consumer<ListMedicalTranscriptionJobsRequest.Builder> 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.
This is a convenience which creates an instance of the
ListMedicalTranscriptionJobsRequest.Builder
avoiding the need to create one manually viaListMedicalTranscriptionJobsRequest.builder()
- Parameters:
listMedicalTranscriptionJobsRequest
- AConsumer
that will call methods onListMedicalTranscriptionJobsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListMedicalTranscriptionJobs operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listMedicalTranscriptionJobsPaginator
default ListMedicalTranscriptionJobsPublisher listMedicalTranscriptionJobsPaginator(ListMedicalTranscriptionJobsRequest listMedicalTranscriptionJobsRequest) This is a variant of
listMedicalTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListMedicalTranscriptionJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transcribe.paginators.ListMedicalTranscriptionJobsPublisher publisher = client.listMedicalTranscriptionJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transcribe.paginators.ListMedicalTranscriptionJobsPublisher publisher = client.listMedicalTranscriptionJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transcribe.model.ListMedicalTranscriptionJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transcribe.model.ListMedicalTranscriptionJobsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMedicalTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListMedicalTranscriptionJobsRequest)
operation.- Parameters:
listMedicalTranscriptionJobsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listMedicalTranscriptionJobsPaginator
default ListMedicalTranscriptionJobsPublisher listMedicalTranscriptionJobsPaginator(Consumer<ListMedicalTranscriptionJobsRequest.Builder> listMedicalTranscriptionJobsRequest) This is a variant of
listMedicalTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListMedicalTranscriptionJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transcribe.paginators.ListMedicalTranscriptionJobsPublisher publisher = client.listMedicalTranscriptionJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transcribe.paginators.ListMedicalTranscriptionJobsPublisher publisher = client.listMedicalTranscriptionJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transcribe.model.ListMedicalTranscriptionJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transcribe.model.ListMedicalTranscriptionJobsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMedicalTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListMedicalTranscriptionJobsRequest)
operation.
This is a convenience which creates an instance of the
ListMedicalTranscriptionJobsRequest.Builder
avoiding the need to create one manually viaListMedicalTranscriptionJobsRequest.builder()
- Parameters:
listMedicalTranscriptionJobsRequest
- AConsumer
that will call methods onListMedicalTranscriptionJobsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listMedicalVocabularies
default CompletableFuture<ListMedicalVocabulariesResponse> listMedicalVocabularies(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.
- Parameters:
listMedicalVocabulariesRequest
-- Returns:
- A Java Future containing the result of the ListMedicalVocabularies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listMedicalVocabularies
default CompletableFuture<ListMedicalVocabulariesResponse> listMedicalVocabularies(Consumer<ListMedicalVocabulariesRequest.Builder> 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.
This is a convenience which creates an instance of the
ListMedicalVocabulariesRequest.Builder
avoiding the need to create one manually viaListMedicalVocabulariesRequest.builder()
- Parameters:
listMedicalVocabulariesRequest
- AConsumer
that will call methods onListMedicalVocabulariesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListMedicalVocabularies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listMedicalVocabulariesPaginator
default ListMedicalVocabulariesPublisher listMedicalVocabulariesPaginator(ListMedicalVocabulariesRequest listMedicalVocabulariesRequest) This is a variant of
listMedicalVocabularies(software.amazon.awssdk.services.transcribe.model.ListMedicalVocabulariesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transcribe.paginators.ListMedicalVocabulariesPublisher publisher = client.listMedicalVocabulariesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transcribe.paginators.ListMedicalVocabulariesPublisher publisher = client.listMedicalVocabulariesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transcribe.model.ListMedicalVocabulariesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transcribe.model.ListMedicalVocabulariesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMedicalVocabularies(software.amazon.awssdk.services.transcribe.model.ListMedicalVocabulariesRequest)
operation.- Parameters:
listMedicalVocabulariesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listMedicalVocabulariesPaginator
default ListMedicalVocabulariesPublisher listMedicalVocabulariesPaginator(Consumer<ListMedicalVocabulariesRequest.Builder> listMedicalVocabulariesRequest) This is a variant of
listMedicalVocabularies(software.amazon.awssdk.services.transcribe.model.ListMedicalVocabulariesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transcribe.paginators.ListMedicalVocabulariesPublisher publisher = client.listMedicalVocabulariesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transcribe.paginators.ListMedicalVocabulariesPublisher publisher = client.listMedicalVocabulariesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transcribe.model.ListMedicalVocabulariesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transcribe.model.ListMedicalVocabulariesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMedicalVocabularies(software.amazon.awssdk.services.transcribe.model.ListMedicalVocabulariesRequest)
operation.
This is a convenience which creates an instance of the
ListMedicalVocabulariesRequest.Builder
avoiding the need to create one manually viaListMedicalVocabulariesRequest.builder()
- Parameters:
listMedicalVocabulariesRequest
- AConsumer
that will call methods onListMedicalVocabulariesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(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.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> 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.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listTranscriptionJobs
default CompletableFuture<ListTranscriptionJobsResponse> listTranscriptionJobs(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.
- Parameters:
listTranscriptionJobsRequest
-- Returns:
- A Java Future containing the result of the ListTranscriptionJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listTranscriptionJobs
default CompletableFuture<ListTranscriptionJobsResponse> listTranscriptionJobs(Consumer<ListTranscriptionJobsRequest.Builder> 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.
This is a convenience which creates an instance of the
ListTranscriptionJobsRequest.Builder
avoiding the need to create one manually viaListTranscriptionJobsRequest.builder()
- Parameters:
listTranscriptionJobsRequest
- AConsumer
that will call methods onListTranscriptionJobsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTranscriptionJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listTranscriptionJobs
Provides a list of transcription jobs that match the specified criteria. If no criteria are specified, all transcription jobs are returned.
To get detailed information about a specific transcription job, use the operation.
- Returns:
- A Java Future containing the result of the ListTranscriptionJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listTranscriptionJobsPaginator
This is a variant of
listTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transcribe.paginators.ListTranscriptionJobsPublisher publisher = client.listTranscriptionJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transcribe.paginators.ListTranscriptionJobsPublisher publisher = client.listTranscriptionJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listTranscriptionJobsPaginator
default ListTranscriptionJobsPublisher listTranscriptionJobsPaginator(ListTranscriptionJobsRequest listTranscriptionJobsRequest) This is a variant of
listTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transcribe.paginators.ListTranscriptionJobsPublisher publisher = client.listTranscriptionJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transcribe.paginators.ListTranscriptionJobsPublisher publisher = client.listTranscriptionJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsRequest)
operation.- Parameters:
listTranscriptionJobsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listTranscriptionJobsPaginator
default ListTranscriptionJobsPublisher listTranscriptionJobsPaginator(Consumer<ListTranscriptionJobsRequest.Builder> listTranscriptionJobsRequest) This is a variant of
listTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transcribe.paginators.ListTranscriptionJobsPublisher publisher = client.listTranscriptionJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transcribe.paginators.ListTranscriptionJobsPublisher publisher = client.listTranscriptionJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsRequest)
operation.
This is a convenience which creates an instance of the
ListTranscriptionJobsRequest.Builder
avoiding the need to create one manually viaListTranscriptionJobsRequest.builder()
- Parameters:
listTranscriptionJobsRequest
- AConsumer
that will call methods onListTranscriptionJobsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listVocabularies
default CompletableFuture<ListVocabulariesResponse> listVocabularies(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.
- Parameters:
listVocabulariesRequest
-- Returns:
- A Java Future containing the result of the ListVocabularies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listVocabularies
default CompletableFuture<ListVocabulariesResponse> listVocabularies(Consumer<ListVocabulariesRequest.Builder> 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.
This is a convenience which creates an instance of the
ListVocabulariesRequest.Builder
avoiding the need to create one manually viaListVocabulariesRequest.builder()
- Parameters:
listVocabulariesRequest
- AConsumer
that will call methods onListVocabulariesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListVocabularies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listVocabularies
Provides a list of custom vocabularies that match the specified criteria. If no criteria are specified, all custom vocabularies are returned.
To get detailed information about a specific custom vocabulary, use the operation.
- Returns:
- A Java Future containing the result of the ListVocabularies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listVocabulariesPaginator
This is a variant of
listVocabularies(software.amazon.awssdk.services.transcribe.model.ListVocabulariesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transcribe.paginators.ListVocabulariesPublisher publisher = client.listVocabulariesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transcribe.paginators.ListVocabulariesPublisher publisher = client.listVocabulariesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transcribe.model.ListVocabulariesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transcribe.model.ListVocabulariesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVocabularies(software.amazon.awssdk.services.transcribe.model.ListVocabulariesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listVocabulariesPaginator
default ListVocabulariesPublisher listVocabulariesPaginator(ListVocabulariesRequest listVocabulariesRequest) This is a variant of
listVocabularies(software.amazon.awssdk.services.transcribe.model.ListVocabulariesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transcribe.paginators.ListVocabulariesPublisher publisher = client.listVocabulariesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transcribe.paginators.ListVocabulariesPublisher publisher = client.listVocabulariesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transcribe.model.ListVocabulariesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transcribe.model.ListVocabulariesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVocabularies(software.amazon.awssdk.services.transcribe.model.ListVocabulariesRequest)
operation.- Parameters:
listVocabulariesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listVocabulariesPaginator
default ListVocabulariesPublisher listVocabulariesPaginator(Consumer<ListVocabulariesRequest.Builder> listVocabulariesRequest) This is a variant of
listVocabularies(software.amazon.awssdk.services.transcribe.model.ListVocabulariesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transcribe.paginators.ListVocabulariesPublisher publisher = client.listVocabulariesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transcribe.paginators.ListVocabulariesPublisher publisher = client.listVocabulariesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transcribe.model.ListVocabulariesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transcribe.model.ListVocabulariesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVocabularies(software.amazon.awssdk.services.transcribe.model.ListVocabulariesRequest)
operation.
This is a convenience which creates an instance of the
ListVocabulariesRequest.Builder
avoiding the need to create one manually viaListVocabulariesRequest.builder()
- Parameters:
listVocabulariesRequest
- AConsumer
that will call methods onListVocabulariesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listVocabularyFilters
default CompletableFuture<ListVocabularyFiltersResponse> listVocabularyFilters(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.
- Parameters:
listVocabularyFiltersRequest
-- Returns:
- A Java Future containing the result of the ListVocabularyFilters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listVocabularyFilters
default CompletableFuture<ListVocabularyFiltersResponse> listVocabularyFilters(Consumer<ListVocabularyFiltersRequest.Builder> 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.
This is a convenience which creates an instance of the
ListVocabularyFiltersRequest.Builder
avoiding the need to create one manually viaListVocabularyFiltersRequest.builder()
- Parameters:
listVocabularyFiltersRequest
- AConsumer
that will call methods onListVocabularyFiltersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListVocabularyFilters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listVocabularyFiltersPaginator
default ListVocabularyFiltersPublisher listVocabularyFiltersPaginator(ListVocabularyFiltersRequest listVocabularyFiltersRequest) This is a variant of
listVocabularyFilters(software.amazon.awssdk.services.transcribe.model.ListVocabularyFiltersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transcribe.paginators.ListVocabularyFiltersPublisher publisher = client.listVocabularyFiltersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transcribe.paginators.ListVocabularyFiltersPublisher publisher = client.listVocabularyFiltersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transcribe.model.ListVocabularyFiltersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transcribe.model.ListVocabularyFiltersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVocabularyFilters(software.amazon.awssdk.services.transcribe.model.ListVocabularyFiltersRequest)
operation.- Parameters:
listVocabularyFiltersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
listVocabularyFiltersPaginator
default ListVocabularyFiltersPublisher listVocabularyFiltersPaginator(Consumer<ListVocabularyFiltersRequest.Builder> listVocabularyFiltersRequest) This is a variant of
listVocabularyFilters(software.amazon.awssdk.services.transcribe.model.ListVocabularyFiltersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.transcribe.paginators.ListVocabularyFiltersPublisher publisher = client.listVocabularyFiltersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.transcribe.paginators.ListVocabularyFiltersPublisher publisher = client.listVocabularyFiltersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.transcribe.model.ListVocabularyFiltersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.transcribe.model.ListVocabularyFiltersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listVocabularyFilters(software.amazon.awssdk.services.transcribe.model.ListVocabularyFiltersRequest)
operation.
This is a convenience which creates an instance of the
ListVocabularyFiltersRequest.Builder
avoiding the need to create one manually viaListVocabularyFiltersRequest.builder()
- Parameters:
listVocabularyFiltersRequest
- AConsumer
that will call methods onListVocabularyFiltersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
startCallAnalyticsJob
default CompletableFuture<StartCallAnalyticsJobResponse> startCallAnalyticsJob(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 theMedia
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
orRedactedMediaFileUri
): 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 ofMediaFileUri
, 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 theRedactedMediaFileUri
field of your response.- Parameters:
startCallAnalyticsJobRequest
-- Returns:
- A Java Future containing the result of the StartCallAnalyticsJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
-
startCallAnalyticsJob
default CompletableFuture<StartCallAnalyticsJobResponse> startCallAnalyticsJob(Consumer<StartCallAnalyticsJobRequest.Builder> 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 theMedia
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
orRedactedMediaFileUri
): 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 ofMediaFileUri
, 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 theRedactedMediaFileUri
field of your response.
This is a convenience which creates an instance of the
StartCallAnalyticsJobRequest.Builder
avoiding the need to create one manually viaStartCallAnalyticsJobRequest.builder()
- Parameters:
startCallAnalyticsJobRequest
- AConsumer
that will call methods onStartCallAnalyticsJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartCallAnalyticsJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
-
startMedicalScribeJob
default CompletableFuture<StartMedicalScribeJobResponse> startMedicalScribeJob(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 theMedia
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 inMedia
, write permission on the Amazon S3 bucket specified inOutputBucketName
, and full permissions on the KMS key specified inOutputEncryptionKMSKeyId
(if set). The role should also allowtranscribe.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
: AMedicalScribeSettings
obect that must set exactly one ofShowSpeakerLabels
orChannelIdentification
to true. IfShowSpeakerLabels
is true,MaxSpeakerLabels
must also be set. -
ChannelDefinitions
: AMedicalScribeChannelDefinitions
array should be set if and only if theChannelIdentification
value ofSettings
is set to true.
- Parameters:
startMedicalScribeJobRequest
-- Returns:
- A Java Future containing the result of the StartMedicalScribeJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
-
startMedicalScribeJob
default CompletableFuture<StartMedicalScribeJobResponse> startMedicalScribeJob(Consumer<StartMedicalScribeJobRequest.Builder> 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 theMedia
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 inMedia
, write permission on the Amazon S3 bucket specified inOutputBucketName
, and full permissions on the KMS key specified inOutputEncryptionKMSKeyId
(if set). The role should also allowtranscribe.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
: AMedicalScribeSettings
obect that must set exactly one ofShowSpeakerLabels
orChannelIdentification
to true. IfShowSpeakerLabels
is true,MaxSpeakerLabels
must also be set. -
ChannelDefinitions
: AMedicalScribeChannelDefinitions
array should be set if and only if theChannelIdentification
value ofSettings
is set to true.
This is a convenience which creates an instance of the
StartMedicalScribeJobRequest.Builder
avoiding the need to create one manually viaStartMedicalScribeJobRequest.builder()
- Parameters:
startMedicalScribeJobRequest
- AConsumer
that will call methods onStartMedicalScribeJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartMedicalScribeJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
-
startMedicalTranscriptionJob
default CompletableFuture<StartMedicalTranscriptionJobResponse> startMedicalTranscriptionJob(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 theMedia
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 been-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 includeOutputKey
. -
Specialty
: This must bePRIMARYCARE
. -
Type
: Choose whether your audio is a conversation or a dictation.
- Parameters:
startMedicalTranscriptionJobRequest
-- Returns:
- A Java Future containing the result of the StartMedicalTranscriptionJob operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
-
startMedicalTranscriptionJob
default CompletableFuture<StartMedicalTranscriptionJobResponse> startMedicalTranscriptionJob(Consumer<StartMedicalTranscriptionJobRequest.Builder> 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 theMedia
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 been-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 includeOutputKey
. -
Specialty
: This must bePRIMARYCARE
. -
Type
: Choose whether your audio is a conversation or a dictation.
This is a convenience which creates an instance of the
StartMedicalTranscriptionJobRequest.Builder
avoiding the need to create one manually viaStartMedicalTranscriptionJobRequest.builder()
- Parameters:
startMedicalTranscriptionJobRequest
- AConsumer
that will call methods onStartMedicalTranscriptionJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartMedicalTranscriptionJob operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
-
startTranscriptionJob
default CompletableFuture<StartTranscriptionJobResponse> startTranscriptionJob(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 theMedia
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
, orIdentifyMultipleLanguages
: If you know the language of your media file, specify it using theLanguageCode
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 eitherIdentifyLanguage
orIdentifyMultipleLanguages
and let Amazon Transcribe identify the languages for you.
- Parameters:
startTranscriptionJobRequest
-- Returns:
- A Java Future containing the result of the StartTranscriptionJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
-
startTranscriptionJob
default CompletableFuture<StartTranscriptionJobResponse> startTranscriptionJob(Consumer<StartTranscriptionJobRequest.Builder> 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 theMedia
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
, orIdentifyMultipleLanguages
: If you know the language of your media file, specify it using theLanguageCode
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 eitherIdentifyLanguage
orIdentifyMultipleLanguages
and let Amazon Transcribe identify the languages for you.
This is a convenience which creates an instance of the
StartTranscriptionJobRequest.Builder
avoiding the need to create one manually viaStartTranscriptionJobRequest.builder()
- Parameters:
startTranscriptionJobRequest
- AConsumer
that will call methods onStartTranscriptionJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartTranscriptionJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
-
tagResource
Adds one or more custom tags, each in the form of a key:value pair, to the specified resource.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> 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.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified Amazon Transcribe resource.
If you include
UntagResource
in your request, you must also includeResourceArn
andTagKeys
.- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the specified tags from the specified Amazon Transcribe resource.
If you include
UntagResource
in your request, you must also includeResourceArn
andTagKeys
.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCallAnalyticsCategory
default CompletableFuture<UpdateCallAnalyticsCategoryResponse> updateCallAnalyticsCategory(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 .
- Parameters:
updateCallAnalyticsCategoryRequest
-- Returns:
- A Java Future containing the result of the UpdateCallAnalyticsCategory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
updateCallAnalyticsCategory
default CompletableFuture<UpdateCallAnalyticsCategoryResponse> updateCallAnalyticsCategory(Consumer<UpdateCallAnalyticsCategoryRequest.Builder> 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 .
This is a convenience which creates an instance of the
UpdateCallAnalyticsCategoryRequest.Builder
avoiding the need to create one manually viaUpdateCallAnalyticsCategoryRequest.builder()
- Parameters:
updateCallAnalyticsCategoryRequest
- AConsumer
that will call methods onUpdateCallAnalyticsCategoryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateCallAnalyticsCategory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
updateMedicalVocabulary
default CompletableFuture<UpdateMedicalVocabularyResponse> updateMedicalVocabulary(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.
- Parameters:
updateMedicalVocabularyRequest
-- Returns:
- A Java Future containing the result of the UpdateMedicalVocabulary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
updateMedicalVocabulary
default CompletableFuture<UpdateMedicalVocabularyResponse> updateMedicalVocabulary(Consumer<UpdateMedicalVocabularyRequest.Builder> 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.
This is a convenience which creates an instance of the
UpdateMedicalVocabularyRequest.Builder
avoiding the need to create one manually viaUpdateMedicalVocabularyRequest.builder()
- Parameters:
updateMedicalVocabularyRequest
- AConsumer
that will call methods onUpdateMedicalVocabularyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateMedicalVocabulary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
updateVocabulary
default CompletableFuture<UpdateVocabularyResponse> updateVocabulary(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.
- Parameters:
updateVocabularyRequest
-- Returns:
- A Java Future containing the result of the UpdateVocabulary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
updateVocabulary
default CompletableFuture<UpdateVocabularyResponse> updateVocabulary(Consumer<UpdateVocabularyRequest.Builder> 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.
This is a convenience which creates an instance of the
UpdateVocabularyRequest.Builder
avoiding the need to create one manually viaUpdateVocabularyRequest.builder()
- Parameters:
updateVocabularyRequest
- AConsumer
that will call methods onUpdateVocabularyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateVocabulary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
updateVocabularyFilter
default CompletableFuture<UpdateVocabularyFilterResponse> updateVocabularyFilter(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.
- Parameters:
updateVocabularyFilterRequest
-- Returns:
- A Java Future containing the result of the UpdateVocabularyFilter operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
updateVocabularyFilter
default CompletableFuture<UpdateVocabularyFilterResponse> updateVocabularyFilter(Consumer<UpdateVocabularyFilterRequest.Builder> 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.
This is a convenience which creates an instance of the
UpdateVocabularyFilterRequest.Builder
avoiding the need to create one manually viaUpdateVocabularyFilterRequest.builder()
- Parameters:
updateVocabularyFilterRequest
- AConsumer
that will call methods onUpdateVocabularyFilterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateVocabularyFilter operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- TranscribeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- 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
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aTranscribeAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aTranscribeAsyncClient
.
-