aws-sdk-transcribeservice 1.74.0 → 1.75.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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.
693
+ #
694
+ # For more information, see [Creating a custom vocabulary][2].
624
695
  #
625
696
  #
626
697
  #
627
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html
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].
@@ -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
  #
@@ -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
  #
@@ -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
  #
@@ -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.
1269
1426
  #
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.
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.
1432
+ #
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
  #
@@ -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
  #
@@ -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
  #
@@ -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
1591
  # 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"
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", "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"
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
@@ -1437,11 +1615,18 @@ module Aws::TranscribeService
1437
1615
  req.send_request(options)
1438
1616
  end
1439
1617
 
1440
- # 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.
1441
1626
  #
1442
1627
  # @option params [required, String] :vocabulary_name
1443
- # The name of the vocabulary to return information about. The name is
1444
- # case sensitive.
1628
+ # The name of the custom vocabulary you want information about.
1629
+ # Vocabulary names are case sensitive.
1445
1630
  #
1446
1631
  # @return [Types::GetVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1447
1632
  #
@@ -1476,10 +1661,18 @@ module Aws::TranscribeService
1476
1661
  req.send_request(options)
1477
1662
  end
1478
1663
 
1479
- # 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.
1480
1672
  #
1481
1673
  # @option params [required, String] :vocabulary_filter_name
1482
- # 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.
1483
1676
  #
1484
1677
  # @return [Types::GetVocabularyFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1485
1678
  #
@@ -1510,20 +1703,24 @@ module Aws::TranscribeService
1510
1703
  req.send_request(options)
1511
1704
  end
1512
1705
 
1513
- # Provides more information about the call analytics categories that
1514
- # you've created. You can use the information in this list to find a
1515
- # specific category. You can then use the operation to get more
1516
- # 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.
1517
1711
  #
1518
1712
  # @option params [String] :next_token
1519
- # When included, `NextToken`fetches the next set of categories if the
1520
- # 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.
1521
1718
  #
1522
1719
  # @option params [Integer] :max_results
1523
- # The maximum number of categories to return in each page of results. If
1524
- # there are fewer results than the value you specify, only the actual
1525
- # results are returned. If you do not specify a value, the default of 5
1526
- # 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.
1527
1724
  #
1528
1725
  # @return [Types::ListCallAnalyticsCategoriesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1529
1726
  #
@@ -1603,27 +1800,33 @@ module Aws::TranscribeService
1603
1800
  req.send_request(options)
1604
1801
  end
1605
1802
 
1606
- # List call analytics jobs with a specified status or substring that
1607
- # 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.
1608
1809
  #
1609
1810
  # @option params [String] :status
1610
- # When specified, returns only call analytics jobs with the specified
1611
- # status. Jobs are ordered by creation date, with the most recent jobs
1612
- # returned first. If you don't specify a status, Amazon Transcribe
1613
- # 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.
1614
1814
  #
1615
1815
  # @option params [String] :job_name_contains
1616
- # When specified, the jobs returned in the list are limited to jobs
1617
- # 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.
1618
1818
  #
1619
1819
  # @option params [String] :next_token
1620
- # If you receive a truncated result in the previous request of , include
1621
- # `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.
1622
1825
  #
1623
1826
  # @option params [Integer] :max_results
1624
- # 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
1625
1828
  # results. If there are fewer results than the value you specify, only
1626
- # 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
1627
1830
  # default of 5 is used.
1628
1831
  #
1629
1832
  # @return [Types::ListCallAnalyticsJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -1665,29 +1868,34 @@ module Aws::TranscribeService
1665
1868
  req.send_request(options)
1666
1869
  end
1667
1870
 
1668
- # Provides more information about the custom language models you've
1669
- # created. You can use the information in this list to find a specific
1670
- # custom language model. You can then use the operation to get more
1671
- # 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.
1672
1877
  #
1673
1878
  # @option params [String] :status_equals
1674
- # When specified, returns only custom language models with the specified
1675
- # status. Language models are ordered by creation date, with the newest
1676
- # models first. If you don't specify a status, Amazon Transcribe
1677
- # 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.
1678
1883
  #
1679
1884
  # @option params [String] :name_contains
1680
- # When specified, the custom language model names returned contain the
1681
- # substring you've specified.
1885
+ # Returns only the custom language models that contain the specified
1886
+ # string. The search is not case sensitive.
1682
1887
  #
1683
1888
  # @option params [String] :next_token
1684
- # When included, fetches the next set of jobs if the result of the
1685
- # 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.
1686
1894
  #
1687
1895
  # @option params [Integer] :max_results
1688
- # 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
1689
1897
  # results. If there are fewer results than the value you specify, only
1690
- # 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
1691
1899
  # default of 5 is used.
1692
1900
  #
1693
1901
  # @return [Types::ListLanguageModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -1731,29 +1939,34 @@ module Aws::TranscribeService
1731
1939
  req.send_request(options)
1732
1940
  end
1733
1941
 
1734
- # Lists medical transcription jobs with a specified status or substring
1735
- # 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.
1736
1948
  #
1737
1949
  # @option params [String] :status
1738
- # When specified, returns only medical transcription jobs with the
1739
- # specified status. Jobs are ordered by creation date, with the newest
1740
- # jobs returned first. If you don't specify a status, Amazon Transcribe
1741
- # 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.
1742
1953
  #
1743
1954
  # @option params [String] :job_name_contains
1744
- # When specified, the jobs returned in the list are limited to jobs
1745
- # 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.
1746
1957
  #
1747
1958
  # @option params [String] :next_token
1748
- # If you a receive a truncated result in the previous request of
1749
- # `ListMedicalTranscriptionJobs`, include `NextToken` to fetch the next
1750
- # 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.
1751
1964
  #
1752
1965
  # @option params [Integer] :max_results
1753
1966
  # The maximum number of medical transcription jobs to return in each
1754
1967
  # page of results. If there are fewer results than the value you
1755
- # specify, only the actual results are returned. If you do not specify a
1756
- # 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.
1757
1970
  #
1758
1971
  # @return [Types::ListMedicalTranscriptionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1759
1972
  #
@@ -1798,30 +2011,35 @@ module Aws::TranscribeService
1798
2011
  req.send_request(options)
1799
2012
  end
1800
2013
 
1801
- # Returns a list of vocabularies that match the specified criteria. If
1802
- # you don't enter a value in any of the request parameters, returns the
1803
- # 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.
1804
2020
  #
1805
2021
  # @option params [String] :next_token
1806
- # If the result of your previous request to `ListMedicalVocabularies`
1807
- # was truncated, include the `NextToken` to fetch the next set of
1808
- # 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.
1809
2027
  #
1810
2028
  # @option params [Integer] :max_results
1811
- # The maximum number of vocabularies to return in each page of results.
1812
- # If there are fewer results than the value you specify, only the actual
1813
- # results are returned. If you do not specify a value, the default of 5
1814
- # 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.
1815
2033
  #
1816
2034
  # @option params [String] :state_equals
1817
- # When specified, returns only vocabularies with the `VocabularyState`
1818
- # equal to the specified vocabulary state. Use this field to see which
1819
- # 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.
1820
2039
  #
1821
2040
  # @option params [String] :name_contains
1822
- # Returns vocabularies whose names contain the specified string. The
1823
- # search is not case sensitive. `ListMedicalVocabularies` returns both
1824
- # "`vocabularyname`" and "`VocabularyName`".
2041
+ # Returns only the custom medical vocabularies that contain the
2042
+ # specified string. The search is not case sensitive.
1825
2043
  #
1826
2044
  # @return [Types::ListMedicalVocabulariesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1827
2045
  #
@@ -1859,15 +2077,24 @@ module Aws::TranscribeService
1859
2077
  req.send_request(options)
1860
2078
  end
1861
2079
 
1862
- # Lists all tags associated with a given transcription job, vocabulary,
1863
- # 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
1864
2089
  #
1865
2090
  # @option params [required, String] :resource_arn
1866
- # Lists all tags associated with a given Amazon Resource Name (ARN).
1867
- # ARNs have the format
1868
- # `arn:partition:service:region:account-id:resource-type/resource-id`
1869
- # (for example,
1870
- # `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
+ #
1871
2098
  # Valid values for `resource-type` are: `transcription-job`,
1872
2099
  # `medical-transcription-job`, `vocabulary`, `medical-vocabulary`,
1873
2100
  # `vocabulary-filter`, and `language-model`.
@@ -1899,26 +2126,34 @@ module Aws::TranscribeService
1899
2126
  req.send_request(options)
1900
2127
  end
1901
2128
 
1902
- # 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.
1903
2135
  #
1904
2136
  # @option params [String] :status
1905
- # When specified, returns only transcription jobs with the specified
1906
- # status. Jobs are ordered by creation date, with the newest jobs
1907
- # returned first. If you don’t specify a status, Amazon Transcribe
1908
- # 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.
1909
2140
  #
1910
2141
  # @option params [String] :job_name_contains
1911
- # When specified, the jobs returned in the list are limited to jobs
1912
- # whose name contains the specified string.
2142
+ # Returns only the transcription jobs that contain the specified string.
2143
+ # The search is not case sensitive.
1913
2144
  #
1914
2145
  # @option params [String] :next_token
1915
- # If the result of the previous request to `ListTranscriptionJobs` is
1916
- # 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.
1917
2151
  #
1918
2152
  # @option params [Integer] :max_results
1919
- # The maximum number of jobs to return in each page of results. If there
1920
- # are fewer results than the value you specify, only the actual results
1921
- # 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.
1922
2157
  #
1923
2158
  # @return [Types::ListTranscriptionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1924
2159
  #
@@ -1956,7 +2191,11 @@ module Aws::TranscribeService
1956
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"
1957
2192
  # resp.transcription_job_summaries[0].model_settings.language_model_name #=> String
1958
2193
  # resp.transcription_job_summaries[0].identify_language #=> Boolean
2194
+ # resp.transcription_job_summaries[0].identify_multiple_languages #=> Boolean
1959
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", "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"
2198
+ # resp.transcription_job_summaries[0].language_codes[0].duration_in_seconds #=> Float
1960
2199
  #
1961
2200
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListTranscriptionJobs AWS API Documentation
1962
2201
  #
@@ -1967,28 +2206,35 @@ module Aws::TranscribeService
1967
2206
  req.send_request(options)
1968
2207
  end
1969
2208
 
1970
- # Returns a list of vocabularies that match the specified criteria. If
1971
- # 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.
1972
2215
  #
1973
2216
  # @option params [String] :next_token
1974
- # If the result of the previous request to `ListVocabularies` was
1975
- # 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.
1976
2222
  #
1977
2223
  # @option params [Integer] :max_results
1978
- # The maximum number of vocabularies to return in each page of results.
1979
- # If there are fewer results than the value you specify, only the actual
1980
- # results are returned. If you do not specify a value, the default of 5
1981
- # 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.
1982
2228
  #
1983
2229
  # @option params [String] :state_equals
