Package software.amazon.awssdk.services.transcribe

Interface TranscribeClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface TranscribeClient extends AwsClient
Service client for accessing Amazon Transcribe Service. This can be created using the static builder() method.

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.

  • Field Details

  • Method Details

    • createCallAnalyticsCategory

      default CreateCallAnalyticsCategoryResponse createCallAnalyticsCategory(CreateCallAnalyticsCategoryRequest createCallAnalyticsCategoryRequest) throws BadRequestException, LimitExceededException, InternalFailureException, ConflictException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • createCallAnalyticsCategory

      default CreateCallAnalyticsCategoryResponse createCallAnalyticsCategory(Consumer<CreateCallAnalyticsCategoryRequest.Builder> createCallAnalyticsCategoryRequest) throws BadRequestException, LimitExceededException, InternalFailureException, ConflictException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the CreateCallAnalyticsCategoryRequest.Builder avoiding the need to create one manually via CreateCallAnalyticsCategoryRequest.builder()

      Parameters:
      createCallAnalyticsCategoryRequest - A Consumer that will call methods on CreateCallAnalyticsCategoryRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • createLanguageModel

      default CreateLanguageModelResponse createLanguageModel(CreateLanguageModelRequest createLanguageModelRequest) throws BadRequestException, LimitExceededException, InternalFailureException, ConflictException, AwsServiceException, SdkClientException, TranscribeException

      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

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • createLanguageModel

      default CreateLanguageModelResponse createLanguageModel(Consumer<CreateLanguageModelRequest.Builder> createLanguageModelRequest) throws BadRequestException, LimitExceededException, InternalFailureException, ConflictException, AwsServiceException, SdkClientException, TranscribeException

      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


      This is a convenience which creates an instance of the CreateLanguageModelRequest.Builder avoiding the need to create one manually via CreateLanguageModelRequest.builder()

      Parameters:
      createLanguageModelRequest - A Consumer that will call methods on CreateLanguageModelRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • createMedicalVocabulary

      default CreateMedicalVocabularyResponse createMedicalVocabulary(CreateMedicalVocabularyRequest createMedicalVocabularyRequest) throws BadRequestException, LimitExceededException, InternalFailureException, ConflictException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • createMedicalVocabulary

      default CreateMedicalVocabularyResponse createMedicalVocabulary(Consumer<CreateMedicalVocabularyRequest.Builder> createMedicalVocabularyRequest) throws BadRequestException, LimitExceededException, InternalFailureException, ConflictException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the CreateMedicalVocabularyRequest.Builder avoiding the need to create one manually via CreateMedicalVocabularyRequest.builder()

      Parameters:
      createMedicalVocabularyRequest - A Consumer that will call methods on CreateMedicalVocabularyRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • createVocabulary

      default CreateVocabularyResponse createVocabulary(CreateVocabularyRequest createVocabularyRequest) throws BadRequestException, LimitExceededException, InternalFailureException, ConflictException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • createVocabulary

      default CreateVocabularyResponse createVocabulary(Consumer<CreateVocabularyRequest.Builder> createVocabularyRequest) throws BadRequestException, LimitExceededException, InternalFailureException, ConflictException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the CreateVocabularyRequest.Builder avoiding the need to create one manually via CreateVocabularyRequest.builder()

      Parameters:
      createVocabularyRequest - A Consumer that will call methods on CreateVocabularyRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • createVocabularyFilter

      default CreateVocabularyFilterResponse createVocabularyFilter(CreateVocabularyFilterRequest createVocabularyFilterRequest) throws BadRequestException, LimitExceededException, InternalFailureException, ConflictException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • createVocabularyFilter

      default CreateVocabularyFilterResponse createVocabularyFilter(Consumer<CreateVocabularyFilterRequest.Builder> createVocabularyFilterRequest) throws BadRequestException, LimitExceededException, InternalFailureException, ConflictException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the CreateVocabularyFilterRequest.Builder avoiding the need to create one manually via CreateVocabularyFilterRequest.builder()

      Parameters:
      createVocabularyFilterRequest - A Consumer that will call methods on CreateVocabularyFilterRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • deleteCallAnalyticsCategory

      default DeleteCallAnalyticsCategoryResponse deleteCallAnalyticsCategory(DeleteCallAnalyticsCategoryRequest deleteCallAnalyticsCategoryRequest) throws NotFoundException, LimitExceededException, BadRequestException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • deleteCallAnalyticsCategory

      default DeleteCallAnalyticsCategoryResponse deleteCallAnalyticsCategory(Consumer<DeleteCallAnalyticsCategoryRequest.Builder> deleteCallAnalyticsCategoryRequest) throws NotFoundException, LimitExceededException, BadRequestException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the DeleteCallAnalyticsCategoryRequest.Builder avoiding the need to create one manually via DeleteCallAnalyticsCategoryRequest.builder()

      Parameters:
      deleteCallAnalyticsCategoryRequest - A Consumer that will call methods on DeleteCallAnalyticsCategoryRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • deleteCallAnalyticsJob

      default DeleteCallAnalyticsJobResponse deleteCallAnalyticsJob(DeleteCallAnalyticsJobRequest deleteCallAnalyticsJobRequest) throws LimitExceededException, BadRequestException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • deleteCallAnalyticsJob

      default DeleteCallAnalyticsJobResponse deleteCallAnalyticsJob(Consumer<DeleteCallAnalyticsJobRequest.Builder> deleteCallAnalyticsJobRequest) throws LimitExceededException, BadRequestException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the DeleteCallAnalyticsJobRequest.Builder avoiding the need to create one manually via DeleteCallAnalyticsJobRequest.builder()

      Parameters:
      deleteCallAnalyticsJobRequest - A Consumer that will call methods on DeleteCallAnalyticsJobRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • deleteLanguageModel

      default DeleteLanguageModelResponse deleteLanguageModel(DeleteLanguageModelRequest deleteLanguageModelRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • deleteLanguageModel

      default DeleteLanguageModelResponse deleteLanguageModel(Consumer<DeleteLanguageModelRequest.Builder> deleteLanguageModelRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the DeleteLanguageModelRequest.Builder avoiding the need to create one manually via DeleteLanguageModelRequest.builder()

      Parameters:
      deleteLanguageModelRequest - A Consumer that will call methods on DeleteLanguageModelRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • deleteMedicalScribeJob

      default DeleteMedicalScribeJobResponse deleteMedicalScribeJob(DeleteMedicalScribeJobRequest deleteMedicalScribeJobRequest) throws LimitExceededException, BadRequestException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • deleteMedicalScribeJob

      default DeleteMedicalScribeJobResponse deleteMedicalScribeJob(Consumer<DeleteMedicalScribeJobRequest.Builder> deleteMedicalScribeJobRequest) throws LimitExceededException, BadRequestException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the DeleteMedicalScribeJobRequest.Builder avoiding the need to create one manually via DeleteMedicalScribeJobRequest.builder()

      Parameters:
      deleteMedicalScribeJobRequest - A Consumer that will call methods on DeleteMedicalScribeJobRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • deleteMedicalTranscriptionJob

      default DeleteMedicalTranscriptionJobResponse deleteMedicalTranscriptionJob(DeleteMedicalTranscriptionJobRequest deleteMedicalTranscriptionJobRequest) throws LimitExceededException, BadRequestException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • deleteMedicalTranscriptionJob

      default DeleteMedicalTranscriptionJobResponse deleteMedicalTranscriptionJob(Consumer<DeleteMedicalTranscriptionJobRequest.Builder> deleteMedicalTranscriptionJobRequest) throws LimitExceededException, BadRequestException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the DeleteMedicalTranscriptionJobRequest.Builder avoiding the need to create one manually via DeleteMedicalTranscriptionJobRequest.builder()

      Parameters:
      deleteMedicalTranscriptionJobRequest - A Consumer that will call methods on DeleteMedicalTranscriptionJobRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • deleteMedicalVocabulary

      default DeleteMedicalVocabularyResponse deleteMedicalVocabulary(DeleteMedicalVocabularyRequest deleteMedicalVocabularyRequest) throws NotFoundException, LimitExceededException, BadRequestException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • deleteMedicalVocabulary

      default DeleteMedicalVocabularyResponse deleteMedicalVocabulary(Consumer<DeleteMedicalVocabularyRequest.Builder> deleteMedicalVocabularyRequest) throws NotFoundException, LimitExceededException, BadRequestException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the DeleteMedicalVocabularyRequest.Builder avoiding the need to create one manually via DeleteMedicalVocabularyRequest.builder()

      Parameters:
      deleteMedicalVocabularyRequest - A Consumer that will call methods on DeleteMedicalVocabularyRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • deleteTranscriptionJob

      default DeleteTranscriptionJobResponse deleteTranscriptionJob(DeleteTranscriptionJobRequest deleteTranscriptionJobRequest) throws LimitExceededException, BadRequestException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • deleteTranscriptionJob

      default DeleteTranscriptionJobResponse deleteTranscriptionJob(Consumer<DeleteTranscriptionJobRequest.Builder> deleteTranscriptionJobRequest) throws LimitExceededException, BadRequestException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the DeleteTranscriptionJobRequest.Builder avoiding the need to create one manually via DeleteTranscriptionJobRequest.builder()

      Parameters:
      deleteTranscriptionJobRequest - A Consumer that will call methods on DeleteTranscriptionJobRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • deleteVocabulary

      default DeleteVocabularyResponse deleteVocabulary(DeleteVocabularyRequest deleteVocabularyRequest) throws NotFoundException, LimitExceededException, BadRequestException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • deleteVocabulary

      default DeleteVocabularyResponse deleteVocabulary(Consumer<DeleteVocabularyRequest.Builder> deleteVocabularyRequest) throws NotFoundException, LimitExceededException, BadRequestException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the DeleteVocabularyRequest.Builder avoiding the need to create one manually via DeleteVocabularyRequest.builder()

      Parameters:
      deleteVocabularyRequest - A Consumer that will call methods on DeleteVocabularyRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • deleteVocabularyFilter

      default DeleteVocabularyFilterResponse deleteVocabularyFilter(DeleteVocabularyFilterRequest deleteVocabularyFilterRequest) throws NotFoundException, LimitExceededException, BadRequestException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • deleteVocabularyFilter

      default DeleteVocabularyFilterResponse deleteVocabularyFilter(Consumer<DeleteVocabularyFilterRequest.Builder> deleteVocabularyFilterRequest) throws NotFoundException, LimitExceededException, BadRequestException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the DeleteVocabularyFilterRequest.Builder avoiding the need to create one manually via DeleteVocabularyFilterRequest.builder()

      Parameters:
      deleteVocabularyFilterRequest - A Consumer that will call methods on DeleteVocabularyFilterRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • describeLanguageModel

      default DescribeLanguageModelResponse describeLanguageModel(DescribeLanguageModelRequest describeLanguageModelRequest) throws BadRequestException, LimitExceededException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • describeLanguageModel

      default DescribeLanguageModelResponse describeLanguageModel(Consumer<DescribeLanguageModelRequest.Builder> describeLanguageModelRequest) throws BadRequestException, LimitExceededException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the DescribeLanguageModelRequest.Builder avoiding the need to create one manually via DescribeLanguageModelRequest.builder()

      Parameters:
      describeLanguageModelRequest - A Consumer that will call methods on DescribeLanguageModelRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • getCallAnalyticsCategory

      default GetCallAnalyticsCategoryResponse getCallAnalyticsCategory(GetCallAnalyticsCategoryRequest getCallAnalyticsCategoryRequest) throws NotFoundException, LimitExceededException, InternalFailureException, BadRequestException, AwsServiceException, SdkClientException, TranscribeException

      Provides information about the specified Call Analytics category.

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

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • getCallAnalyticsCategory

      default GetCallAnalyticsCategoryResponse getCallAnalyticsCategory(Consumer<GetCallAnalyticsCategoryRequest.Builder> getCallAnalyticsCategoryRequest) throws NotFoundException, LimitExceededException, InternalFailureException, BadRequestException, AwsServiceException, SdkClientException, TranscribeException

      Provides information about the specified Call Analytics category.

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


      This is a convenience which creates an instance of the GetCallAnalyticsCategoryRequest.Builder avoiding the need to create one manually via GetCallAnalyticsCategoryRequest.builder()

      Parameters:
      getCallAnalyticsCategoryRequest - A Consumer that will call methods on GetCallAnalyticsCategoryRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • getCallAnalyticsJob

      default GetCallAnalyticsJobResponse getCallAnalyticsJob(GetCallAnalyticsJobRequest getCallAnalyticsJobRequest) throws BadRequestException, LimitExceededException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • getCallAnalyticsJob

      default GetCallAnalyticsJobResponse getCallAnalyticsJob(Consumer<GetCallAnalyticsJobRequest.Builder> getCallAnalyticsJobRequest) throws BadRequestException, LimitExceededException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the GetCallAnalyticsJobRequest.Builder avoiding the need to create one manually via GetCallAnalyticsJobRequest.builder()

      Parameters:
      getCallAnalyticsJobRequest - A Consumer that will call methods on GetCallAnalyticsJobRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • getMedicalScribeJob

      default GetMedicalScribeJobResponse getMedicalScribeJob(GetMedicalScribeJobRequest getMedicalScribeJobRequest) throws BadRequestException, LimitExceededException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • getMedicalScribeJob

      default GetMedicalScribeJobResponse getMedicalScribeJob(Consumer<GetMedicalScribeJobRequest.Builder> getMedicalScribeJobRequest) throws BadRequestException, LimitExceededException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the GetMedicalScribeJobRequest.Builder avoiding the need to create one manually via GetMedicalScribeJobRequest.builder()

      Parameters:
      getMedicalScribeJobRequest - A Consumer that will call methods on GetMedicalScribeJobRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • getMedicalTranscriptionJob

      default GetMedicalTranscriptionJobResponse getMedicalTranscriptionJob(GetMedicalTranscriptionJobRequest getMedicalTranscriptionJobRequest) throws BadRequestException, LimitExceededException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • getMedicalTranscriptionJob

      default GetMedicalTranscriptionJobResponse getMedicalTranscriptionJob(Consumer<GetMedicalTranscriptionJobRequest.Builder> getMedicalTranscriptionJobRequest) throws BadRequestException, LimitExceededException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the GetMedicalTranscriptionJobRequest.Builder avoiding the need to create one manually via GetMedicalTranscriptionJobRequest.builder()

      Parameters:
      getMedicalTranscriptionJobRequest - A Consumer that will call methods on GetMedicalTranscriptionJobRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • getMedicalVocabulary

      default GetMedicalVocabularyResponse getMedicalVocabulary(GetMedicalVocabularyRequest getMedicalVocabularyRequest) throws NotFoundException, LimitExceededException, InternalFailureException, BadRequestException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • getMedicalVocabulary

      default GetMedicalVocabularyResponse getMedicalVocabulary(Consumer<GetMedicalVocabularyRequest.Builder> getMedicalVocabularyRequest) throws NotFoundException, LimitExceededException, InternalFailureException, BadRequestException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the GetMedicalVocabularyRequest.Builder avoiding the need to create one manually via GetMedicalVocabularyRequest.builder()

      Parameters:
      getMedicalVocabularyRequest - A Consumer that will call methods on GetMedicalVocabularyRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • getTranscriptionJob

      default GetTranscriptionJobResponse getTranscriptionJob(GetTranscriptionJobRequest getTranscriptionJobRequest) throws BadRequestException, LimitExceededException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • getTranscriptionJob

      default GetTranscriptionJobResponse getTranscriptionJob(Consumer<GetTranscriptionJobRequest.Builder> getTranscriptionJobRequest) throws BadRequestException, LimitExceededException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the GetTranscriptionJobRequest.Builder avoiding the need to create one manually via GetTranscriptionJobRequest.builder()

      Parameters:
      getTranscriptionJobRequest - A Consumer that will call methods on GetTranscriptionJobRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • getVocabulary

      default GetVocabularyResponse getVocabulary(GetVocabularyRequest getVocabularyRequest) throws NotFoundException, LimitExceededException, InternalFailureException, BadRequestException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • getVocabulary

      default GetVocabularyResponse getVocabulary(Consumer<GetVocabularyRequest.Builder> getVocabularyRequest) throws NotFoundException, LimitExceededException, InternalFailureException, BadRequestException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the GetVocabularyRequest.Builder avoiding the need to create one manually via GetVocabularyRequest.builder()

      Parameters:
      getVocabularyRequest - A Consumer that will call methods on GetVocabularyRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • getVocabularyFilter

      default GetVocabularyFilterResponse getVocabularyFilter(GetVocabularyFilterRequest getVocabularyFilterRequest) throws NotFoundException, LimitExceededException, InternalFailureException, BadRequestException, AwsServiceException, SdkClientException, TranscribeException

      Provides information about the specified custom vocabulary filter.

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

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • getVocabularyFilter

      default GetVocabularyFilterResponse getVocabularyFilter(Consumer<GetVocabularyFilterRequest.Builder> getVocabularyFilterRequest) throws NotFoundException, LimitExceededException, InternalFailureException, BadRequestException, AwsServiceException, SdkClientException, TranscribeException

      Provides information about the specified custom vocabulary filter.

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


      This is a convenience which creates an instance of the GetVocabularyFilterRequest.Builder avoiding the need to create one manually via GetVocabularyFilterRequest.builder()

      Parameters:
      getVocabularyFilterRequest - A Consumer that will call methods on GetVocabularyFilterRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listCallAnalyticsCategories

      default ListCallAnalyticsCategoriesResponse listCallAnalyticsCategories(ListCallAnalyticsCategoriesRequest listCallAnalyticsCategoriesRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listCallAnalyticsCategories

      default ListCallAnalyticsCategoriesResponse listCallAnalyticsCategories(Consumer<ListCallAnalyticsCategoriesRequest.Builder> listCallAnalyticsCategoriesRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the ListCallAnalyticsCategoriesRequest.Builder avoiding the need to create one manually via ListCallAnalyticsCategoriesRequest.builder()

      Parameters:
      listCallAnalyticsCategoriesRequest - A Consumer that will call methods on ListCallAnalyticsCategoriesRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listCallAnalyticsCategoriesPaginator

      default ListCallAnalyticsCategoriesIterable listCallAnalyticsCategoriesPaginator(ListCallAnalyticsCategoriesRequest listCallAnalyticsCategoriesRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      This is a variant of listCallAnalyticsCategories(software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsCategoriesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a Stream 
       
 software.amazon.awssdk.services.transcribe.paginators.ListCallAnalyticsCategoriesIterable responses = client.listCallAnalyticsCategoriesPaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.transcribe.paginators.ListCallAnalyticsCategoriesIterable responses = client
             .listCallAnalyticsCategoriesPaginator(request);
     for (software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsCategoriesResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.transcribe.paginators.ListCallAnalyticsCategoriesIterable responses = client.listCallAnalyticsCategoriesPaginator(request);
 responses.iterator().forEachRemaining(....);

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCallAnalyticsCategories(software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsCategoriesRequest) operation.

      Parameters:
      listCallAnalyticsCategoriesRequest -
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listCallAnalyticsCategoriesPaginator

      default ListCallAnalyticsCategoriesIterable listCallAnalyticsCategoriesPaginator(Consumer<ListCallAnalyticsCategoriesRequest.Builder> listCallAnalyticsCategoriesRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      This is a variant of listCallAnalyticsCategories(software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsCategoriesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a Stream 
       
 software.amazon.awssdk.services.transcribe.paginators.ListCallAnalyticsCategoriesIterable responses = client.listCallAnalyticsCategoriesPaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.transcribe.paginators.ListCallAnalyticsCategoriesIterable responses = client
             .listCallAnalyticsCategoriesPaginator(request);
     for (software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsCategoriesResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.transcribe.paginators.ListCallAnalyticsCategoriesIterable responses = client.listCallAnalyticsCategoriesPaginator(request);
 responses.iterator().forEachRemaining(....);

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCallAnalyticsCategories(software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsCategoriesRequest) operation.


      This is a convenience which creates an instance of the ListCallAnalyticsCategoriesRequest.Builder avoiding the need to create one manually via ListCallAnalyticsCategoriesRequest.builder()

      Parameters:
      listCallAnalyticsCategoriesRequest - A Consumer that will call methods on ListCallAnalyticsCategoriesRequest.Builder to create a request.
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listCallAnalyticsJobs

      default ListCallAnalyticsJobsResponse listCallAnalyticsJobs(ListCallAnalyticsJobsRequest listCallAnalyticsJobsRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listCallAnalyticsJobs

      default ListCallAnalyticsJobsResponse listCallAnalyticsJobs(Consumer<ListCallAnalyticsJobsRequest.Builder> listCallAnalyticsJobsRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the ListCallAnalyticsJobsRequest.Builder avoiding the need to create one manually via ListCallAnalyticsJobsRequest.builder()

      Parameters:
      listCallAnalyticsJobsRequest - A Consumer that will call methods on ListCallAnalyticsJobsRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listCallAnalyticsJobsPaginator

      default ListCallAnalyticsJobsIterable listCallAnalyticsJobsPaginator(ListCallAnalyticsJobsRequest listCallAnalyticsJobsRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      This is a variant of listCallAnalyticsJobs(software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a Stream 
       
 software.amazon.awssdk.services.transcribe.paginators.ListCallAnalyticsJobsIterable responses = client.listCallAnalyticsJobsPaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.transcribe.paginators.ListCallAnalyticsJobsIterable responses = client
             .listCallAnalyticsJobsPaginator(request);
     for (software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsJobsResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.transcribe.paginators.ListCallAnalyticsJobsIterable responses = client.listCallAnalyticsJobsPaginator(request);
 responses.iterator().forEachRemaining(....);

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCallAnalyticsJobs(software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsJobsRequest) operation.

      Parameters:
      listCallAnalyticsJobsRequest -
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listCallAnalyticsJobsPaginator

      default ListCallAnalyticsJobsIterable listCallAnalyticsJobsPaginator(Consumer<ListCallAnalyticsJobsRequest.Builder> listCallAnalyticsJobsRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      This is a variant of listCallAnalyticsJobs(software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a Stream 
       
 software.amazon.awssdk.services.transcribe.paginators.ListCallAnalyticsJobsIterable responses = client.listCallAnalyticsJobsPaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.transcribe.paginators.ListCallAnalyticsJobsIterable responses = client
             .listCallAnalyticsJobsPaginator(request);
     for (software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsJobsResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.transcribe.paginators.ListCallAnalyticsJobsIterable responses = client.listCallAnalyticsJobsPaginator(request);
 responses.iterator().forEachRemaining(....);

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listCallAnalyticsJobs(software.amazon.awssdk.services.transcribe.model.ListCallAnalyticsJobsRequest) operation.


      This is a convenience which creates an instance of the ListCallAnalyticsJobsRequest.Builder avoiding the need to create one manually via ListCallAnalyticsJobsRequest.builder()

      Parameters:
      listCallAnalyticsJobsRequest - A Consumer that will call methods on ListCallAnalyticsJobsRequest.Builder to create a request.
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listLanguageModels

      default ListLanguageModelsResponse listLanguageModels(ListLanguageModelsRequest listLanguageModelsRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listLanguageModels

      default ListLanguageModelsResponse listLanguageModels(Consumer<ListLanguageModelsRequest.Builder> listLanguageModelsRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the ListLanguageModelsRequest.Builder avoiding the need to create one manually via ListLanguageModelsRequest.builder()

      Parameters:
      listLanguageModelsRequest - A Consumer that will call methods on ListLanguageModelsRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listLanguageModelsPaginator

      default ListLanguageModelsIterable listLanguageModelsPaginator(ListLanguageModelsRequest listLanguageModelsRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      This is a variant of listLanguageModels(software.amazon.awssdk.services.transcribe.model.ListLanguageModelsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a Stream 
       
 software.amazon.awssdk.services.transcribe.paginators.ListLanguageModelsIterable responses = client.listLanguageModelsPaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.transcribe.paginators.ListLanguageModelsIterable responses = client
             .listLanguageModelsPaginator(request);
     for (software.amazon.awssdk.services.transcribe.model.ListLanguageModelsResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.transcribe.paginators.ListLanguageModelsIterable responses = client.listLanguageModelsPaginator(request);
 responses.iterator().forEachRemaining(....);

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listLanguageModels(software.amazon.awssdk.services.transcribe.model.ListLanguageModelsRequest) operation.

      Parameters:
      listLanguageModelsRequest -
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listLanguageModelsPaginator

      default ListLanguageModelsIterable listLanguageModelsPaginator(Consumer<ListLanguageModelsRequest.Builder> listLanguageModelsRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      This is a variant of listLanguageModels(software.amazon.awssdk.services.transcribe.model.ListLanguageModelsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a Stream 
       
 software.amazon.awssdk.services.transcribe.paginators.ListLanguageModelsIterable responses = client.listLanguageModelsPaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.transcribe.paginators.ListLanguageModelsIterable responses = client
             .listLanguageModelsPaginator(request);
     for (software.amazon.awssdk.services.transcribe.model.ListLanguageModelsResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.transcribe.paginators.ListLanguageModelsIterable responses = client.listLanguageModelsPaginator(request);
 responses.iterator().forEachRemaining(....);

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listLanguageModels(software.amazon.awssdk.services.transcribe.model.ListLanguageModelsRequest) operation.


      This is a convenience which creates an instance of the ListLanguageModelsRequest.Builder avoiding the need to create one manually via ListLanguageModelsRequest.builder()

      Parameters:
      listLanguageModelsRequest - A Consumer that will call methods on ListLanguageModelsRequest.Builder to create a request.
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listMedicalScribeJobs

      default ListMedicalScribeJobsResponse listMedicalScribeJobs(ListMedicalScribeJobsRequest listMedicalScribeJobsRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listMedicalScribeJobs

      default ListMedicalScribeJobsResponse listMedicalScribeJobs(Consumer<ListMedicalScribeJobsRequest.Builder> listMedicalScribeJobsRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the ListMedicalScribeJobsRequest.Builder avoiding the need to create one manually via ListMedicalScribeJobsRequest.builder()

      Parameters:
      listMedicalScribeJobsRequest - A Consumer that will call methods on ListMedicalScribeJobsRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listMedicalScribeJobsPaginator

      default ListMedicalScribeJobsIterable listMedicalScribeJobsPaginator(ListMedicalScribeJobsRequest listMedicalScribeJobsRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      This is a variant of listMedicalScribeJobs(software.amazon.awssdk.services.transcribe.model.ListMedicalScribeJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a Stream 
       
 software.amazon.awssdk.services.transcribe.paginators.ListMedicalScribeJobsIterable responses = client.listMedicalScribeJobsPaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.transcribe.paginators.ListMedicalScribeJobsIterable responses = client
             .listMedicalScribeJobsPaginator(request);
     for (software.amazon.awssdk.services.transcribe.model.ListMedicalScribeJobsResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.transcribe.paginators.ListMedicalScribeJobsIterable responses = client.listMedicalScribeJobsPaginator(request);
 responses.iterator().forEachRemaining(....);

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listMedicalScribeJobs(software.amazon.awssdk.services.transcribe.model.ListMedicalScribeJobsRequest) operation.

      Parameters:
      listMedicalScribeJobsRequest -
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listMedicalScribeJobsPaginator

      default ListMedicalScribeJobsIterable listMedicalScribeJobsPaginator(Consumer<ListMedicalScribeJobsRequest.Builder> listMedicalScribeJobsRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      This is a variant of listMedicalScribeJobs(software.amazon.awssdk.services.transcribe.model.ListMedicalScribeJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a Stream 
       
 software.amazon.awssdk.services.transcribe.paginators.ListMedicalScribeJobsIterable responses = client.listMedicalScribeJobsPaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.transcribe.paginators.ListMedicalScribeJobsIterable responses = client
             .listMedicalScribeJobsPaginator(request);
     for (software.amazon.awssdk.services.transcribe.model.ListMedicalScribeJobsResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.transcribe.paginators.ListMedicalScribeJobsIterable responses = client.listMedicalScribeJobsPaginator(request);
 responses.iterator().forEachRemaining(....);

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listMedicalScribeJobs(software.amazon.awssdk.services.transcribe.model.ListMedicalScribeJobsRequest) operation.


      This is a convenience which creates an instance of the ListMedicalScribeJobsRequest.Builder avoiding the need to create one manually via ListMedicalScribeJobsRequest.builder()

      Parameters:
      listMedicalScribeJobsRequest - A Consumer that will call methods on ListMedicalScribeJobsRequest.Builder to create a request.
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listMedicalTranscriptionJobs

      default ListMedicalTranscriptionJobsResponse listMedicalTranscriptionJobs(ListMedicalTranscriptionJobsRequest listMedicalTranscriptionJobsRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listMedicalTranscriptionJobs

      default ListMedicalTranscriptionJobsResponse listMedicalTranscriptionJobs(Consumer<ListMedicalTranscriptionJobsRequest.Builder> listMedicalTranscriptionJobsRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the ListMedicalTranscriptionJobsRequest.Builder avoiding the need to create one manually via ListMedicalTranscriptionJobsRequest.builder()

      Parameters:
      listMedicalTranscriptionJobsRequest - A Consumer that will call methods on ListMedicalTranscriptionJobsRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listMedicalTranscriptionJobsPaginator

      default ListMedicalTranscriptionJobsIterable listMedicalTranscriptionJobsPaginator(ListMedicalTranscriptionJobsRequest listMedicalTranscriptionJobsRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      This is a variant of listMedicalTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListMedicalTranscriptionJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a Stream 
       
 software.amazon.awssdk.services.transcribe.paginators.ListMedicalTranscriptionJobsIterable responses = client.listMedicalTranscriptionJobsPaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.transcribe.paginators.ListMedicalTranscriptionJobsIterable responses = client
             .listMedicalTranscriptionJobsPaginator(request);
     for (software.amazon.awssdk.services.transcribe.model.ListMedicalTranscriptionJobsResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.transcribe.paginators.ListMedicalTranscriptionJobsIterable responses = client.listMedicalTranscriptionJobsPaginator(request);
 responses.iterator().forEachRemaining(....);

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listMedicalTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListMedicalTranscriptionJobsRequest) operation.

      Parameters:
      listMedicalTranscriptionJobsRequest -
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listMedicalTranscriptionJobsPaginator

      default ListMedicalTranscriptionJobsIterable listMedicalTranscriptionJobsPaginator(Consumer<ListMedicalTranscriptionJobsRequest.Builder> listMedicalTranscriptionJobsRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      This is a variant of listMedicalTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListMedicalTranscriptionJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a Stream 
       
 software.amazon.awssdk.services.transcribe.paginators.ListMedicalTranscriptionJobsIterable responses = client.listMedicalTranscriptionJobsPaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.transcribe.paginators.ListMedicalTranscriptionJobsIterable responses = client
             .listMedicalTranscriptionJobsPaginator(request);
     for (software.amazon.awssdk.services.transcribe.model.ListMedicalTranscriptionJobsResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.transcribe.paginators.ListMedicalTranscriptionJobsIterable responses = client.listMedicalTranscriptionJobsPaginator(request);
 responses.iterator().forEachRemaining(....);

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listMedicalTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListMedicalTranscriptionJobsRequest) operation.


      This is a convenience which creates an instance of the ListMedicalTranscriptionJobsRequest.Builder avoiding the need to create one manually via ListMedicalTranscriptionJobsRequest.builder()

      Parameters:
      listMedicalTranscriptionJobsRequest - A Consumer that will call methods on ListMedicalTranscriptionJobsRequest.Builder to create a request.
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listMedicalVocabularies

      default ListMedicalVocabulariesResponse listMedicalVocabularies(ListMedicalVocabulariesRequest listMedicalVocabulariesRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listMedicalVocabularies

      default ListMedicalVocabulariesResponse listMedicalVocabularies(Consumer<ListMedicalVocabulariesRequest.Builder> listMedicalVocabulariesRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the ListMedicalVocabulariesRequest.Builder avoiding the need to create one manually via ListMedicalVocabulariesRequest.builder()

      Parameters:
      listMedicalVocabulariesRequest - A Consumer that will call methods on ListMedicalVocabulariesRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listMedicalVocabulariesPaginator

      default ListMedicalVocabulariesIterable listMedicalVocabulariesPaginator(ListMedicalVocabulariesRequest listMedicalVocabulariesRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      This is a variant of listMedicalVocabularies(software.amazon.awssdk.services.transcribe.model.ListMedicalVocabulariesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a Stream 
       
 software.amazon.awssdk.services.transcribe.paginators.ListMedicalVocabulariesIterable responses = client.listMedicalVocabulariesPaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.transcribe.paginators.ListMedicalVocabulariesIterable responses = client
             .listMedicalVocabulariesPaginator(request);
     for (software.amazon.awssdk.services.transcribe.model.ListMedicalVocabulariesResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.transcribe.paginators.ListMedicalVocabulariesIterable responses = client.listMedicalVocabulariesPaginator(request);
 responses.iterator().forEachRemaining(....);

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listMedicalVocabularies(software.amazon.awssdk.services.transcribe.model.ListMedicalVocabulariesRequest) operation.

      Parameters:
      listMedicalVocabulariesRequest -
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listMedicalVocabulariesPaginator

      default ListMedicalVocabulariesIterable listMedicalVocabulariesPaginator(Consumer<ListMedicalVocabulariesRequest.Builder> listMedicalVocabulariesRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      This is a variant of listMedicalVocabularies(software.amazon.awssdk.services.transcribe.model.ListMedicalVocabulariesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a Stream 
       
 software.amazon.awssdk.services.transcribe.paginators.ListMedicalVocabulariesIterable responses = client.listMedicalVocabulariesPaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.transcribe.paginators.ListMedicalVocabulariesIterable responses = client
             .listMedicalVocabulariesPaginator(request);
     for (software.amazon.awssdk.services.transcribe.model.ListMedicalVocabulariesResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.transcribe.paginators.ListMedicalVocabulariesIterable responses = client.listMedicalVocabulariesPaginator(request);
 responses.iterator().forEachRemaining(....);

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listMedicalVocabularies(software.amazon.awssdk.services.transcribe.model.ListMedicalVocabulariesRequest) operation.


      This is a convenience which creates an instance of the ListMedicalVocabulariesRequest.Builder avoiding the need to create one manually via ListMedicalVocabulariesRequest.builder()

      Parameters:
      listMedicalVocabulariesRequest - A Consumer that will call methods on ListMedicalVocabulariesRequest.Builder to create a request.
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listTagsForResource

      default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws BadRequestException, NotFoundException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listTagsForResource

      default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws BadRequestException, NotFoundException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listTranscriptionJobs

      default ListTranscriptionJobsResponse listTranscriptionJobs(ListTranscriptionJobsRequest listTranscriptionJobsRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listTranscriptionJobs

      default ListTranscriptionJobsResponse listTranscriptionJobs(Consumer<ListTranscriptionJobsRequest.Builder> listTranscriptionJobsRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the ListTranscriptionJobsRequest.Builder avoiding the need to create one manually via ListTranscriptionJobsRequest.builder()

      Parameters:
      listTranscriptionJobsRequest - A Consumer that will call methods on ListTranscriptionJobsRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listTranscriptionJobs

      default ListTranscriptionJobsResponse listTranscriptionJobs() throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listTranscriptionJobsPaginator

      default ListTranscriptionJobsIterable listTranscriptionJobsPaginator() throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      This is a variant of listTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a Stream 
       
 software.amazon.awssdk.services.transcribe.paginators.ListTranscriptionJobsIterable responses = client.listTranscriptionJobsPaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.transcribe.paginators.ListTranscriptionJobsIterable responses = client
             .listTranscriptionJobsPaginator(request);
     for (software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.transcribe.paginators.ListTranscriptionJobsIterable responses = client.listTranscriptionJobsPaginator(request);
 responses.iterator().forEachRemaining(....);

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsRequest) operation.

      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listTranscriptionJobsPaginator

      default ListTranscriptionJobsIterable listTranscriptionJobsPaginator(ListTranscriptionJobsRequest listTranscriptionJobsRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      This is a variant of listTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a Stream 
       
 software.amazon.awssdk.services.transcribe.paginators.ListTranscriptionJobsIterable responses = client.listTranscriptionJobsPaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.transcribe.paginators.ListTranscriptionJobsIterable responses = client
             .listTranscriptionJobsPaginator(request);
     for (software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.transcribe.paginators.ListTranscriptionJobsIterable responses = client.listTranscriptionJobsPaginator(request);
 responses.iterator().forEachRemaining(....);

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsRequest) operation.

      Parameters:
      listTranscriptionJobsRequest -
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listTranscriptionJobsPaginator

      default ListTranscriptionJobsIterable listTranscriptionJobsPaginator(Consumer<ListTranscriptionJobsRequest.Builder> listTranscriptionJobsRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      This is a variant of listTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a Stream 
       
 software.amazon.awssdk.services.transcribe.paginators.ListTranscriptionJobsIterable responses = client.listTranscriptionJobsPaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.transcribe.paginators.ListTranscriptionJobsIterable responses = client
             .listTranscriptionJobsPaginator(request);
     for (software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.transcribe.paginators.ListTranscriptionJobsIterable responses = client.listTranscriptionJobsPaginator(request);
 responses.iterator().forEachRemaining(....);

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTranscriptionJobs(software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsRequest) operation.


      This is a convenience which creates an instance of the ListTranscriptionJobsRequest.Builder avoiding the need to create one manually via ListTranscriptionJobsRequest.builder()

      Parameters:
      listTranscriptionJobsRequest - A Consumer that will call methods on ListTranscriptionJobsRequest.Builder to create a request.
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listVocabularies

      default ListVocabulariesResponse listVocabularies(ListVocabulariesRequest listVocabulariesRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listVocabularies

      default ListVocabulariesResponse listVocabularies(Consumer<ListVocabulariesRequest.Builder> listVocabulariesRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the ListVocabulariesRequest.Builder avoiding the need to create one manually via ListVocabulariesRequest.builder()

      Parameters:
      listVocabulariesRequest - A Consumer that will call methods on ListVocabulariesRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listVocabularies

      default ListVocabulariesResponse listVocabularies() throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listVocabulariesPaginator

      default ListVocabulariesIterable listVocabulariesPaginator() throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      This is a variant of listVocabularies(software.amazon.awssdk.services.transcribe.model.ListVocabulariesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a Stream 
       
 software.amazon.awssdk.services.transcribe.paginators.ListVocabulariesIterable responses = client.listVocabulariesPaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.transcribe.paginators.ListVocabulariesIterable responses = client
             .listVocabulariesPaginator(request);
     for (software.amazon.awssdk.services.transcribe.model.ListVocabulariesResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.transcribe.paginators.ListVocabulariesIterable responses = client.listVocabulariesPaginator(request);
 responses.iterator().forEachRemaining(....);

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listVocabularies(software.amazon.awssdk.services.transcribe.model.ListVocabulariesRequest) operation.

      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listVocabulariesPaginator

      default ListVocabulariesIterable listVocabulariesPaginator(ListVocabulariesRequest listVocabulariesRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      This is a variant of listVocabularies(software.amazon.awssdk.services.transcribe.model.ListVocabulariesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a Stream 
       
 software.amazon.awssdk.services.transcribe.paginators.ListVocabulariesIterable responses = client.listVocabulariesPaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.transcribe.paginators.ListVocabulariesIterable responses = client
             .listVocabulariesPaginator(request);
     for (software.amazon.awssdk.services.transcribe.model.ListVocabulariesResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.transcribe.paginators.ListVocabulariesIterable responses = client.listVocabulariesPaginator(request);
 responses.iterator().forEachRemaining(....);

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listVocabularies(software.amazon.awssdk.services.transcribe.model.ListVocabulariesRequest) operation.

      Parameters:
      listVocabulariesRequest -
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listVocabulariesPaginator

      default ListVocabulariesIterable listVocabulariesPaginator(Consumer<ListVocabulariesRequest.Builder> listVocabulariesRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      This is a variant of listVocabularies(software.amazon.awssdk.services.transcribe.model.ListVocabulariesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a Stream 
       
 software.amazon.awssdk.services.transcribe.paginators.ListVocabulariesIterable responses = client.listVocabulariesPaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.transcribe.paginators.ListVocabulariesIterable responses = client
             .listVocabulariesPaginator(request);
     for (software.amazon.awssdk.services.transcribe.model.ListVocabulariesResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.transcribe.paginators.ListVocabulariesIterable responses = client.listVocabulariesPaginator(request);
 responses.iterator().forEachRemaining(....);

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listVocabularies(software.amazon.awssdk.services.transcribe.model.ListVocabulariesRequest) operation.


      This is a convenience which creates an instance of the ListVocabulariesRequest.Builder avoiding the need to create one manually via ListVocabulariesRequest.builder()

      Parameters:
      listVocabulariesRequest - A Consumer that will call methods on ListVocabulariesRequest.Builder to create a request.
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listVocabularyFilters

      default ListVocabularyFiltersResponse listVocabularyFilters(ListVocabularyFiltersRequest listVocabularyFiltersRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listVocabularyFilters

      default ListVocabularyFiltersResponse listVocabularyFilters(Consumer<ListVocabularyFiltersRequest.Builder> listVocabularyFiltersRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the ListVocabularyFiltersRequest.Builder avoiding the need to create one manually via ListVocabularyFiltersRequest.builder()

      Parameters:
      listVocabularyFiltersRequest - A Consumer that will call methods on ListVocabularyFiltersRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listVocabularyFiltersPaginator

      default ListVocabularyFiltersIterable listVocabularyFiltersPaginator(ListVocabularyFiltersRequest listVocabularyFiltersRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      This is a variant of listVocabularyFilters(software.amazon.awssdk.services.transcribe.model.ListVocabularyFiltersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a Stream 
       
 software.amazon.awssdk.services.transcribe.paginators.ListVocabularyFiltersIterable responses = client.listVocabularyFiltersPaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.transcribe.paginators.ListVocabularyFiltersIterable responses = client
             .listVocabularyFiltersPaginator(request);
     for (software.amazon.awssdk.services.transcribe.model.ListVocabularyFiltersResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.transcribe.paginators.ListVocabularyFiltersIterable responses = client.listVocabularyFiltersPaginator(request);
 responses.iterator().forEachRemaining(....);

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listVocabularyFilters(software.amazon.awssdk.services.transcribe.model.ListVocabularyFiltersRequest) operation.

      Parameters:
      listVocabularyFiltersRequest -
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • listVocabularyFiltersPaginator

      default ListVocabularyFiltersIterable listVocabularyFiltersPaginator(Consumer<ListVocabularyFiltersRequest.Builder> listVocabularyFiltersRequest) throws BadRequestException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      This is a variant of listVocabularyFilters(software.amazon.awssdk.services.transcribe.model.ListVocabularyFiltersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

      When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

      The following are few ways to iterate through the response pages:

      1) Using a Stream 
       
 software.amazon.awssdk.services.transcribe.paginators.ListVocabularyFiltersIterable responses = client.listVocabularyFiltersPaginator(request);
 responses.stream().forEach(....);
      2) Using For loop 
       {
     @code
     software.amazon.awssdk.services.transcribe.paginators.ListVocabularyFiltersIterable responses = client
             .listVocabularyFiltersPaginator(request);
     for (software.amazon.awssdk.services.transcribe.model.ListVocabularyFiltersResponse response : responses) {
         // do something;
     }
 }
      3) Use iterator directly 
       
 software.amazon.awssdk.services.transcribe.paginators.ListVocabularyFiltersIterable responses = client.listVocabularyFiltersPaginator(request);
 responses.iterator().forEachRemaining(....);

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listVocabularyFilters(software.amazon.awssdk.services.transcribe.model.ListVocabularyFiltersRequest) operation.


      This is a convenience which creates an instance of the ListVocabularyFiltersRequest.Builder avoiding the need to create one manually via ListVocabularyFiltersRequest.builder()

      Parameters:
      listVocabularyFiltersRequest - A Consumer that will call methods on ListVocabularyFiltersRequest.Builder to create a request.
      Returns:
      A custom iterable that can be used to iterate through all the response pages.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • startCallAnalyticsJob

      default StartCallAnalyticsJobResponse startCallAnalyticsJob(StartCallAnalyticsJobRequest startCallAnalyticsJobRequest) throws BadRequestException, LimitExceededException, InternalFailureException, ConflictException, AwsServiceException, SdkClientException, TranscribeException

      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.

      Job queuing is available for Call Analytics jobs. If you pass a DataAccessRoleArn in your request and you exceed your Concurrent Job Limit, your job will automatically be added to a queue to be processed once your concurrent job count is below the limit.

      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.

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

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • startCallAnalyticsJob

      default StartCallAnalyticsJobResponse startCallAnalyticsJob(Consumer<StartCallAnalyticsJobRequest.Builder> startCallAnalyticsJobRequest) throws BadRequestException, LimitExceededException, InternalFailureException, ConflictException, AwsServiceException, SdkClientException, TranscribeException

      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.

      Job queuing is available for Call Analytics jobs. If you pass a DataAccessRoleArn in your request and you exceed your Concurrent Job Limit, your job will automatically be added to a queue to be processed once your concurrent job count is below the limit.

      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.

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


      This is a convenience which creates an instance of the StartCallAnalyticsJobRequest.Builder avoiding the need to create one manually via StartCallAnalyticsJobRequest.builder()

      Parameters:
      startCallAnalyticsJobRequest - A Consumer that will call methods on StartCallAnalyticsJobRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • startMedicalScribeJob

      default StartMedicalScribeJobResponse startMedicalScribeJob(StartMedicalScribeJobRequest startMedicalScribeJobRequest) throws BadRequestException, LimitExceededException, InternalFailureException, ConflictException, AwsServiceException, SdkClientException, TranscribeException

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

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • startMedicalScribeJob

      default StartMedicalScribeJobResponse startMedicalScribeJob(Consumer<StartMedicalScribeJobRequest.Builder> startMedicalScribeJobRequest) throws BadRequestException, LimitExceededException, InternalFailureException, ConflictException, AwsServiceException, SdkClientException, TranscribeException

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


      This is a convenience which creates an instance of the StartMedicalScribeJobRequest.Builder avoiding the need to create one manually via StartMedicalScribeJobRequest.builder()

      Parameters:
      startMedicalScribeJobRequest - A Consumer that will call methods on StartMedicalScribeJobRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • startMedicalTranscriptionJob

      default StartMedicalTranscriptionJobResponse startMedicalTranscriptionJob(StartMedicalTranscriptionJobRequest startMedicalTranscriptionJobRequest) throws BadRequestException, LimitExceededException, InternalFailureException, ConflictException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • startMedicalTranscriptionJob

      default StartMedicalTranscriptionJobResponse startMedicalTranscriptionJob(Consumer<StartMedicalTranscriptionJobRequest.Builder> startMedicalTranscriptionJobRequest) throws BadRequestException, LimitExceededException, InternalFailureException, ConflictException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the StartMedicalTranscriptionJobRequest.Builder avoiding the need to create one manually via StartMedicalTranscriptionJobRequest.builder()

      Parameters:
      startMedicalTranscriptionJobRequest - A Consumer that will call methods on StartMedicalTranscriptionJobRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • startTranscriptionJob

      default StartTranscriptionJobResponse startTranscriptionJob(StartTranscriptionJobRequest startTranscriptionJobRequest) throws BadRequestException, LimitExceededException, InternalFailureException, ConflictException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • startTranscriptionJob

      default StartTranscriptionJobResponse startTranscriptionJob(Consumer<StartTranscriptionJobRequest.Builder> startTranscriptionJobRequest) throws BadRequestException, LimitExceededException, InternalFailureException, ConflictException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the StartTranscriptionJobRequest.Builder avoiding the need to create one manually via StartTranscriptionJobRequest.builder()

      Parameters:
      startTranscriptionJobRequest - A Consumer that will call methods on StartTranscriptionJobRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • tagResource

      default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws BadRequestException, ConflictException, NotFoundException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • tagResource

      default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws BadRequestException, ConflictException, NotFoundException, LimitExceededException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • untagResource

      default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws LimitExceededException, BadRequestException, ConflictException, NotFoundException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      Removes the specified tags from the specified Amazon Transcribe resource.

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

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • untagResource

      default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws LimitExceededException, BadRequestException, ConflictException, NotFoundException, InternalFailureException, AwsServiceException, SdkClientException, TranscribeException

      Removes the specified tags from the specified Amazon Transcribe resource.

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


      This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • updateCallAnalyticsCategory

      default UpdateCallAnalyticsCategoryResponse updateCallAnalyticsCategory(UpdateCallAnalyticsCategoryRequest updateCallAnalyticsCategoryRequest) throws BadRequestException, LimitExceededException, InternalFailureException, NotFoundException, ConflictException, AwsServiceException, SdkClientException, TranscribeException

      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 .

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • updateCallAnalyticsCategory

      default UpdateCallAnalyticsCategoryResponse updateCallAnalyticsCategory(Consumer<UpdateCallAnalyticsCategoryRequest.Builder> updateCallAnalyticsCategoryRequest) throws BadRequestException, LimitExceededException, InternalFailureException, NotFoundException, ConflictException, AwsServiceException, SdkClientException, TranscribeException

      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 .


      This is a convenience which creates an instance of the UpdateCallAnalyticsCategoryRequest.Builder avoiding the need to create one manually via UpdateCallAnalyticsCategoryRequest.builder()

      Parameters:
      updateCallAnalyticsCategoryRequest - A Consumer that will call methods on UpdateCallAnalyticsCategoryRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • updateMedicalVocabulary

      default UpdateMedicalVocabularyResponse updateMedicalVocabulary(UpdateMedicalVocabularyRequest updateMedicalVocabularyRequest) throws BadRequestException, LimitExceededException, InternalFailureException, NotFoundException, ConflictException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • updateMedicalVocabulary

      default UpdateMedicalVocabularyResponse updateMedicalVocabulary(Consumer<UpdateMedicalVocabularyRequest.Builder> updateMedicalVocabularyRequest) throws BadRequestException, LimitExceededException, InternalFailureException, NotFoundException, ConflictException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the UpdateMedicalVocabularyRequest.Builder avoiding the need to create one manually via UpdateMedicalVocabularyRequest.builder()

      Parameters:
      updateMedicalVocabularyRequest - A Consumer that will call methods on UpdateMedicalVocabularyRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • updateVocabulary

      default UpdateVocabularyResponse updateVocabulary(UpdateVocabularyRequest updateVocabularyRequest) throws BadRequestException, LimitExceededException, InternalFailureException, NotFoundException, ConflictException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • updateVocabulary

      default UpdateVocabularyResponse updateVocabulary(Consumer<UpdateVocabularyRequest.Builder> updateVocabularyRequest) throws BadRequestException, LimitExceededException, InternalFailureException, NotFoundException, ConflictException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the UpdateVocabularyRequest.Builder avoiding the need to create one manually via UpdateVocabularyRequest.builder()

      Parameters:
      updateVocabularyRequest - A Consumer that will call methods on UpdateVocabularyRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • updateVocabularyFilter

      default UpdateVocabularyFilterResponse updateVocabularyFilter(UpdateVocabularyFilterRequest updateVocabularyFilterRequest) throws BadRequestException, LimitExceededException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, TranscribeException

      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.

      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • updateVocabularyFilter

      default UpdateVocabularyFilterResponse updateVocabularyFilter(Consumer<UpdateVocabularyFilterRequest.Builder> updateVocabularyFilterRequest) throws BadRequestException, LimitExceededException, InternalFailureException, NotFoundException, AwsServiceException, SdkClientException, TranscribeException

      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.


      This is a convenience which creates an instance of the UpdateVocabularyFilterRequest.Builder avoiding the need to create one manually via UpdateVocabularyFilterRequest.builder()

      Parameters:
      updateVocabularyFilterRequest - A Consumer that will call methods on UpdateVocabularyFilterRequest.Builder to create a request.
      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.
      SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      TranscribeException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      AwsServiceException
      See Also:

    • waiter

      default TranscribeWaiter waiter()
      Create an instance of TranscribeWaiter using this client.

      Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.

      Returns:
      an instance of TranscribeWaiter

    • create

      static TranscribeClient create()
      Create a TranscribeClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static TranscribeClientBuilder builder()
      Create a builder that can be used to configure and create a TranscribeClient.

    • serviceMetadata

      static ServiceMetadata serviceMetadata()

    • serviceClientConfiguration

      default TranscribeServiceClientConfiguration serviceClientConfiguration()
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient