aws-sdk-transcribeservice 1.73.0 → 1.76.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -361,23 +361,46 @@ module Aws::TranscribeService
361
361
 
362
362
  # @!group API Operations
363
363
 
364
- # Creates a call analytics category. Amazon Transcribe applies the
365
- # conditions specified by your call analytics categories to your call
366
- # analytics jobs. For each analytics category, you must create between 1
367
- # and 20 rules. For example, you can create a 'greeting' category with
368
- # a rule that flags calls in which your agent does not use a specified
369
- # phrase (for example: "Please note this call may be recorded.") in
370
- # the first 15 seconds of the call. When you start a call analytics job,
371
- # Amazon Transcribe applies all your existing call analytics categories
372
- # to that job.
364
+ # Creates a new Call Analytics category.
365
+ #
366
+ # All categories are automatically applied to your Call Analytics jobs.
367
+ # Note that in order to apply your categories to your jobs, you must
368
+ # create them before submitting your job request, as categories cannot
369
+ # be applied retroactively.
370
+ #
371
+ # Call Analytics categories are composed of rules. For each category,
372
+ # you must create between 1 and 20 rules. Rules can include these
373
+ # parameters: , , , and .
374
+ #
375
+ # To update an existing category, see .
376
+ #
377
+ # To learn more about:
378
+ #
379
+ # * Call Analytics categories, see [Creating categories][1]
380
+ #
381
+ # * Using rules, see [Rule criteria][2] and refer to the data type
382
+ #
383
+ # * Call Analytics, see [Analyzing call center audio with Call
384
+ # Analytics][3]
385
+ #
386
+ #
387
+ #
388
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html
389
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html#call-analytics-create-categories-rules
390
+ # [3]: https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html
373
391
  #
374
392
  # @option params [required, String] :category_name
375
- # A unique name, chosen by you, for your call analytics category. For
376
- # example, `sentiment-positive-last30seconds`.
393
+ # A unique name, chosen by you, for your Call Analytics category. It's
394
+ # helpful to use a detailed naming system that will make sense to you in
395
+ # the future. For example, it's better to use
396
+ # `sentiment-positive-last30seconds` for a category over a generic name
397
+ # like `test-category`.
398
+ #
399
+ # Category names are case sensitive.
377
400
  #
378
401
  # @option params [required, Array<Types::Rule>] :rules
379
- # Rules make up a call analytics category. When creating a call
380
- # analytics category, you must create between 1 and 20 rules for your
402
+ # Rules define a Call Analytics category. When creating a new Call
403
+ # Analytics category, you must create between 1 and 20 rules for that
381
404
  # category. For each rule, you specify a filter you want applied to the
382
405
  # attributes of a call. For example, you can choose a sentiment filter
383
406
  # that detects if a customer's sentiment was positive during the last
@@ -527,17 +550,45 @@ module Aws::TranscribeService
527
550
  req.send_request(options)
528
551
  end
529
552
 
530
- # Creates a new custom language model. When creating a new language
531
- # model, you must specify if you want a Wideband (audio sample rates
532
- # over 16,000 Hz) or Narrowband (audio sample rates under 16,000 Hz)
533
- # base model. You then include the S3 URI location of your training and
534
- # tuning files, the language for the model, a unique name, and any tags
535
- # you want associated with your model.
553
+ # Creates a new custom language model.
554
+ #
555
+ # When creating a new language model, you must specify:
556
+ #
557
+ # * If you want a Wideband (audio sample rates over 16,000 Hz) or
558
+ # Narrowband (audio sample rates under 16,000 Hz) base model
559
+ #
560
+ # * The location of your training and tuning files (this must be an
561
+ # Amazon S3 URI)
562
+ #
563
+ # * The language of your model
564
+ #
565
+ # * A unique name for your model
566
+ #
567
+ # For more information, see [Custom language models][1].
568
+ #
569
+ #
570
+ #
571
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html
536
572
  #
537
573
  # @option params [required, String] :language_code
538
- # The language of your custom language model; note that the language
539
- # code you select must match the language of your training and tuning
540
- # data.
574
+ # The language code that represents the language of your model. Each
575
+ # language model must contain terms in only one language, and the
576
+ # language you select for your model must match the language of your
577
+ # training and tuning data.
578
+ #
579
+ # For a list of supported languages and their associated language codes,
580
+ # refer to the [Supported languages][1] table. Note that U.S. English
581
+ # (`en-US`) is the only language supported with Amazon Transcribe
582
+ # Medical.
583
+ #
584
+ # A custom language model can only be used to transcribe files in the
585
+ # same language as the model. For example, if you create a language
586
+ # model using US English (`en-US`), you can only apply this model to
587
+ # files that contain English audio.
588
+ #
589
+ #
590
+ #
591
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
541
592
  #
542
593
  # @option params [required, String] :base_model_name
543
594
  # The Amazon Transcribe standard language model, or base model, used to
@@ -549,21 +600,37 @@ module Aws::TranscribeService
549
600
  # less than 16,000 Hz, choose `NarrowBand`.
550
601
  #
551
602
  # @option params [required, String] :model_name
552
- # The name of your new custom language model.
603
+ # A unique name, chosen by you, for your custom language model.
553
604
  #
554
605
  # This name is case sensitive, cannot contain spaces, and must be unique
555
- # within an Amazon Web Services account. If you try to create a language
556
- # model with the same name as a previous language model, you get a
557
- # `ConflictException` error.
606
+ # within an Amazon Web Services account. If you try to create a new
607
+ # language model with the same name as an existing language model, you
608
+ # get a `ConflictException` error.
558
609
  #
559
610
  # @option params [required, Types::InputDataConfig] :input_data_config
560
- # Contains your data access role ARN (Amazon Resource Name) and the
561
- # Amazon S3 locations of your training (`S3Uri`) and tuning
562
- # (`TuningDataS3Uri`) data.
611
+ # Contains the Amazon S3 location of the training data you want to use
612
+ # to create a new custom language model, and permissions to access this
613
+ # location.
614
+ #
615
+ # When using `InputDataConfig`, you must include these sub-parameters:
616
+ # `S3Uri`, which is the Amazon S3 location of your training data, and
617
+ # `DataAccessRoleArn`, which is the Amazon Resource Name (ARN) of the
618
+ # role that has permission to access your specified Amazon S3 location.
619
+ # You can optionally include `TuningDataS3Uri`, which is the Amazon S3
620
+ # location of your tuning data. If you specify different Amazon S3
621
+ # locations for training and tuning data, the ARN you use must have
622
+ # permissions to access both locations.
563
623
  #
564
624
  # @option params [Array<Types::Tag>] :tags
565
- # Optionally add tags, each in the form of a key:value pair, to your new
566
- # language model. See also: .
625
+ # Adds one or more custom tags, each in the form of a key:value pair, to
626
+ # a new custom language model at the time you create this new model.
627
+ #
628
+ # To learn more about using tags with Amazon Transcribe, refer to
629
+ # [Tagging resources][1].
630
+ #
631
+ #
632
+ #
633
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html
567
634
  #
568
635
  # @return [Types::CreateLanguageModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
569
636
  #
@@ -613,44 +680,48 @@ module Aws::TranscribeService
613
680
 
614
681
  # Creates a new custom medical vocabulary.
615
682
  #
616
- # When creating a new medical vocabulary, you must upload a text file
617
- # that contains your new entries, phrases, and terms into an S3 bucket.
618
- # Note that this differs from , where you can include a list of terms
619
- # within your request using the `Phrases` flag, as
683
+ # Prior to creating a new medical vocabulary, you must first upload a
684
+ # text file that contains your new entries, phrases, and terms into an
685
+ # Amazon S3 bucket. Note that this differs from , where you can include
686
+ # a list of terms within your request using the `Phrases` flag;
620
687
  # `CreateMedicalVocabulary` does not support the `Phrases` flag.
621
688
  #
622
- # For more information on creating a custom vocabulary text file, see
623
- # [Creating a custom vocabulary][1].
689
+ # Each language has a character set that contains all allowed characters
690
+ # for that specific language. If you use unsupported characters, your
691
+ # vocabulary request fails. Refer to [Character Sets for Custom
692
+ # Vocabularies][1] to get the character set for your language.
624
693
  #
694
+ # For more information, see [Creating a custom vocabulary][2].
625
695
  #
626
696
  #
627
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html
697
+ #
698
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html
699
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html
628
700
  #
629
701
  # @option params [required, String] :vocabulary_name
630
- # The name of your new vocabulary.
702
+ # A unique name, chosen by you, for your new custom medical vocabulary.
631
703
  #
632
704
  # This name is case sensitive, cannot contain spaces, and must be unique
633
- # within an Amazon Web Services account. If you try to create a
634
- # vocabulary with the same name as a previous vocabulary, you get a
635
- # `ConflictException` error.
705
+ # within an Amazon Web Services account. If you try to create a new
706
+ # medical vocabulary with the same name as an existing medical
707
+ # vocabulary, you get a `ConflictException` error.
636
708
  #
637
709
  # @option params [required, String] :language_code
638
710
  # The language code that represents the language of the entries in your
639
- # custom vocabulary. Note that U.S. English (`en-US`) is the only
640
- # language supported with Amazon Transcribe Medical.
711
+ # custom vocabulary. US English (`en-US`) is the only language supported
712
+ # with Amazon Transcribe Medical.
641
713
  #
642
714
  # @option params [required, String] :vocabulary_file_uri
643
715
  # The Amazon S3 location (URI) of the text file that contains your
644
- # custom vocabulary. The URI must be in the same Amazon Web Services
645
- # Region as the resource that you're calling.
716
+ # custom medical vocabulary. The URI must be in the same Amazon Web
717
+ # Services Region as the resource you're calling.
646
718
  #
647
719
  # Here's an example URI path:
648
- #
649
- # `https://s3.us-east-1.amazonaws.com/my-s3-bucket/my-vocab-file.txt`
720
+ # `s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt`
650
721
  #
651
722
  # @option params [Array<Types::Tag>] :tags
652
- # Adds one or more tags, each in the form of a key:value pair, to a new
653
- # medical vocabulary at the time you create the new vocabulary.
723
+ # Adds one or more custom tags, each in the form of a key:value pair, to
724
+ # a new medical vocabulary at the time you create this new vocabulary.
654
725
  #
655
726
  # To learn more about using tags with Amazon Transcribe, refer to
656
727
  # [Tagging resources][1].
@@ -671,7 +742,7 @@ module Aws::TranscribeService
671
742
  #
672
743
  # resp = client.create_medical_vocabulary({
673
744
  # vocabulary_name: "VocabularyName", # required
674
- # language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
745
+ # language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
675
746
  # vocabulary_file_uri: "Uri", # required
676
747
  # tags: [
677
748
  # {
@@ -684,7 +755,7 @@ module Aws::TranscribeService
684
755
  # @example Response structure
685
756
  #
686
757
  # resp.vocabulary_name #=> String
687
- # resp.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "cy-GB", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "ga-IE", "gd-GB", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
758
+ # resp.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
688
759
  # resp.vocabulary_state #=> String, one of "PENDING", "READY", "FAILED"
689
760
  # resp.last_modified_time #=> Time
690
761
  # resp.failure_reason #=> String
@@ -700,57 +771,88 @@ module Aws::TranscribeService
700
771
 
701
772
  # Creates a new custom vocabulary.
702
773
  #
703
- # When creating a new medical vocabulary, you can either upload a text
704
- # file that contains your new entries, phrases, and terms into an S3
705
- # bucket or include a list of terms directly in your request using the
706
- # `Phrases` flag.
774
+ # When creating a new vocabulary, you can either upload a text file that
775
+ # contains your new entries, phrases, and terms into an Amazon S3 bucket
776
+ # and include the URI in your request, or you can include a list of
777
+ # terms directly in your request using the `Phrases` flag.
778
+ #
779
+ # Each language has a character set that contains all allowed characters
780
+ # for that specific language. If you use unsupported characters, your
781
+ # vocabulary request fails. Refer to [Character Sets for Custom
782
+ # Vocabularies][1] to get the character set for your language.
707
783
  #
708
- # For more information on creating a custom vocabulary, see [Creating a
709
- # custom vocabulary][1].
784
+ # For more information, see [Creating a custom vocabulary][2].
710
785
  #
711
786
  #
712
787
  #
713
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html
788
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html
789
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html
714
790
  #
715
791
  # @option params [required, String] :vocabulary_name
716
- # The name of your new vocabulary.
792
+ # A unique name, chosen by you, for your new custom vocabulary.
717
793
  #
718
794
  # This name is case sensitive, cannot contain spaces, and must be unique
719
- # within an Amazon Web Services account. If you try to create a
720
- # vocabulary with the same name as a previous vocabulary, you get a
795
+ # within an Amazon Web Services account. If you try to create a new
796
+ # vocabulary with the same name as an existing vocabulary, you get a
721
797
  # `ConflictException` error.
722
798
  #
723
799
  # @option params [required, String] :language_code
724
800
  # The language code that represents the language of the entries in your
725
801
  # custom vocabulary. Each vocabulary must contain terms in only one
726
- # language. For a list of languages and their corresponding language
727
- # codes, see [Supported languages][1].
802
+ # language.
803
+ #
804
+ # A custom vocabulary can only be used to transcribe files in the same
805
+ # language as the vocabulary. For example, if you create a vocabulary
806
+ # using US English (`en-US`), you can only apply this vocabulary to
807
+ # files that contain English audio.
808
+ #
809
+ # For a list of supported languages and their associated language codes,
810
+ # refer to the [Supported languages][1] table.
728
811
  #
729
812
  #
730
813
  #
731
814
  # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
732
815
  #
733
816
  # @option params [Array<String>] :phrases
734
- # Use this flag to include a list of terms within your request.
817
+ # Use this parameter if you want to create your vocabulary by including
818
+ # all desired terms, as comma-separated values, within your request. The
819
+ # other option for creating your vocabulary is to save your entries in a
820
+ # text file and upload them to an Amazon S3 bucket, then specify the
821
+ # location of your file using the `VocabularyFileUri` parameter.
735
822
  #
736
823
  # Note that if you include `Phrases` in your request, you cannot use
737
824
  # `VocabularyFileUri`; you must choose one or the other.
738
825
  #
826
+ # Each language has a character set that contains all allowed characters
827
+ # for that specific language. If you use unsupported characters, your
828
+ # vocabulary filter request fails. Refer to [Character Sets for Custom
829
+ # Vocabularies][1] to get the character set for your language.
830
+ #
831
+ #
832
+ #
833
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html
834
+ #
739
835
  # @option params [String] :vocabulary_file_uri
740
- # The S3 location of the text file that contains your custom vocabulary.
741
- # The URI must be located in the same region as the API endpoint you're
742
- # calling.
836
+ # The Amazon S3 location of the text file that contains your custom
837
+ # vocabulary. The URI must be located in the same Amazon Web Services
838
+ # Region as the resource you're calling.
743
839
  #
744
840
  # Here's an example URI path:
745
- #
746
- # `https://s3.us-east-1.amazonaws.com/my-s3-bucket/my-vocab-file.txt`
841
+ # `s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt`
747
842
  #
748
843
  # Note that if you include `VocabularyFileUri` in your request, you
749
844
  # cannot use the `Phrases` flag; you must choose one or the other.
750
845
  #
751
846
  # @option params [Array<Types::Tag>] :tags
752
- # Adds one or more tags, each in the form of a key:value pair, to a new
753
- # custom vocabulary at the time you create this new vocabulary.
847
+ # Adds one or more custom tags, each in the form of a key:value pair, to
848
+ # a new custom vocabulary at the time you create this new vocabulary.
849
+ #
850
+ # To learn more about using tags with Amazon Transcribe, refer to
851
+ # [Tagging resources][1].
852
+ #
853
+ #
854
+ #
855
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html
754
856
  #
755
857
  # @return [Types::CreateVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
756
858
  #
@@ -764,7 +866,7 @@ module Aws::TranscribeService
764
866
  #
765
867
  # resp = client.create_vocabulary({
766
868
  # vocabulary_name: "VocabularyName", # required
767
- # language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
869
+ # language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
768
870
  # phrases: ["Phrase"],
769
871
  # vocabulary_file_uri: "Uri",
770
872
  # tags: [
@@ -778,7 +880,7 @@ module Aws::TranscribeService
778
880
  # @example Response structure
779
881
  #
780
882
  # resp.vocabulary_name #=> String
781
- # resp.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "cy-GB", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "ga-IE", "gd-GB", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
883
+ # resp.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
782
884
  # resp.vocabulary_state #=> String, one of "PENDING", "READY", "FAILED"
783
885
  # resp.last_modified_time #=> Time
784
886
  # resp.failure_reason #=> String
@@ -792,53 +894,91 @@ module Aws::TranscribeService
792
894
  req.send_request(options)
793
895
  end
794
896
 
795
- # Creates a new vocabulary filter that you can use to filter words from
796
- # your transcription output. For example, you can use this operation to
797
- # remove profanity from your transcript.
897
+ # Creates a new custom vocabulary filter.
898
+ #
899
+ # You can use vocabulary filters to mask, delete, or flag specific words
900
+ # from your transcript. Vocabulary filters are commonly used to mask
901
+ # profanity in transcripts.
902
+ #
903
+ # Each language has a character set that contains all allowed characters
904
+ # for that specific language. If you use unsupported characters, your
905
+ # vocabulary filter request fails. Refer to [Character Sets for Custom
906
+ # Vocabularies][1] to get the character set for your language.
907
+ #
908
+ # For more information, see [Using vocabulary filtering with unwanted
909
+ # words][2].
910
+ #
911
+ #
912
+ #
913
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html
914
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html
798
915
  #
799
916
  # @option params [required, String] :vocabulary_filter_name
800
- # The name of your new vocabulary filter.
917
+ # A unique name, chosen by you, for your new custom vocabulary filter.
801
918
  #
802
919
  # This name is case sensitive, cannot contain spaces, and must be unique
803
- # within an Amazon Web Services account. If you try to create a
804
- # vocabulary filter with the same name as a previous vocabulary filter,
920
+ # within an Amazon Web Services account. If you try to create a new
921
+ # vocabulary filter with the same name as an existing vocabulary filter,
805
922
  # you get a `ConflictException` error.
806
923
  #
807
924
  # @option params [required, String] :language_code
