com.amazonaws.services.transcribe

Class AmazonTranscribeClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.transcribe.AmazonTranscribeClient

All Implemented Interfaces:

AmazonTranscribe

Direct Known Subclasses:

AmazonTranscribeAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonTranscribeClient
extends AmazonWebServiceClient
implements AmazonTranscribe

Client for accessing Amazon Transcribe Service. All service calls made using this client are blocking, and will not return until the service call completes.

Operations and objects for transcribing speech to text.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.transcribe.AmazonTranscribe

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonTranscribeClientBuilder	builder()
CreateVocabularyResult	createVocabulary(CreateVocabularyRequest request) Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.
DeleteTranscriptionJobResult	deleteTranscriptionJob(DeleteTranscriptionJobRequest request) Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on.
DeleteVocabularyResult	deleteVocabulary(DeleteVocabularyRequest request) Deletes a vocabulary from Amazon Transcribe.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetTranscriptionJobResult	getTranscriptionJob(GetTranscriptionJobRequest request) Returns information about a transcription job.
GetVocabularyResult	getVocabulary(GetVocabularyRequest request) Gets information about a vocabulary.
ListTranscriptionJobsResult	listTranscriptionJobs(ListTranscriptionJobsRequest request) Lists transcription jobs with the specified status.
ListVocabulariesResult	listVocabularies(ListVocabulariesRequest request) Returns a list of vocabularies that match the specified criteria.
StartTranscriptionJobResult	startTranscriptionJob(StartTranscriptionJobRequest request) Starts an asynchronous job to transcribe speech to text.
UpdateVocabularyResult	updateVocabulary(UpdateVocabularyRequest request) Updates an existing vocabulary with new values.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.transcribe.AmazonTranscribe

shutdown

Method Detail

builder

public static AmazonTranscribeClientBuilder builder()

createVocabulary

public CreateVocabularyResult createVocabulary(CreateVocabularyRequest request)

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.

Specified by:

createVocabulary in interface AmazonTranscribe

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.

See Also:

AWS API Documentation

deleteTranscriptionJob

public DeleteTranscriptionJobResult deleteTranscriptionJob(DeleteTranscriptionJobRequest request)

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

Specified by:

deleteTranscriptionJob in interface AmazonTranscribe

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.

See Also:

AWS API Documentation

deleteVocabulary

public DeleteVocabularyResult deleteVocabulary(DeleteVocabularyRequest request)

Deletes a vocabulary from Amazon Transcribe.

Specified by:

deleteVocabulary in interface AmazonTranscribe

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.

See Also:

AWS API Documentation

getTranscriptionJob

public GetTranscriptionJobResult getTranscriptionJob(GetTranscriptionJobRequest request)

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.

Specified by:

getTranscriptionJob in interface AmazonTranscribe

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.

See Also:

AWS API Documentation

getVocabulary

public GetVocabularyResult getVocabulary(GetVocabularyRequest request)

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.

Specified by:

getVocabulary in interface AmazonTranscribe

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.

See Also:

AWS API Documentation

listTranscriptionJobs

public ListTranscriptionJobsResult listTranscriptionJobs(ListTranscriptionJobsRequest request)

Lists transcription jobs with the specified status.

Specified by:

listTranscriptionJobs in interface AmazonTranscribe

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.

See Also:

AWS API Documentation

listVocabularies

public ListVocabulariesResult listVocabularies(ListVocabulariesRequest request)

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

Specified by:

listVocabularies in interface AmazonTranscribe

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.

See Also:

AWS API Documentation

startTranscriptionJob

public StartTranscriptionJobResult startTranscriptionJob(StartTranscriptionJobRequest request)

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.

Specified by:

startTranscriptionJob in interface AmazonTranscribe

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.

See Also:

AWS API Documentation

updateVocabulary

public UpdateVocabularyResult updateVocabulary(UpdateVocabularyRequest request)

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.

Specified by:

updateVocabulary in interface AmazonTranscribe

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonTranscribe

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.