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

public class AmazonTranscribeClient
extends AmazonWebServiceClient
implements AmazonTranscribe

Client for accessing Amazon Transcribe. 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

Modifier and Type	Field and Description
protected List<com.amazonaws.transform.JsonErrorUnmarshaller>	jsonErrorUnmarshallers List of exception unmarshallers for all Amazon Transcribe exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, endpointPrefix, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AmazonTranscribeClient() Deprecated.
AmazonTranscribeClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AmazonTranscribe using the specified AWS account credentials.
AmazonTranscribeClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonTranscribe using the specified AWS account credentials and client configuration options.
AmazonTranscribeClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AmazonTranscribe using the specified AWS account credentials provider.
AmazonTranscribeClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonTranscribe using the specified AWS account credentials provider and client configuration options.
AmazonTranscribeClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, HttpClient httpClient) Constructs a new client to invoke service methods on AmazonTranscribe using the specified AWS account credentials provider, client configuration options and request metric collector.
AmazonTranscribeClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated.
AmazonTranscribeClient(ClientConfiguration clientConfiguration) Deprecated.

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) Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.
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.
StartTranscriptionJobResult	startTranscriptionJob(StartTranscriptionJobRequest startTranscriptionJobRequest) Starts an asynchronous job to transcribe speech to text.
UpdateVocabularyResult	updateVocabulary(UpdateVocabularyRequest updateVocabularyRequest) Updates an existing vocabulary with new values.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configSigner, configSigner, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpoint, getEndpointPrefix, getRegions, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class java.lang.Object

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

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

setEndpoint, setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

protected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers

List of exception unmarshallers for all Amazon Transcribe exceptions.

Constructor Detail

AmazonTranscribeClient

@Deprecated
public AmazonTranscribeClient()

Deprecated.

Constructs a new client to invoke service methods on AmazonTranscribe. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AmazonTranscribeClient

@Deprecated
public AmazonTranscribeClient(ClientConfiguration clientConfiguration)

Deprecated.

Constructs a new client to invoke service methods on AmazonTranscribe. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AmazonTranscribe (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonTranscribeClient

public AmazonTranscribeClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AmazonTranscribe using the specified AWS account credentials.

If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.

Automatically managed sessions will be shared among all clients that use the same credentials and service endpoint. To opt out of this behavior, explicitly provide an instance of AWSCredentialsProvider that returns AWSSessionCredentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonTranscribeClient

public AmazonTranscribeClient(AWSCredentials awsCredentials,
                              ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonTranscribe using the specified AWS account credentials and client configuration options.

If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.

Automatically managed sessions will be shared among all clients that use the same credentials and service endpoint. To opt out of this behavior, explicitly provide an instance of AWSCredentialsProvider that returns AWSSessionCredentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonTranscribe (ex: proxy settings, retry counts, etc.).

AmazonTranscribeClient

public AmazonTranscribeClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AmazonTranscribe using the specified AWS account credentials provider.

If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.

Automatically managed sessions will be shared among all clients that use the same credentials and service endpoint. To opt out of this behavior, explicitly provide an instance of AWSCredentialsProvider that returns AWSSessionCredentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonTranscribeClient

public AmazonTranscribeClient(AWSCredentialsProvider awsCredentialsProvider,
                              ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonTranscribe using the specified AWS account credentials provider and client configuration options.

If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.

Automatically managed sessions will be shared among all clients that use the same credentials and service endpoint. To opt out of this behavior, explicitly provide an instance of AWSCredentialsProvider that returns AWSSessionCredentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonTranscribe (ex: proxy settings, retry counts, etc.).

AmazonTranscribeClient

@Deprecated
public AmazonTranscribeClient(AWSCredentialsProvider awsCredentialsProvider,
                                          ClientConfiguration clientConfiguration,
                                          RequestMetricCollector requestMetricCollector)

Deprecated.

Constructs a new client to invoke service methods on AmazonTranscribe using the specified AWS account credentials provider, client configuration options and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonTranscribe (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

AmazonTranscribeClient

public AmazonTranscribeClient(AWSCredentialsProvider awsCredentialsProvider,
                              ClientConfiguration clientConfiguration,
                              HttpClient httpClient)

Constructs a new client to invoke service methods on AmazonTranscribe using the specified AWS account credentials provider, client configuration options and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonTranscribe (ex: proxy settings, retry counts, etc.).

httpClient - A http client

Method Detail

createVocabulary

public CreateVocabularyResult createVocabulary(CreateVocabularyRequest createVocabularyRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

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

Specified by:

createVocabulary in interface AmazonTranscribe

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

public void deleteTranscriptionJob(DeleteTranscriptionJobRequest deleteTranscriptionJobRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

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 -

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

public void deleteVocabulary(DeleteVocabularyRequest deleteVocabularyRequest)
                      throws AmazonServiceException,
                             AmazonClientException

Deletes a vocabulary from Amazon Transcribe.

Specified by:

deleteVocabulary in interface AmazonTranscribe

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

public GetTranscriptionJobResult getTranscriptionJob(GetTranscriptionJobRequest getTranscriptionJobRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

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:

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

public GetVocabularyResult getVocabulary(GetVocabularyRequest getVocabularyRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Gets information about a vocabulary.

Specified by:

getVocabulary in interface AmazonTranscribe

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

public ListTranscriptionJobsResult listTranscriptionJobs(ListTranscriptionJobsRequest listTranscriptionJobsRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Lists transcription jobs with the specified status.

Specified by:

listTranscriptionJobs in interface AmazonTranscribe

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

public ListVocabulariesResult listVocabularies(ListVocabulariesRequest listVocabulariesRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

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:

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

public StartTranscriptionJobResult startTranscriptionJob(StartTranscriptionJobRequest startTranscriptionJobRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Starts an asynchronous job to transcribe speech to text.

Specified by:

startTranscriptionJob in interface AmazonTranscribe

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

public UpdateVocabularyResult updateVocabulary(UpdateVocabularyRequest updateVocabularyRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

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.

Specified by:

updateVocabulary in interface AmazonTranscribe

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.

getCachedResponseMetadata

@Deprecated
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.

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.