com.amazonaws.services.transcribe

Interface AmazonTranscribe

All Known Subinterfaces:

AmazonTranscribeAsync

All Known Implementing Classes:

AmazonTranscribeAsyncClient, AmazonTranscribeClient

public interface AmazonTranscribe

Interface for accessing Amazon Transcribe

Operations and objects for transcribing speech to text.

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.
void	deleteTranscriptionJob(DeleteTranscriptionJobRequest deleteTranscriptionJobRequest) Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on.
void	deleteVocabulary(DeleteVocabularyRequest deleteVocabularyRequest) 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 getTranscriptionJobRequest) Returns information about a transcription job.
GetVocabularyResult	getVocabulary(GetVocabularyRequest getVocabularyRequest) Gets information about a vocabulary.
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.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://transcribe.us-east-1.amazonaws.com").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
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.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
          throws IllegalArgumentException

Overrides the default endpoint for this client ("https://transcribe.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "transcribe.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://transcribe.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "transcribe.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://transcribe.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
        throws IllegalArgumentException

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

createVocabulary

CreateVocabularyResult createVocabulary(CreateVocabularyRequest createVocabularyRequest)
                                 throws AmazonClientException,
                                        AmazonServiceException

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

Parameters:

createVocabularyRequest -

Returns:

createVocabularyResult The response from the CreateVocabulary service method, as returned by Amazon Transcribe.

Throws:

BadRequestException

LimitExceededException

InternalFailureException

ConflictException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Transcribe indicating either a problem with the data in the request, or a server side issue.

deleteTranscriptionJob

void deleteTranscriptionJob(DeleteTranscriptionJobRequest deleteTranscriptionJobRequest)
                     throws AmazonClientException,
                            AmazonServiceException

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

Parameters:

deleteTranscriptionJobRequest -

Throws:

LimitExceededException

BadRequestException

InternalFailureException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Transcribe indicating either a problem with the data in the request, or a server side issue.

deleteVocabulary

void deleteVocabulary(DeleteVocabularyRequest deleteVocabularyRequest)
               throws AmazonClientException,
                      AmazonServiceException

Deletes a vocabulary from Amazon Transcribe.

Parameters:

deleteVocabularyRequest -

Throws:

NotFoundException

LimitExceededException

BadRequestException

InternalFailureException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Transcribe indicating either a problem with the data in the request, or a server side issue.

getTranscriptionJob

GetTranscriptionJobResult getTranscriptionJob(GetTranscriptionJobRequest getTranscriptionJobRequest)
                                       throws AmazonClientException,
                                              AmazonServiceException

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:

getTranscriptionJobResult The response from the GetTranscriptionJob service method, as returned by Amazon Transcribe.

Throws:

BadRequestException

LimitExceededException

InternalFailureException

NotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Transcribe indicating either a problem with the data in the request, or a server side issue.

getVocabulary

GetVocabularyResult getVocabulary(GetVocabularyRequest getVocabularyRequest)
                           throws AmazonClientException,
                                  AmazonServiceException

Gets information about a vocabulary.

Parameters:

getVocabularyRequest -

Returns:

getVocabularyResult The response from the GetVocabulary service method, as returned by Amazon Transcribe.

Throws:

NotFoundException

LimitExceededException

InternalFailureException

BadRequestException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Transcribe indicating either a problem with the data in the request, or a server side issue.

listTranscriptionJobs

ListTranscriptionJobsResult listTranscriptionJobs(ListTranscriptionJobsRequest listTranscriptionJobsRequest)
                                           throws AmazonClientException,
                                                  AmazonServiceException

Lists transcription jobs with the specified status.

Parameters:

listTranscriptionJobsRequest -

Returns:

listTranscriptionJobsResult The response from the ListTranscriptionJobs service method, as returned by Amazon Transcribe.

Throws:

BadRequestException

LimitExceededException

InternalFailureException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Transcribe indicating either a problem with the data in the request, or a server side issue.

listVocabularies

ListVocabulariesResult listVocabularies(ListVocabulariesRequest listVocabulariesRequest)
                                 throws AmazonClientException,
                                        AmazonServiceException

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

Parameters:

listVocabulariesRequest -

Returns:

listVocabulariesResult The response from the ListVocabularies service method, as returned by Amazon Transcribe.

Throws:

BadRequestException

LimitExceededException

InternalFailureException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Transcribe indicating either a problem with the data in the request, or a server side issue.

startTranscriptionJob

StartTranscriptionJobResult startTranscriptionJob(StartTranscriptionJobRequest startTranscriptionJobRequest)
                                           throws AmazonClientException,
                                                  AmazonServiceException

Starts an asynchronous job to transcribe speech to text.

Parameters:

startTranscriptionJobRequest -

Returns:

startTranscriptionJobResult The response from the StartTranscriptionJob service method, as returned by Amazon Transcribe.

Throws:

BadRequestException

LimitExceededException

InternalFailureException

ConflictException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Transcribe indicating either a problem with the data in the request, or a server side issue.

updateVocabulary

UpdateVocabularyResult updateVocabulary(UpdateVocabularyRequest updateVocabularyRequest)
                                 throws AmazonClientException,
                                        AmazonServiceException

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:

updateVocabularyResult The response from the UpdateVocabulary service method, as returned by Amazon Transcribe.

Throws:

BadRequestException

LimitExceededException

InternalFailureException

NotFoundException

ConflictException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Transcribe indicating either a problem with the data in the request, or a server side issue.

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.