808
- # The language code of the words in the vocabulary filter. All words in
809
- # the filter must be in the same language. The vocabulary filter can
810
- # only be used with transcription jobs in the specified language.
925
+ # The language code that represents the language of the entries in your
926
+ # vocabulary filter. Each vocabulary filter must contain terms in only
927
+ # one language.
928
+ #
929
+ # A vocabulary filter can only be used to transcribe files in the same
930
+ # language as the filter. For example, if you create a vocabulary filter
931
+ # using US English (`en-US`), you can only apply this filter to files
932
+ # that contain English audio.
933
+ #
934
+ # For a list of supported languages and their associated language codes,
935
+ # refer to the [Supported languages][1] table.
936
+ #
937
+ #
938
+ #
939
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
811
940
  #
812
941
  # @option params [Array<String>] :words
813
- # The words you want in your vocabulary filter. Only use characters
814
- # specified in the [Character sets][1] for the language you're
815
- # transcribing.
942
+ # Use this parameter if you want to create your vocabulary filter by
943
+ # including all desired terms, as comma-separated values, within your
944
+ # request. The other option for creating your vocabulary filter is to
945
+ # save your entries in a text file and upload them to an Amazon S3
946
+ # bucket, then specify the location of your file using the
947
+ # `VocabularyFilterFileUri` parameter.
816
948
  #
817
949
  # Note that if you include `Words` in your request, you cannot use
818
950
  # `VocabularyFilterFileUri`; you must choose one or the other.
819
951
  #
952
+ # Each language has a character set that contains all allowed characters
953
+ # for that specific language. If you use unsupported characters, your
954
+ # vocabulary filter request fails. Refer to [Character Sets for Custom
955
+ # Vocabularies][1] to get the character set for your language.
956
+ #
820
957
  #
821
958
  #
822
959
  # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html
823
960
  #
824
961
  # @option params [String] :vocabulary_filter_file_uri
825
- # The Amazon S3 location of a text file used as input to create the
826
- # vocabulary filter. Only use characters from the character set defined
827
- # for custom vocabularies. For a list of character sets, see [Character
828
- # Sets for Custom Vocabularies][1].
962
+ # The Amazon S3 location of the text file that contains your custom
963
+ # vocabulary filter terms. The URI must be located in the same Amazon
964
+ # Web Services Region as the resource you're calling.
829
965
  #
830
- # Your vocabulary filter file must be less than 50 KB in size.
966
+ # Here's an example URI path:
967
+ # `s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt`
831
968
  #
832
969
  # Note that if you include `VocabularyFilterFileUri` in your request,
833
970
  # you cannot use `Words`; you must choose one or the other.
834
971
  #
972
+ # @option params [Array<Types::Tag>] :tags
973
+ # Adds one or more custom tags, each in the form of a key:value pair, to
974
+ # a new custom vocabulary filter at the time you create this new filter.
835
975
  #
976
+ # To learn more about using tags with Amazon Transcribe, refer to
977
+ # [Tagging resources][1].
836
978
  #
837
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html
838
979
  #
839
- # @option params [Array<Types::Tag>] :tags
840
- # Adds one or more tags, each in the form of a key:value pair, to a new
841
- # vocabulary filter at the time you create this new vocabulary filter.
980
+ #
981
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html
842
982
  #
843
983
  # @return [Types::CreateVocabularyFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
844
984
  #
@@ -850,7 +990,7 @@ module Aws::TranscribeService
850
990
  #
851
991
  # resp = client.create_vocabulary_filter({
852
992
  # vocabulary_filter_name: "VocabularyFilterName", # required
853
- # language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
993
+ # language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
854
994
  # words: ["Word"],
855
995
  # vocabulary_filter_file_uri: "Uri",
856
996
  # tags: [
@@ -864,7 +1004,7 @@ module Aws::TranscribeService
864
1004
  # @example Response structure
865
1005
  #
866
1006
  # resp.vocabulary_filter_name #=> String
867
- # resp.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "cy-GB", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "ga-IE", "gd-GB", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
1007
+ # resp.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
868
1008
  # resp.last_modified_time #=> Time
869
1009
  #
870
1010
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateVocabularyFilter AWS API Documentation
@@ -876,12 +1016,13 @@ module Aws::TranscribeService
876
1016
  req.send_request(options)
877
1017
  end
878
1018
 
879
- # Deletes a call analytics category. To use this operation, specify the
880
- # name of the category you want to delete using `CategoryName`.
1019
+ # Deletes a Call Analytics category. To use this operation, specify the
1020
+ # name of the category you want to delete using `CategoryName`. Category
1021
+ # names are case sensitive.
881
1022
  #
882
1023
  # @option params [required, String] :category_name
883
- # The name of the call analytics category you want to delete. Category
884
- # names are case-sensitive.
1024
+ # The name of the Call Analytics category you want to delete. Category
1025
+ # names are case sensitive.
885
1026
  #
886
1027
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
887
1028
  #
@@ -900,12 +1041,13 @@ module Aws::TranscribeService
900
1041
  req.send_request(options)
901
1042
  end
902
1043
 
903
- # Deletes a call analytics job. To use this operation, specify the name
904
- # of the job you want to delete using `CallAnalyticsJobName`.
1044
+ # Deletes a Call Analytics job. To use this operation, specify the name
1045
+ # of the job you want to delete using `CallAnalyticsJobName`. Job names
1046
+ # are case sensitive.
905
1047
  #
906
1048
  # @option params [required, String] :call_analytics_job_name
907
- # The name of the call analytics job you want to delete. Job names are
908
- # case-sensitive.
1049
+ # The name of the Call Analytics job you want to delete. Job names are
1050
+ # case sensitive.
909
1051
  #
910
1052
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
911
1053
  #
@@ -926,10 +1068,11 @@ module Aws::TranscribeService
926
1068
 
927
1069
  # Deletes a custom language model. To use this operation, specify the
928
1070
  # name of the language model you want to delete using `ModelName`.
1071
+ # Language model names are case sensitive.
929
1072
  #
930
1073
  # @option params [required, String] :model_name
931
- # The name of the model you want to delete. Model names are
932
- # case-sensitive.
1074
+ # The name of the custom language model you want to delete. Model names
1075
+ # are case sensitive.
933
1076
  #
934
1077
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
935
1078
  #
@@ -948,13 +1091,13 @@ module Aws::TranscribeService
948
1091
  req.send_request(options)
949
1092
  end
950
1093
 
951
- # Deletes a medical transcription job, along with any related
952
- # information. To use this operation, specify the name of the job you
953
- # want to delete using `MedicalTranscriptionJobName`.
1094
+ # Deletes a medical transcription job. To use this operation, specify
1095
+ # the name of the job you want to delete using
1096
+ # `MedicalTranscriptionJobName`. Job names are case sensitive.
954
1097
  #
955
1098
  # @option params [required, String] :medical_transcription_job_name
956
1099
  # The name of the medical transcription job you want to delete. Job
957
- # names are case-sensitive.
1100
+ # names are case sensitive.
958
1101
  #
959
1102
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
960
1103
  #
@@ -975,10 +1118,11 @@ module Aws::TranscribeService
975
1118
 
976
1119
  # Deletes a custom medical vocabulary. To use this operation, specify
977
1120
  # the name of the vocabulary you want to delete using `VocabularyName`.
1121
+ # Vocabulary names are case sensitive.
978
1122
  #
979
1123
  # @option params [required, String] :vocabulary_name
980
- # The name of the vocabulary that you want to delete. Vocabulary names
981
- # are case-sensitive.
1124
+ # The name of the custom medical vocabulary you want to delete.
1125
+ # Vocabulary names are case sensitive.
982
1126
  #
983
1127
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
984
1128
  #
@@ -997,13 +1141,13 @@ module Aws::TranscribeService
997
1141
  req.send_request(options)
998
1142
  end
999
1143
 
1000
- # Deletes a transcription job, along with any related information. To
1001
- # use this operation, specify the name of the job you want to delete
1002
- # using `TranscriptionJobName`.
1144
+ # Deletes a transcription job. To use this operation, specify the name
1145
+ # of the job you want to delete using `TranscriptionJobName`. Job names
1146
+ # are case sensitive.
1003
1147
  #
1004
1148
  # @option params [required, String] :transcription_job_name
1005
1149
  # The name of the transcription job you want to delete. Job names are
1006
- # case-sensitive.
1150
+ # case sensitive.
1007
1151
  #
1008
1152
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1009
1153
  #
@@ -1024,10 +1168,11 @@ module Aws::TranscribeService
1024
1168
 
1025
1169
  # Deletes a custom vocabulary. To use this operation, specify the name
1026
1170
  # of the vocabulary you want to delete using `VocabularyName`.
1171
+ # Vocabulary names are case sensitive.
1027
1172
  #
1028
1173
  # @option params [required, String] :vocabulary_name
1029
- # The name of the vocabulary you want to delete. Vocabulary names are
1030
- # case-sensitive.
1174
+ # The name of the custom vocabulary you want to delete. Vocabulary names
1175
+ # are case sensitive.
1031
1176
  #
1032
1177
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1033
1178
  #
@@ -1048,11 +1193,11 @@ module Aws::TranscribeService
1048
1193
 
1049
1194
  # Deletes a vocabulary filter. To use this operation, specify the name
1050
1195
  # of the vocabulary filter you want to delete using
1051
- # `VocabularyFilterName`.
1196
+ # `VocabularyFilterName`. Vocabulary filter names are case sensitive.
1052
1197
  #
1053
1198
  # @option params [required, String] :vocabulary_filter_name
1054
- # The name of the vocabulary filter you want to delete. Vocabulary
1055
- # filter names are case-sensitive.
1199
+ # The name of the custom vocabulary filter you want to delete.
1200
+ # Vocabulary filter names are case sensitive.
1056
1201
  #
1057
1202
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1058
1203
  #
@@ -1071,8 +1216,7 @@ module Aws::TranscribeService
1071
1216
  req.send_request(options)
1072
1217
  end
1073
1218
 
1074
- # Provides information about a specific custom language model in your
1075
- # Amazon Web Services account.
1219
+ # Provides information about the specified custom language model.
1076
1220
  #
1077
1221
  # This operation also shows if the base language model you used to
1078
1222
  # create your custom language model has been updated. If Amazon
@@ -1080,12 +1224,14 @@ module Aws::TranscribeService
1080
1224
  # language model using the updated base model.
1081
1225
  #
1082
1226
  # If you tried to create a new custom language model and the request
1083
- # wasn't successful, you can use this operation to help identify the
1084
- # reason.
1227
+ # wasn't successful, you can use `DescribeLanguageModel` to help
1228
+ # identify the reason for this failure.
1229
+ #
1230
+ # To get a list of your custom language models, use the operation.
1085
1231
  #
1086
1232
  # @option params [required, String] :model_name
1087
- # The name of the custom language model you want described. Model names
1088
- # are case-sensitive.
1233
+ # The name of the custom language model you want information about.
1234
+ # Model names are case sensitive.
1089
1235
  #
1090
1236
  # @return [Types::DescribeLanguageModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1091
1237
  #
@@ -1120,11 +1266,13 @@ module Aws::TranscribeService
1120
1266
  req.send_request(options)
1121
1267
  end
1122
1268
 
1123
- # Retrieves information about a call analytics category.
1269
+ # Provides information about the specified Call Analytics category.
1270
+ #
1271
+ # To get a list of your Call Analytics categories, use the operation.
1124
1272
  #
1125
1273
  # @option params [required, String] :category_name
1126
- # The name of the category you want information about. Category names
1127
- # are case sensitive.
1274
+ # The name of the Call Analytics category you want information about.
1275
+ # Category names are case sensitive.
1128
1276
  #
1129
1277
  # @return [Types::GetCallAnalyticsCategoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1130
1278
  #
@@ -1198,18 +1346,27 @@ module Aws::TranscribeService
1198
1346
  req.send_request(options)
1199
1347
  end
1200
1348
 
1201
- # Retrieves information about a call analytics job.
1349
+ # Provides information about the specified Call Analytics job.
1202
1350
  #
1203
- # To view the job's status, refer to the `CallAnalyticsJobStatus`
1204
- # field. If the status is `COMPLETED`, the job is finished. You can then
1205
- # find your transcript at the URI specified in the `TranscriptFileUri`
1206
- # field. If you enabled personally identifiable information (PII)
1207
- # redaction, the redacted transcript appears in the
1208
- # `RedactedTranscriptFileUri` field.
1351
+ # To view the job's status, refer to `CallAnalyticsJobStatus`. If the
1352
+ # status is `COMPLETED`, the job is finished. You can find your
1353
+ # completed transcript at the URI specified in `TranscriptFileUri`. If
1354
+ # the status is `FAILED`, `FailureReason` provides details on why your
1355
+ # transcription job failed.
1356
+ #
1357
+ # If you enabled personally identifiable information (PII) redaction,
1358
+ # the redacted transcript appears at the location specified in
1359
+ # `RedactedTranscriptFileUri`.
1360
+ #
1361
+ # If you chose to redact the audio in your media file, you can find your
1362
+ # redacted media file at the location specified in
1363
+ # `RedactedMediaFileUri`.
1364
+ #
1365
+ # To get a list of your Call Analytics jobs, use the operation.
1209
1366
  #
1210
1367
  # @option params [required, String] :call_analytics_job_name
1211
- # The name of the analytics job you want information about. This value
1212
- # is case sensitive.
1368
+ # The name of the Call Analytics job you want information about. Job
1369
+ # names are case sensitive.
1213
1370
  #
1214
1371
  # @return [Types::GetCallAnalyticsJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1215
1372
  #
@@ -1225,7 +1382,7 @@ module Aws::TranscribeService
1225
1382
  #
1226
1383
  # resp.call_analytics_job.call_analytics_job_name #=> String
1227
1384
  # resp.call_analytics_job.call_analytics_job_status #=> String, one of "QUEUED", "IN_PROGRESS", "FAILED", "COMPLETED"
1228
- # resp.call_analytics_job.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "cy-GB", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "ga-IE", "gd-GB", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
1385
+ # resp.call_analytics_job.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
1229
1386
  # resp.call_analytics_job.media_sample_rate_hertz #=> Integer
1230
1387
  # resp.call_analytics_job.media_format #=> String, one of "mp3", "mp4", "wav", "flac", "ogg", "amr", "webm"
1231
1388
  # resp.call_analytics_job.media.media_file_uri #=> String
@@ -1247,7 +1404,7 @@ module Aws::TranscribeService
1247
1404
  # resp.call_analytics_job.settings.content_redaction.pii_entity_types #=> Array
1248
1405
  # resp.call_analytics_job.settings.content_redaction.pii_entity_types[0] #=> String, one of "BANK_ACCOUNT_NUMBER", "BANK_ROUTING", "CREDIT_DEBIT_NUMBER", "CREDIT_DEBIT_CVV", "CREDIT_DEBIT_EXPIRY", "PIN", "EMAIL", "ADDRESS", "NAME", "PHONE", "SSN", "ALL"
1249
1406
  # resp.call_analytics_job.settings.language_options #=> Array
1250
- # resp.call_analytics_job.settings.language_options[0] #=> String, one of "af-ZA", "ar-AE", "ar-SA", "cy-GB", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "ga-IE", "gd-GB", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
1407
+ # resp.call_analytics_job.settings.language_options[0] #=> String, one of "af-ZA", "ar-AE", "ar-SA", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
1251
1408
  # resp.call_analytics_job.settings.language_id_settings #=> Hash
1252
1409
  # resp.call_analytics_job.settings.language_id_settings["LanguageCode"].vocabulary_name #=> String
1253
1410
  # resp.call_analytics_job.settings.language_id_settings["LanguageCode"].vocabulary_filter_name #=> String
@@ -1265,16 +1422,19 @@ module Aws::TranscribeService
1265
1422
  req.send_request(options)
1266
1423
  end
1267
1424
 
1268
- # Retrieves information about a medical transcription job.
1425
+ # Provides information about the specified medical transcription job.
1426
+ #
1427
+ # To view the status of the specified medical transcription job, check
1428
+ # the `TranscriptionJobStatus` field. If the status is `COMPLETED`, the
1429
+ # job is finished and you can find the results at the location specified
1430
+ # in `TranscriptFileUri`. If the status is `FAILED`, `FailureReason`
1431
+ # provides details on why your transcription job failed.
1269
1432
  #
1270
- # To view the job's status, refer to the `TranscriptionJobStatus`
1271
- # field. If the status is `COMPLETED`, the job is finished. You can then
1272
- # find your transcript at the URI specified in the `TranscriptFileUri`
1273
- # field.
1433
+ # To get a list of your medical transcription jobs, use the operation.
1274
1434
  #
1275
1435
  # @option params [required, String] :medical_transcription_job_name
1276
1436
  # The name of the medical transcription job you want information about.
1277
- # This value is case sensitive.
1437
+ # Job names are case sensitive.
1278
1438
  #
1279
1439
  # @return [Types::GetMedicalTranscriptionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1280
1440
  #
@@ -1290,7 +1450,7 @@ module Aws::TranscribeService
1290
1450
  #
1291
1451
  # resp.medical_transcription_job.medical_transcription_job_name #=> String
1292
1452
  # resp.medical_transcription_job.transcription_job_status #=> String, one of "QUEUED", "IN_PROGRESS", "FAILED", "COMPLETED"
1293
- # resp.medical_transcription_job.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "cy-GB", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "ga-IE", "gd-GB", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
1453
+ # resp.medical_transcription_job.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
1294
1454
  # resp.medical_transcription_job.media_sample_rate_hertz #=> Integer
1295
1455
  # resp.medical_transcription_job.media_format #=> String, one of "mp3", "mp4", "wav", "flac", "ogg", "amr", "webm"
1296
1456
  # resp.medical_transcription_job.media.media_file_uri #=> String
@@ -1322,11 +1482,18 @@ module Aws::TranscribeService
1322
1482
  req.send_request(options)
1323
1483
  end
1324
1484
 
1325
- # Retrieves information about a medical vocabulary.
1485
+ # Provides information about the specified custom medical vocabulary.
1486
+ #
1487
+ # To view the status of the specified medical vocabulary, check the
1488
+ # `VocabularyState` field. If the status is `READY`, your vocabulary is
1489
+ # available to use. If the status is `FAILED`, `FailureReason` provides
1490
+ # details on why your vocabulary failed.
1491
+ #
1492
+ # To get a list of your custom medical vocabularies, use the operation.
1326
1493
  #
1327
1494
  # @option params [required, String] :vocabulary_name
