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
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.
ListTranscriptionJobsResult	listTranscriptionJobs(ListTranscriptionJobsRequest listTranscriptionJobsRequest) Lists transcription jobs with the specified status.
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.

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

getTranscriptionJob

GetTranscriptionJobResult getTranscriptionJob(GetTranscriptionJobRequest getTranscriptionJobRequest)

Returns information about a transcription job. To see the status of the job, check the Status field. If the status is COMPLETE, 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 - There is a problem with one of the input fields. Check the S3 bucket name, make sure that the job name is not a duplicate, and confirm that you are using the correct file format. Then resend your request.

LimitExceededException - Either you have sent too many requests or your input file is longer than 2 hours. 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 job. Check the job name and try your request again.

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 - There is a problem with one of the input fields. Check the S3 bucket name, make sure that the job name is not a duplicate, and confirm that you are using the correct file format. Then resend your request.

LimitExceededException - Either you have sent too many requests or your input file is longer than 2 hours. 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 - There is a problem with one of the input fields. Check the S3 bucket name, make sure that the job name is not a duplicate, and confirm that you are using the correct file format. Then resend your request.

LimitExceededException - Either you have sent too many requests or your input file is longer than 2 hours. 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 - The JobName field is a duplicate of a previously entered job name. Resend your request with a different name.

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.