software.amazon.awssdk.services.transcribe

Interface TranscribeClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface TranscribeClient
extends SdkClient

Service client for accessing Amazon Transcribe Service. This can be created using the static builder() method.

Operations and objects for transcribing speech to text.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static TranscribeClientBuilder	builder() Create a builder that can be used to configure and create a TranscribeClient.
static TranscribeClient	create() Create a TranscribeClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateVocabularyResponse	createVocabulary(Consumer<CreateVocabularyRequest.Builder> createVocabularyRequest) Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.
default CreateVocabularyResponse	createVocabulary(CreateVocabularyRequest createVocabularyRequest) Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.
default DeleteTranscriptionJobResponse	deleteTranscriptionJob(Consumer<DeleteTranscriptionJobRequest.Builder> deleteTranscriptionJobRequest) Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on.
default DeleteTranscriptionJobResponse	deleteTranscriptionJob(DeleteTranscriptionJobRequest deleteTranscriptionJobRequest) Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on.
default DeleteVocabularyResponse	deleteVocabulary(Consumer<DeleteVocabularyRequest.Builder> deleteVocabularyRequest) Deletes a vocabulary from Amazon Transcribe.
default DeleteVocabularyResponse	deleteVocabulary(DeleteVocabularyRequest deleteVocabularyRequest) Deletes a vocabulary from Amazon Transcribe.
default GetTranscriptionJobResponse	getTranscriptionJob(Consumer<GetTranscriptionJobRequest.Builder> getTranscriptionJobRequest) Returns information about a transcription job.
default GetTranscriptionJobResponse	getTranscriptionJob(GetTranscriptionJobRequest getTranscriptionJobRequest) Returns information about a transcription job.
default GetVocabularyResponse	getVocabulary(Consumer<GetVocabularyRequest.Builder> getVocabularyRequest) Gets information about a vocabulary.
default GetVocabularyResponse	getVocabulary(GetVocabularyRequest getVocabularyRequest) Gets information about a vocabulary.
default ListTranscriptionJobsResponse	listTranscriptionJobs() Lists transcription jobs with the specified status.
default ListTranscriptionJobsResponse	listTranscriptionJobs(Consumer<ListTranscriptionJobsRequest.Builder> listTranscriptionJobsRequest) Lists transcription jobs with the specified status.
default ListTranscriptionJobsResponse	listTranscriptionJobs(ListTranscriptionJobsRequest listTranscriptionJobsRequest) Lists transcription jobs with the specified status.
default ListTranscriptionJobsIterable	listTranscriptionJobsPaginator() Lists transcription jobs with the specified status.
default ListTranscriptionJobsIterable	listTranscriptionJobsPaginator(Consumer<ListTranscriptionJobsRequest.Builder> listTranscriptionJobsRequest) Lists transcription jobs with the specified status.
default ListTranscriptionJobsIterable	listTranscriptionJobsPaginator(ListTranscriptionJobsRequest listTranscriptionJobsRequest) Lists transcription jobs with the specified status.
default ListVocabulariesResponse	listVocabularies() Returns a list of vocabularies that match the specified criteria.
default ListVocabulariesResponse	listVocabularies(Consumer<ListVocabulariesRequest.Builder> listVocabulariesRequest) Returns a list of vocabularies that match the specified criteria.
default ListVocabulariesResponse	listVocabularies(ListVocabulariesRequest listVocabulariesRequest) Returns a list of vocabularies that match the specified criteria.
default ListVocabulariesIterable	listVocabulariesPaginator() Returns a list of vocabularies that match the specified criteria.
default ListVocabulariesIterable	listVocabulariesPaginator(Consumer<ListVocabulariesRequest.Builder> listVocabulariesRequest) Returns a list of vocabularies that match the specified criteria.
default ListVocabulariesIterable	listVocabulariesPaginator(ListVocabulariesRequest listVocabulariesRequest) Returns a list of vocabularies that match the specified criteria.
static ServiceMetadata	serviceMetadata()
default StartTranscriptionJobResponse	startTranscriptionJob(Consumer<StartTranscriptionJobRequest.Builder> startTranscriptionJobRequest) Starts an asynchronous job to transcribe speech to text.
default StartTranscriptionJobResponse	startTranscriptionJob(StartTranscriptionJobRequest startTranscriptionJobRequest) Starts an asynchronous job to transcribe speech to text.
default UpdateVocabularyResponse	updateVocabulary(Consumer<UpdateVocabularyRequest.Builder> updateVocabularyRequest) Updates an existing vocabulary with new values.
default UpdateVocabularyResponse	updateVocabulary(UpdateVocabularyRequest updateVocabularyRequest) Updates an existing vocabulary with new values.

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static TranscribeClient create()