1984
- # When specified, only returns vocabularies with the `VocabularyState`
1985
- # 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.
1986
2234
  #
1987
2235
  # @option params [String] :name_contains
1988
- # When specified, the vocabularies returned in the list are limited to
1989
- # vocabularies whose name contains the specified string. The search is
1990
- # not case sensitive, `ListVocabularies` returns both "vocabularyname"
1991
- # and "VocabularyName" in the response list.
2236
+ # Returns only the custom vocabularies that contain the specified
2237
+ # string. The search is not case sensitive.
1992
2238
  #
1993
2239
  # @return [Types::ListVocabulariesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1994
2240
  #
@@ -2026,22 +2272,29 @@ module Aws::TranscribeService
2026
2272
  req.send_request(options)
2027
2273
  end
2028
2274
 
2029
- # 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.
2030
2281
  #
2031
2282
  # @option params [String] :next_token
2032
- # If the result of the previous request to `ListVocabularyFilters` was
2033
- # truncated, include the `NextToken` to fetch the next set of
2034
- # 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.
2035
2288
  #
2036
2289
  # @option params [Integer] :max_results
2037
- # The maximum number of filters to return in each page of results. If
2038
- # there are fewer results than the value you specify, only the actual
2039
- # results are returned. If you do not specify a value, the default of 5
2040
- # 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.
2041
2294
  #
2042
2295
  # @option params [String] :name_contains
2043
- # Filters the response so that it only contains vocabulary filters whose
2044
- # name contains the specified string.
2296
+ # Returns only the custom vocabulary filters that contain the specified
2297
+ # string. The search is not case sensitive.
2045
2298
  #
2046
2299
  # @return [Types::ListVocabularyFiltersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2047
2300
  #
@@ -2075,102 +2328,161 @@ module Aws::TranscribeService
2075
2328
  req.send_request(options)
2076
2329
  end
2077
2330
 
2078
- # Starts an asynchronous analytics job that not only transcribes the
2079
- # audio recording of a caller and agent, but also returns additional
2080
- # insights. These insights include how quickly or loudly the caller or
2081
- # agent was speaking. To retrieve additional insights with your
2082
- # analytics jobs, create categories. A category is a way to classify
2083
- # analytics jobs based on attributes, such as a customer's sentiment or
2084
- # a particular phrase being used during the call. For more information,
2085
- # 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.
2086
2333
  #
2087
- # @option params [required, String] :call_analytics_job_name
2088
- # The name of the call analytics job. You can't use the string "." or
2089
- # ".." by themselves as the job name. The name must also be unique
2090
- # within an Amazon Web Services account. If you try to create a call
2091
- # analytics job with the same name as a previous call analytics job, you
2092
- # 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].
2093
2340
  #
2094
- # @option params [required, Types::Media] :media
2095
- # 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].
2096
2346
  #
2097
- # @option params [String] :output_location
2098
- # The Amazon S3 location where the output of the call analytics job is
2099
- # stored. You can provide the following location types to store the
2100
- # 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:
2353
+ #
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].
2358
+ #
2359
+ # * `CallAnalyticsJobName`\: A custom name you create for your
2360
+ # transcription job that is unique within your Amazon Web Services
2361
+ # account.
2101
2362
  #
2102
- # * s3://DOC-EXAMPLE-BUCKET1
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.
2103
2366
  #
2104
- # If you specify a bucket, Amazon Transcribe saves the output of the
2105
- # analytics job as a JSON file at the root level of the bucket.
2367
+ # * `Media` (`MediaFileUri` or `RedactedMediaFileUri`): The Amazon S3
2368
+ # location of your media file.
2106
2369
  #
2107
- # * s3://DOC-EXAMPLE-BUCKET1/folder/
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.
2108
2375
  #
2109
- # f you specify a path, Amazon Transcribe saves the output of the
2110
- # analytics job as
2111
- # s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json.
2376
+ # </note>
2112
2377
  #
2113
- # If you specify a folder, you must provide a trailing slash.
2114
2378
  #
2115
- # * s3://DOC-EXAMPLE-BUCKET1/folder/filename.json.
2116
2379
  #
2117
- # If you provide a path that has the filename specified, Amazon
2118
- # Transcribe saves the output of the analytics job as
2119
- # s3://DOC-EXAMPLEBUCKET1/folder/filename.json.
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.
2120
2391
  #
2121
- # You can specify an Amazon Web Services Key Management Service (KMS)
2122
- # key to encrypt the output of our analytics job using the
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
2123
2412
  # `OutputEncryptionKMSKeyId` parameter. If you don't specify a KMS key,
2124
2413
  # Amazon Transcribe uses the default Amazon S3 key for server-side
2125
- # encryption of the analytics job output that is placed in your S3
2126
- # 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.
2127
2419
  #
2128
2420
  # @option params [String] :output_encryption_kms_key_id
2129
- # The Amazon Resource Name (ARN) of the Amazon Web Services Key
2130
- # Management Service key used to encrypt the output of the call
2131
- # analytics job. The user calling the operation must have permission to
2132
- # 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`.
2133
2428
  #
2134
- # You use either of the following to identify an Amazon Web Services KMS
2135
- # key in the current account:
2429
+ # 2. Use an alias for the KMS key ID. For example,
2430
+ # `alias/ExampleAlias`.
2136
2431
  #
2137
- # * 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`.
2138
2435
  #
2139
- # * 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`.
2140
2438
  #
2141
- # You can use either of the following to identify a KMS key in the
2142
- # 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:
2143
2442
  #
2144
- # * Amazon Resource Name (ARN) of a KMS key in the current account or
2145
- # another account: "arn:aws:kms:region:account
2146
- # 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`.
2147
2445
  #