1328
- # The name of the medical vocabulary you want information about. This
1329
- # value is case sensitive.
1495
+ # The name of the custom medical vocabulary you want information about.
1496
+ # Vocabulary names are case sensitive.
1330
1497
  #
1331
1498
  # @return [Types::GetMedicalVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1332
1499
  #
@@ -1346,7 +1513,7 @@ module Aws::TranscribeService
1346
1513
  # @example Response structure
1347
1514
  #
1348
1515
  # resp.vocabulary_name #=> String
1349
- # resp.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "cy-GB", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "ga-IE", "gd-GB", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
1516
+ # resp.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
1350
1517
  # resp.vocabulary_state #=> String, one of "PENDING", "READY", "FAILED"
1351
1518
  # resp.last_modified_time #=> Time
1352
1519
  # resp.failure_reason #=> String
@@ -1361,15 +1528,22 @@ module Aws::TranscribeService
1361
1528
  req.send_request(options)
1362
1529
  end
1363
1530
 
1364
- # Returns information about a transcription job. To see the status of
1365
- # the job, check the `TranscriptionJobStatus` field. If the status is
1366
- # `COMPLETED`, the job is finished and you can find the results at the
1367
- # location specified in the `TranscriptFileUri` field. If you enable
1368
- # content redaction, the redacted transcript appears in
1369
- # `RedactedTranscriptFileUri`.
1531
+ # Provides information about the specified transcription job.
1532
+ #
1533
+ # To view the status of the specified transcription job, check the
1534
+ # `TranscriptionJobStatus` field. If the status is `COMPLETED`, the job
1535
+ # is finished and you can find the results at the location specified in
1536
+ # `TranscriptFileUri`. If the status is `FAILED`, `FailureReason`
1537
+ # provides details on why your transcription job failed.
1538
+ #
1539
+ # If you enabled content redaction, the redacted transcript can be found
1540
+ # at the location specified in `RedactedTranscriptFileUri`.
1541
+ #
1542
+ # To get a list of your transcription jobs, use the operation.
1370
1543
  #
1371
1544
  # @option params [required, String] :transcription_job_name
1372
- # The name of the job.
1545
+ # The name of the transcription job you want information about. Job
1546
+ # names are case sensitive.
1373
1547
  #
1374
1548
  # @return [Types::GetTranscriptionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1375
1549
  #
@@ -1385,7 +1559,7 @@ module Aws::TranscribeService
1385
1559
  #
1386
1560
  # resp.transcription_job.transcription_job_name #=> String
1387
1561
  # resp.transcription_job.transcription_job_status #=> String, one of "QUEUED", "IN_PROGRESS", "FAILED", "COMPLETED"
1388
- # resp.transcription_job.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "cy-GB", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "ga-IE", "gd-GB", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
1562
+ # resp.transcription_job.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
1389
1563
  # resp.transcription_job.media_sample_rate_hertz #=> Integer
1390
1564
  # resp.transcription_job.media_format #=> String, one of "mp3", "mp4", "wav", "flac", "ogg", "amr", "webm"
1391
1565
  # resp.transcription_job.media.media_file_uri #=> String
@@ -1412,9 +1586,13 @@ module Aws::TranscribeService
1412
1586
  # resp.transcription_job.content_redaction.pii_entity_types #=> Array
1413
1587
  # resp.transcription_job.content_redaction.pii_entity_types[0] #=> String, one of "BANK_ACCOUNT_NUMBER", "BANK_ROUTING", "CREDIT_DEBIT_NUMBER", "CREDIT_DEBIT_CVV", "CREDIT_DEBIT_EXPIRY", "PIN", "EMAIL", "ADDRESS", "NAME", "PHONE", "SSN", "ALL"
1414
1588
  # resp.transcription_job.identify_language #=> Boolean
1589
+ # resp.transcription_job.identify_multiple_languages #=> Boolean
1415
1590
  # resp.transcription_job.language_options #=> Array
1416
- # resp.transcription_job.language_options[0] #=> String, one of "af-ZA", "ar-AE", "ar-SA", "cy-GB", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "ga-IE", "gd-GB", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
1591
+ # resp.transcription_job.language_options[0] #=> String, one of "af-ZA", "ar-AE", "ar-SA", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
1417
1592
  # resp.transcription_job.identified_language_score #=> Float
1593
+ # resp.transcription_job.language_codes #=> Array
1594
+ # resp.transcription_job.language_codes[0].language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
1595
+ # resp.transcription_job.language_codes[0].duration_in_seconds #=> Float
1418
1596
  # resp.transcription_job.tags #=> Array
1419
1597
  # resp.transcription_job.tags[0].key #=> String
1420
1598
  # resp.transcription_job.tags[0].value #=> String
@@ -1422,6 +1600,7 @@ module Aws::TranscribeService
1422
1600
  # resp.transcription_job.subtitles.formats[0] #=> String, one of "vtt", "srt"
1423
1601
  # resp.transcription_job.subtitles.subtitle_file_uris #=> Array
1424
1602
  # resp.transcription_job.subtitles.subtitle_file_uris[0] #=> String
1603
+ # resp.transcription_job.subtitles.output_start_index #=> Integer
1425
1604
  # resp.transcription_job.language_id_settings #=> Hash
1426
1605
  # resp.transcription_job.language_id_settings["LanguageCode"].vocabulary_name #=> String
1427
1606
  # resp.transcription_job.language_id_settings["LanguageCode"].vocabulary_filter_name #=> String
@@ -1436,11 +1615,18 @@ module Aws::TranscribeService
1436
1615
  req.send_request(options)
1437
1616
  end
1438
1617
 
1439
- # Gets information about a vocabulary.
1618
+ # Provides information about the specified custom vocabulary.
1619
+ #
1620
+ # To view the status of the specified vocabulary, check the
1621
+ # `VocabularyState` field. If the status is `READY`, your vocabulary is
1622
+ # available to use. If the status is `FAILED`, `FailureReason` provides
1623
+ # details on why your vocabulary failed.
1624
+ #
1625
+ # To get a list of your custom vocabularies, use the operation.
1440
1626
  #
1441
1627
  # @option params [required, String] :vocabulary_name
1442
- # The name of the vocabulary to return information about. The name is
1443
- # case sensitive.
1628
+ # The name of the custom vocabulary you want information about.
1629
+ # Vocabulary names are case sensitive.
1444
1630
  #
1445
1631
  # @return [Types::GetVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1446
1632
  #
@@ -1460,7 +1646,7 @@ module Aws::TranscribeService
1460
1646
  # @example Response structure
1461
1647
  #
1462
1648
  # resp.vocabulary_name #=> String
1463
- # resp.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "cy-GB", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "ga-IE", "gd-GB", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
1649
+ # resp.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
1464
1650
  # resp.vocabulary_state #=> String, one of "PENDING", "READY", "FAILED"
1465
1651
  # resp.last_modified_time #=> Time
1466
1652
  # resp.failure_reason #=> String
@@ -1475,10 +1661,18 @@ module Aws::TranscribeService
1475
1661
  req.send_request(options)
1476
1662
  end
1477
1663
 
1478
- # Returns information about a vocabulary filter.
1664
+ # Provides information about the specified custom vocabulary filter.
1665
+ #
1666
+ # To view the status of the specified vocabulary filter, check the
1667
+ # `VocabularyState` field. If the status is `READY`, your vocabulary is
1668
+ # available to use. If the status is `FAILED`, `FailureReason` provides
1669
+ # details on why your vocabulary filter failed.
1670
+ #
1671
+ # To get a list of your custom vocabulary filters, use the operation.
1479
1672
  #
1480
1673
  # @option params [required, String] :vocabulary_filter_name
1481
- # The name of the vocabulary filter for which to return information.
1674
+ # The name of the custom vocabulary filter you want information about.
1675
+ # Vocabulary filter names are case sensitive.
1482
1676
  #
1483
1677
  # @return [Types::GetVocabularyFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1484
1678
  #
@@ -1496,7 +1690,7 @@ module Aws::TranscribeService
1496
1690
  # @example Response structure
1497
1691
  #
1498
1692
  # resp.vocabulary_filter_name #=> String
1499
- # resp.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "cy-GB", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "ga-IE", "gd-GB", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
1693
+ # resp.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
1500
1694
  # resp.last_modified_time #=> Time
1501
1695
  # resp.download_uri #=> String
1502
1696
  #
@@ -1509,20 +1703,24 @@ module Aws::TranscribeService
1509
1703
  req.send_request(options)
1510
1704
  end
1511
1705
 
1512
- # Provides more information about the call analytics categories that
1513
- # you've created. You can use the information in this list to find a
1514
- # specific category. You can then use the operation to get more
1515
- # information about it.
1706
+ # Provides a list of Call Analytics categories, including all rules that
1707
+ # make up each category.
1708
+ #
1709
+ # To get detailed information about a specific Call Analytics category,
1710
+ # use the operation.
1516
1711
  #
1517
1712
  # @option params [String] :next_token
1518
- # When included, `NextToken`fetches the next set of categories if the
1519
- # result of the previous request was truncated.
1713
+ # If your `ListCallAnalyticsCategories` request returns more results
1714
+ # than can be displayed, `NextToken` is displayed in the response with
1715
+ # an associated string. To get the next page of results, copy this
1716
+ # string and repeat your request, including `NextToken` with the value
1717
+ # of the copied string. Repeat as needed to view all your results.
1520
1718
  #
1521
1719
  # @option params [Integer] :max_results
1522
- # The maximum number of categories to return in each page of results. If
1523
- # there are fewer results than the value you specify, only the actual
1524
- # results are returned. If you do not specify a value, the default of 5
1525
- # is used.
1720
+ # The maximum number of Call Analytics categories to return in each page
1721
+ # of results. If there are fewer results than the value you specify,
1722
+ # only the actual results are returned. If you don't specify a value, a
1723
+ # default of 5 is used.
1526
1724
  #
1527
1725
  # @return [Types::ListCallAnalyticsCategoriesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1528
1726
  #
@@ -1602,27 +1800,33 @@ module Aws::TranscribeService
1602
1800
  req.send_request(options)
1603
1801
  end
1604
1802
 
1605
- # List call analytics jobs with a specified status or substring that
1606
- # matches their names.
1803
+ # Provides a list of Call Analytics jobs that match the specified
1804
+ # criteria. If no criteria are specified, all Call Analytics jobs are
1805
+ # returned.
1806
+ #
1807
+ # To get detailed information about a specific Call Analytics job, use
1808
+ # the operation.
1607
1809
  #
1608
1810
  # @option params [String] :status
1609
- # When specified, returns only call analytics jobs with the specified
1610
- # status. Jobs are ordered by creation date, with the most recent jobs
1611
- # returned first. If you don't specify a status, Amazon Transcribe
1612
- # returns all analytics jobs ordered by creation date.
1811
+ # Returns only Call Analytics jobs with the specified status. Jobs are
1812
+ # ordered by creation date, with the newest job first. If you don't
1813
+ # include `Status`, all Call Analytics jobs are returned.
1613
1814
  #
1614
1815
  # @option params [String] :job_name_contains
1615
- # When specified, the jobs returned in the list are limited to jobs
1616
- # whose name contains the specified string.
1816
+ # Returns only the Call Analytics jobs that contain the specified
1817
+ # string. The search is not case sensitive.
1617
1818
  #
1618
1819
  # @option params [String] :next_token
1619
- # If you receive a truncated result in the previous request of , include
1620
- # `NextToken` to fetch the next set of jobs.
1820
+ # If your `ListCallAnalyticsJobs` request returns more results than can
1821
+ # be displayed, `NextToken` is displayed in the response with an
1822
+ # associated string. To get the next page of results, copy this string
1823
+ # and repeat your request, including `NextToken` with the value of the
1824
+ # copied string. Repeat as needed to view all your results.
1621
1825
  #
1622
1826
  # @option params [Integer] :max_results
1623
- # The maximum number of call analytics jobs to return in each page of
1827
+ # The maximum number of Call Analytics jobs to return in each page of
1624
1828
  # results. If there are fewer results than the value you specify, only
1625
- # the actual results are returned. If you do not specify a value, the
1829
+ # the actual results are returned. If you don't specify a value, a
1626
1830
  # default of 5 is used.
1627
1831
  #
1628
1832
  # @return [Types::ListCallAnalyticsJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -1651,7 +1855,7 @@ module Aws::TranscribeService
1651
1855
  # resp.call_analytics_job_summaries[0].creation_time #=> Time
1652
1856
  # resp.call_analytics_job_summaries[0].start_time #=> Time
1653
1857
  # resp.call_analytics_job_summaries[0].completion_time #=> Time
1654
- # resp.call_analytics_job_summaries[0].language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "cy-GB", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "ga-IE", "gd-GB", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
1858
+ # resp.call_analytics_job_summaries[0].language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
1655
1859
  # resp.call_analytics_job_summaries[0].call_analytics_job_status #=> String, one of "QUEUED", "IN_PROGRESS", "FAILED", "COMPLETED"
1656
1860
  # resp.call_analytics_job_summaries[0].failure_reason #=> String
1657
1861
  #
@@ -1664,29 +1868,34 @@ module Aws::TranscribeService
1664
1868
  req.send_request(options)
1665
1869
  end
1666
1870
 
1667
- # Provides more information about the custom language models you've
1668
- # created. You can use the information in this list to find a specific
1669
- # custom language model. You can then use the operation to get more
1670
- # information about it.
1871
+ # Provides a list of custom language models that match the specified
1872
+ # criteria. If no criteria are specified, all language models are
1873
+ # returned.
1874
+ #
1875
+ # To get detailed information about a specific custom language model,
1876
+ # use the operation.
1671
1877
  #
1672
1878
  # @option params [String] :status_equals
1673
- # When specified, returns only custom language models with the specified
1674
- # status. Language models are ordered by creation date, with the newest
1675
- # models first. If you don't specify a status, Amazon Transcribe
1676
- # returns all custom language models ordered by date.
1879
+ # Returns only custom language models with the specified status.
1880
+ # Language models are ordered by creation date, with the newest model
1881
+ # first. If you don't include `StatusEquals`, all custom language
1882
+ # models are returned.
1677
1883
  #
1678
1884
  # @option params [String] :name_contains
1679
- # When specified, the custom language model names returned contain the
1680
- # substring you've specified.
1885
+ # Returns only the custom language models that contain the specified
1886
+ # string. The search is not case sensitive.
1681
1887
  #
1682
1888
  # @option params [String] :next_token
1683
- # When included, fetches the next set of jobs if the result of the
1684
- # previous request was truncated.
1889
+ # If your `ListLanguageModels` request returns more results than can be
1890
+ # displayed, `NextToken` is displayed in the response with an associated
1891
+ # string. To get the next page of results, copy this string and repeat
1892
+ # your request, including `NextToken` with the value of the copied
1893
+ # string. Repeat as needed to view all your results.
1685
1894
  #
1686
1895
  # @option params [Integer] :max_results
1687
- # The maximum number of language models to return in each page of
1896
+ # The maximum number of custom language models to return in each page of
1688
1897
  # results. If there are fewer results than the value you specify, only
1689
- # the actual results are returned. If you do not specify a value, the
1898
+ # the actual results are returned. If you don't specify a value, a
1690
1899
  # default of 5 is used.
1691
1900
  #
1692
1901
  # @return [Types::ListLanguageModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -1730,29 +1939,34 @@ module Aws::TranscribeService
1730
1939
  req.send_request(options)
1731
1940
  end
1732
1941
 
1733
- # Lists medical transcription jobs with a specified status or substring
1734
- # that matches their names.
1942
+ # Provides a list of medical transcription jobs that match the specified
1943
+ # criteria. If no criteria are specified, all medical transcription jobs
1944
+ # are returned.
1945
+ #
1946
+ # To get detailed information about a specific medical transcription
1947
+ # job, use the operation.
1735
1948
  #
1736
1949
  # @option params [String] :status
1737
- # When specified, returns only medical transcription jobs with the
1738
- # specified status. Jobs are ordered by creation date, with the newest
1739
- # jobs returned first. If you don't specify a status, Amazon Transcribe
1740
- # Medical returns all transcription jobs ordered by creation date.
1950
+ # Returns only medical transcription jobs with the specified status.
1951
+ # Jobs are ordered by creation date, with the newest job first. If you
1952
+ # don't include `Status`, all medical transcription jobs are returned.
1741
1953
  #
1742
1954
  # @option params [String] :job_name_contains
1743
- # When specified, the jobs returned in the list are limited to jobs
1744
- # whose name contains the specified string.
1955
+ # Returns only the medical transcription jobs that contain the specified
1956
+ # string. The search is not case sensitive.
1745
1957
  #
1746
1958
  # @option params [String] :next_token
1747
- # If you a receive a truncated result in the previous request of
1748
- # `ListMedicalTranscriptionJobs`, include `NextToken` to fetch the next
1749
- # set of jobs.
1959
+ # If your `ListMedicalTranscriptionJobs` request returns more results
1960
+ # than can be displayed, `NextToken` is displayed in the response with
1961
+ # an associated string. To get the next page of results, copy this
1962
+ # string and repeat your request, including `NextToken` with the value
1963
+ # of the copied string. Repeat as needed to view all your results.
1750
1964
  #
1751
1965
  # @option params [Integer] :max_results
1752
1966
  # The maximum number of medical transcription jobs to return in each
1753
1967
  # page of results. If there are fewer results than the value you
1754
- # specify, only the actual results are returned. If you do not specify a
1755
- # value, the default of 5 is used.
1968
+ # specify, only the actual results are returned. If you don't specify a
1969
+ # value, a default of 5 is used.
1756
1970
  #
1757
1971
  # @return [Types::ListMedicalTranscriptionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1758
1972
  #
@@ -1780,7 +1994,7 @@ module Aws::TranscribeService
1780
1994
  # resp.medical_transcription_job_summaries[0].creation_time #=> Time
1781
1995
  # resp.medical_transcription_job_summaries[0].start_time #=> Time
1782
1996
  # resp.medical_transcription_job_summaries[0].completion_time #=> Time
1783
- # resp.medical_transcription_job_summaries[0].language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "cy-GB", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "ga-IE", "gd-GB", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
1997
+ # resp.medical_transcription_job_summaries[0].language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
1784
1998
  # resp.medical_transcription_job_summaries[0].transcription_job_status #=> String, one of "QUEUED", "IN_PROGRESS", "FAILED", "COMPLETED"
1785
1999
  # resp.medical_transcription_job_summaries[0].failure_reason #=> String
1786
2000
  # resp.medical_transcription_job_summaries[0].output_location_type #=> String, one of "CUSTOMER_BUCKET", "SERVICE_BUCKET"
@@ -1797,30 +2011,35 @@ module Aws::TranscribeService
1797
2011
  req.send_request(options)
1798
2012
  end
1799
2013
 
1800
- # Returns a list of vocabularies that match the specified criteria. If
1801
- # you don't enter a value in any of the request parameters, returns the
1802
- # entire list of vocabularies.
2014
+ # Provides a list of custom medical vocabularies that match the
2015
+ # specified criteria. If no criteria are specified, all custom medical
2016
+ # vocabularies are returned.
2017
+ #
2018
+ # To get detailed information about a specific custom medical
2019
+ # vocabulary, use the operation.
1803
2020
  #
1804
2021
  # @option params [String] :next_token
1805
- # If the result of your previous request to `ListMedicalVocabularies`
1806
- # was truncated, include the `NextToken` to fetch the next set of
1807
- # vocabularies.
2022
+ # If your `ListMedicalVocabularies` request returns more results than
2023
+ # can be displayed, `NextToken` is displayed in the response with an
2024
+ # associated string. To get the next page of results, copy this string
2025
+ # and repeat your request, including `NextToken` with the value of the
2026
+ # copied string. Repeat as needed to view all your results.
1808
2027
  #
1809
2028
  # @option params [Integer] :max_results
1810
- # The maximum number of vocabularies to return in each page of results.
1811
- # If there are fewer results than the value you specify, only the actual
1812
- # results are returned. If you do not specify a value, the default of 5
1813
- # is used.
2029
+ # The maximum number of custom medical vocabularies to return in each
2030
+ # page of results. If there are fewer results than the value you
2031
+ # specify, only the actual results are returned. If you don't specify a
2032
+ # value, a default of 5 is used.
1814
2033
  #
1815
2034
  # @option params [String] :state_equals
1816
- # When specified, returns only vocabularies with the `VocabularyState`
1817
- # equal to the specified vocabulary state. Use this field to see which
1818
- # vocabularies are ready for your medical transcription jobs.
2035
+ # Returns only custom medical vocabularies with the specified state.
2036
+ # Vocabularies are ordered by creation date, with the newest vocabulary
2037
+ # first. If you don't include `StateEquals`, all custom medical
2038
+ # vocabularies are returned.
1819
2039
  #
1820
2040
  # @option params [String] :name_contains
1821
- # Returns vocabularies whose names contain the specified string. The
1822
- # search is not case sensitive. `ListMedicalVocabularies` returns both
1823
- # "`vocabularyname`" and "`VocabularyName`".
2041
+ # Returns only the custom medical vocabularies that contain the
2042
+ # specified string. The search is not case sensitive.
1824
2043
  #
1825
2044
  # @return [Types::ListMedicalVocabulariesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1826
2045
  #
@@ -1845,7 +2064,7 @@ module Aws::TranscribeService
1845
2064
  # resp.next_token #=> String
1846
2065
  # resp.vocabularies #=> Array
1847
2066
  # resp.vocabularies[0].vocabulary_name #=> String
1848
- # resp.vocabularies[0].language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "cy-GB", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "ga-IE", "gd-GB", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
2067
+ # resp.vocabularies[0].language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
1849
2068
  # resp.vocabularies[0].last_modified_time #=> Time
1850
2069
  # resp.vocabularies[0].vocabulary_state #=> String, one of "PENDING", "READY", "FAILED"
1851
2070
  #
@@ -1858,15 +2077,24 @@ module Aws::TranscribeService
1858
2077
  req.send_request(options)
1859
2078
  end
1860
2079
 
1861
- # Lists all tags associated with a given transcription job, vocabulary,
1862
- # or resource.
2080
+ # Lists all tags associated with the specified transcription job,
2081
+ # vocabulary, model, or resource.
2082
+ #
2083
+ # To learn more about using tags with Amazon Transcribe, refer to
2084
+ # [Tagging resources][1].
2085
+ #
2086
+ #
2087
+ #
2088
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html
1863
2089
  #
1864
2090
  # @option params [required, String] :resource_arn
1865
- # Lists all tags associated with a given Amazon Resource Name (ARN).
1866
- # ARNs have the format
1867
- # `arn:partition:service:region:account-id:resource-type/resource-id`
1868
- # (for example,
1869
- # `arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name`).
2091
+ # Returns a list of all tags associated with the specified Amazon
2092
+ # Resource Name (ARN). ARNs have the format
2093
+ # `arn:partition:service:region:account-id:resource-type/resource-id`.
2094
+ #
2095
+ # For example,
2096
+ # `arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name`.
2097
+ #
1870
2098
  # Valid values for `resource-type` are: `transcription-job`,
1871
2099
  # `medical-transcription-job`, `vocabulary`, `medical-vocabulary`,
1872
2100
  # `vocabulary-filter`, and `language-model`.
@@ -1898,26 +2126,34 @@ module Aws::TranscribeService
1898
2126
  req.send_request(options)
1899
2127
  end
1900
2128
 
1901
- # Lists transcription jobs with the specified status.
2129
+ # Provides a list of transcription jobs that match the specified
2130
+ # criteria. If no criteria are specified, all transcription jobs are
2131
+ # returned.
2132
+ #
2133
+ # To get detailed information about a specific transcription job, use
2134
+ # the operation.
1902
2135
  #
1903
2136
  # @option params [String] :status
1904
- # When specified, returns only transcription jobs with the specified
1905
- # status. Jobs are ordered by creation date, with the newest jobs
1906
- # returned first. If you don’t specify a status, Amazon Transcribe
1907
- # returns all transcription jobs ordered by creation date.
2137
+ # Returns only transcription jobs with the specified status. Jobs are
2138
+ # ordered by creation date, with the newest job first. If you don't
2139
+ # include `Status`, all transcription jobs are returned.
1908
2140
  #
1909
2141
  # @option params [String] :job_name_contains
1910
- # When specified, the jobs returned in the list are limited to jobs
1911
- # whose name contains the specified string.
2142
+ # Returns only the transcription jobs that contain the specified string.
2143
+ # The search is not case sensitive.
1912
2144
  #
1913
2145
  # @option params [String] :next_token
1914
- # If the result of the previous request to `ListTranscriptionJobs` is
1915
- # truncated, include the `NextToken` to fetch the next set of jobs.
2146
+ # If your `ListTranscriptionJobs` request returns more results than can
2147
+ # be displayed, `NextToken` is displayed in the response with an
2148
+ # associated string. To get the next page of results, copy this string
2149
+ # and repeat your request, including `NextToken` with the value of the
2150
+ # copied string. Repeat as needed to view all your results.
1916
2151
  #
1917
2152
  # @option params [Integer] :max_results
1918
- # The maximum number of jobs to return in each page of results. If there
1919
- # are fewer results than the value you specify, only the actual results
1920
- # are returned. If you do not specify a value, the default of 5 is used.
2153
+ # The maximum number of transcription jobs to return in each page of
2154
+ # results. If there are fewer results than the value you specify, only
2155
+ # the actual results are returned. If you don't specify a value, a
2156
+ # default of 5 is used.
1921
2157
  #
1922
2158
  # @return [Types::ListTranscriptionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1923
2159
  #
@@ -1945,7 +2181,7 @@ module Aws::TranscribeService
1945
2181
  # resp.transcription_job_summaries[0].creation_time #=> Time
1946
2182
  # resp.transcription_job_summaries[0].start_time #=> Time
1947
2183
  # resp.transcription_job_summaries[0].completion_time #=> Time
1948
- # resp.transcription_job_summaries[0].language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "cy-GB", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "ga-IE", "gd-GB", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
2184
+ # resp.transcription_job_summaries[0].language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
1949
2185
  # resp.transcription_job_summaries[0].transcription_job_status #=> String, one of "QUEUED", "IN_PROGRESS", "FAILED", "COMPLETED"
1950
2186
  # resp.transcription_job_summaries[0].failure_reason #=> String
1951
2187
  # resp.transcription_job_summaries[0].output_location_type #=> String, one of "CUSTOMER_BUCKET", "SERVICE_BUCKET"
@@ -1955,7 +2191,11 @@ module Aws::TranscribeService
1955
2191
  # resp.transcription_job_summaries[0].content_redaction.pii_entity_types[0] #=> String, one of "BANK_ACCOUNT_NUMBER", "BANK_ROUTING", "CREDIT_DEBIT_NUMBER", "CREDIT_DEBIT_CVV", "CREDIT_DEBIT_EXPIRY", "PIN", "EMAIL", "ADDRESS", "NAME", "PHONE", "SSN", "ALL"
1956
2192
  # resp.transcription_job_summaries[0].model_settings.language_model_name #=> String
1957
2193
  # resp.transcription_job_summaries[0].identify_language #=> Boolean
2194
+ # resp.transcription_job_summaries[0].identify_multiple_languages #=> Boolean
1958
2195
  # resp.transcription_job_summaries[0].identified_language_score #=> Float
2196
+ # resp.transcription_job_summaries[0].language_codes #=> Array
2197
+ # resp.transcription_job_summaries[0].language_codes[0].language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
2198
+ # resp.transcription_job_summaries[0].language_codes[0].duration_in_seconds #=> Float
1959
2199
  #
1960
2200
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListTranscriptionJobs AWS API Documentation
1961
2201
  #
@@ -1966,28 +2206,35 @@ module Aws::TranscribeService
1966
2206
  req.send_request(options)
1967
2207
  end
1968
2208
 
1969
- # Returns a list of vocabularies that match the specified criteria. If
1970
- # no criteria are specified, returns the entire list of vocabularies.
2209
+ # Provides a list of custom vocabularies that match the specified
2210
+ # criteria. If no criteria are specified, all custom vocabularies are
2211
+ # returned.
2212
+ #
2213
+ # To get detailed information about a specific custom vocabulary, use
2214
+ # the operation.
1971
2215
  #
1972
2216
  # @option params [String] :next_token
1973
- # If the result of the previous request to `ListVocabularies` was
1974
- # truncated, include the `NextToken` to fetch the next set of jobs.
2217
+ # If your `ListVocabularies` request returns more results than can be
2218
+ # displayed, `NextToken` is displayed in the response with an associated
2219
+ # string. To get the next page of results, copy this string and repeat
2220
+ # your request, including `NextToken` with the value of the copied
2221
+ # string. Repeat as needed to view all your results.
1975
2222
  #
1976
2223
  # @option params [Integer] :max_results
1977
- # The maximum number of vocabularies to return in each page of results.
1978
- # If there are fewer results than the value you specify, only the actual
1979
- # results are returned. If you do not specify a value, the default of 5
1980
- # is used.
2224
+ # The maximum number of custom vocabularies to return in each page of
2225
+ # results. If there are fewer results than the value you specify, only
2226
+ # the actual results are returned. If you don't specify a value, a
2227
+ # default of 5 is used.
1981
2228
  #
1982
2229
  # @option params [String] :state_equals
1983
- # When specified, only returns vocabularies with the `VocabularyState`
1984
- # field equal to the specified state.
2230
+ # Returns only custom vocabularies with the specified state.
2231
+ # Vocabularies are ordered by creation date, with the newest vocabulary
2232
+ # first. If you don't include `StateEquals`, all custom medical
2233
+ # vocabularies are returned.
1985
2234
  #
1986
2235
  # @option params [String] :name_contains
1987
- # When specified, the vocabularies returned in the list are limited to
1988
- # vocabularies whose name contains the specified string. The search is
1989
- # not case sensitive, `ListVocabularies` returns both "vocabularyname"
1990
- # and "VocabularyName" in the response list.
2236
+ # Returns only the custom vocabularies that contain the specified
2237
+ # string. The search is not case sensitive.
1991
2238
  #
1992
2239
  # @return [Types::ListVocabulariesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1993
2240
  #
@@ -2012,7 +2259,7 @@ module Aws::TranscribeService
2012
2259
  # resp.next_token #=> String
2013
2260
  # resp.vocabularies #=> Array
2014
2261
  # resp.vocabularies[0].vocabulary_name #=> String
2015
- # resp.vocabularies[0].language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "cy-GB", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "ga-IE", "gd-GB", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
2262
+ # resp.vocabularies[0].language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
2016
2263
  # resp.vocabularies[0].last_modified_time #=> Time
2017
2264
  # resp.vocabularies[0].vocabulary_state #=> String, one of "PENDING", "READY", "FAILED"
2018
2265
  #
@@ -2025,22 +2272,29 @@ module Aws::TranscribeService
2025
2272
  req.send_request(options)
2026
2273
  end
2027
2274
 
2028
- # Gets information about vocabulary filters.
2275
+ # Provides a list of custom vocabulary filters that match the specified
2276
+ # criteria. If no criteria are specified, all custom vocabularies are
2277
+ # returned.
2278
+ #
2279
+ # To get detailed information about a specific custom vocabulary filter,
2280
+ # use the operation.
2029
2281
  #
2030
2282
  # @option params [String] :next_token
2031
- # If the result of the previous request to `ListVocabularyFilters` was
2032
- # truncated, include the `NextToken` to fetch the next set of
2033
- # collections.
2283
+ # If your `ListVocabularyFilters` request returns more results than can
2284
+ # be displayed, `NextToken` is displayed in the response with an
2285
+ # associated string. To get the next page of results, copy this string
2286
+ # and repeat your request, including `NextToken` with the value of the
2287
+ # copied string. Repeat as needed to view all your results.
2034
2288
  #
2035
2289
  # @option params [Integer] :max_results
2036
- # The maximum number of filters to return in each page of results. If
2037
- # there are fewer results than the value you specify, only the actual
2038
- # results are returned. If you do not specify a value, the default of 5
2039
- # is used.
2290
+ # The maximum number of custom vocabulary filters to return in each page
2291
+ # of results. If there are fewer results than the value you specify,
2292
+ # only the actual results are returned. If you don't specify a value, a
2293
+ # default of 5 is used.
2040
2294
  #
2041
2295
  # @option params [String] :name_contains
2042
- # Filters the response so that it only contains vocabulary filters whose
2043
- # name contains the specified string.
2296
+ # Returns only the custom vocabulary filters that contain the specified
2297
+ # string. The search is not case sensitive.
2044
2298
  #
2045
2299
  # @return [Types::ListVocabularyFiltersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2046
2300
  #
@@ -2062,7 +2316,7 @@ module Aws::TranscribeService
2062
2316
  # resp.next_token #=> String
2063
2317
  # resp.vocabulary_filters #=> Array
2064
2318
  # resp.vocabulary_filters[0].vocabulary_filter_name #=> String
2065
- # resp.vocabulary_filters[0].language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "cy-GB", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "ga-IE", "gd-GB", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
2319
+ # resp.vocabulary_filters[0].language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
2066
2320
  # resp.vocabulary_filters[0].last_modified_time #=> Time
2067
2321
  #
2068
2322
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListVocabularyFilters AWS API Documentation
@@ -2074,102 +2328,161 @@ module Aws::TranscribeService
2074
2328
  req.send_request(options)
2075
2329
  end
2076
2330
 
2077
- # Starts an asynchronous analytics job that not only transcribes the
2078
- # audio recording of a caller and agent, but also returns additional
2079
- # insights. These insights include how quickly or loudly the caller or
2080
- # agent was speaking. To retrieve additional insights with your
2081
- # analytics jobs, create categories. A category is a way to classify
2082
- # analytics jobs based on attributes, such as a customer's sentiment or
2083
- # a particular phrase being used during the call. For more information,
2084
- # see the operation.
2331
+ # Transcribes the audio from a customer service call and applies any
2332
+ # additional Request Parameters you choose to include in your request.
2085
2333
  #
2086
- # @option params [required, String] :call_analytics_job_name
2087
- # The name of the call analytics job. You can't use the string "." or
2088
- # ".." by themselves as the job name. The name must also be unique
2089
- # within an Amazon Web Services account. If you try to create a call
2090
- # analytics job with the same name as a previous call analytics job, you
2091
- # get a `ConflictException` error.
2334
+ # In addition to many of the standard transcription features, Call
2335
+ # Analytics provides you with call characteristics, call summarization,
2336
+ # speaker sentiment, and optional redaction of your text transcript and
2337
+ # your audio file. You can also apply custom categories to flag
2338
+ # specified conditions. To learn more about these features and insights,
2339
+ # refer to [Analyzing call center audio with Call Analytics][1].
2092
2340
  #
2093
- # @option params [required, Types::Media] :media
2094
- # Describes the input media file in a transcription request.
2341
+ # If you want to apply categories to your Call Analytics job, you must
2342
+ # create them before submitting your job request. Categories cannot be
2343
+ # retroactively applied to a job. To create a new category, use the
2344
+ # operation. To learn more about Call Analytics categories, see
2345
+ # [Creating categories][2].
2095
2346
  #
2096
- # @option params [String] :output_location
2097
- # The Amazon S3 location where the output of the call analytics job is
2098
- # stored. You can provide the following location types to store the
2099
- # output of call analytics job:
2347
+ # To make a `StartCallAnalyticsJob` request, you must first upload your
2348
+ # media file into an Amazon S3 bucket; you can then specify the Amazon
2349
+ # S3 location of the file using the `Media` parameter.
2350
+ #
2351
+ # You must include the following parameters in your
2352
+ # `StartCallAnalyticsJob` request:
2100
2353
  #
2101
- # * s3://DOC-EXAMPLE-BUCKET1
2354
+ # * `region`\: The Amazon Web Services Region where you are making your
2355
+ # request. For a list of Amazon Web Services Regions supported with
2356
+ # Amazon Transcribe, refer to [Amazon Transcribe endpoints and
2357
+ # quotas][3].
2102
2358
  #
2103
- # If you specify a bucket, Amazon Transcribe saves the output of the
2104
- # analytics job as a JSON file at the root level of the bucket.
2359
+ # * `CallAnalyticsJobName`\: A custom name you create for your
2360
+ # transcription job that is unique within your Amazon Web Services
2361
+ # account.
2105
2362
  #
2106
- # * s3://DOC-EXAMPLE-BUCKET1/folder/
2363
+ # * `DataAccessRoleArn`\: The Amazon Resource Name (ARN) of an IAM role
2364
+ # that has permissions to access the Amazon S3 bucket that contains
2365
+ # your input files.
2107
2366
  #
2108
- # f you specify a path, Amazon Transcribe saves the output of the
2109
- # analytics job as
2110
- # s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json.
2367
+ # * `Media` (`MediaFileUri` or `RedactedMediaFileUri`): The Amazon S3
2368
+ # location of your media file.
2111
2369
  #
2112
- # If you specify a folder, you must provide a trailing slash.
2370
+ # <note markdown="1"> With Call Analytics, you can redact the audio contained in your media
2371
+ # file by including `RedactedMediaFileUri`, instead of `MediaFileUri`,
2372
+ # to specify the location of your input audio. If you choose to redact
2373
+ # your audio, you can find your redacted media at the location specified
2374
+ # in the `RedactedMediaFileUri` field of your response.
2113
2375
  #
2114
- # * s3://DOC-EXAMPLE-BUCKET1/folder/filename.json.
2376
+ # </note>
2115
2377
  #
2116
- # If you provide a path that has the filename specified, Amazon
2117
- # Transcribe saves the output of the analytics job as
2118
- # s3://DOC-EXAMPLEBUCKET1/folder/filename.json.
2119
2378
  #
2120
- # You can specify an Amazon Web Services Key Management Service (KMS)
2121
- # key to encrypt the output of our analytics job using the
2379
+ #
2380
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html
2381
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html
2382
+ # [3]: https://docs.aws.amazon.com/general/latest/gr/transcribe.html
2383
+ #
2384
+ # @option params [required, String] :call_analytics_job_name
2385
+ # A unique name, chosen by you, for your Call Analytics job.
2386
+ #
2387
+ # This name is case sensitive, cannot contain spaces, and must be unique
2388
+ # within an Amazon Web Services account. If you try to create a new job
2389
+ # with the same name as an existing job, you get a `ConflictException`
2390
+ # error.
2391
+ #
2392
+ # @option params [required, Types::Media] :media
2393
+ # Describes the Amazon S3 location of the media file you want to use in
2394
+ # your request.
2395
+ #
2396
+ # @option params [String] :output_location
2397
+ # The Amazon S3 location where you want your Call Analytics
2398
+ # transcription output stored. You can use any of the following formats
2399
+ # to specify the output location:
2400
+ #
2401
+ # 1. s3://DOC-EXAMPLE-BUCKET
2402
+ #
2403
+ # 2. s3://DOC-EXAMPLE-BUCKET/my-output-folder/
2404
+ #
2405
+ # 3. s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json
2406
+ #
2407
+ # Unless you specify a file name (option 3), the name of your output
2408
+ # file has a default value that matches the name you specified for your
2409
+ # transcription job using the `CallAnalyticsJobName` parameter.
2410
+ #
2411
+ # You can specify a KMS key to encrypt your output using the
2122
2412
  # `OutputEncryptionKMSKeyId` parameter. If you don't specify a KMS key,
2123
2413
  # Amazon Transcribe uses the default Amazon S3 key for server-side
2124
- # encryption of the analytics job output that is placed in your S3
2125
- # bucket.
2414
+ # encryption.
2415
+ #
2416
+ # If you don't specify `OutputLocation`, your transcript is placed in a
2417
+ # service-managed Amazon S3 bucket and you are provided with a URI to
2418
+ # access your transcript.
2126
2419
  #
2127
2420
  # @option params [String] :output_encryption_kms_key_id
2128
- # The Amazon Resource Name (ARN) of the Amazon Web Services Key
2129
- # Management Service key used to encrypt the output of the call
2130
- # analytics job. The user calling the operation must have permission to
2131
- # use the specified KMS key.
2421
+ # The KMS key you want to use to encrypt your Call Analytics output.
2422
+ #
2423
+ # If using a key located in the **current** Amazon Web Services account,
2424
+ # you can specify your KMS key in one of four ways:
2425
+ #
2426
+ # 1. Use the KMS key ID itself. For example,
2427
+ # `1234abcd-12ab-34cd-56ef-1234567890ab`.
2132
2428
  #
2133
- # You use either of the following to identify an Amazon Web Services KMS
2134
- # key in the current account:
2429
+ # 2. Use an alias for the KMS key ID. For example,
2430
+ # `alias/ExampleAlias`.
2135
2431
  #
2136
- # * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
2432
+ # 3. Use the Amazon Resource Name (ARN) for the KMS key ID. For
2433
+ # example,
2434
+ # `arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
2137
2435
  #
2138
- # * KMS Key Alias: "alias/ExampleAlias"
2436
+ # 4. Use the ARN for the KMS key alias. For example,
2437
+ # `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
2139
2438
  #
2140
- # You can use either of the following to identify a KMS key in the
2141
- # current account or another account:
2439
+ # If using a key located in a **different** Amazon Web Services account
2440
+ # than the current Amazon Web Services account, you can specify your KMS
2441
+ # key in one of two ways:
2142
2442
  #
2143
- # * Amazon Resource Name (ARN) of a KMS key in the current account or
2144
- # another account: "arn:aws:kms:region:account
2145
- # ID:key/1234abcd-12ab-34cd-56ef1234567890ab"
2443
+ # 1. Use the ARN for the KMS key ID. For example,
2444
+ # `arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
2146
2445
  #
2147
- # * ARN of a KMS Key Alias:
2148
- # "arn:aws:kms:region:accountID:alias/ExampleAlias"
2446
+ # 2. Use the ARN for the KMS key alias. For example,
2447
+ # `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
2149
2448
  #
2150
- # If you don't specify an encryption key, the output of the call
2151
- # analytics job is encrypted with the default Amazon S3 key (SSE-S3).
2449
+ # If you don't specify an encryption key, your output is encrypted with
2450
+ # the default Amazon S3 key (SSE-S3).
2152
2451
  #
2153
2452
  # If you specify a KMS key to encrypt your output, you must also specify
2154
- # an output location in the `OutputLocation` parameter.
2453
+ # an output location using the `OutputLocation` parameter.
2454
+ #
2455
+ # Note that the user making the request must have permission to use the
2456
+ # specified KMS key.
2457
+ #
2458
+ # @option params [String] :data_access_role_arn
2459
+ # The Amazon Resource Name (ARN) of an IAM role that has permissions to
2460
+ # access the Amazon S3 bucket that contains your input files. If the
2461
+ # role you specify doesn’t have the appropriate permissions to access
2462
+ # the specified Amazon S3 location, your request fails.
2463
+ #
2464
+ # IAM role ARNs have the format
2465
+ # `arn:partition:iam::account:role/role-name-with-path`. For example:
2466
+ # `arn:aws:iam::111122223333:role/Admin`.
2467
+ #
2468
+ # For more information, see [IAM ARNs][1].
2155
2469
  #
2156
- # @option params [required, String] :data_access_role_arn
2157
- # The Amazon Resource Name (ARN) of a role that has access to the S3
2158
- # bucket that contains your input files. Amazon Transcribe assumes this
2159
- # role to read queued audio files. If you have specified an output S3
2160
- # bucket for your transcription results, this role should have access to
2161
- # the output bucket as well.
2470
+ #
2471
+ #
2472
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns
2162
2473
  #
2163
2474
  # @option params [Types::CallAnalyticsJobSettings] :settings
2164
- # A `Settings` object that provides optional settings for a call
2165
- # analytics job.
2475
+ # Specify additional optional settings in your request, including
2476
+ # content redaction; allows you to apply custom language models,
2477
+ # vocabulary filters, and custom vocabularies to your Call Analytics
2478
+ # job.
2166
2479
  #
2167
2480
  # @option params [Array<Types::ChannelDefinition>] :channel_definitions
2168
- # When you start a call analytics job, you must pass an array that maps
2169
- # the agent and the customer to specific audio channels. The values you
2170
- # can assign to a channel are 0 and 1. The agent and the customer must
2171
- # each have their own channel. You can't assign more than one channel
2172
- # to an agent or customer.
2481
+ # Allows you to specify which speaker is on which channel. For example,
2482
+ # if your agent is the first participant to speak, you would set
2483
+ # `ChannelId` to `0` (to indicate the first channel) and
2484
+ # `ParticipantRole` to `AGENT` (to indicate that it's the agent
2485
+ # speaking).
2173
2486
  #
2174
2487
  # @return [Types::StartCallAnalyticsJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2175
2488
  #
@@ -2185,7 +2498,7 @@ module Aws::TranscribeService
2185
2498
  # },
2186
2499
  # output_location: "Uri",
2187
2500
  # output_encryption_kms_key_id: "KMSKeyId",
2188
- # data_access_role_arn: "DataAccessRoleArn", # required
2501
+ # data_access_role_arn: "DataAccessRoleArn",
2189
2502
  # settings: {
2190
2503
  # vocabulary_name: "VocabularyName",
2191
2504
  # vocabulary_filter_name: "VocabularyFilterName",
@@ -2196,7 +2509,7 @@ module Aws::TranscribeService
2196
2509
  # redaction_output: "redacted", # required, accepts redacted, redacted_and_unredacted
2197
2510
  # pii_entity_types: ["BANK_ACCOUNT_NUMBER"], # accepts BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, ALL
2198
2511
  # },
2199
- # language_options: ["af-ZA"], # accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
2512
+ # language_options: ["af-ZA"], # accepts af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
2200
2513
  # language_id_settings: {
2201
2514
  # "af-ZA" => {
2202
2515
  # vocabulary_name: "VocabularyName",
@@ -2217,7 +2530,7 @@ module Aws::TranscribeService
2217
2530
  #
2218
2531
  # resp.call_analytics_job.call_analytics_job_name #=> String
2219
2532
  # resp.call_analytics_job.call_analytics_job_status #=> String, one of "QUEUED", "IN_PROGRESS", "FAILED", "COMPLETED"
2220
- # resp.call_analytics_job.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "cy-GB", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "ga-IE", "gd-GB", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
2533
+ # resp.call_analytics_job.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
2221
2534
  # resp.call_analytics_job.media_sample_rate_hertz #=> Integer
2222
2535
  # resp.call_analytics_job.media_format #=> String, one of "mp3", "mp4", "wav", "flac", "ogg", "amr", "webm"
2223
2536
  # resp.call_analytics_job.media.media_file_uri #=> String
@@ -2239,7 +2552,7 @@ module Aws::TranscribeService
2239
2552
  # resp.call_analytics_job.settings.content_redaction.pii_entity_types #=> Array
2240
2553
  # resp.call_analytics_job.settings.content_redaction.pii_entity_types[0] #=> String, one of "BANK_ACCOUNT_NUMBER", "BANK_ROUTING", "CREDIT_DEBIT_NUMBER", "CREDIT_DEBIT_CVV", "CREDIT_DEBIT_EXPIRY", "PIN", "EMAIL", "ADDRESS", "NAME", "PHONE", "SSN", "ALL"
2241
2554
  # resp.call_analytics_job.settings.language_options #=> Array
2242
- # resp.call_analytics_job.settings.language_options[0] #=> String, one of "af-ZA", "ar-AE", "ar-SA", "cy-GB", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "ga-IE", "gd-GB", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
2555
+ # resp.call_analytics_job.settings.language_options[0] #=> String, one of "af-ZA", "ar-AE", "ar-SA", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
2243
2556
  # resp.call_analytics_job.settings.language_id_settings #=> Hash
2244
2557
  # resp.call_analytics_job.settings.language_id_settings["LanguageCode"].vocabulary_name #=> String
2245
2558
  # resp.call_analytics_job.settings.language_id_settings["LanguageCode"].vocabulary_filter_name #=> String
@@ -2257,134 +2570,236 @@ module Aws::TranscribeService
2257
2570
  req.send_request(options)
2258
2571
  end
2259
2572
 
2260
- # Starts a batch job to transcribe medical speech to text.
2573
+ # Transcribes the audio from a medical dictation or conversation and
2574
+ # applies any additional Request Parameters you choose to include in
2575
+ # your request.
2576
+ #
2577
+ # In addition to many of the standard transcription features, Amazon
2578
+ # Transcribe Medical provides you with a robust medical vocabulary and,
2579
+ # optionally, content identification, which adds flags to personal
2580
+ # health information (PHI). To learn more about these features, refer to
2581
+ # [How Amazon Transcribe Medical works][1].
2582
+ #
2583
+ # To make a `StartMedicalTranscriptionJob` request, you must first
2584
+ # upload your media file into an Amazon S3 bucket; you can then specify
2585
+ # the S3 location of the file using the `Media` parameter.
2586
+ #
2587
+ # You must include the following parameters in your
2588
+ # `StartMedicalTranscriptionJob` request:
2589
+ #
2590
+ # * `region`\: The Amazon Web Services Region where you are making your
2591
+ # request. For a list of Amazon Web Services Regions supported with
2592
+ # Amazon Transcribe, refer to [Amazon Transcribe endpoints and
2593
+ # quotas][2].
2594
+ #
2595
+ # * `MedicalTranscriptionJobName`\: A custom name you create for your
2596
+ # transcription job that is unique within your Amazon Web Services
2597
+ # account.
2598
+ #
2599
+ # * `Media` (`MediaFileUri`): The Amazon S3 location of your media file.
2600
+ #
2601
+ # * `LanguageCode`\: This must be `en-US`.
2602
+ #
2603
+ # * `OutputBucketName`\: The Amazon S3 bucket where you want your
2604
+ # transcript stored. If you want your output stored in a sub-folder of
2605
+ # this bucket, you must also include `OutputKey`.
2606
+ #
2607
+ # * `Specialty`\: This must be `PRIMARYCARE`.
2608
+ #
2609
+ # * `Type`\: Choose whether your audio is a conversation or a dictation.
2610
+ #
2611
+ #
2612
+ #
2613
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/how-it-works-med.html
2614
+ # [2]: https://docs.aws.amazon.com/general/latest/gr/transcribe.html
2261
2615
  #
2262
2616
  # @option params [required, String] :medical_transcription_job_name
2263
- # The name of the medical transcription job. You can't use the strings
2264
- # "`.`" or "`..`" by themselves as the job name. The name must also
2265
- # be unique within an Amazon Web Services account. If you try to create
2266
- # a medical transcription job with the same name as a previous medical
2267
- # transcription job, you get a `ConflictException` error.
2617
+ # A unique name, chosen by you, for your medical transcription job. The
2618
+ # name you specify is also used as the default name of your
2619
+ # transcription output file. If you want to specify a different name for
2620
+ # your transcription output, use the `OutputKey` parameter.
2621
+ #
2622
+ # This name is case sensitive, cannot contain spaces, and must be unique
2623
+ # within an Amazon Web Services account. If you try to create a new job
2624
+ # with the same name as an existing job, you get a `ConflictException`
2625
+ # error.
2268
2626
  #
2269
2627
  # @option params [required, String] :language_code
2270
- # The language code for the language spoken in the input media file. US
2271
- # English (en-US) is the valid value for medical transcription jobs. Any
2272
- # other value you enter for language code results in a
2273
- # `BadRequestException` error.
2628
+ # The language code that represents the language spoken in the input
2629
+ # media file. US English (`en-US`) is the only valid value for medical
2630
+ # transcription jobs. Any other value you enter for language code
2631
+ # results in a `BadRequestException` error.
2274
2632
  #
2275
2633
  # @option params [Integer] :media_sample_rate_hertz
2276
- # The sample rate, in Hertz, of the audio track in the input media file.
2634
+ # The sample rate, in Hertz, of the audio track in your input media
2635
+ # file.
2277
2636
  #
2278
- # If you do not specify the media sample rate, Amazon Transcribe Medical
2279
- # determines the sample rate. If you specify the sample rate, it must
2280
- # match the rate detected by Amazon Transcribe Medical. In most cases,
2281
- # you should leave the `MediaSampleRateHertz` field blank and let Amazon
2282
- # Transcribe Medical determine the sample rate.
2637
+ # If you don't specify the media sample rate, Amazon Transcribe Medical
2638
+ # determines it for you. If you specify the sample rate, it must match
2639
+ # the rate detected by Amazon Transcribe Medical; if there's a mismatch
2640
+ # between the value you specify and the value detected, your job fails.
2641
+ # Therefore, in most cases, it's advised to omit `MediaSampleRateHertz`
2642
+ # and let Amazon Transcribe Medical determine the sample rate.
2283
2643
  #
2284
2644
  # @option params [String] :media_format
2285
- # The audio format of the input media file.
2645
+ # Specify the format of your input media file.
2286
2646
  #
2287
2647
  # @option params [required, Types::Media] :media
2288
- # Describes the input media file in a transcription request.
2648
+ # Describes the Amazon S3 location of the media file you want to use in
2649
+ # your request.
2289
2650
  #
2290
2651
  # @option params [required, String] :output_bucket_name
2291
- # The Amazon S3 location where the transcription is stored.
2292
- #
2293
- # You must set `OutputBucketName` for Amazon Transcribe Medical to store
2294
- # the transcription results. Your transcript appears in the S3 location
2295
- # you specify. When you call the GetMedicalTranscriptionJob, the
2296
- # operation returns this location in the `TranscriptFileUri` field. The
2297
- # S3 bucket must have permissions that allow Amazon Transcribe Medical
2298
- # to put files in the bucket. For more information, see [Permissions
2299
- # Required for IAM User Roles][1].
2300
- #
2301
- # You can specify an Amazon Web Services Key Management Service (KMS)
2302
- # key to encrypt the output of your transcription using the
2303
- # `OutputEncryptionKMSKeyId` parameter. If you don't specify a KMS key,
2304
- # Amazon Transcribe Medical uses the default Amazon S3 key for
2305
- # server-side encryption of transcripts that are placed in your S3
2306
- # bucket.
2652
+ # The name of the Amazon S3 bucket where you want your medical
2653
+ # transcription output stored. Do not include the `S3://` prefix of the
2654
+ # specified bucket.
2307
2655
  #
2656
+ # If you want your output to go to a sub-folder of this bucket, specify
2657
+ # it using the `OutputKey` parameter; `OutputBucketName` only accepts
2658
+ # the name of a bucket.
2308
2659
  #
2660
+ # For example, if you want your output stored in
2661
+ # `S3://DOC-EXAMPLE-BUCKET`, set `OutputBucketName` to
2662
+ # `DOC-EXAMPLE-BUCKET`. However, if you want your output stored in
2663
+ # `S3://DOC-EXAMPLE-BUCKET/test-files/`, set `OutputBucketName` to
2664
+ # `DOC-EXAMPLE-BUCKET` and `OutputKey` to `test-files/`.
2309
2665
  #
2310
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user
2666
+ # Note that Amazon Transcribe must have permission to use the specified
2667
+ # location. You can change Amazon S3 permissions using the [Amazon Web
2668
+ # Services Management Console][1]. See also [Permissions Required for
2669
+ # IAM User Roles][2].
2670
+ #
2671
+ # If you don't specify `OutputBucketName`, your transcript is placed in
2672
+ # a service-managed Amazon S3 bucket and you are provided with a URI to
2673
+ # access your transcript.
2674
+ #
2675
+ #
2676
+ #
2677
+ # [1]: https://console.aws.amazon.com/s3
2678
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user
2311
2679
  #
2312
2680
  # @option params [String] :output_key
2313
- # You can specify a location in an Amazon S3 bucket to store the output
2314
- # of your medical transcription job.
2315
- #
2316
- # If you don't specify an output key, Amazon Transcribe Medical stores
2317
- # the output of your transcription job in the Amazon S3 bucket you
2318
- # specified. By default, the object key is
2319
- # "your-transcription-job-name.json".
2320
- #
2321
- # You can use output keys to specify the Amazon S3 prefix and file name
2322
- # of the transcription output. For example, specifying the Amazon S3
2323
- # prefix, "folder1/folder2/", as an output key would lead to the
2324
- # output being stored as
2325
- # "folder1/folder2/your-transcription-job-name.json". If you specify
2326
- # "my-other-job-name.json" as the output key, the object key is
2327
- # changed to "my-other-job-name.json". You can use an output key to
2328
- # change both the prefix and the file name, for example
2329
- # "folder/my-other-job-name.json".
2330
- #
2331
- # If you specify an output key, you must also specify an S3 bucket in
2332
- # the `OutputBucketName` parameter.
2681
+ # Use in combination with `OutputBucketName` to specify the output
2682
+ # location of your transcript and, optionally, a unique name for your
2683
+ # output file. The default name for your transcription output is the
2684
+ # same as the name you specified for your medical transcription job
2685
+ # (`MedicalTranscriptionJobName`).
2686
+ #
2687
+ # Here are some examples of how you can use `OutputKey`\:
2688
+ #
2689
+ # * If you specify 'DOC-EXAMPLE-BUCKET' as the `OutputBucketName` and
2690
+ # 'my-transcript.json' as the `OutputKey`, your transcription output
2691
+ # path is `s3://DOC-EXAMPLE-BUCKET/my-transcript.json`.
2692
+ #
2693
+ # * If you specify 'my-first-transcription' as the
2694
+ # `MedicalTranscriptionJobName`, 'DOC-EXAMPLE-BUCKET' as the
2695
+ # `OutputBucketName`, and 'my-transcript' as the `OutputKey`, your
2696
+ # transcription output path is
2697
+ # `s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json`.
2698
+ #
2699
+ # * If you specify 'DOC-EXAMPLE-BUCKET' as the `OutputBucketName` and
2700
+ # 'test-files/my-transcript.json' as the `OutputKey`, your
2701
+ # transcription output path is
2702
+ # `s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json`.
2703
+ #
2704
+ # * If you specify 'my-first-transcription' as the
2705
+ # `MedicalTranscriptionJobName`, 'DOC-EXAMPLE-BUCKET' as the
2706
+ # `OutputBucketName`, and 'test-files/my-transcript' as the
2707
+ # `OutputKey`, your transcription output path is
2708
+ # `s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json`.
2709
+ #
2710
+ # If you specify the name of an Amazon S3 bucket sub-folder that
2711
+ # doesn't exist, one is created for you.
2333
2712
  #
2334
2713
  # @option params [String] :output_encryption_kms_key_id
2335
- # The Amazon Resource Name (ARN) of the Amazon Web Services Key
2336
- # Management Service (KMS) key used to encrypt the output of the
2337
- # transcription job. The user calling the StartMedicalTranscriptionJob
2338
- # operation must have permission to use the specified KMS key.
2714
+ # The KMS key you want to use to encrypt your medical transcription
2715
+ # output.
2716
+ #
2717
+ # If using a key located in the **current** Amazon Web Services account,
2718
+ # you can specify your KMS key in one of four ways:
2339
2719
  #
2340
- # You use either of the following to identify a KMS key in the current
2341
- # account:
2720
+ # 1. Use the KMS key ID itself. For example,
2721
+ # `1234abcd-12ab-34cd-56ef-1234567890ab`.
2342
2722
  #
2343
- # * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
2723
+ # 2. Use an alias for the KMS key ID. For example,
2724
+ # `alias/ExampleAlias`.
2344
2725
  #
2345
- # * KMS Key Alias: "alias/ExampleAlias"
2726
+ # 3. Use the Amazon Resource Name (ARN) for the KMS key ID. For
2727
+ # example,
2728
+ # `arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
2346
2729
  #
2347
- # You can use either of the following to identify a KMS key in the
2348
- # current account or another account:
2730
+ # 4. Use the ARN for the KMS key alias. For example,
2731
+ # `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
2349
2732
  #
2350
- # * Amazon Resource Name (ARN) of a KMS key in the current account or
2351
- # another account:
2352
- # "arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"
2733
+ # If using a key located in a **different** Amazon Web Services account
2734
+ # than the current Amazon Web Services account, you can specify your KMS
2735
+ # key in one of two ways:
2353
2736
  #
2354
- # * ARN of a KMS Key Alias: "arn:aws:kms:region:account
2355
- # ID:alias/ExampleAlias"
2737
+ # 1. Use the ARN for the KMS key ID. For example,
2738
+ # `arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
2356
2739
  #
2357
- # If you don't specify an encryption key, the output of the medical
2358
- # transcription job is encrypted with the default Amazon S3 key
2359
- # (SSE-S3).
2740
+ # 2. Use the ARN for the KMS key alias. For example,
2741
+ # `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
2742
+ #
2743
+ # If you don't specify an encryption key, your output is encrypted with
2744
+ # the default Amazon S3 key (SSE-S3).
2360
2745
  #
2361
2746
  # If you specify a KMS key to encrypt your output, you must also specify
2362
- # an output location in the `OutputBucketName` parameter.
2747
+ # an output location using the `OutputLocation` parameter.
2748
+ #
2749
+ # Note that the user making the request must have permission to use the
2750
+ # specified KMS key.
2363
2751
  #
2364
2752
  # @option params [Hash<String,String>] :kms_encryption_context
2365
2753
  # A map of plain text, non-secret key:value pairs, known as encryption
2366
2754
  # context pairs, that provide an added layer of security for your data.
2755
+ # For more information, see [KMS encryption context][1] and [Asymmetric
2756
+ # keys in KMS][2].
2757
+ #
2758
+ #
2759
+ #
2760
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context
2761
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html
2367
2762
  #
2368
2763
  # @option params [Types::MedicalTranscriptionSetting] :settings
2369
- # Optional settings for the medical transcription job.
2764
+ # Specify additional optional settings in your request, including
2765
+ # channel identification, alternative transcriptions, and speaker
2766
+ # labeling; allows you to apply custom vocabularies to your
2767
+ # transcription job.
2370
2768
  #
2371
2769
  # @option params [String] :content_identification_type
2372
- # You can configure Amazon Transcribe Medical to label content in the
2373
- # transcription output. If you specify `PHI`, Amazon Transcribe Medical
2374
- # labels the personal health information (PHI) that it identifies in the
2375
- # transcription output.
2770
+ # Labels all personal health information (PHI) identified in your
2771
+ # transcript. For more information, see [Identifying personal health
2772
+ # information (PHI) in a transcription][1].
2773
+ #
2774
+ #
2775
+ #
2776
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html
2376
2777
  #
2377
2778
  # @option params [required, String] :specialty
2378
- # The medical specialty of any clinician speaking in the input media.
2779
+ # Specify the predominant medical specialty represented in your media.
2780
+ # For batch transcriptions, `PRIMARYCARE` is the only valid value. If
2781
+ # you require additional specialties, refer to .
2379
2782
  #
2380
2783
  # @option params [required, String] :type
2381
- # The type of speech in the input audio. `CONVERSATION` refers to
2382
- # conversations between two or more speakers, e.g., a conversations
2383
- # between doctors and patients. `DICTATION` refers to single-speaker
2384
- # dictated speech, such as clinical notes.
2784
+ # Specify whether your input media contains only one person
2785
+ # (`DICTATION`) or contains a conversation between two people
2786
+ # (`CONVERSATION`).
2787
+ #
2788
+ # For example, `DICTATION` could be used for a medical professional
2789
+ # wanting to transcribe voice memos; `CONVERSATION` could be used for
2790
+ # transcribing the doctor-patient dialogue during the patient's office
2791
+ # visit.
2385
2792
  #
2386
2793
  # @option params [Array<Types::Tag>] :tags
2387
- # Add tags to an Amazon Transcribe Medical transcription job.
2794
+ # Adds one or more custom tags, each in the form of a key:value pair, to
2795
+ # a new medical transcription job at the time you start this new job.
2796
+ #
2797
+ # To learn more about using tags with Amazon Transcribe, refer to
2798
+ # [Tagging resources][1].
2799
+ #
2800
+ #
2801
+ #
2802
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html
2388
2803
  #
2389
2804
  # @return [Types::StartMedicalTranscriptionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2390
2805
  #
@@ -2394,7 +2809,7 @@ module Aws::TranscribeService
2394
2809
  #
2395
2810
  # resp = client.start_medical_transcription_job({
2396
2811
  # medical_transcription_job_name: "TranscriptionJobName", # required
2397
- # language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
2812
+ # language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
2398
2813
  # media_sample_rate_hertz: 1,
2399
2814
  # media_format: "mp3", # accepts mp3, mp4, wav, flac, ogg, amr, webm
2400
2815
  # media: { # required
@@ -2430,7 +2845,7 @@ module Aws::TranscribeService
2430
2845
  #
2431
2846
  # resp.medical_transcription_job.medical_transcription_job_name #=> String
2432
2847
  # resp.medical_transcription_job.transcription_job_status #=> String, one of "QUEUED", "IN_PROGRESS", "FAILED", "COMPLETED"
2433
- # resp.medical_transcription_job.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "cy-GB", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "ga-IE", "gd-GB", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
2848
+ # resp.medical_transcription_job.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
2434
2849
  # resp.medical_transcription_job.media_sample_rate_hertz #=> Integer
2435
2850
  # resp.medical_transcription_job.media_format #=> String, one of "mp3", "mp4", "wav", "flac", "ogg", "amr", "webm"
2436
2851
  # resp.medical_transcription_job.media.media_file_uri #=> String
@@ -2462,162 +2877,347 @@ module Aws::TranscribeService
2462
2877
  req.send_request(options)
2463
2878
  end
2464
2879
 
2465
- # Starts an asynchronous job to transcribe speech to text.
2880
+ # Transcribes the audio from a media file and applies any additional
2881
+ # Request Parameters you choose to include in your request.
2882
+ #
2883
+ # To make a `StartTranscriptionJob` request, you must first upload your
2884
+ # media file into an Amazon S3 bucket; you can then specify the Amazon
2885
+ # S3 location of the file using the `Media` parameter.
2886
+ #
2887
+ # You must include the following parameters in your
2888
+ # `StartTranscriptionJob` request:
2889
+ #
2890
+ # * `region`\: The Amazon Web Services Region where you are making your
2891
+ # request. For a list of Amazon Web Services Regions supported with
2892
+ # Amazon Transcribe, refer to [Amazon Transcribe endpoints and
2893
+ # quotas][1].
2894
+ #
2895
+ # * `TranscriptionJobName`\: A custom name you create for your
2896
+ # transcription job that is unique within your Amazon Web Services
2897
+ # account.
2898
+ #
2899
+ # * `Media` (`MediaFileUri`): The Amazon S3 location of your media file.
2900
+ #
2901
+ # * One of `LanguageCode`, `IdentifyLanguage`, or
2902
+ # `IdentifyMultipleLanguages`\: If you know the language of your media
2903
+ # file, specify it using the `LanguageCode` parameter; you can find
2904
+ # all valid language codes in the [Supported languages][2] table. If
2905
+ # you don't know the languages spoken in your media, use either
2906
+ # `IdentifyLanguage` or `IdentifyMultipleLanguages` and let Amazon
2907
+ # Transcribe identify the languages for you.
2908
+ #
2909
+ #
2910
+ #
2911
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/transcribe.html
2912
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
2466
2913
  #
2467
2914
  # @option params [required, String] :transcription_job_name
2468
- # The name of the job. You can't use the strings "`.`" or "`..`" by
2469
- # themselves as the job name. The name must also be unique within an
2470
- # Amazon Web Services account. If you try to create a transcription job
2471
- # with the same name as a previous transcription job, you get a
2472
- # `ConflictException` error.
2915
+ # A unique name, chosen by you, for your transcription job. The name you
2916
+ # specify is also used as the default name of your transcription output
2917
+ # file. If you want to specify a different name for your transcription
2918
+ # output, use the `OutputKey` parameter.
2919
+ #
2920
+ # This name is case sensitive, cannot contain spaces, and must be unique
2921
+ # within an Amazon Web Services account. If you try to create a new job
2922
+ # with the same name as an existing job, you get a `ConflictException`
2923
+ # error.
2473
2924
  #
2474
2925
  # @option params [String] :language_code
2475
- # The language code for the language used in the input media file.
2926
+ # The language code that represents the language spoken in the input
2927
+ # media file.
2928
+ #
2929
+ # If you're unsure of the language spoken in your media file, consider
2930
+ # using `IdentifyLanguage` or `IdentifyMultipleLanguages` to enable
2931
+ # automatic language identification.
2932
+ #
2933
+ # Note that you must include one of `LanguageCode`, `IdentifyLanguage`,
2934
+ # or `IdentifyMultipleLanguages` in your request. If you include more
2935
+ # than one of these parameters, your transcription job fails.
2936
+ #
2937
+ # For a list of supported languages and their associated language codes,
2938
+ # refer to the [Supported languages][1] table.
2476
2939
  #
2477
- # To transcribe speech in Modern Standard Arabic (ar-SA), your audio or
2478
- # video file must be encoded at a sample rate of 16,000 Hz or higher.
2940
+ # <note markdown="1"> To transcribe speech in Modern Standard Arabic (`ar-SA`), your media
2941
+ # file must be encoded at a sample rate of 16,000 Hz or higher.
2942
+ #
2943
+ # </note>
2944
+ #
2945
+ #
2946
+ #
2947
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
2479
2948
  #
2480
2949
  # @option params [Integer] :media_sample_rate_hertz
2481
- # The sample rate, in Hertz, of the audio track in the input media file.
2950
+ # The sample rate, in Hertz, of the audio track in your input media
2951
+ # file.
2482
2952
  #
2483
- # If you do not specify the media sample rate, Amazon Transcribe
2484
- # determines the sample rate. If you specify the sample rate, it must
2485
- # match the sample rate detected by Amazon Transcribe. In most cases,
2486
- # you should leave the `MediaSampleRateHertz` field blank and let Amazon
2487
- # Transcribe determine the sample rate.
2953
+ # If you don't specify the media sample rate, Amazon Transcribe
2954
+ # determines it for you. If you specify the sample rate, it must match
2955
+ # the rate detected by Amazon Transcribe; if there's a mismatch between
2956
+ # the value you specify and the value detected, your job fails.
2957
+ # Therefore, in most cases, it's advised to omit `MediaSampleRateHertz`
2958
+ # and let Amazon Transcribe determine the sample rate.
2488
2959
  #
2489
2960
  # @option params [String] :media_format
2490
- # The format of the input media file.
2961
+ # Specify the format of your input media file.
2491
2962
  #
2492
2963
  # @option params [required, Types::Media] :media
2493
- # An object that describes the input media for a transcription job.
2964
+ # Describes the Amazon S3 location of the media file you want to use in
2965
+ # your request.
2494
2966
  #
2495
2967
  # @option params [String] :output_bucket_name
2496
- # The location where the transcription is stored.
2497
- #
2498
- # If you set the `OutputBucketName`, Amazon Transcribe puts the
2499
- # transcript in the specified S3 bucket. When you call the
2500
- # GetTranscriptionJob operation, the operation returns this location in
2501
- # the `TranscriptFileUri` field. If you enable content redaction, the
2502
- # redacted transcript appears in `RedactedTranscriptFileUri`. If you
2503
- # enable content redaction and choose to output an unredacted
2504
- # transcript, that transcript's location still appears in the
2505
- # `TranscriptFileUri`. The S3 bucket must have permissions that allow
2506
- # Amazon Transcribe to put files in the bucket. For more information,
2507
- # see [Permissions Required for IAM User Roles][1].
2508
- #
2509
- # You can specify an Amazon Web Services Key Management Service (KMS)
2510
- # key to encrypt the output of your transcription using the
2511
- # `OutputEncryptionKMSKeyId` parameter. If you don't specify a KMS key,
2512
- # Amazon Transcribe uses the default Amazon S3 key for server-side
2513
- # encryption of transcripts that are placed in your S3 bucket.
2968
+ # The name of the Amazon S3 bucket where you want your transcription
2969
+ # output stored. Do not include the `S3://` prefix of the specified
2970
+ # bucket.
2971
+ #
2972
+ # If you want your output to go to a sub-folder of this bucket, specify
2973
+ # it using the `OutputKey` parameter; `OutputBucketName` only accepts
2974
+ # the name of a bucket.
2514
2975
  #
2515
- # If you don't set the `OutputBucketName`, Amazon Transcribe generates
2516
- # a pre-signed URL, a shareable URL that provides secure access to your
2517
- # transcription, and returns it in the `TranscriptFileUri` field. Use
2518
- # this URL to download the transcription.
2976
+ # For example, if you want your output stored in
2977
+ # `S3://DOC-EXAMPLE-BUCKET`, set `OutputBucketName` to
2978
+ # `DOC-EXAMPLE-BUCKET`. However, if you want your output stored in
2979
+ # `S3://DOC-EXAMPLE-BUCKET/test-files/`, set `OutputBucketName` to
2980
+ # `DOC-EXAMPLE-BUCKET` and `OutputKey` to `test-files/`.
2519
2981
  #
2982
+ # Note that Amazon Transcribe must have permission to use the specified
2983
+ # location. You can change Amazon S3 permissions using the [Amazon Web
2984
+ # Services Management Console][1]. See also [Permissions Required for
2985
+ # IAM User Roles][2].
2520
2986
  #
2987
+ # If you don't specify `OutputBucketName`, your transcript is placed in
2988
+ # a service-managed Amazon S3 bucket and you are provided with a URI to
2989
+ # access your transcript.
2521
2990
  #
2522
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user
2991
+ #
2992
+ #
2993
+ # [1]: https://console.aws.amazon.com/s3
2994
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user
2523
2995
  #