Create a TranscribeClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static TranscribeClientBuilder builder()

Create a builder that can be used to configure and create a TranscribeClient.

createVocabulary

default CreateVocabularyResponse createVocabulary(CreateVocabularyRequest createVocabularyRequest)
                                           throws BadRequestException,
                                                  LimitExceededException,
                                                  InternalFailureException,
                                                  ConflictException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  TranscribeException

Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file. Note that vocabularies for en-AU, en-UK, and fr-CA languages that are in preview are not available. In the console, the vocabulary section will be greyed-out and SDK will return error message.

Parameters:

createVocabularyRequest -

Returns:

Result of the CreateVocabulary operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the transcription you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

ConflictException - When you are using the StartTranscriptionJob operation, the JobName field is a duplicate of a previously entered job name. Resend your request with a different name.

When you are using the UpdateVocabulary operation, there are two jobs running at the same time. Resend the second request later.

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.

AwsServiceException

See Also:

AWS API Documentation

createVocabulary

default CreateVocabularyResponse createVocabulary(Consumer<CreateVocabularyRequest.Builder> createVocabularyRequest)
                                           throws BadRequestException,
                                                  LimitExceededException,
                                                  InternalFailureException,
                                                  ConflictException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  TranscribeException

Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file. Note that vocabularies for en-AU, en-UK, and fr-CA languages that are in preview are not available. In the console, the vocabulary section will be greyed-out and SDK will return error message.

This is a convenience which creates an instance of the CreateVocabularyRequest.Builder avoiding the need to create one manually via CreateVocabularyRequest.builder()

Parameters:

createVocabularyRequest - A Consumer that will call methods on CreateVocabularyRequest.Builder to create a request.

Returns:

Result of the CreateVocabulary operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the transcription you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

ConflictException - When you are using the StartTranscriptionJob operation, the JobName field is a duplicate of a previously entered job name. Resend your request with a different name.

When you are using the UpdateVocabulary operation, there are two jobs running at the same time. Resend the second request later.

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.

AwsServiceException

See Also:

AWS API Documentation

deleteTranscriptionJob

default DeleteTranscriptionJobResponse deleteTranscriptionJob(DeleteTranscriptionJobRequest deleteTranscriptionJobRequest)
                                                       throws LimitExceededException,
                                                              BadRequestException,
                                                              InternalFailureException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              TranscribeException

Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on.

Parameters:

deleteTranscriptionJobRequest -

Returns:

Result of the DeleteTranscriptionJob operation returned by the service.

Throws:

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

BadRequestException - Your request didn't pass one or more validation tests. For example, if the transcription you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

InternalFailureException - There was an internal error. Check the error message 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.

AwsServiceException

See Also:

AWS API Documentation

deleteTranscriptionJob

default DeleteTranscriptionJobResponse deleteTranscriptionJob(Consumer<DeleteTranscriptionJobRequest.Builder> deleteTranscriptionJobRequest)
                                                       throws LimitExceededException,
                                                              BadRequestException,
                                                              InternalFailureException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              TranscribeException

Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on.