2148
- # * ARN of a KMS Key Alias:
2149
- # "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`.
2150
2448
  #
2151
- # If you don't specify an encryption key, the output of the call
2152
- # 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).
2153
2451
  #
2154
2452
  # If you specify a KMS key to encrypt your output, you must also specify
2155
- # 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].
2469
+ #
2470
+ #
2156
2471
  #
2157
- # @option params [required, String] :data_access_role_arn
2158
- # The Amazon Resource Name (ARN) of a role that has access to the S3
2159
- # bucket that contains your input files. Amazon Transcribe assumes this
2160
- # role to read queued audio files. If you have specified an output S3
2161
- # bucket for your transcription results, this role should have access to
2162
- # the output bucket as well.
2472
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns
2163
2473
  #
2164
2474
  # @option params [Types::CallAnalyticsJobSettings] :settings
2165
- # A `Settings` object that provides optional settings for a call
2166
- # 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.
2167
2479
  #
2168
2480
  # @option params [Array<Types::ChannelDefinition>] :channel_definitions
2169
- # When you start a call analytics job, you must pass an array that maps
2170
- # the agent and the customer to specific audio channels. The values you
2171
- # can assign to a channel are 0 and 1. The agent and the customer must
2172
- # each have their own channel. You can't assign more than one channel
2173
- # 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).
2174
2486
  #
2175
2487
  # @return [Types::StartCallAnalyticsJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2176
2488
  #
@@ -2186,7 +2498,7 @@ module Aws::TranscribeService
2186
2498
  # },
2187
2499
  # output_location: "Uri",
2188
2500
  # output_encryption_kms_key_id: "KMSKeyId",
2189
- # data_access_role_arn: "DataAccessRoleArn", # required
2501
+ # data_access_role_arn: "DataAccessRoleArn",
2190
2502
  # settings: {
2191
2503
  # vocabulary_name: "VocabularyName",
2192
2504
  # vocabulary_filter_name: "VocabularyFilterName",
@@ -2258,134 +2570,236 @@ module Aws::TranscribeService
2258
2570
  req.send_request(options)
2259
2571
  end
2260
2572
 
2261
- # 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
2262
2615
  #
2263
2616
  # @option params [required, String] :medical_transcription_job_name
2264
- # The name of the medical transcription job. You can't use the strings
2265
- # "`.`" or "`..`" by themselves as the job name. The name must also
2266
- # be unique within an Amazon Web Services account. If you try to create
2267
- # a medical transcription job with the same name as a previous medical
2268
- # 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.
2269
2626
  #
2270
2627
  # @option params [required, String] :language_code
2271
- # The language code for the language spoken in the input media file. US
2272
- # English (en-US) is the valid value for medical transcription jobs. Any
2273
- # other value you enter for language code results in a
2274
- # `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.
2275
2632
  #
2276
2633
  # @option params [Integer] :media_sample_rate_hertz
2277
- # 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.
2278
2636
  #
2279
- # If you do not specify the media sample rate, Amazon Transcribe Medical
2280
- # determines the sample rate. If you specify the sample rate, it must
2281
- # match the rate detected by Amazon Transcribe Medical. In most cases,
2282
- # you should leave the `MediaSampleRateHertz` field blank and let Amazon
2283
- # 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.
2284
2643
  #
2285
2644
  # @option params [String] :media_format
2286
- # The audio format of the input media file.
2645
+ # Specify the format of your input media file.
2287
2646
  #
2288
2647
  # @option params [required, Types::Media] :media
2289
- # 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.
2290
2650
  #
2291
2651
  # @option params [required, String] :output_bucket_name
2292
- # The Amazon S3 location where the transcription is stored.
2293
- #
2294
- # You must set `OutputBucketName` for Amazon Transcribe Medical to store
2295
- # the transcription results. Your transcript appears in the S3 location
2296
- # you specify. When you call the GetMedicalTranscriptionJob, the
2297
- # operation returns this location in the `TranscriptFileUri` field. The
2298
- # S3 bucket must have permissions that allow Amazon Transcribe Medical
2299
- # to put files in the bucket. For more information, see [Permissions
2300
- # Required for IAM User Roles][1].
2301
- #
2302
- # You can specify an Amazon Web Services Key Management Service (KMS)
2303
- # key to encrypt the output of your transcription using the
2304
- # `OutputEncryptionKMSKeyId` parameter. If you don't specify a KMS key,
2305
- # Amazon Transcribe Medical uses the default Amazon S3 key for
2306
- # server-side encryption of transcripts that are placed in your S3
2307
- # 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.
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.
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/`.
2308
2665
  #
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].
2309
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.
2310
2674
  #
2311
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user
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
2312
2679
  #
2313
2680
  # @option params [String] :output_key
2314
- # You can specify a location in an Amazon S3 bucket to store the output
2315
- # of your medical transcription job.
2316
- #
2317
- # If you don't specify an output key, Amazon Transcribe Medical stores
2318
- # the output of your transcription job in the Amazon S3 bucket you
2319
- # specified. By default, the object key is
2320
- # "your-transcription-job-name.json".
2321
- #
2322
- # You can use output keys to specify the Amazon S3 prefix and file name
2323
- # of the transcription output. For example, specifying the Amazon S3
2324
- # prefix, "folder1/folder2/", as an output key would lead to the
2325
- # output being stored as
2326
- # "folder1/folder2/your-transcription-job-name.json". If you specify
2327
- # "my-other-job-name.json" as the output key, the object key is
2328
- # changed to "my-other-job-name.json". You can use an output key to
2329
- # change both the prefix and the file name, for example
2330
- # "folder/my-other-job-name.json".
2331
- #
2332
- # If you specify an output key, you must also specify an S3 bucket in
2333
- # 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.
2334
2712
  #
2335
2713
  # @option params [String] :output_encryption_kms_key_id
2336
- # The Amazon Resource Name (ARN) of the Amazon Web Services Key
2337
- # Management Service (KMS) key used to encrypt the output of the
2338
- # transcription job. The user calling the StartMedicalTranscriptionJob
2339
- # 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:
2340
2719
  #
2341
- # You use either of the following to identify a KMS key in the current
2342
- # account:
2720
+ # 1. Use the KMS key ID itself. For example,
2721
+ # `1234abcd-12ab-34cd-56ef-1234567890ab`.
2343
2722
  #
2344
- # * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
2723
+ # 2. Use an alias for the KMS key ID. For example,
2724
+ # `alias/ExampleAlias`.
2345
2725
  #
2346
- # * 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`.
2347
2729
  #