2524
2996
  # @option params [String] :output_key
2525
- # You can specify a location in an Amazon S3 bucket to store the output
2526
- # of your transcription job.
2527
- #
2528
- # If you don't specify an output key, Amazon Transcribe stores the
2529
- # output of your transcription job in the Amazon S3 bucket you
2530
- # specified. By default, the object key is
2531
- # "your-transcription-job-name.json".
2532
- #
2533
- # You can use output keys to specify the Amazon S3 prefix and file name
2534
- # of the transcription output. For example, specifying the Amazon S3
2535
- # prefix, "folder1/folder2/", as an output key would lead to the
2536
- # output being stored as
2537
- # "folder1/folder2/your-transcription-job-name.json". If you specify
2538
- # "my-other-job-name.json" as the output key, the object key is
2539
- # changed to "my-other-job-name.json". You can use an output key to
2540
- # change both the prefix and the file name, for example
2541
- # "folder/my-other-job-name.json".
2542
- #
2543
- # If you specify an output key, you must also specify an S3 bucket in
2544
- # the `OutputBucketName` parameter.
2997
+ # Use in combination with `OutputBucketName` to specify the output
2998
+ # location of your transcript and, optionally, a unique name for your
2999
+ # output file. The default name for your transcription output is the
3000
+ # same as the name you specified for your transcription job
3001
+ # (`TranscriptionJobName`).
3002
+ #
3003
+ # Here are some examples of how you can use `OutputKey`\:
3004
+ #
3005
+ # * If you specify 'DOC-EXAMPLE-BUCKET' as the `OutputBucketName` and
3006
+ # 'my-transcript.json' as the `OutputKey`, your transcription output
3007
+ # path is `s3://DOC-EXAMPLE-BUCKET/my-transcript.json`.
3008
+ #
3009
+ # * If you specify 'my-first-transcription' as the
3010
+ # `TranscriptionJobName`, 'DOC-EXAMPLE-BUCKET' as the
3011
+ # `OutputBucketName`, and 'my-transcript' as the `OutputKey`, your
3012
+ # transcription output path is
3013
+ # `s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json`.
3014
+ #
3015
+ # * If you specify 'DOC-EXAMPLE-BUCKET' as the `OutputBucketName` and
3016
+ # 'test-files/my-transcript.json' as the `OutputKey`, your
3017
+ # transcription output path is
3018
+ # `s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json`.
3019
+ #
3020
+ # * If you specify 'my-first-transcription' as the
3021
+ # `TranscriptionJobName`, 'DOC-EXAMPLE-BUCKET' as the
3022
+ # `OutputBucketName`, and 'test-files/my-transcript' as the
3023
+ # `OutputKey`, your transcription output path is
3024
+ # `s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json`.
3025
+ #
3026
+ # If you specify the name of an Amazon S3 bucket sub-folder that
3027
+ # doesn't exist, one is created for you.
2545
3028
  #
2546
3029
  # @option params [String] :output_encryption_kms_key_id
2547
- # The Amazon Resource Name (ARN) of the Amazon Web Services Key
2548
- # Management Service (KMS) key used to encrypt the output of the
2549
- # transcription job. The user calling the `StartTranscriptionJob`
2550
- # operation must have permission to use the specified KMS key.
3030
+ # The KMS key you want to use to encrypt your transcription output.
3031
+ #
3032
+ # If using a key located in the **current** Amazon Web Services account,
3033
+ # you can specify your KMS key in one of four ways:
2551
3034
  #
2552
- # You can use either of the following to identify a KMS key in the
2553
- # current account:
3035
+ # 1. Use the KMS key ID itself. For example,
3036
+ # `1234abcd-12ab-34cd-56ef-1234567890ab`.
2554
3037
  #
2555
- # * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
3038
+ # 2. Use an alias for the KMS key ID. For example,
3039
+ # `alias/ExampleAlias`.
2556
3040
  #
2557
- # * KMS Key Alias: "alias/ExampleAlias"
3041
+ # 3. Use the Amazon Resource Name (ARN) for the KMS key ID. For
3042
+ # example,
3043
+ # `arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
2558
3044
  #
2559
- # You can use either of the following to identify a KMS key in the
2560
- # current account or another account:
3045
+ # 4. Use the ARN for the KMS key alias. For example,
3046
+ # `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
2561
3047
  #
2562
- # * Amazon Resource Name (ARN) of a KMS Key:
2563
- # "arn:aws:kms:region:account
2564
- # ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"
3048
+ # If using a key located in a **different** Amazon Web Services account
3049
+ # than the current Amazon Web Services account, you can specify your KMS
3050
+ # key in one of two ways:
2565
3051
  #
2566
- # * ARN of a KMS Key Alias:
2567
- # "arn:aws:kms:region:account-ID:alias/ExampleAlias"
3052
+ # 1. Use the ARN for the KMS key ID. For example,
3053
+ # `arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
2568
3054
  #
2569
- # If you don't specify an encryption key, the output of the
2570
- # transcription job is encrypted with the default Amazon S3 key
2571
- # (SSE-S3).
3055
+ # 2. Use the ARN for the KMS key alias. For example,
3056
+ # `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
3057
+ #
3058
+ # If you don't specify an encryption key, your output is encrypted with
3059
+ # the default Amazon S3 key (SSE-S3).
2572
3060
  #
2573
3061
  # If you specify a KMS key to encrypt your output, you must also specify
2574
- # an output location in the `OutputBucketName` parameter.
3062
+ # an output location using the `OutputLocation` parameter.
3063
+ #
3064
+ # Note that the user making the request must have permission to use the
3065
+ # specified KMS key.
2575
3066
  #
2576
3067
  # @option params [Hash<String,String>] :kms_encryption_context
2577
3068
  # A map of plain text, non-secret key:value pairs, known as encryption
2578
3069
  # context pairs, that provide an added layer of security for your data.
3070
+ # For more information, see [KMS encryption context][1] and [Asymmetric
3071
+ # keys in KMS][2].
3072
+ #
3073
+ #
3074
+ #
3075
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context
3076
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html
2579
3077
  #
2580
3078
  # @option params [Types::Settings] :settings
2581
- # A `Settings` object that provides optional settings for a
2582
- # transcription job.
3079
+ # Specify additional optional settings in your request, including
3080
+ # channel identification, alternative transcriptions, speaker labeling;
3081
+ # allows you to apply custom vocabularies and vocabulary filters.
3082
+ #
3083
+ # If you want to include a custom vocabulary or a custom vocabulary
3084
+ # filter (or both) with your request but **do not** want to use
3085
+ # automatic language identification, use `Settings` with the
3086
+ # `VocabularyName` or `VocabularyFilterName` (or both) sub-parameter.
3087
+ #
3088
+ # If you're using automatic language identification with your request
3089
+ # and want to include a custom language model, a custom vocabulary, or a
3090
+ # custom vocabulary filter, use instead the ` parameter with the
3091
+ # LanguageModelName, VocabularyName or VocabularyFilterName
3092
+ # sub-parameters.</p>
3093
+ # `
2583
3094
  #
2584
3095
  # @option params [Types::ModelSettings] :model_settings
2585
- # Choose the custom language model you use for your transcription job in
2586
- # this parameter.
3096
+ # Specify the custom language model you want to include with your
3097
+ # transcription job. If you include `ModelSettings` in your request, you
3098
+ # must include the `LanguageModelName` sub-parameter.
3099
+ #
3100
+ # For more information, see [Custom language models][1].
3101
+ #
3102
+ #
3103
+ #
3104
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html
2587
3105
  #
2588
3106
  # @option params [Types::JobExecutionSettings] :job_execution_settings
2589
- # Provides information about how a transcription job is executed. Use
2590
- # this field to indicate that the job can be queued for deferred
2591
- # execution if the concurrency limit is reached and there are no slots
2592
- # available to immediately run the job.
3107
+ # Allows you to control how your transcription job is processed.
3108
+ # Currently, the only `JobExecutionSettings` modification you can choose
3109
+ # is enabling job queueing using the `AllowDeferredExecution`
3110
+ # sub-parameter.
3111
+ #
3112
+ # If you include `JobExecutionSettings` in your request, you must also
3113
+ # include the sub-parameters: `AllowDeferredExecution` and
3114
+ # `DataAccessRoleArn`.
2593
3115
  #
2594
3116
  # @option params [Types::ContentRedaction] :content_redaction
2595
- # An object that contains the request parameters for content redaction.
3117
+ # Allows you to redact or flag specified personally identifiable
3118
+ # information (PII) in your transcript. If you use `ContentRedaction`,
3119
+ # you must also include the sub-parameters: `PiiEntityTypes`,
3120
+ # `RedactionOutput`, and `RedactionType`.
2596
3121
  #
2597
3122
  # @option params [Boolean] :identify_language
2598
- # Set this field to `true` to enable automatic language identification.
2599
- # Automatic language identification is disabled by default. You receive
2600
- # a `BadRequestException` error if you enter a value for a
2601
- # `LanguageCode`.
3123
+ # Enables automatic language identification in your transcription job
3124
+ # request.
3125
+ #
3126
+ # If you include `IdentifyLanguage`, you can optionally include a list
3127
+ # of language codes, using `LanguageOptions`, that you think may be
3128
+ # present in your media file. Including language options can improve
3129
+ # transcription accuracy.
3130
+ #
3131
+ # If you want to apply a custom language model, a custom vocabulary, or
3132
+ # a custom vocabulary filter to your automatic language identification
3133
+ # request, include `LanguageIdSettings` with the relevant sub-parameters
3134
+ # (`VocabularyName`, `LanguageModelName`, and `VocabularyFilterName`).
3135
+ #
3136
+ # Note that you must include one of `LanguageCode`, `IdentifyLanguage`,
3137
+ # or `IdentifyMultipleLanguages` in your request. If you include more
3138
+ # than one of these parameters, your transcription job fails.
3139
+ #
3140
+ # @option params [Boolean] :identify_multiple_languages
3141
+ # Enables automatic multi-language identification in your transcription
3142
+ # job request. Use this parameter if your media file contains more than
3143
+ # one language.
3144
+ #
3145
+ # If you include `IdentifyMultipleLanguages`, you can optionally include
3146
+ # a list of language codes, using `LanguageOptions`, that you think may
3147
+ # be present in your media file. Including language options can improve
3148
+ # transcription accuracy.
3149
+ #
3150
+ # If you want to apply a custom vocabulary or a custom vocabulary filter
3151
+ # to your automatic language identification request, include
3152
+ # `LanguageIdSettings` with the relevant sub-parameters
3153
+ # (`VocabularyName` and `VocabularyFilterName`).
3154
+ #
3155
+ # Note that you must include one of `LanguageCode`, `IdentifyLanguage`,
3156
+ # or `IdentifyMultipleLanguages` in your request. If you include more
3157
+ # than one of these parameters, your transcription job fails.
2602
3158
  #
2603
3159
  # @option params [Array<String>] :language_options
2604
- # An object containing a list of languages that might be present in your
2605
- # collection of audio files. Automatic language identification chooses a
2606
- # language that best matches the source audio from that list.
3160
+ # You can specify two or more language codes that represent the
3161
+ # languages you think may be present in your media; including more than
3162
+ # five is not recommended. If you're unsure what languages are present,
3163
+ # do not include this parameter.
2607
3164
  #
2608
- # To transcribe speech in Modern Standard Arabic (ar-SA), your audio or
2609
- # video file must be encoded at a sample rate of 16,000 Hz or higher.
3165
+ # If you include `LanguageOptions` in your request, you must also
3166
+ # include `IdentifyLanguage`.
3167
+ #
3168
+ # For more information, refer to [Supported languages][1].
3169
+ #
3170
+ # To transcribe speech in Modern Standard Arabic (`ar-SA`), your media
3171
+ # file must be encoded at a sample rate of 16,000 Hz or higher.
3172
+ #
3173
+ #
3174
+ #
3175
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
2610
3176
  #
2611
3177
  # @option params [Types::Subtitles] :subtitles
2612
- # Add subtitles to your batch transcription job.
3178
+ # Produces subtitle files for your input media. You can specify WebVTT
3179
+ # (*.vtt) and SubRip (*.srt) formats.
2613
3180
  #
2614
3181
  # @option params [Array<Types::Tag>] :tags
2615
- # Add tags to an Amazon Transcribe transcription job.
3182
+ # Adds one or more custom tags, each in the form of a key:value pair, to
3183
+ # a new transcription job at the time you start this new job.
3184
+ #
3185
+ # To learn more about using tags with Amazon Transcribe, refer to
3186
+ # [Tagging resources][1].
3187
+ #
3188
+ #
3189
+ #
3190
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html
2616
3191
  #
2617
3192
  # @option params [Hash<String,Types::LanguageIdSettings>] :language_id_settings
2618
- # The language identification settings associated with your
2619
- # transcription job. These settings include `VocabularyName`,
2620
- # `VocabularyFilterName`, and `LanguageModelName`.
3193
+ # If using automatic language identification (`IdentifyLanguage`) in
3194
+ # your request and you want to apply a custom language model, a custom
3195
+ # vocabulary, or a custom vocabulary filter, include
3196
+ # `LanguageIdSettings` with the relevant sub-parameters
3197
+ # (`VocabularyName`, `LanguageModelName`, and `VocabularyFilterName`).
3198
+ #
3199
+ # You can specify two or more language codes that represent the
3200
+ # languages you think may be present in your media; including more than
3201
+ # five is not recommended. Each language code you include can have an
3202
+ # associated custom language model, custom vocabulary, and custom
3203
+ # vocabulary filter. The languages you specify must match the languages
3204
+ # of the specified custom language models, custom vocabularies, and
3205
+ # custom vocabulary filters.
3206
+ #
3207
+ # To include language options using `IdentifyLanguage` **without**
3208
+ # including a custom language model, a custom vocabulary, or a custom
3209
+ # vocabulary filter, use `LanguageOptions` instead of
3210
+ # `LanguageIdSettings`. Including language options can improve the
3211
+ # accuracy of automatic language identification.
3212
+ #
3213
+ # If you want to include a custom language model with your request but
3214
+ # **do not** want to use automatic language identification, use instead
3215
+ # the ` parameter with the LanguageModelName sub-parameter.</p> If you
3216
+ # want to include a custom vocabulary or a custom vocabulary filter (or
3217
+ # both) with your request but do not want to use automatic language
3218
+ # identification, use instead the parameter with the VocabularyName or
3219
+ # VocabularyFilterName (or both) sub-parameter.</p>
3220
+ # `
2621
3221
  #
2622
3222
  # @return [Types::StartTranscriptionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2623
3223
  #
@@ -2627,7 +3227,7 @@ module Aws::TranscribeService
2627
3227
  #
2628
3228
  # resp = client.start_transcription_job({
2629
3229
  # transcription_job_name: "TranscriptionJobName", # required
2630
- # language_code: "af-ZA", # accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
3230
+ # language_code: "af-ZA", # accepts af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
2631
3231
  # media_sample_rate_hertz: 1,
2632
3232
  # media_format: "mp3", # accepts mp3, mp4, wav, flac, ogg, amr, webm
2633
3233
  # media: { # required
@@ -2663,9 +3263,11 @@ module Aws::TranscribeService
2663
3263
  # pii_entity_types: ["BANK_ACCOUNT_NUMBER"], # accepts BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, ALL
2664
3264
  # },
2665
3265
  # identify_language: false,
2666
- # language_options: ["af-ZA"], # accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
3266
+ # identify_multiple_languages: false,
3267
+ # language_options: ["af-ZA"], # accepts af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
2667
3268
  # subtitles: {
2668
3269
  # formats: ["vtt"], # accepts vtt, srt
3270
+ # output_start_index: 1,
2669
3271
  # },
2670
3272
  # tags: [
2671
3273
  # {
@@ -2686,7 +3288,7 @@ module Aws::TranscribeService
2686
3288
  #
2687
3289
  # resp.transcription_job.transcription_job_name #=> String
2688
3290
  # resp.transcription_job.transcription_job_status #=> String, one of "QUEUED", "IN_PROGRESS", "FAILED", "COMPLETED"
2689
- # resp.transcription_job.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "cy-GB", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "ga-IE", "gd-GB", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
3291
+ # resp.transcription_job.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
2690
3292
  # resp.transcription_job.media_sample_rate_hertz #=> Integer
2691
3293
  # resp.transcription_job.media_format #=> String, one of "mp3", "mp4", "wav", "flac", "ogg", "amr", "webm"
2692
3294
  # resp.transcription_job.media.media_file_uri #=> String
@@ -2713,9 +3315,13 @@ module Aws::TranscribeService
2713
3315
  # resp.transcription_job.content_redaction.pii_entity_types #=> Array
2714
3316
  # resp.transcription_job.content_redaction.pii_entity_types[0] #=> String, one of "BANK_ACCOUNT_NUMBER", "BANK_ROUTING", "CREDIT_DEBIT_NUMBER", "CREDIT_DEBIT_CVV", "CREDIT_DEBIT_EXPIRY", "PIN", "EMAIL", "ADDRESS", "NAME", "PHONE", "SSN", "ALL"
2715
3317
  # resp.transcription_job.identify_language #=> Boolean
3318
+ # resp.transcription_job.identify_multiple_languages #=> Boolean
2716
3319
  # resp.transcription_job.language_options #=> Array
2717
- # resp.transcription_job.language_options[0] #=> String, one of "af-ZA", "ar-AE", "ar-SA", "cy-GB", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "ga-IE", "gd-GB", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
3320
+ # resp.transcription_job.language_options[0] #=> String, one of "af-ZA", "ar-AE", "ar-SA", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
2718
3321
  # resp.transcription_job.identified_language_score #=> Float
3322
+ # resp.transcription_job.language_codes #=> Array
3323
+ # resp.transcription_job.language_codes[0].language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
3324
+ # resp.transcription_job.language_codes[0].duration_in_seconds #=> Float
2719
3325
  # resp.transcription_job.tags #=> Array
2720
3326
  # resp.transcription_job.tags[0].key #=> String
2721
3327
  # resp.transcription_job.tags[0].value #=> String
@@ -2723,6 +3329,7 @@ module Aws::TranscribeService
2723
3329
  # resp.transcription_job.subtitles.formats[0] #=> String, one of "vtt", "srt"
2724
3330
  # resp.transcription_job.subtitles.subtitle_file_uris #=> Array
2725
3331
  # resp.transcription_job.subtitles.subtitle_file_uris[0] #=> String