This is a convenience which creates an instance of the DeleteTranscriptionJobRequest.Builder avoiding the need to create one manually via DeleteTranscriptionJobRequest.builder()

Parameters:

deleteTranscriptionJobRequest - A Consumer that will call methods on DeleteTranscriptionJobRequest.Builder to create a request.

Returns:

Result of the DeleteTranscriptionJob operation returned by the service.

Throws:

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

BadRequestException - Your request didn't pass one or more validation tests. For example, if the transcription you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

InternalFailureException - There was an internal error. Check the error message 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.

AwsServiceException

See Also:

AWS API Documentation

deleteVocabulary

default DeleteVocabularyResponse deleteVocabulary(DeleteVocabularyRequest deleteVocabularyRequest)
                                           throws NotFoundException,
                                                  LimitExceededException,
                                                  BadRequestException,
                                                  InternalFailureException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  TranscribeException

Deletes a vocabulary from Amazon Transcribe.

Parameters:

deleteVocabularyRequest -

Returns:

Result of the DeleteVocabulary operation returned by the service.

Throws:

NotFoundException - We can't find the requested resource. Check the name and try your request again.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

BadRequestException - Your request didn't pass one or more validation tests. For example, if the transcription you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

InternalFailureException - There was an internal error. Check the error message 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.

AwsServiceException

See Also:

AWS API Documentation

deleteVocabulary

default DeleteVocabularyResponse deleteVocabulary(Consumer<DeleteVocabularyRequest.Builder> deleteVocabularyRequest)
                                           throws NotFoundException,
                                                  LimitExceededException,
                                                  BadRequestException,
                                                  InternalFailureException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  TranscribeException

Deletes a vocabulary from Amazon Transcribe.

This is a convenience which creates an instance of the DeleteVocabularyRequest.Builder avoiding the need to create one manually via DeleteVocabularyRequest.builder()

Parameters:

deleteVocabularyRequest - A Consumer that will call methods on DeleteVocabularyRequest.Builder to create a request.

Returns:

Result of the DeleteVocabulary operation returned by the service.

Throws:

NotFoundException - We can't find the requested resource. Check the name and try your request again.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

BadRequestException - Your request didn't pass one or more validation tests. For example, if the transcription you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

InternalFailureException - There was an internal error. Check the error message 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.

AwsServiceException

See Also:

AWS API Documentation

getTranscriptionJob

default GetTranscriptionJobResponse getTranscriptionJob(GetTranscriptionJobRequest getTranscriptionJobRequest)
                                                 throws BadRequestException,
                                                        LimitExceededException,
                                                        InternalFailureException,
                                                        NotFoundException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        TranscribeException

Returns information about a transcription job. To see the status of the job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the location specified in the TranscriptionFileUri field.

Parameters:

getTranscriptionJobRequest -

Returns:

Result of the GetTranscriptionJob operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the transcription you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

NotFoundException - We can't find the requested resource. Check the name 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.

AwsServiceException

See Also:

AWS API Documentation

getTranscriptionJob

default GetTranscriptionJobResponse getTranscriptionJob(Consumer<GetTranscriptionJobRequest.Builder> getTranscriptionJobRequest)
                                                 throws BadRequestException,
                                                        LimitExceededException,
                                                        InternalFailureException,
                                                        NotFoundException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        TranscribeException

Returns information about a transcription job. To see the status of the job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the location specified in the TranscriptionFileUri field.

This is a convenience which creates an instance of the GetTranscriptionJobRequest.Builder avoiding the need to create one manually via GetTranscriptionJobRequest.builder()

Parameters:

getTranscriptionJobRequest - A Consumer that will call methods on GetTranscriptionJobRequest.Builder to create a request.

Returns:

Result of the GetTranscriptionJob operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the transcription you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

NotFoundException - We can't find the requested resource. Check the name 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.

AwsServiceException

See Also:

AWS API Documentation

getVocabulary