2348
- # You can use either of the following to identify a KMS key in the
2349
- # 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`.
2350
2732
  #
2351
- # * Amazon Resource Name (ARN) of a KMS key in the current account or
2352
- # another account:
2353
- # "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:
2354
2736
  #
2355
- # * ARN of a KMS Key Alias: "arn:aws:kms:region:account
2356
- # 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`.
2357
2739
  #
2358
- # If you don't specify an encryption key, the output of the medical
2359
- # transcription job is encrypted with the default Amazon S3 key
2360
- # (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).
2361
2745
  #
2362
2746
  # If you specify a KMS key to encrypt your output, you must also specify
2363
- # 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.
2364
2751
  #
2365
2752
  # @option params [Hash<String,String>] :kms_encryption_context
2366
2753
  # A map of plain text, non-secret key:value pairs, known as encryption
2367
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
2368
2762
  #
2369
2763
  # @option params [Types::MedicalTranscriptionSetting] :settings
2370
- # 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.
2371
2768
  #
2372
2769
  # @option params [String] :content_identification_type
2373
- # You can configure Amazon Transcribe Medical to label content in the
2374
- # transcription output. If you specify `PHI`, Amazon Transcribe Medical
2375
- # labels the personal health information (PHI) that it identifies in the
2376
- # 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
2377
2777
  #
2378
2778
  # @option params [required, String] :specialty
2379
- # 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 .
2380
2782
  #
2381
2783
  # @option params [required, String] :type
2382
- # The type of speech in the input audio. `CONVERSATION` refers to
2383
- # conversations between two or more speakers, e.g., a conversations
2384
- # between doctors and patients. `DICTATION` refers to single-speaker
2385
- # 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.
2386
2792
  #
2387
2793
  # @option params [Array<Types::Tag>] :tags
2388
- # 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
2389
2803
  #
2390
2804
  # @return [Types::StartMedicalTranscriptionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2391
2805
  #
@@ -2463,167 +2877,347 @@ module Aws::TranscribeService
2463
2877
  req.send_request(options)
2464
2878
  end
2465
2879
 
2466
- # 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
2467
2913
  #
2468
2914
  # @option params [required, String] :transcription_job_name
2469
- # The name of the job. You can't use the strings "`.`" or "`..`" by
2470
- # themselves as the job name. The name must also be unique within an
2471
- # Amazon Web Services account. If you try to create a transcription job
2472
- # with the same name as a previous transcription job, you get a
2473
- # `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.
2474
2924
  #
2475
2925
  # @option params [String] :language_code
2476
- # The language code for the language used in the input media file. You
2477
- # must include either `LanguageCode` or `IdentifyLanguage` in your
2478
- # request.
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.
2939
+ #
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>
2479
2944
  #
2480
- # To transcribe speech in Modern Standard Arabic (ar-SA), your audio or
2481
- # video file must be encoded at a sample rate of 16,000 Hz or higher.
2945
+ #
2946
+ #
2947
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
2482
2948
  #
2483
2949
  # @option params [Integer] :media_sample_rate_hertz
2484
- # 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.
2485
2952
  #
2486
- # If you do not specify the media sample rate, Amazon Transcribe
2487
- # determines the sample rate. If you specify the sample rate, it must
2488
- # match the sample rate detected by Amazon Transcribe. In most cases,
2489
- # you should leave the `MediaSampleRateHertz` field blank and let Amazon
2490
- # 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.
2491
2959
  #
2492
2960
  # @option params [String] :media_format
2493
- # The format of the input media file.
2961
+ # Specify the format of your input media file.
2494
2962
  #
2495
2963
  # @option params [required, Types::Media] :media
2496
- # 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.
2497
2966
  #
2498
2967
  # @option params [String] :output_bucket_name