3332
+ # resp.transcription_job.subtitles.output_start_index #=> Integer
2726
3333
  # resp.transcription_job.language_id_settings #=> Hash
2727
3334
  # resp.transcription_job.language_id_settings["LanguageCode"].vocabulary_name #=> String
2728
3335
  # resp.transcription_job.language_id_settings["LanguageCode"].vocabulary_filter_name #=> String
@@ -2737,20 +3344,38 @@ module Aws::TranscribeService
2737
3344
  req.send_request(options)
2738
3345
  end
2739
3346
 
2740
- # Tags an Amazon Transcribe resource with the given list of tags.
3347
+ # Adds one or more custom tags, each in the form of a key:value pair, to
3348
+ # the specified resource.
3349
+ #
3350
+ # To learn more about using tags with Amazon Transcribe, refer to
3351
+ # [Tagging resources][1].
3352
+ #
3353
+ #
3354
+ #
3355
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html
2741
3356
  #
2742
3357
  # @option params [required, String] :resource_arn
2743
- # The Amazon Resource Name (ARN) of the Amazon Transcribe resource you
2744
- # want to tag. ARNs have the format
2745
- # `arn:partition:service:region:account-id:resource-type/resource-id`
2746
- # (for example,
2747
- # `arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name`).
3358
+ # The Amazon Resource Name (ARN) of the resource you want to tag. ARNs
3359
+ # have the format
3360
+ # `arn:partition:service:region:account-id:resource-type/resource-id`.
3361
+ #
3362
+ # For example,
3363
+ # `arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name`.
3364
+ #
2748
3365
  # Valid values for `resource-type` are: `transcription-job`,
2749
3366
  # `medical-transcription-job`, `vocabulary`, `medical-vocabulary`,
2750
3367
  # `vocabulary-filter`, and `language-model`.
2751
3368
  #
2752
3369
  # @option params [required, Array<Types::Tag>] :tags
2753
- # The tags you are assigning to a given Amazon Transcribe resource.
3370
+ # Adds one or more custom tags, each in the form of a key:value pair, to
3371
+ # the specified resource.
3372
+ #
3373
+ # To learn more about using tags with Amazon Transcribe, refer to
3374
+ # [Tagging resources][1].
3375
+ #
3376
+ #
3377
+ #
3378
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html
2754
3379
  #
2755
3380
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2756
3381
  #
@@ -2775,21 +3400,27 @@ module Aws::TranscribeService
2775
3400
  req.send_request(options)
2776
3401
  end
2777
3402
 
2778
- # Removes specified tags from a specified Amazon Transcribe resource.
3403
+ # Removes the specified tags from the specified Amazon Transcribe
3404
+ # resource.
3405
+ #
3406
+ # If you include `UntagResource` in your request, you must also include
3407
+ # `ResourceArn` and `TagKeys`.
2779
3408
  #
2780
3409
  # @option params [required, String] :resource_arn
2781
3410
  # The Amazon Resource Name (ARN) of the Amazon Transcribe resource you
2782
3411
  # want to remove tags from. ARNs have the format
2783
- # `arn:partition:service:region:account-id:resource-type/resource-id`
2784
- # (for example,
2785
- # `arn:aws:transcribe:us-east-1:account-id:transcription-job/your-job-name`).
3412
+ # `arn:partition:service:region:account-id:resource-type/resource-id`.
3413
+ #
3414
+ # For example,
3415
+ # `arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name`.
3416
+ #
2786
3417
  # Valid values for `resource-type` are: `transcription-job`,
2787
3418
  # `medical-transcription-job`, `vocabulary`, `medical-vocabulary`,
2788
3419
  # `vocabulary-filter`, and `language-model`.
2789
3420
  #
2790
3421
  # @option params [required, Array<String>] :tag_keys
2791
- # A list of tag keys you want to remove from a specified Amazon
2792
- # Transcribe resource.
3422
+ # Removes the specified tag keys from the specified Amazon Transcribe
3423
+ # resource.
2793
3424
  #
2794
3425
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2795
3426
  #
@@ -2809,19 +3440,21 @@ module Aws::TranscribeService
2809
3440
  req.send_request(options)
2810
3441
  end
2811
3442
 
2812
- # Updates the call analytics category with new values. The
2813
- # `UpdateCallAnalyticsCategory` operation overwrites all of the existing
2814
- # information with the values that you provide in the request.
3443
+ # Updates the specified Call Analytics category with new rules. Note
3444
+ # that the `UpdateCallAnalyticsCategory` operation overwrites all
3445
+ # existing rules contained in the specified category. You cannot append
3446
+ # additional rules onto an existing category.
3447
+ #
3448
+ # To create a new category, see .
2815
3449
  #
2816
3450
  # @option params [required, String] :category_name
2817
- # The name of the analytics category to update. The name is case
2818
- # sensitive. If you try to update a call analytics category with the
2819
- # same name as a previous category you will receive a
2820
- # `ConflictException` error.
3451
+ # The name of the Call Analytics category you want to update. Category
3452
+ # names are case sensitive.
2821
3453
  #
2822
3454
  # @option params [required, Array<Types::Rule>] :rules
2823
- # The rules used for the updated analytics category. The rules that you
2824
- # provide in this field replace the ones that are currently being used.
3455
+ # The rules used for the updated Call Analytics category. The rules you
3456
+ # provide in this field replace the ones that are currently being used
3457
+ # in the specified category.
2825
3458
  #
2826
3459
  # @return [Types::UpdateCallAnalyticsCategoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2827
3460
  #
@@ -2967,43 +3600,26 @@ module Aws::TranscribeService
2967
3600
  req.send_request(options)
2968
3601
  end
2969
3602
 
2970
- # Updates a vocabulary with new values that you provide in a different
2971
- # text file from the one you used to create the vocabulary. The
2972
- # `UpdateMedicalVocabulary` operation overwrites all of the existing
2973
- # information with the values that you provide in the request.
3603
+ # Updates an existing custom medical vocabulary with new values. This
3604
+ # operation overwrites all existing information with your new values;
3605
+ # you cannot append new terms onto an existing vocabulary.
2974
3606
  #
2975
3607
  # @option params [required, String] :vocabulary_name
2976
- # The name of the vocabulary to update. The name is case sensitive. If
2977
- # you try to update a vocabulary with the same name as a vocabulary
2978
- # you've already made, you get a `ConflictException` error.
3608
+ # The name of the custom medical vocabulary you want to update.
3609
+ # Vocabulary names are case sensitive.
2979
3610
  #
2980
3611
  # @option params [required, String] :language_code
2981
- # The language code of the language used for the entries in the updated
2982
- # vocabulary. U.S. English (en-US) is the only valid language code in
2983
- # Amazon Transcribe Medical.
2984
- #
2985
- # @option params [String] :vocabulary_file_uri
2986
- # The location in Amazon S3 of the text file that contains your custom
2987
- # vocabulary. The URI must be in the same Amazon Web Services Region as
2988
- # the resource that you are calling. The following is the format for a
2989
- # URI:
2990
- #
2991
- # `https://s3.aws-region.amazonaws.com/bucket-name/keyprefix/objectkey`
2992
- #
2993
- # For example:
2994
- #
2995
- # `https://s3.us-east-1.amazonaws.com/DOC-EXAMPLE-BUCKET/vocab.txt`
2996
- #
2997
- # For more information about Amazon S3 object names, see [Object
2998
- # Keys][1] in the *Amazon S3 Developer Guide*.
2999
- #
3000
- # For more information about custom vocabularies in Amazon Transcribe
3001
- # Medical, see [Medical Custom Vocabularies][2].
3002
- #
3612
+ # The language code that represents the language of the entries in the
3613
+ # custom vocabulary you want to update. US English (`en-US`) is the only
3614
+ # language supported with Amazon Transcribe Medical.
3003
3615
  #
3616
+ # @option params [required, String] :vocabulary_file_uri
3617
+ # The Amazon S3 location of the text file that contains your custom
3618
+ # medical vocabulary. The URI must be located in the same Amazon Web
3619
+ # Services Region as the resource you're calling.
3004
3620
  #
3005
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys
3006
- # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-med.html
3621
+ # Here's an example URI path:
3622
+ # `s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt`
3007
3623
  #
3008
3624
  # @return [Types::UpdateMedicalVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3009
3625
  #
@@ -3016,14 +3632,14 @@ module Aws::TranscribeService
3016
3632
  #
3017
3633
  # resp = client.update_medical_vocabulary({
3018
3634
  # vocabulary_name: "VocabularyName", # required
3019
- # language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
3020
- # vocabulary_file_uri: "Uri",
3635
+ # language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
3636
+ # vocabulary_file_uri: "Uri", # required
3021
3637
  # })
3022
3638
  #
3023
3639
  # @example Response structure
3024
3640
  #
3025
3641
  # resp.vocabulary_name #=> String
3026
- # resp.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "cy-GB", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "ga-IE", "gd-GB", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
3642
+ # resp.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
3027
3643
  # resp.last_modified_time #=> Time
3028
3644
  # resp.vocabulary_state #=> String, one of "PENDING", "READY", "FAILED"
3029
3645
  #
@@ -3036,47 +3652,60 @@ module Aws::TranscribeService
3036
3652
  req.send_request(options)
3037
3653
  end
3038
3654
 
3039
- # Updates an existing vocabulary with new values. The `UpdateVocabulary`
3040
- # operation overwrites all of the existing information with the values
3041
- # that you provide in the request.
3655
+ # Updates an existing custom vocabulary with new values. This operation
3656
+ # overwrites all existing information with your new values; you cannot
3657
+ # append new terms onto an existing vocabulary.
3042
3658
  #
3043
3659
  # @option params [required, String] :vocabulary_name
3044
- # The name of the vocabulary to update. The name is case sensitive. If
3045
- # you try to update a vocabulary with the same name as a previous
3046
- # vocabulary you will receive a `ConflictException` error.
3660
+ # The name of the custom vocabulary you want to update. Vocabulary names
3661
+ # are case sensitive.
3047
3662
  #
3048
3663
  # @option params [required, String] :language_code
3049
- # The language code of the vocabulary entries. For a list of languages
3050
- # and their corresponding language codes, see [Supported languages][1].
3664
+ # The language code that represents the language of the entries in the
3665
+ # custom vocabulary you want to update. Each vocabulary must contain
3666
+ # terms in only one language.
3667
+ #
3668
+ # A custom vocabulary can only be used to transcribe files in the same
3669
+ # language as the vocabulary. For example, if you create a vocabulary
3670
+ # using US English (`en-US`), you can only apply this vocabulary to
3671
+ # files that contain English audio.
3672
+ #
3673
+ # For a list of supported languages and their associated language codes,
3674
+ # refer to the [Supported languages][1] table.
3051
3675
  #
3052
3676
  #
3053
3677
  #
3054
3678
  # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
3055
3679
  #
3056
3680
  # @option params [Array<String>] :phrases
3057
- # An array of strings containing the vocabulary entries.
3058
- #
3059
- # @option params [String] :vocabulary_file_uri
3060
- # The S3 location of the text file that contains the definition of the
3061
- # custom vocabulary. The URI must be in the same region as the API
3062
- # endpoint that you are calling. The general form is:
3681
+ # Use this parameter if you want to update your vocabulary by including
3682
+ # all desired terms, as comma-separated values, within your request. The
3683
+ # other option for updating your vocabulary is to save your entries in a
3684
+ # text file and upload them to an Amazon S3 bucket, then specify the
3685
+ # location of your file using the `VocabularyFileUri` parameter.
3063
3686
  #
3064
- # `https://s3.aws-region.amazonaws.com/bucket-name/keyprefix/objectkey`
3687
+ # Note that if you include `Phrases` in your request, you cannot use
3688
+ # `VocabularyFileUri`; you must choose one or the other.
3065
3689
  #
3066
- # For example:
3690
+ # Each language has a character set that contains all allowed characters
3691
+ # for that specific language. If you use unsupported characters, your
3692
+ # vocabulary filter request fails. Refer to [Character Sets for Custom
3693
+ # Vocabularies][1] to get the character set for your language.
3067
3694
  #
3068
- # `https://s3.us-east-1.amazonaws.com/DOC-EXAMPLE-BUCKET/vocab.txt`
3069
3695
  #
3070
- # For more information about S3 object names, see [Object Keys][1] in
3071
- # the *Amazon S3 Developer Guide*.
3072
3696
  #
3073
- # For more information about custom vocabularies, see [Custom
3074
- # Vocabularies][2].
3697
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html
3075
3698
  #
3699
+ # @option params [String] :vocabulary_file_uri
3700
+ # The Amazon S3 location of the text file that contains your custom
3701
+ # vocabulary. The URI must be located in the same Amazon Web Services
3702
+ # Region as the resource you're calling.
3076
3703
  #
3704
+ # Here's an example URI path:
3705
+ # `s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt`
3077
3706
  #
3078
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys
3079
- # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html
3707
+ # Note that if you include `VocabularyFileUri` in your request, you
3708
+ # cannot use the `Phrases` flag; you must choose one or the other.
3080
3709
  #
3081
3710
  # @return [Types::UpdateVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3082
3711
  #
@@ -3089,7 +3718,7 @@ module Aws::TranscribeService
3089
3718
  #
3090
3719
  # resp = client.update_vocabulary({
3091
3720
  # vocabulary_name: "VocabularyName", # required
3092
- # language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
3721
+ # language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
3093
3722
  # phrases: ["Phrase"],
3094
3723
  # vocabulary_file_uri: "Uri",
3095
3724
  # })
@@ -3097,7 +3726,7 @@ module Aws::TranscribeService
3097
3726
  # @example Response structure
3098
3727
  #
3099
3728
  # resp.vocabulary_name #=> String
3100
- # resp.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "cy-GB", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "ga-IE", "gd-GB", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
3729
+ # resp.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
3101
3730
  # resp.last_modified_time #=> Time
3102
3731
  # resp.vocabulary_state #=> String, one of "PENDING", "READY", "FAILED"
3103
3732
  #
@@ -3110,40 +3739,44 @@ module Aws::TranscribeService
3110
3739
  req.send_request(options)
3111
3740
  end
3112
3741
 
3113
- # Updates a vocabulary filter with a new list of filtered words.
3742
+ # Updates an existing custom vocabulary filter with a new list of words.
3743
+ # The new list you provide overwrites all previous entries; you cannot
3744
+ # append new terms onto an existing vocabulary filter.
3114
3745
  #
3115
3746
  # @option params [required, String] :vocabulary_filter_name
3116
- # The name of the vocabulary filter to update. If you try to update a
3117
- # vocabulary filter with the same name as another vocabulary filter, you
3118
- # get a `ConflictException` error.
3747
+ # The name of the custom vocabulary filter you want to update.
3748
+ # Vocabulary filter names are case sensitive.
3119
3749
  #
3120
3750
  # @option params [Array<String>] :words
3121
- # The words to use in the vocabulary filter. Only use characters from
3122
- # the character set defined for custom vocabularies. For a list of
3123
- # character sets, see [Character Sets for Custom Vocabularies][1].
3751
+ # Use this parameter if you want to update your vocabulary filter by
3752
+ # including all desired terms, as comma-separated values, within your
3753
+ # request. The other option for updating your vocabulary filter is to
3754
+ # save your entries in a text file and upload them to an Amazon S3
3755
+ # bucket, then specify the location of your file using the
3756
+ # `VocabularyFilterFileUri` parameter.
3757
+ #
3758
+ # Note that if you include `Words` in your request, you cannot use
3759
+ # `VocabularyFilterFileUri`; you must choose one or the other.
3124
3760
  #
3125
- # If you provide a list of words in the `Words` parameter, you can't
3126
- # use the `VocabularyFilterFileUri` parameter.
3761
+ # Each language has a character set that contains all allowed characters
3762
+ # for that specific language. If you use unsupported characters, your
3763
+ # vocabulary filter request fails. Refer to [Character Sets for Custom
3764
+ # Vocabularies][1] to get the character set for your language.
3127
3765
  #
3128
3766
  #
3129
3767
  #
3130
3768
  # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html
3131
3769
  #
3132
3770
  # @option params [String] :vocabulary_filter_file_uri
3133
- # The Amazon S3 location of a text file used as input to create the
3134
- # vocabulary filter. Only use characters from the character set defined
3135
- # for custom vocabularies. For a list of character sets, see [Character
3136
- # Sets for Custom Vocabularies][1].
3137
- #
3138
- # The specified file must be less than 50 KB of UTF-8 characters.
3139
- #
3140
- # If you provide the location of a list of words in the
3141
- # `VocabularyFilterFileUri` parameter, you can't use the `Words`
3142
- # parameter.
3143
- #
3771
+ # The Amazon S3 location of the text file that contains your custom
3772
+ # vocabulary filter terms. The URI must be located in the same Amazon
3773
+ # Web Services Region as the resource you're calling.
3144
3774
  #
3775
+ # Here's an example URI path:
3776
+ # `s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt`
3145
3777
  #
3146
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html
3778
+ # Note that if you include `VocabularyFilterFileUri` in your request,
3779
+ # you cannot use `Words`; you must choose one or the other.
3147
3780
  #
3148
3781
  # @return [Types::UpdateVocabularyFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3149
3782
  #
@@ -3162,7 +3795,7 @@ module Aws::TranscribeService
3162
3795
  # @example Response structure
3163
3796
  #
3164
3797
  # resp.vocabulary_filter_name #=> String
3165
- # resp.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "cy-GB", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "ga-IE", "gd-GB", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
3798
+ # resp.language_code #=> String, one of "af-ZA", "ar-AE", "ar-SA", "da-DK", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fa-IR", "fr-CA", "fr-FR", "he-IL", "hi-IN", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "pt-BR", "pt-PT", "ru-RU", "ta-IN", "te-IN", "tr-TR", "zh-CN", "zh-TW", "th-TH", "en-ZA", "en-NZ"
3166
3799
  # resp.last_modified_time #=> Time
3167
3800
  #
3168
3801
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateVocabularyFilter AWS API Documentation
@@ -3187,7 +3820,7 @@ module Aws::TranscribeService
3187
3820
  params: params,
3188
3821
  config: config)
3189
3822
  context[:gem_name] = 'aws-sdk-transcribeservice'
3190
- context[:gem_version] = '1.73.0'
3823
+ context[:gem_version] = '1.76.0'
3191
3824
  Seahorse::Client::Request.new(handlers, context)
3192
3825
  end
3193
3826