com.amazonaws.services.transcribe

Interface AmazonTranscribe

All Known Subinterfaces:

AmazonTranscribeAsync

All Known Implementing Classes:

AbstractAmazonTranscribe, AbstractAmazonTranscribeAsync, AmazonTranscribeAsyncClient, AmazonTranscribeClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonTranscribe

Interface for accessing Amazon Transcribe Service.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonTranscribe instead.

Operations and objects for transcribing speech to text.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateVocabularyResult	createVocabulary(CreateVocabularyRequest createVocabularyRequest) Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.
CreateVocabularyFilterResult	createVocabularyFilter(CreateVocabularyFilterRequest createVocabularyFilterRequest) Creates a new vocabulary filter that you can use to filter words, such as profane words, from the output of a transcription job.
DeleteTranscriptionJobResult	deleteTranscriptionJob(DeleteTranscriptionJobRequest deleteTranscriptionJobRequest) Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on.
DeleteVocabularyResult	deleteVocabulary(DeleteVocabularyRequest deleteVocabularyRequest) Deletes a vocabulary from Amazon Transcribe.
DeleteVocabularyFilterResult	deleteVocabularyFilter(DeleteVocabularyFilterRequest deleteVocabularyFilterRequest) Removes a vocabulary filter.
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 getTranscriptionJobRequest) Returns information about a transcription job.
GetVocabularyResult	getVocabulary(GetVocabularyRequest getVocabularyRequest) Gets information about a vocabulary.
GetVocabularyFilterResult	getVocabularyFilter(GetVocabularyFilterRequest getVocabularyFilterRequest) Returns information about a vocabulary filter.
ListTranscriptionJobsResult	listTranscriptionJobs(ListTranscriptionJobsRequest listTranscriptionJobsRequest) Lists transcription jobs with the specified status.
ListVocabulariesResult	listVocabularies(ListVocabulariesRequest listVocabulariesRequest) Returns a list of vocabularies that match the specified criteria.
ListVocabularyFiltersResult	listVocabularyFilters(ListVocabularyFiltersRequest listVocabularyFiltersRequest) Gets information about vocabulary filters.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartTranscriptionJobResult	startTranscriptionJob(StartTranscriptionJobRequest startTranscriptionJobRequest) Starts an asynchronous job to transcribe speech to text.
UpdateVocabularyResult	updateVocabulary(UpdateVocabularyRequest updateVocabularyRequest) Updates an existing vocabulary with new values.
UpdateVocabularyFilterResult	updateVocabularyFilter(UpdateVocabularyFilterRequest updateVocabularyFilterRequest) Updates a vocabulary filter with a new list of filtered words.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createVocabulary

CreateVocabularyResult createVocabulary(CreateVocabularyRequest createVocabularyRequest)

Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.

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 CreateVocabulary 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

createVocabularyFilter

CreateVocabularyFilterResult createVocabularyFilter(CreateVocabularyFilterRequest createVocabularyFilterRequest)

Creates a new vocabulary filter that you can use to filter words, such as profane words, from the output of a transcription job.

Parameters:

createVocabularyFilterRequest -

Returns:

Result of the CreateVocabularyFilter 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 CreateVocabulary 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

DeleteTranscriptionJobResult deleteTranscriptionJob(DeleteTranscriptionJobRequest deleteTranscriptionJobRequest)

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.

See Also:

AWS API Documentation

deleteVocabulary

DeleteVocabularyResult deleteVocabulary(DeleteVocabularyRequest deleteVocabularyRequest)

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.

See Also:

AWS API Documentation

deleteVocabularyFilter

DeleteVocabularyFilterResult deleteVocabularyFilter(DeleteVocabularyFilterRequest deleteVocabularyFilterRequest)

Removes a vocabulary filter.

Parameters:

deleteVocabularyFilterRequest -

Returns:

Result of the DeleteVocabularyFilter 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

GetTranscriptionJobResult getTranscriptionJob(GetTranscriptionJobRequest getTranscriptionJobRequest)

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.

See Also:

AWS API Documentation

getVocabulary

GetVocabularyResult getVocabulary(GetVocabularyRequest getVocabularyRequest)

Gets information about a vocabulary.

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

getVocabularyFilter

GetVocabularyFilterResult getVocabularyFilter(GetVocabularyFilterRequest getVocabularyFilterRequest)

Returns information about a vocabulary filter.

Parameters:

getVocabularyFilterRequest -

Returns:

Result of the GetVocabularyFilter 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

ListTranscriptionJobsResult listTranscriptionJobs(ListTranscriptionJobsRequest listTranscriptionJobsRequest)

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.

See Also:

AWS API Documentation

listVocabularies

ListVocabulariesResult listVocabularies(ListVocabulariesRequest listVocabulariesRequest)

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.

See Also:

AWS API Documentation

listVocabularyFilters

ListVocabularyFiltersResult listVocabularyFilters(ListVocabularyFiltersRequest listVocabularyFiltersRequest)

Gets information about vocabulary filters.

Parameters:

listVocabularyFiltersRequest -

Returns:

Result of the ListVocabularyFilters 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

StartTranscriptionJobResult startTranscriptionJob(StartTranscriptionJobRequest startTranscriptionJobRequest)

Starts an asynchronous job to transcribe speech to text.

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 CreateVocabulary 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

UpdateVocabularyResult updateVocabulary(UpdateVocabularyRequest updateVocabularyRequest)

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.

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 CreateVocabulary 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

updateVocabularyFilter

UpdateVocabularyFilterResult updateVocabularyFilter(UpdateVocabularyFilterRequest updateVocabularyFilterRequest)

Updates a vocabulary filter with a new list of filtered words.

Parameters:

updateVocabularyFilterRequest -

Returns:

Result of the UpdateVocabularyFilter 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

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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