default GetVocabularyResponse getVocabulary(GetVocabularyRequest getVocabularyRequest)
                                     throws NotFoundException,
                                            LimitExceededException,
                                            InternalFailureException,
                                            BadRequestException,
                                            AwsServiceException,
                                            SdkClientException,
                                            TranscribeException

Gets information about a vocabulary. Note that vocabularies for en-AU, en-UK, and fr-CA languages that are in preview are not available. In the console, the vocabulary section will be greyed-out and SDK will return error message.

Parameters:

getVocabularyRequest -

Returns:

Result of the GetVocabulary operation returned by the service.

Throws:

NotFoundException - We can't find the requested resource. Check the name and try your request again.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

BadRequestException - Your request didn't pass one or more validation tests. For example, if the transcription you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "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.

AwsServiceException

See Also:

AWS API Documentation

getVocabulary

default GetVocabularyResponse getVocabulary(Consumer<GetVocabularyRequest.Builder> getVocabularyRequest)
                                     throws NotFoundException,
                                            LimitExceededException,
                                            InternalFailureException,
                                            BadRequestException,
                                            AwsServiceException,
                                            SdkClientException,
                                            TranscribeException

Gets information about a vocabulary. Note that vocabularies for en-AU, en-UK, and fr-CA languages that are in preview are not available. In the console, the vocabulary section will be greyed-out and SDK will return error message.

This is a convenience which creates an instance of the GetVocabularyRequest.Builder avoiding the need to create one manually via GetVocabularyRequest.builder()

Parameters:

getVocabularyRequest - A Consumer that will call methods on GetVocabularyRequest.Builder to create a request.

Returns:

Result of the GetVocabulary operation returned by the service.

Throws:

NotFoundException - We can't find the requested resource. Check the name and try your request again.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

BadRequestException - Your request didn't pass one or more validation tests. For example, if the transcription you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "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.

AwsServiceException

See Also:

AWS API Documentation

listTranscriptionJobs

default ListTranscriptionJobsResponse listTranscriptionJobs()
                                                     throws BadRequestException,
                                                            LimitExceededException,
                                                            InternalFailureException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            TranscribeException

Lists transcription jobs with the specified status.

Returns:

Result of the ListTranscriptionJobs operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the transcription you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message 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.

AwsServiceException

See Also:

listTranscriptionJobs(ListTranscriptionJobsRequest), AWS API Documentation

listTranscriptionJobs

default ListTranscriptionJobsResponse listTranscriptionJobs(ListTranscriptionJobsRequest listTranscriptionJobsRequest)
                                                     throws BadRequestException,
                                                            LimitExceededException,
                                                            InternalFailureException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            TranscribeException

Lists transcription jobs with the specified status.

Parameters:

listTranscriptionJobsRequest -

Returns:

Result of the ListTranscriptionJobs operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the transcription you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message 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.

AwsServiceException

See Also:

AWS API Documentation

listTranscriptionJobs

default ListTranscriptionJobsResponse listTranscriptionJobs(Consumer<ListTranscriptionJobsRequest.Builder> listTranscriptionJobsRequest)
                                                     throws BadRequestException,
                                                            LimitExceededException,
                                                            InternalFailureException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            TranscribeException

Lists transcription jobs with the specified status.

This is a convenience which creates an instance of the ListTranscriptionJobsRequest.Builder avoiding the need to create one manually via ListTranscriptionJobsRequest.builder()

Parameters:

listTranscriptionJobsRequest - A Consumer that will call methods on ListTranscriptionJobsRequest.Builder to create a request.

Returns:

Result of the ListTranscriptionJobs operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the transcription you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message 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.

AwsServiceException

See Also:

AWS API Documentation

listTranscriptionJobsPaginator

default ListTranscriptionJobsIterable listTranscriptionJobsPaginator()
                                                              throws BadRequestException,
                                                                     LimitExceededException,
                                                                     InternalFailureException,
                                                                     AwsServiceException,
                                                                     SdkClientException,
                                                                     TranscribeException