2499
- # The location where the transcription is stored.
2500
- #
2501
- # If you set the `OutputBucketName`, Amazon Transcribe puts the
2502
- # transcript in the specified S3 bucket. When you call the
2503
- # GetTranscriptionJob operation, the operation returns this location in
2504
- # the `TranscriptFileUri` field. If you enable content redaction, the
2505
- # redacted transcript appears in `RedactedTranscriptFileUri`. If you
2506
- # enable content redaction and choose to output an unredacted
2507
- # transcript, that transcript's location still appears in the
2508
- # `TranscriptFileUri`. The S3 bucket must have permissions that allow
2509
- # Amazon Transcribe to put files in the bucket. For more information,
2510
- # see [Permissions Required for IAM User Roles][1].
2511
- #
2512
- # You can specify an Amazon Web Services Key Management Service (KMS)
2513
- # key to encrypt the output of your transcription using the
2514
- # `OutputEncryptionKMSKeyId` parameter. If you don't specify a KMS key,
2515
- # Amazon Transcribe uses the default Amazon S3 key for server-side
2516
- # 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.
2975
+ #
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/`.
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].
2517
2986
  #
2518
- # If you don't set the `OutputBucketName`, Amazon Transcribe generates
2519
- # a pre-signed URL, a shareable URL that provides secure access to your
2520
- # transcription, and returns it in the `TranscriptFileUri` field. Use
2521
- # this URL to download the transcription.
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.
2522
2990
  #
2523
2991
  #
2524
2992
  #
2525
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user
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
2526
2995
  #
2527
2996
  # @option params [String] :output_key
2528
- # You can specify a location in an Amazon S3 bucket to store the output
2529
- # of your transcription job.
2530
- #
2531
- # If you don't specify an output key, Amazon Transcribe stores the
2532
- # output of your transcription job in the Amazon S3 bucket you
2533
- # specified. By default, the object key is
2534
- # "your-transcription-job-name.json".
2535
- #
2536
- # You can use output keys to specify the Amazon S3 prefix and file name
2537
- # of the transcription output. For example, specifying the Amazon S3
2538
- # prefix, "folder1/folder2/", as an output key would lead to the
2539
- # output being stored as
2540
- # "folder1/folder2/your-transcription-job-name.json". If you specify
2541
- # "my-other-job-name.json" as the output key, the object key is
2542
- # changed to "my-other-job-name.json". You can use an output key to
2543
- # change both the prefix and the file name, for example
2544
- # "folder/my-other-job-name.json".
2545
- #
2546
- # If you specify an output key, you must also specify an S3 bucket in
2547
- # 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.
2548
3028
  #
2549
3029
  # @option params [String] :output_encryption_kms_key_id
2550
- # The Amazon Resource Name (ARN) of the Amazon Web Services Key
2551
- # Management Service (KMS) key used to encrypt the output of the
2552
- # transcription job. The user calling the `StartTranscriptionJob`
2553
- # operation must have permission to use the specified KMS key.
3030
+ # The KMS key you want to use to encrypt your transcription output.
2554
3031
  #
2555
- # You can use either of the following to identify a KMS key in the
2556
- # current account:
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:
2557
3034
  #
2558
- # * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
3035
+ # 1. Use the KMS key ID itself. For example,
3036
+ # `1234abcd-12ab-34cd-56ef-1234567890ab`.
2559
3037
  #
2560
- # * KMS Key Alias: "alias/ExampleAlias"
3038
+ # 2. Use an alias for the KMS key ID. For example,
3039
+ # `alias/ExampleAlias`.
2561
3040
  #
2562
- # You can use either of the following to identify a KMS key in the
2563
- # current account or another account:
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`.
2564
3044
  #
2565
- # * Amazon Resource Name (ARN) of a KMS Key:
2566
- # "arn:aws:kms:region:account
2567
- # ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"
3045
+ # 4. Use the ARN for the KMS key alias. For example,
3046
+ # `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
2568
3047
  #
2569
- # * ARN of a KMS Key Alias:
2570
- # "arn:aws:kms:region:account-ID:alias/ExampleAlias"
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:
2571
3051
  #
2572
- # If you don't specify an encryption key, the output of the
2573
- # transcription job is encrypted with the default Amazon S3 key
2574
- # (SSE-S3).
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`.
3054
+ #
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).
2575
3060
  #
2576
3061
  # If you specify a KMS key to encrypt your output, you must also specify
2577
- # 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.
2578
3066
  #
2579
3067
  # @option params [Hash<String,String>] :kms_encryption_context
2580
3068
  # A map of plain text, non-secret key:value pairs, known as encryption
2581
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
2582
3077
  #
2583
3078
  # @option params [Types::Settings] :settings
2584
- # A `Settings` object that provides optional settings for a
2585
- # 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
+ # `
2586
3094
  #
2587
3095
  # @option params [Types::ModelSettings] :model_settings
2588
- # Choose the custom language model you use for your transcription job in
2589
- # 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
2590
3105
  #
2591
3106
  # @option params [Types::JobExecutionSettings] :job_execution_settings
2592
- # Provides information about how a transcription job is executed. Use
2593
- # this field to indicate that the job can be queued for deferred
2594
- # execution if the concurrency limit is reached and there are no slots
2595
- # 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`.
2596
3115
  #
2597
3116
  # @option params [Types::ContentRedaction] :content_redaction
2598
- # 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`.
2599
3121
  #
2600
3122
  # @option params [Boolean] :identify_language
2601
- # Set this field to `true` to enable automatic language identification.
2602
- # Automatic language identification is disabled by default. You receive
2603
- # a `BadRequestException` error if you enter a value for a
2604
- # `LanguageCode`.
2605
- #
2606
- # You must include either `LanguageCode` or `IdentifyLanguage` in your
3123
+ # Enables automatic language identification in your transcription job
2607
3124
  # request.
2608
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.
3158
+ #
2609
3159
  # @option params [Array<String>] :language_options
2610
- # An object containing a list of languages that might be present in your
2611
- # collection of audio files. Automatic language identification chooses a
2612
- # 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.
3164
+ #
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
+ #
2613
3173
  #
2614
- # To transcribe speech in Modern Standard Arabic (ar-SA), your audio or
2615
- # video file must be encoded at a sample rate of 16,000 Hz or higher.
3174
+ #
3175
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
2616
3176
  #
