JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
  • Detail:
  • Field |
  • Constr |
  • Method
com.amazonaws.services.transcribe

Class 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.

    Amazon Transcribe offers three main types of batch transcription: Standard, Medical, and Call Analytics.

    • Standard transcriptions are the most common option. Refer to for details.

    • Medical transcriptions are tailored to medical professionals and incorporate medical terms. A common use case for this service is transcribing doctor-patient dialogue into after-visit notes. Refer to for details.

    • Call Analytics transcriptions are designed for use with call center audio on two different channels; if you're looking for insight into customer service calls, use this option. Refer to for details.

    • Method Detail

      • createCallAnalyticsCategory

        public CreateCallAnalyticsCategoryResult createCallAnalyticsCategory(CreateCallAnalyticsCategoryRequest request)

        Creates a new Call Analytics category.

        All categories are automatically applied to your Call Analytics transcriptions. Note that in order to apply categories to your transcriptions, you must create them before submitting your transcription request, as categories cannot be applied retroactively.

        When creating a new category, you can use the InputType parameter to label the category as a POST_CALL or a REAL_TIME category. POST_CALL categories can only be applied to post-call transcriptions and REAL_TIME categories can only be applied to real-time transcriptions. If you do not include InputType, your category is created as a POST_CALL category by default.

        Call Analytics categories are composed of rules. For each category, you must create between 1 and 20 rules. Rules can include these parameters: , , , and .

        To update an existing category, see .

        To learn more about Call Analytics categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions.

        Specified by:
        createCallAnalyticsCategory in interface AmazonTranscribe
        Parameters:
        createCallAnalyticsCategoryRequest -
        Returns:
        Result of the CreateCallAnalyticsCategory operation returned by the service.
        Throws:
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        ConflictException - A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.
        See Also:
        AWS API Documentation
      • createLanguageModel

        public CreateLanguageModelResult createLanguageModel(CreateLanguageModelRequest request)

        Creates a new custom language model.

        When creating a new custom language model, you must specify:

        • If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband (audio sample rates under 16,000 Hz) base model

        • The location of your training and tuning files (this must be an Amazon S3 URI)

        • The language of your model

        • A unique name for your model

        Specified by:
        createLanguageModel in interface AmazonTranscribe
        Parameters:
        createLanguageModelRequest -
        Returns:
        Result of the CreateLanguageModel operation returned by the service.
        Throws:
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        ConflictException - A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.
        See Also:
        AWS API Documentation
      • createMedicalVocabulary

        public CreateMedicalVocabularyResult createMedicalVocabulary(CreateMedicalVocabularyRequest request)

        Creates a new custom medical vocabulary.

        Before creating a new custom medical vocabulary, you must first upload a text file that contains your vocabulary table into an Amazon S3 bucket. Note that this differs from , where you can include a list of terms within your request using the Phrases flag; CreateMedicalVocabulary does not support the Phrases flag and only accepts vocabularies in table format.

        Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

        For more information, see Custom vocabularies.

        Specified by:
        createMedicalVocabulary in interface AmazonTranscribe
        Parameters:
        createMedicalVocabularyRequest -
        Returns:
        Result of the CreateMedicalVocabulary operation returned by the service.
        Throws:
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        ConflictException - A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.
        See Also:
        AWS API Documentation
      • createVocabulary

        public CreateVocabularyResult createVocabulary(CreateVocabularyRequest request)

        Creates a new custom vocabulary.

        When creating a new custom vocabulary, you can either upload a text file that contains your new entries, phrases, and terms into an Amazon S3 bucket and include the URI in your request. Or you can include a list of terms directly in your request using the Phrases flag.

        Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

        For more information, see Custom vocabularies.

        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. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        ConflictException - A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.
        See Also:
        AWS API Documentation
      • createVocabularyFilter

        public CreateVocabularyFilterResult createVocabularyFilter(CreateVocabularyFilterRequest request)

        Creates a new custom vocabulary filter.

        You can use custom vocabulary filters to mask, delete, or flag specific words from your transcript. Custom vocabulary filters are commonly used to mask profanity in transcripts.

        Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

        For more information, see Vocabulary filtering.

        Specified by:
        createVocabularyFilter in interface AmazonTranscribe
        Parameters:
        createVocabularyFilterRequest -
        Returns:
        Result of the CreateVocabularyFilter operation returned by the service.
        Throws:
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        ConflictException - A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.
        See Also:
        AWS API Documentation
      • deleteCallAnalyticsCategory

        public DeleteCallAnalyticsCategoryResult deleteCallAnalyticsCategory(DeleteCallAnalyticsCategoryRequest request)

        Deletes a Call Analytics category. To use this operation, specify the name of the category you want to delete using CategoryName. Category names are case sensitive.

        Specified by:
        deleteCallAnalyticsCategory in interface AmazonTranscribe
        Parameters:
        deleteCallAnalyticsCategoryRequest -
        Returns:
        Result of the DeleteCallAnalyticsCategory operation returned by the service.
        Throws:
        NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request again.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        See Also:
        AWS API Documentation
      • deleteCallAnalyticsJob

        public DeleteCallAnalyticsJobResult deleteCallAnalyticsJob(DeleteCallAnalyticsJobRequest request)

        Deletes a Call Analytics job. To use this operation, specify the name of the job you want to delete using CallAnalyticsJobName. Job names are case sensitive.

        Specified by:
        deleteCallAnalyticsJob in interface AmazonTranscribe
        Parameters:
        deleteCallAnalyticsJobRequest -
        Returns:
        Result of the DeleteCallAnalyticsJob operation returned by the service.
        Throws:
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        See Also:
        AWS API Documentation
      • deleteLanguageModel

        public DeleteLanguageModelResult deleteLanguageModel(DeleteLanguageModelRequest request)

        Deletes a custom language model. To use this operation, specify the name of the language model you want to delete using ModelName. custom language model names are case sensitive.

        Specified by:
        deleteLanguageModel in interface AmazonTranscribe
        Parameters:
        deleteLanguageModelRequest -
        Returns:
        Result of the DeleteLanguageModel operation returned by the service.
        Throws:
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        See Also:
        AWS API Documentation
      • deleteMedicalScribeJob

        public DeleteMedicalScribeJobResult deleteMedicalScribeJob(DeleteMedicalScribeJobRequest request)

        Deletes a Medical Scribe job. To use this operation, specify the name of the job you want to delete using MedicalScribeJobName. Job names are case sensitive.

        Specified by:
        deleteMedicalScribeJob in interface AmazonTranscribe
        Parameters:
        deleteMedicalScribeJobRequest -
        Returns:
        Result of the DeleteMedicalScribeJob operation returned by the service.
        Throws:
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        See Also:
        AWS API Documentation
      • deleteMedicalTranscriptionJob

        public DeleteMedicalTranscriptionJobResult deleteMedicalTranscriptionJob(DeleteMedicalTranscriptionJobRequest request)

        Deletes a medical transcription job. To use this operation, specify the name of the job you want to delete using MedicalTranscriptionJobName. Job names are case sensitive.

        Specified by:
        deleteMedicalTranscriptionJob in interface AmazonTranscribe
        Parameters:
        deleteMedicalTranscriptionJobRequest -
        Returns:
        Result of the DeleteMedicalTranscriptionJob operation returned by the service.
        Throws:
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        See Also:
        AWS API Documentation
      • deleteMedicalVocabulary

        public DeleteMedicalVocabularyResult deleteMedicalVocabulary(DeleteMedicalVocabularyRequest request)

        Deletes a custom medical vocabulary. To use this operation, specify the name of the custom vocabulary you want to delete using VocabularyName. Custom vocabulary names are case sensitive.

        Specified by:
        deleteMedicalVocabulary in interface AmazonTranscribe
        Parameters:
        deleteMedicalVocabularyRequest -
        Returns:
        Result of the DeleteMedicalVocabulary operation returned by the service.
        Throws:
        NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request again.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        See Also:
        AWS API Documentation
      • deleteTranscriptionJob

        public DeleteTranscriptionJobResult deleteTranscriptionJob(DeleteTranscriptionJobRequest request)

        Deletes a transcription job. To use this operation, specify the name of the job you want to delete using TranscriptionJobName. Job names are case sensitive.

        Specified by:
        deleteTranscriptionJob in interface AmazonTranscribe
        Parameters:
        deleteTranscriptionJobRequest -
        Returns:
        Result of the DeleteTranscriptionJob operation returned by the service.
        Throws:
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        See Also:
        AWS API Documentation
      • deleteVocabulary

        public DeleteVocabularyResult deleteVocabulary(DeleteVocabularyRequest request)

        Deletes a custom vocabulary. To use this operation, specify the name of the custom vocabulary you want to delete using VocabularyName. Custom vocabulary names are case sensitive.

        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 that the specified name is correct and try your request again.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        See Also:
        AWS API Documentation
      • deleteVocabularyFilter

        public DeleteVocabularyFilterResult deleteVocabularyFilter(DeleteVocabularyFilterRequest request)

        Deletes a custom vocabulary filter. To use this operation, specify the name of the custom vocabulary filter you want to delete using VocabularyFilterName. Custom vocabulary filter names are case sensitive.

        Specified by:
        deleteVocabularyFilter in interface AmazonTranscribe
        Parameters:
        deleteVocabularyFilterRequest -
        Returns:
        Result of the DeleteVocabularyFilter operation returned by the service.
        Throws:
        NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request again.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        See Also:
        AWS API Documentation
      • describeLanguageModel

        public DescribeLanguageModelResult describeLanguageModel(DescribeLanguageModelRequest request)

        Provides information about the specified custom language model.

        This operation also shows if the base language model that you used to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a new custom language model using the updated base model.

        If you tried to create a new custom language model and the request wasn't successful, you can use DescribeLanguageModel to help identify the reason for this failure.

        Specified by:
        describeLanguageModel in interface AmazonTranscribe
        Parameters:
        describeLanguageModelRequest -
        Returns:
        Result of the DescribeLanguageModel operation returned by the service.
        Throws:
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request again.
        See Also:
        AWS API Documentation
      • getCallAnalyticsCategory

        public GetCallAnalyticsCategoryResult getCallAnalyticsCategory(GetCallAnalyticsCategoryRequest request)

        Provides information about the specified Call Analytics category.

        To get a list of your Call Analytics categories, use the operation.

        Specified by:
        getCallAnalyticsCategory in interface AmazonTranscribe
        Parameters:
        getCallAnalyticsCategoryRequest -
        Returns:
        Result of the GetCallAnalyticsCategory operation returned by the service.
        Throws:
        NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request again.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        See Also:
        AWS API Documentation
      • getCallAnalyticsJob

        public GetCallAnalyticsJobResult getCallAnalyticsJob(GetCallAnalyticsJobRequest request)

        Provides information about the specified Call Analytics job.

        To view the job's status, refer to CallAnalyticsJobStatus. If the status is COMPLETED, the job is finished. You can find your completed transcript at the URI specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

        If you enabled personally identifiable information (PII) redaction, the redacted transcript appears at the location specified in RedactedTranscriptFileUri.

        If you chose to redact the audio in your media file, you can find your redacted media file at the location specified in RedactedMediaFileUri.

        To get a list of your Call Analytics jobs, use the operation.

        Specified by:
        getCallAnalyticsJob in interface AmazonTranscribe
        Parameters:
        getCallAnalyticsJobRequest -
        Returns:
        Result of the GetCallAnalyticsJob operation returned by the service.
        Throws:
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request again.
        See Also:
        AWS API Documentation
      • getMedicalScribeJob

        public GetMedicalScribeJobResult getMedicalScribeJob(GetMedicalScribeJobRequest request)

        Provides information about the specified Medical Scribe job.

        To view the status of the specified medical transcription job, check the MedicalScribeJobStatus field. If the status is COMPLETED, the job is finished. You can find the results at the location specified in MedicalScribeOutput. If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.

        To get a list of your Medical Scribe jobs, use the operation.

        Specified by:
        getMedicalScribeJob in interface AmazonTranscribe
        Parameters:
        getMedicalScribeJobRequest -
        Returns:
        Result of the GetMedicalScribeJob operation returned by the service.
        Throws:
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request again.
        See Also:
        AWS API Documentation
      • getMedicalTranscriptionJob

        public GetMedicalTranscriptionJobResult getMedicalTranscriptionJob(GetMedicalTranscriptionJobRequest request)

        Provides information about the specified medical transcription job.

        To view the status of the specified medical transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. You can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

        To get a list of your medical transcription jobs, use the operation.

        Specified by:
        getMedicalTranscriptionJob in interface AmazonTranscribe
        Parameters:
        getMedicalTranscriptionJobRequest -
        Returns:
        Result of the GetMedicalTranscriptionJob operation returned by the service.
        Throws:
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request again.
        See Also:
        AWS API Documentation
      • getMedicalVocabulary

        public GetMedicalVocabularyResult getMedicalVocabulary(GetMedicalVocabularyRequest request)

        Provides information about the specified custom medical vocabulary.

        To view the status of the specified custom medical vocabulary, check the VocabularyState field. If the status is READY, your custom vocabulary is available to use. If the status is FAILED, FailureReason provides details on why your vocabulary failed.

        To get a list of your custom medical vocabularies, use the operation.

        Specified by:
        getMedicalVocabulary in interface AmazonTranscribe
        Parameters:
        getMedicalVocabularyRequest -
        Returns:
        Result of the GetMedicalVocabulary operation returned by the service.
        Throws:
        NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request again.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        See Also:
        AWS API Documentation
      • getTranscriptionJob

        public GetTranscriptionJobResult getTranscriptionJob(GetTranscriptionJobRequest request)

        Provides information about the specified transcription job.

        To view the status of the specified transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. You can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

        If you enabled content redaction, the redacted transcript can be found at the location specified in RedactedTranscriptFileUri.

        To get a list of your transcription jobs, use the operation.

        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. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request again.
        See Also:
        AWS API Documentation
      • getVocabulary

        public GetVocabularyResult getVocabulary(GetVocabularyRequest request)

        Provides information about the specified custom vocabulary.

        To view the status of the specified custom vocabulary, check the VocabularyState field. If the status is READY, your custom vocabulary is available to use. If the status is FAILED, FailureReason provides details on why your custom vocabulary failed.

        To get a list of your custom vocabularies, use the operation.

        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 that the specified name is correct and try your request again.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        See Also:
        AWS API Documentation
      • getVocabularyFilter

        public GetVocabularyFilterResult getVocabularyFilter(GetVocabularyFilterRequest request)

        Provides information about the specified custom vocabulary filter.

        To get a list of your custom vocabulary filters, use the operation.

        Specified by:
        getVocabularyFilter in interface AmazonTranscribe
        Parameters:
        getVocabularyFilterRequest -
        Returns:
        Result of the GetVocabularyFilter operation returned by the service.
        Throws:
        NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request again.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        See Also:
        AWS API Documentation
      • listCallAnalyticsCategories

        public ListCallAnalyticsCategoriesResult listCallAnalyticsCategories(ListCallAnalyticsCategoriesRequest request)

        Provides a list of Call Analytics categories, including all rules that make up each category.

        To get detailed information about a specific Call Analytics category, use the operation.

        Specified by:
        listCallAnalyticsCategories in interface AmazonTranscribe
        Parameters:
        listCallAnalyticsCategoriesRequest -
        Returns:
        Result of the ListCallAnalyticsCategories operation returned by the service.
        Throws:
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        See Also:
        AWS API Documentation
      • listCallAnalyticsJobs

        public ListCallAnalyticsJobsResult listCallAnalyticsJobs(ListCallAnalyticsJobsRequest request)

        Provides a list of Call Analytics jobs that match the specified criteria. If no criteria are specified, all Call Analytics jobs are returned.

        To get detailed information about a specific Call Analytics job, use the operation.

        Specified by:
        listCallAnalyticsJobs in interface AmazonTranscribe
        Parameters:
        listCallAnalyticsJobsRequest -
        Returns:
        Result of the ListCallAnalyticsJobs operation returned by the service.
        Throws:
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        See Also:
        AWS API Documentation
      • listLanguageModels

        public ListLanguageModelsResult listLanguageModels(ListLanguageModelsRequest request)

        Provides a list of custom language models that match the specified criteria. If no criteria are specified, all custom language models are returned.

        To get detailed information about a specific custom language model, use the operation.

        Specified by:
        listLanguageModels in interface AmazonTranscribe
        Parameters:
        listLanguageModelsRequest -
        Returns:
        Result of the ListLanguageModels operation returned by the service.
        Throws:
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        See Also:
        AWS API Documentation
      • listMedicalScribeJobs

        public ListMedicalScribeJobsResult listMedicalScribeJobs(ListMedicalScribeJobsRequest request)

        Provides a list of Medical Scribe jobs that match the specified criteria. If no criteria are specified, all Medical Scribe jobs are returned.

        To get detailed information about a specific Medical Scribe job, use the operation.

        Specified by:
        listMedicalScribeJobs in interface AmazonTranscribe
        Parameters:
        listMedicalScribeJobsRequest -
        Returns:
        Result of the ListMedicalScribeJobs operation returned by the service.
        Throws:
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        See Also:
        AWS API Documentation
      • listMedicalTranscriptionJobs

        public ListMedicalTranscriptionJobsResult listMedicalTranscriptionJobs(ListMedicalTranscriptionJobsRequest request)

        Provides a list of medical transcription jobs that match the specified criteria. If no criteria are specified, all medical transcription jobs are returned.

        To get detailed information about a specific medical transcription job, use the operation.

        Specified by:
        listMedicalTranscriptionJobs in interface AmazonTranscribe
        Parameters:
        listMedicalTranscriptionJobsRequest -
        Returns:
        Result of the ListMedicalTranscriptionJobs operation returned by the service.
        Throws:
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        See Also:
        AWS API Documentation
      • listMedicalVocabularies

        public ListMedicalVocabulariesResult listMedicalVocabularies(ListMedicalVocabulariesRequest request)

        Provides a list of custom medical vocabularies that match the specified criteria. If no criteria are specified, all custom medical vocabularies are returned.

        To get detailed information about a specific custom medical vocabulary, use the operation.

        Specified by:
        listMedicalVocabularies in interface AmazonTranscribe
        Parameters:
        listMedicalVocabulariesRequest -
        Returns:
        Result of the ListMedicalVocabularies operation returned by the service.
        Throws:
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        See Also:
        AWS API Documentation
      • listTagsForResource

        public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

        Lists all tags associated with the specified transcription job, vocabulary, model, or resource.

        To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

        Specified by:
        listTagsForResource in interface AmazonTranscribe
        Parameters:
        listTagsForResourceRequest -
        Returns:
        Result of the ListTagsForResource operation returned by the service.
        Throws:
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request again.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        See Also:
        AWS API Documentation
      • listTranscriptionJobs

        public ListTranscriptionJobsResult listTranscriptionJobs(ListTranscriptionJobsRequest request)

        Provides a list of transcription jobs that match the specified criteria. If no criteria are specified, all transcription jobs are returned.

        To get detailed information about a specific transcription job, use the operation.

        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. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        See Also:
        AWS API Documentation
      • listVocabularies

        public ListVocabulariesResult listVocabularies(ListVocabulariesRequest request)

        Provides a list of custom vocabularies that match the specified criteria. If no criteria are specified, all custom vocabularies are returned.

        To get detailed information about a specific custom vocabulary, use the operation.

        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. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        See Also:
        AWS API Documentation
      • listVocabularyFilters

        public ListVocabularyFiltersResult listVocabularyFilters(ListVocabularyFiltersRequest request)

        Provides a list of custom vocabulary filters that match the specified criteria. If no criteria are specified, all custom vocabularies are returned.

        To get detailed information about a specific custom vocabulary filter, use the operation.

        Specified by:
        listVocabularyFilters in interface AmazonTranscribe
        Parameters:
        listVocabularyFiltersRequest -
        Returns:
        Result of the ListVocabularyFilters operation returned by the service.
        Throws:
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        See Also:
        AWS API Documentation
      • startCallAnalyticsJob

        public StartCallAnalyticsJobResult startCallAnalyticsJob(StartCallAnalyticsJobRequest request)

        Transcribes the audio from a customer service call and applies any additional Request Parameters you choose to include in your request.

        In addition to many standard transcription features, Call Analytics provides you with call characteristics, call summarization, speaker sentiment, and optional redaction of your text transcript and your audio file. You can also apply custom categories to flag specified conditions. To learn more about these features and insights, refer to Analyzing call center audio with Call Analytics.

        If you want to apply categories to your Call Analytics job, you must create them before submitting your job request. Categories cannot be retroactively applied to a job. To create a new category, use the operation. To learn more about Call Analytics categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions.

        To make a StartCallAnalyticsJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter.

        Note that job queuing is enabled by default for Call Analytics jobs.

        You must include the following parameters in your StartCallAnalyticsJob request:

        • region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.

        • CallAnalyticsJobName: A custom name that you create for your transcription job that's unique within your Amazon Web Services account.

        • DataAccessRoleArn: The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files.

        • Media (MediaFileUri or RedactedMediaFileUri): The Amazon S3 location of your media file.

        With Call Analytics, you can redact the audio contained in your media file by including RedactedMediaFileUri, instead of MediaFileUri, to specify the location of your input audio. If you choose to redact your audio, you can find your redacted media at the location specified in the RedactedMediaFileUri field of your response.

        Specified by:
        startCallAnalyticsJob in interface AmazonTranscribe
        Parameters:
        startCallAnalyticsJobRequest -
        Returns:
        Result of the StartCallAnalyticsJob operation returned by the service.
        Throws:
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        ConflictException - A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.
        See Also:
        AWS API Documentation
      • startMedicalScribeJob

        public StartMedicalScribeJobResult startMedicalScribeJob(StartMedicalScribeJobRequest request)

        Transcribes patient-clinician conversations and generates clinical notes.

        Amazon Web Services HealthScribe automatically provides rich conversation transcripts, identifies speaker roles, classifies dialogues, extracts medical terms, and generates preliminary clinical notes. To learn more about these features, refer to Amazon Web Services HealthScribe.

        To make a StartMedicalScribeJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter.

        You must include the following parameters in your StartMedicalTranscriptionJob request:

        • DataAccessRoleArn: The ARN of an IAM role with the these minimum permissions: read permission on input file Amazon S3 bucket specified in Media, write permission on the Amazon S3 bucket specified in OutputBucketName, and full permissions on the KMS key specified in OutputEncryptionKMSKeyId (if set). The role should also allow transcribe.amazonaws.com to assume it.

        • Media (MediaFileUri): The Amazon S3 location of your media file.

        • MedicalScribeJobName: A custom name you create for your MedicalScribe job that is unique within your Amazon Web Services account.

        • OutputBucketName: The Amazon S3 bucket where you want your output files stored.

        • Settings: A MedicalScribeSettings obect that must set exactly one of ShowSpeakerLabels or ChannelIdentification to true. If ShowSpeakerLabels is true, MaxSpeakerLabels must also be set.

        • ChannelDefinitions: A MedicalScribeChannelDefinitions array should be set if and only if the ChannelIdentification value of Settings is set to true.

        Specified by:
        startMedicalScribeJob in interface AmazonTranscribe
        Parameters:
        startMedicalScribeJobRequest -
        Returns:
        Result of the StartMedicalScribeJob operation returned by the service.
        Throws:
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        ConflictException - A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.
        See Also:
        AWS API Documentation
      • startMedicalTranscriptionJob

        public StartMedicalTranscriptionJobResult startMedicalTranscriptionJob(StartMedicalTranscriptionJobRequest request)

        Transcribes the audio from a medical dictation or conversation and applies any additional Request Parameters you choose to include in your request.

        In addition to many standard transcription features, Amazon Transcribe Medical provides you with a robust medical vocabulary and, optionally, content identification, which adds flags to personal health information (PHI). To learn more about these features, refer to How Amazon Transcribe Medical works.

        To make a StartMedicalTranscriptionJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter.

        You must include the following parameters in your StartMedicalTranscriptionJob request:

        • region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.

        • MedicalTranscriptionJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account.

        • Media (MediaFileUri): The Amazon S3 location of your media file.

        • LanguageCode: This must be en-US.

        • OutputBucketName: The Amazon S3 bucket where you want your transcript stored. If you want your output stored in a sub-folder of this bucket, you must also include OutputKey.

        • Specialty: This must be PRIMARYCARE.

        • Type: Choose whether your audio is a conversation or a dictation.

        Specified by:
        startMedicalTranscriptionJob in interface AmazonTranscribe
        Parameters:
        startMedicalTranscriptionJobRequest -
        Returns:
        Result of the StartMedicalTranscriptionJob operation returned by the service.
        Throws:
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        ConflictException - A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.
        See Also:
        AWS API Documentation
      • startTranscriptionJob

        public StartTranscriptionJobResult startTranscriptionJob(StartTranscriptionJobRequest request)

        Transcribes the audio from a media file and applies any additional Request Parameters you choose to include in your request.

        To make a StartTranscriptionJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter.

        You must include the following parameters in your StartTranscriptionJob request:

        • region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas.

        • TranscriptionJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account.

        • Media (MediaFileUri): The Amazon S3 location of your media file.

        • One of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages: If you know the language of your media file, specify it using the LanguageCode parameter; you can find all valid language codes in the Supported languages table. If you do not know the languages spoken in your media, use either IdentifyLanguage or IdentifyMultipleLanguages and let Amazon Transcribe identify the languages for you.

        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. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        ConflictException - A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.
        See Also:
        AWS API Documentation
      • tagResource

        public TagResourceResult tagResource(TagResourceRequest request)

        Adds one or more custom tags, each in the form of a key:value pair, to the specified resource.

        To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

        Specified by:
        tagResource in interface AmazonTranscribe
        Parameters:
        tagResourceRequest -
        Returns:
        Result of the TagResource operation returned by the service.
        Throws:
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        ConflictException - A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.
        NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request again.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        See Also:
        AWS API Documentation
      • untagResource

        public UntagResourceResult untagResource(UntagResourceRequest request)

        Removes the specified tags from the specified Amazon Transcribe resource.

        If you include UntagResource in your request, you must also include ResourceArn and TagKeys.

        Specified by:
        untagResource in interface AmazonTranscribe
        Parameters:
        untagResourceRequest -
        Returns:
        Result of the UntagResource operation returned by the service.
        Throws:
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        ConflictException - A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.
        NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        See Also:
        AWS API Documentation
      • updateCallAnalyticsCategory

        public UpdateCallAnalyticsCategoryResult updateCallAnalyticsCategory(UpdateCallAnalyticsCategoryRequest request)

        Updates the specified Call Analytics category with new rules. Note that the UpdateCallAnalyticsCategory operation overwrites all existing rules contained in the specified category. You cannot append additional rules onto an existing category.

        To create a new category, see .

        Specified by:
        updateCallAnalyticsCategory in interface AmazonTranscribe
        Parameters:
        updateCallAnalyticsCategoryRequest -
        Returns:
        Result of the UpdateCallAnalyticsCategory operation returned by the service.
        Throws:
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request again.
        ConflictException - A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.
        See Also:
        AWS API Documentation
      • updateMedicalVocabulary

        public UpdateMedicalVocabularyResult updateMedicalVocabulary(UpdateMedicalVocabularyRequest request)

        Updates an existing custom medical vocabulary with new values. This operation overwrites all existing information with your new values; you cannot append new terms onto an existing custom vocabulary.

        Specified by:
        updateMedicalVocabulary in interface AmazonTranscribe
        Parameters:
        updateMedicalVocabularyRequest -
        Returns:
        Result of the UpdateMedicalVocabulary operation returned by the service.
        Throws:
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request again.
        ConflictException - A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.
        See Also:
        AWS API Documentation
      • updateVocabulary

        public UpdateVocabularyResult updateVocabulary(UpdateVocabularyRequest request)

        Updates an existing custom vocabulary with new values. This operation overwrites all existing information with your new values; you cannot append new terms onto an existing custom vocabulary.

        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. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request again.
        ConflictException - A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.
        See Also:
        AWS API Documentation
      • updateVocabularyFilter

        public UpdateVocabularyFilterResult updateVocabularyFilter(UpdateVocabularyFilterRequest request)

        Updates an existing custom vocabulary filter with a new list of words. The new list you provide overwrites all previous entries; you cannot append new terms onto an existing custom vocabulary filter.

        Specified by:
        updateVocabularyFilter in interface AmazonTranscribe
        Parameters:
        updateVocabularyFilterRequest -
        Returns:
        Result of the UpdateVocabularyFilter operation returned by the service.
        Throws:
        BadRequestException - Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.
        LimitExceededException - You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
        InternalFailureException - There was an internal error. Check the error message, correct the issue, and try your request again.
        NotFoundException - We can't find the requested resource. Check that the specified name is correct and try your request again.
        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.
      • shutdown

        public void shutdown()
        Description copied from class: AmazonWebServiceClient
        Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
        Specified by:
        shutdown in interface AmazonTranscribe
        Overrides:
        shutdown in class AmazonWebServiceClient
Skip navigation links
  • Detail:
  • Field |
  • Constr |
  • Method

AltStyle によって変換されたページ (->オリジナル) /