Lists transcription jobs with the specified status.

This is a variant of listTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.transcribe.paginators.ListTranscriptionJobsIterable responses = client.listTranscriptionJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.transcribe.paginators.ListTranscriptionJobsIterable responses = client
             .listTranscriptionJobsPaginator(request);
     for (software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.transcribe.paginators.ListTranscriptionJobsIterable responses = client.listTranscriptionJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Note: If you prefer to have control on service calls, use the listTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsRequest) operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the transcription you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message 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.

AwsServiceException

See Also:

listTranscriptionJobsPaginator(ListTranscriptionJobsRequest), AWS API Documentation

listTranscriptionJobsPaginator

default ListTranscriptionJobsIterable listTranscriptionJobsPaginator(ListTranscriptionJobsRequest listTranscriptionJobsRequest)
                                                              throws BadRequestException,
                                                                     LimitExceededException,
                                                                     InternalFailureException,
                                                                     AwsServiceException,
                                                                     SdkClientException,
                                                                     TranscribeException

Lists transcription jobs with the specified status.

This is a variant of listTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.transcribe.paginators.ListTranscriptionJobsIterable responses = client.listTranscriptionJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.transcribe.paginators.ListTranscriptionJobsIterable responses = client
             .listTranscriptionJobsPaginator(request);
     for (software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.transcribe.paginators.ListTranscriptionJobsIterable responses = client.listTranscriptionJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the transcription you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message 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.

AwsServiceException

See Also:

AWS API Documentation

listTranscriptionJobsPaginator

default ListTranscriptionJobsIterable listTranscriptionJobsPaginator(Consumer<ListTranscriptionJobsRequest.Builder> listTranscriptionJobsRequest)
                                                              throws BadRequestException,
                                                                     LimitExceededException,
                                                                     InternalFailureException,
                                                                     AwsServiceException,
                                                                     SdkClientException,
                                                                     TranscribeException

Lists transcription jobs with the specified status.

This is a variant of listTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.transcribe.paginators.ListTranscriptionJobsIterable responses = client.listTranscriptionJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.transcribe.paginators.ListTranscriptionJobsIterable responses = client
             .listTranscriptionJobsPaginator(request);
     for (software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.transcribe.paginators.ListTranscriptionJobsIterable responses = client.listTranscriptionJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 via ListTranscriptionJobsRequest.builder()

Parameters:

listTranscriptionJobsRequest - A Consumer that will call methods on ListTranscriptionJobsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the transcription you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message 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.

AwsServiceException

See Also:

AWS API Documentation

listVocabularies

default ListVocabulariesResponse listVocabularies()
                                           throws BadRequestException,
                                                  LimitExceededException,
                                                  InternalFailureException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  TranscribeException

Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.

Returns:

Result of the ListVocabularies operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the transcription you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message 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.

AwsServiceException

See Also:

listVocabularies(ListVocabulariesRequest), AWS API Documentation

listVocabularies

default ListVocabulariesResponse listVocabularies(ListVocabulariesRequest listVocabulariesRequest)
                                           throws BadRequestException,
                                                  LimitExceededException,
                                                  InternalFailureException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  TranscribeException

Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.

Parameters:

listVocabulariesRequest -

Returns:

Result of the ListVocabularies operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the transcription you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message 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.

AwsServiceException

See Also:

AWS API Documentation

listVocabularies

default ListVocabulariesResponse listVocabularies(Consumer<ListVocabulariesRequest.Builder> listVocabulariesRequest)
                                           throws BadRequestException,
                                                  LimitExceededException,
                                                  InternalFailureException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  TranscribeException

Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.

This is a convenience which creates an instance of the ListVocabulariesRequest.Builder avoiding the need to create one manually via ListVocabulariesRequest.builder()

Parameters:

listVocabulariesRequest - A Consumer that will call methods on ListVocabulariesRequest.Builder to create a request.

Returns:

Result of the ListVocabularies operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the transcription you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message 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.

AwsServiceException

See Also:

AWS API Documentation

listVocabulariesPaginator

default ListVocabulariesIterable listVocabulariesPaginator()
                                                    throws BadRequestException,
                                                           LimitExceededException,
                                                           InternalFailureException,
                                                           AwsServiceException,
                                                           SdkClientException,
                                                           TranscribeException

Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.

This is a variant of listVocabularies(software.amazon.awssdk.services.transcribe.model.ListVocabulariesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.transcribe.paginators.ListVocabulariesIterable responses = client.listVocabulariesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.transcribe.paginators.ListVocabulariesIterable responses = client
             .listVocabulariesPaginator(request);
     for (software.amazon.awssdk.services.transcribe.model.ListVocabulariesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.transcribe.paginators.ListVocabulariesIterable responses = client.listVocabulariesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Note: If you prefer to have control on service calls, use the listVocabularies(software.amazon.awssdk.services.transcribe.model.ListVocabulariesRequest) operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the transcription you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message 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.

AwsServiceException

See Also:

listVocabulariesPaginator(ListVocabulariesRequest), AWS API Documentation

listVocabulariesPaginator

default ListVocabulariesIterable listVocabulariesPaginator(ListVocabulariesRequest listVocabulariesRequest)
                                                    throws BadRequestException,
                                                           LimitExceededException,
                                                           InternalFailureException,
                                                           AwsServiceException,
                                                           SdkClientException,
                                                           TranscribeException

Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.

This is a variant of listVocabularies(software.amazon.awssdk.services.transcribe.model.ListVocabulariesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.transcribe.paginators.ListVocabulariesIterable responses = client.listVocabulariesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.transcribe.paginators.ListVocabulariesIterable responses = client
             .listVocabulariesPaginator(request);
     for (software.amazon.awssdk.services.transcribe.model.ListVocabulariesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.transcribe.paginators.ListVocabulariesIterable responses = client.listVocabulariesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the transcription you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message 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.

AwsServiceException

See Also:

AWS API Documentation

listVocabulariesPaginator

default ListVocabulariesIterable listVocabulariesPaginator(Consumer<ListVocabulariesRequest.Builder> listVocabulariesRequest)
                                                    throws BadRequestException,
                                                           LimitExceededException,
                                                           InternalFailureException,
                                                           AwsServiceException,
                                                           SdkClientException,
                                                           TranscribeException

Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.

This is a variant of listVocabularies(software.amazon.awssdk.services.transcribe.model.ListVocabulariesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.transcribe.paginators.ListVocabulariesIterable responses = client.listVocabulariesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.transcribe.paginators.ListVocabulariesIterable responses = client
             .listVocabulariesPaginator(request);
     for (software.amazon.awssdk.services.transcribe.model.ListVocabulariesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.transcribe.paginators.ListVocabulariesIterable responses = client.listVocabulariesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 via ListVocabulariesRequest.builder()

Parameters:

listVocabulariesRequest - A Consumer that will call methods on ListVocabulariesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the transcription you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message 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.

AwsServiceException

See Also:

AWS API Documentation

startTranscriptionJob

default StartTranscriptionJobResponse startTranscriptionJob(StartTranscriptionJobRequest startTranscriptionJobRequest)
                                                     throws BadRequestException,
                                                            LimitExceededException,
                                                            InternalFailureException,
                                                            ConflictException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            TranscribeException

Starts an asynchronous job to transcribe speech to text. Note that en-AU, en-UK, and fr-CA languages are in preview and are only available to whitelisted customers.

Parameters:

startTranscriptionJobRequest -

Returns:

Result of the StartTranscriptionJob operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the transcription you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

ConflictException - When you are using the StartTranscriptionJob operation, the JobName field is a duplicate of a previously entered job name. Resend your request with a different name.

When you are using the UpdateVocabulary operation, there are two jobs running at the same time. Resend the second request later.

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.

AwsServiceException

See Also:

AWS API Documentation

startTranscriptionJob

default StartTranscriptionJobResponse startTranscriptionJob(Consumer<StartTranscriptionJobRequest.Builder> startTranscriptionJobRequest)
                                                     throws BadRequestException,
                                                            LimitExceededException,
                                                            InternalFailureException,
                                                            ConflictException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            TranscribeException

Starts an asynchronous job to transcribe speech to text. Note that en-AU, en-UK, and fr-CA languages are in preview and are only available to whitelisted customers.

This is a convenience which creates an instance of the StartTranscriptionJobRequest.Builder avoiding the need to create one manually via StartTranscriptionJobRequest.builder()

Parameters:

startTranscriptionJobRequest - A Consumer that will call methods on StartTranscriptionJobRequest.Builder to create a request.

Returns:

Result of the StartTranscriptionJob operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the transcription you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

ConflictException - When you are using the StartTranscriptionJob operation, the JobName field is a duplicate of a previously entered job name. Resend your request with a different name.

When you are using the UpdateVocabulary operation, there are two jobs running at the same time. Resend the second request later.

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.

AwsServiceException

See Also:

AWS API Documentation

updateVocabulary

default UpdateVocabularyResponse updateVocabulary(UpdateVocabularyRequest updateVocabularyRequest)
                                           throws BadRequestException,
                                                  LimitExceededException,
                                                  InternalFailureException,
                                                  NotFoundException,
                                                  ConflictException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  TranscribeException

Updates an existing vocabulary with new values. The UpdateVocabulary operation overwrites all of the existing information with the values that you provide in the request. Note that vocabularies for en-AU, en-UK, and fr-CA languages that are in preview are not available. In the console, the vocabulary section will be greyed-out and SDK will return error message.

Parameters:

updateVocabularyRequest -

Returns:

Result of the UpdateVocabulary operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the transcription you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

NotFoundException - We can't find the requested resource. Check the name and try your request again.

ConflictException - When you are using the StartTranscriptionJob operation, the JobName field is a duplicate of a previously entered job name. Resend your request with a different name.

When you are using the UpdateVocabulary operation, there are two jobs running at the same time. Resend the second request later.

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.

AwsServiceException

See Also:

AWS API Documentation

updateVocabulary

default UpdateVocabularyResponse updateVocabulary(Consumer<UpdateVocabularyRequest.Builder> updateVocabularyRequest)
                                           throws BadRequestException,
                                                  LimitExceededException,
                                                  InternalFailureException,
                                                  NotFoundException,
                                                  ConflictException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  TranscribeException

Updates an existing vocabulary with new values. The UpdateVocabulary operation overwrites all of the existing information with the values that you provide in the request. Note that vocabularies for en-AU, en-UK, and fr-CA languages that are in preview are not available. In the console, the vocabulary section will be greyed-out and SDK will return error message.

This is a convenience which creates an instance of the UpdateVocabularyRequest.Builder avoiding the need to create one manually via UpdateVocabularyRequest.builder()

Parameters:

updateVocabularyRequest - A Consumer that will call methods on UpdateVocabularyRequest.Builder to create a request.

Returns:

Result of the UpdateVocabulary operation returned by the service.

Throws:

BadRequestException - Your request didn't pass one or more validation tests. For example, if the transcription you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

LimitExceededException - Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

InternalFailureException - There was an internal error. Check the error message and try your request again.

NotFoundException - We can't find the requested resource. Check the name and try your request again.

ConflictException - When you are using the StartTranscriptionJob operation, the JobName field is a duplicate of a previously entered job name. Resend your request with a different name.

When you are using the UpdateVocabulary operation, there are two jobs running at the same time. Resend the second request later.

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.

AwsServiceException

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()