2617
3177
  # @option params [Types::Subtitles] :subtitles
2618
- # 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.
2619
3180
  #
2620
3181
  # @option params [Array<Types::Tag>] :tags
2621
- # 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
2622
3191
  #
2623
3192
  # @option params [Hash<String,Types::LanguageIdSettings>] :language_id_settings
2624
- # The language identification settings associated with your
2625
- # transcription job. These settings include `VocabularyName`,
2626
- # `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
+ # `
2627
3221
  #
2628
3222
  # @return [Types::StartTranscriptionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2629
3223
  #
@@ -2669,6 +3263,7 @@ module Aws::TranscribeService
2669
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
2670
3264
  # },
2671
3265
  # identify_language: false,
3266
+ # identify_multiple_languages: false,
2672
3267
  # 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
2673
3268
  # subtitles: {
2674
3269
  # formats: ["vtt"], # accepts vtt, srt
@@ -2720,9 +3315,13 @@ module Aws::TranscribeService
2720
3315
  # resp.transcription_job.content_redaction.pii_entity_types #=> Array
2721
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"
2722
3317
  # resp.transcription_job.identify_language #=> Boolean
3318
+ # resp.transcription_job.identify_multiple_languages #=> Boolean
2723
3319
  # resp.transcription_job.language_options #=> Array
2724
3320
  # 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"
2725
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", "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"
3324
+ # resp.transcription_job.language_codes[0].duration_in_seconds #=> Float
2726
3325
  # resp.transcription_job.tags #=> Array
2727
3326
  # resp.transcription_job.tags[0].key #=> String
2728
3327
  # resp.transcription_job.tags[0].value #=> String
@@ -2745,20 +3344,38 @@ module Aws::TranscribeService
2745
3344
  req.send_request(options)
2746
3345
  end
2747
3346
 
2748
- # 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
2749
3356
  #
2750
3357
  # @option params [required, String] :resource_arn
2751
- # The Amazon Resource Name (ARN) of the Amazon Transcribe resource you
2752
- # want to tag. ARNs have the format
2753
- # `arn:partition:service:region:account-id:resource-type/resource-id`
2754
- # (for example,
2755
- # `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
+ #
2756
3365
  # Valid values for `resource-type` are: `transcription-job`,
2757
3366
  # `medical-transcription-job`, `vocabulary`, `medical-vocabulary`,
2758
3367
  # `vocabulary-filter`, and `language-model`.
2759
3368
  #
2760
3369
  # @option params [required, Array<Types::Tag>] :tags
2761
- # 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
2762
3379
  #
2763
3380
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2764
3381
  #
@@ -2783,21 +3400,27 @@ module Aws::TranscribeService
2783
3400
  req.send_request(options)
2784
3401
  end
2785
3402
 
2786
- # 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`.
2787
3408
  #
2788
3409
  # @option params [required, String] :resource_arn
2789
3410
  # The Amazon Resource Name (ARN) of the Amazon Transcribe resource you
2790
3411
  # want to remove tags from. ARNs have the format
2791
- # `arn:partition:service:region:account-id:resource-type/resource-id`
2792
- # (for example,
2793
- # `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
+ #
2794
3417
  # Valid values for `resource-type` are: `transcription-job`,
2795
3418
  # `medical-transcription-job`, `vocabulary`, `medical-vocabulary`,
2796
3419
  # `vocabulary-filter`, and `language-model`.
2797
3420
  #
2798
3421
  # @option params [required, Array<String>] :tag_keys
2799
- # A list of tag keys you want to remove from a specified Amazon
2800
- # Transcribe resource.
3422
+ # Removes the specified tag keys from the specified Amazon Transcribe
3423
+ # resource.
2801
3424
  #
2802
3425
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2803
3426
  #
@@ -2817,19 +3440,21 @@ module Aws::TranscribeService
2817
3440
  req.send_request(options)
2818
3441
  end
2819
3442
 
2820
- # Updates the call analytics category with new values. The
2821
- # `UpdateCallAnalyticsCategory` operation overwrites all of the existing
2822
- # 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 .
2823
3449
  #
2824
3450
  # @option params [required, String] :category_name
2825
- # The name of the analytics category to update. The name is case
2826
- # sensitive. If you try to update a call analytics category with the
2827
- # same name as a previous category you will receive a
2828
- # `ConflictException` error.
3451
+ # The name of the Call Analytics category you want to update. Category
3452
+ # names are case sensitive.
2829
3453
  #
2830
3454
  # @option params [required, Array<Types::Rule>] :rules
2831
- # The rules used for the updated analytics category. The rules that you
2832
- # 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.
2833
3458
  #
2834
3459
  # @return [Types::UpdateCallAnalyticsCategoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2835
3460
  #
@@ -2975,43 +3600,26 @@ module Aws::TranscribeService
2975
3600
  req.send_request(options)
2976
3601
  end
2977
3602
 
2978
- # Updates a vocabulary with new values that you provide in a different
2979
- # text file from the one you used to create the vocabulary. The
2980
- # `UpdateMedicalVocabulary` operation overwrites all of the existing
2981
- # 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.
2982
3606
  #
2983
3607
  # @option params [required, String] :vocabulary_name
2984
- # The name of the vocabulary to update. The name is case sensitive. If
2985
- # you try to update a vocabulary with the same name as a vocabulary
2986
- # 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.
2987
3610
  #
2988
3611
  # @option params [required, String] :language_code
2989
- # The language code of the language used for the entries in the updated
2990
- # vocabulary. U.S. English (en-US) is the only valid language code in
2991
- # Amazon Transcribe Medical.
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.
2992
3615
  #
2993
3616
  # @option params [String] :vocabulary_file_uri
2994
- # The location in Amazon S3 of the text file that contains your custom
2995
- # vocabulary. The URI must be in the same Amazon Web Services Region as
2996
- # the resource that you are calling. The following is the format for a
2997
- # URI:
2998
- #
2999
- # `https://s3.aws-region.amazonaws.com/bucket-name/keyprefix/objectkey`
3000
- #
3001
- # For example:
3002
- #
3003
- # `https://s3.us-east-1.amazonaws.com/DOC-EXAMPLE-BUCKET/vocab.txt`
3004
- #
3005
- # For more information about Amazon S3 object names, see [Object
3006
- # Keys][1] in the *Amazon S3 Developer Guide*.
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.
3007
3620
  #
3008
- # For more information about custom vocabularies in Amazon Transcribe
3009
- # Medical, see [Medical Custom Vocabularies][2].
3010
- #
3011
- #
3012
- #
3013
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys
3014
- # [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`
3015
3623
  #
3016
3624
  # @return [Types::UpdateMedicalVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3017
3625
  #
@@ -3044,47 +3652,60 @@ module Aws::TranscribeService
3044
3652
  req.send_request(options)
3045
3653
  end
3046
3654
 
3047
- # Updates an existing vocabulary with new values. The `UpdateVocabulary`
3048
- # operation overwrites all of the existing information with the values
3049
- # 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.
3050
3658
  #
3051
3659
  # @option params [required, String] :vocabulary_name
3052
- # The name of the vocabulary to update. The name is case sensitive. If
3053
- # you try to update a vocabulary with the same name as a previous
3054
- # vocabulary you will receive a `ConflictException` error.
3660
+ # The name of the custom vocabulary you want to update. Vocabulary names
3661
+ # are case sensitive.
3055
3662
  #
3056
3663
  # @option params [required, String] :language_code
3057
- # The language code of the vocabulary entries. For a list of languages
3058
- # 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.
3059
3675
  #
3060
3676
  #
3061
3677
  #
3062
3678
  # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
3063
3679
  #
3064
3680
  # @option params [Array<String>] :phrases
3065
- # An array of strings containing the vocabulary entries.
3066
- #
3067
- # @option params [String] :vocabulary_file_uri
3068
- # The S3 location of the text file that contains the definition of the
3069
- # custom vocabulary. The URI must be in the same region as the API
3070
- # 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.
3071
3686
  #
3072
- # `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.
3073
3689
  #
3074
- # 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.
3075
3694
  #
3076
- # `https://s3.us-east-1.amazonaws.com/DOC-EXAMPLE-BUCKET/vocab.txt`
3077
3695
  #
3078
- # For more information about S3 object names, see [Object Keys][1] in
3079
- # the *Amazon S3 Developer Guide*.
3080
3696
  #
3081
- # For more information about custom vocabularies, see [Custom
3082
- # Vocabularies][2].
3697
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html
3083
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.
3084
3703
  #
3704
+ # Here's an example URI path:
3705
+ # `s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt`
3085
3706
  #
3086
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys
3087
- # [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.
3088
3709
  #
3089
3710
  # @return [Types::UpdateVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3090
3711
  #
@@ -3118,40 +3739,44 @@ module Aws::TranscribeService
3118
3739
  req.send_request(options)
3119
3740
  end
3120
3741
 
3121
- # 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.
3122
3745
  #
3123
3746
  # @option params [required, String] :vocabulary_filter_name
3124
- # The name of the vocabulary filter to update. If you try to update a
3125
- # vocabulary filter with the same name as another vocabulary filter, you
3126
- # get a `ConflictException` error.
3747
+ # The name of the custom vocabulary filter you want to update.
3748
+ # Vocabulary filter names are case sensitive.
3127
3749
  #
3128
3750
  # @option params [Array<String>] :words
3129
- # The words to use in the vocabulary filter. Only use characters from
3130
- # the character set defined for custom vocabularies. For a list of
3131
- # 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.
3132
3760
  #
3133
- # If you provide a list of words in the `Words` parameter, you can't
3134
- # 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.
3135
3765
  #
3136
3766
  #
3137
3767
  #
3138
3768
  # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html
3139
3769
  #
3140
3770
  # @option params [String] :vocabulary_filter_file_uri
3141
- # The Amazon S3 location of a text file used as input to create the
3142
- # vocabulary filter. Only use characters from the character set defined
3143
- # for custom vocabularies. For a list of character sets, see [Character
3144
- # Sets for Custom Vocabularies][1].
3145
- #
3146
- # The specified file must be less than 50 KB of UTF-8 characters.
3147
- #
3148
- # If you provide the location of a list of words in the
3149
- # `VocabularyFilterFileUri` parameter, you can't use the `Words`
3150
- # parameter.
3151
- #
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.
3152
3774
  #
3775
+ # Here's an example URI path:
3776
+ # `s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt`
3153
3777
  #
3154
- # [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.
3155
3780
  #
3156
3781
  # @return [Types::UpdateVocabularyFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3157
3782
  #
@@ -3195,7 +3820,7 @@ module Aws::TranscribeService
3195
3820
  params: params,
3196
3821
  config: config)
3197
3822
  context[:gem_name] = 'aws-sdk-transcribeservice'
3198
- context[:gem_version] = '1.74.0'
3823
+ context[:gem_version] = '1.75.0'
3199
3824
  Seahorse::Client::Request.new(handlers, context)
3200
3825
  end
3201
3826