aws-sdk-transcribeservice 1.70.0 → 1.73.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -27,7 +27,9 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
29
  require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/checksum_algorithm.rb'
30
31
  require 'aws-sdk-core/plugins/defaults_mode.rb'
32
+ require 'aws-sdk-core/plugins/recursion_detection.rb'
31
33
  require 'aws-sdk-core/plugins/signature_v4.rb'
32
34
  require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
33
35
 
@@ -74,7 +76,9 @@ module Aws::TranscribeService
74
76
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
75
77
  add_plugin(Aws::Plugins::TransferEncoding)
76
78
  add_plugin(Aws::Plugins::HttpChecksum)
79
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
77
80
  add_plugin(Aws::Plugins::DefaultsMode)
81
+ add_plugin(Aws::Plugins::RecursionDetection)
78
82
  add_plugin(Aws::Plugins::SignatureV4)
79
83
  add_plugin(Aws::Plugins::Protocols::JsonRpc)
80
84
 
@@ -357,22 +361,27 @@ module Aws::TranscribeService
357
361
 
358
362
  # @!group API Operations
359
363
 
360
- # Creates an analytics category. Amazon Transcribe applies the
361
- # conditions specified by your analytics categories to your call
362
- # analytics jobs. For each analytics category, you specify one or more
363
- # rules. For example, you can specify a rule that the customer sentiment
364
- # was neutral or negative within that category. If you start a call
365
- # analytics job, Amazon Transcribe applies the category to the analytics
366
- # job that you've specified.
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.
367
373
  #
368
374
  # @option params [required, String] :category_name
369
- # The name that you choose for your category when you create it.
375
+ # A unique name, chosen by you, for your call analytics category. For
376
+ # example, `sentiment-positive-last30seconds`.
370
377
  #
371
378
  # @option params [required, Array<Types::Rule>] :rules
372
- # To create a category, you must specify between 1 and 20 rules. For
373
- # each rule, you specify a filter to be applied to the attributes of the
374
- # call. For example, you can specify a sentiment filter to detect if the
375
- # customer's sentiment was negative or neutral.
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
381
+ # category. For each rule, you specify a filter you want applied to the
382
+ # attributes of a call. For example, you can choose a sentiment filter
383
+ # that detects if a customer's sentiment was positive during the last
384
+ # 30 seconds of the call.
376
385
  #
377
386
  # @return [Types::CreateCallAnalyticsCategoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
378
387
  #
@@ -518,34 +527,43 @@ module Aws::TranscribeService
518
527
  req.send_request(options)
519
528
  end
520
529
 
521
- # Creates a new custom language model. Use Amazon S3 prefixes to provide
522
- # the location of your input files. The time it takes to create your
523
- # model depends on the size of your training data.
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.
524
536
  #
525
537
  # @option params [required, String] :language_code
526
- # The language of the input text you're using to train your custom
527
- # language model.
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.
528
541
  #
529
542
  # @option params [required, String] :base_model_name
530
- # The Amazon Transcribe standard language model, or base model used to
531
- # create your custom language model.
543
+ # The Amazon Transcribe standard language model, or base model, used to
544
+ # create your custom language model. Amazon Transcribe offers two
545
+ # options for base models: Wideband and Narrowband.
532
546
  #
533
- # If you want to use your custom language model to transcribe audio with
534
- # a sample rate of 16,000 Hz or greater, choose `Wideband`.
535
- #
536
- # If you want to use your custom language model to transcribe audio with
537
- # a sample rate that is less than 16,000 Hz, choose `Narrowband`.
547
+ # If the audio you want to transcribe has a sample rate of 16,000 Hz or
548
+ # greater, choose `WideBand`. To transcribe audio with a sample rate
549
+ # less than 16,000 Hz, choose `NarrowBand`.
538
550
  #
539
551
  # @option params [required, String] :model_name
540
- # The name you choose for your custom language model when you create it.
552
+ # The name of your new custom language model.
553
+ #
554
+ # 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.
541
558
  #
542
559
  # @option params [required, Types::InputDataConfig] :input_data_config
543
- # Contains the data access role and the Amazon S3 prefixes to read the
544
- # required input files to create a custom language model.
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.
545
563
  #
546
564
  # @option params [Array<Types::Tag>] :tags
547
- # Adds one or more tags, each in the form of a key:value pair, to a new
548
- # language model at the time you create this new model.
565
+ # Optionally add tags, each in the form of a key:value pair, to your new
566
+ # language model. See also: .
549
567
  #
550
568
  # @return [Types::CreateLanguageModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
551
569
  #
@@ -593,48 +611,53 @@ module Aws::TranscribeService
593
611
  req.send_request(options)
594
612
  end
595
613
 
596
- # Creates a new custom vocabulary that you can use to modify how Amazon
597
- # Transcribe Medical transcribes your audio file.
614
+ # Creates a new custom medical vocabulary.
615
+ #
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
620
+ # `CreateMedicalVocabulary` does not support the `Phrases` flag.
621
+ #
622
+ # For more information on creating a custom vocabulary text file, see
623
+ # [Creating a custom vocabulary][1].
624
+ #
625
+ #
626
+ #
627
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html
598
628
  #
599
629
  # @option params [required, String] :vocabulary_name
600
- # The name of the custom vocabulary. This case-sensitive name must be
601
- # unique within an Amazon Web Services account. If you try to create a
630
+ # The name of your new vocabulary.
631
+ #
632
+ # 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
602
634
  # vocabulary with the same name as a previous vocabulary, you get a
603
635
  # `ConflictException` error.
604
636
  #
605
637
  # @option params [required, String] :language_code
606
- # The language code for the language used for the entries in your custom
607
- # vocabulary. The language code of your custom vocabulary must match the
608
- # language code of your transcription job. US English (en-US) is the
609
- # only language code available for Amazon Transcribe Medical.
638
+ # 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.
610
641
  #
611
642
  # @option params [required, String] :vocabulary_file_uri
612
- # The location in Amazon S3 of the text file you use to define your
643
+ # The Amazon S3 location (URI) of the text file that contains your
613
644
  # custom vocabulary. The URI must be in the same Amazon Web Services
614
- # Region as the resource that you're calling. Enter information about
615
- # your `VocabularyFileUri` in the following format:
616
- #
617
- # `https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>`
618
- #
619
- # The following is an example URI for a vocabulary file that is stored
620
- # in Amazon S3:
645
+ # Region as the resource that you're calling.
621
646
  #
622
- # `https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt`
647
+ # Here's an example URI path:
623
648
  #
624
- # For more information about Amazon S3 object names, see [Object
625
- # Keys][1] in the *Amazon S3 Developer Guide*.
649
+ # `https://s3.us-east-1.amazonaws.com/my-s3-bucket/my-vocab-file.txt`
626
650
  #
627
- # For more information about custom vocabularies, see [Medical Custom
628
- # Vocabularies][2].
651
+ # @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.
629
654
  #
655
+ # To learn more about using tags with Amazon Transcribe, refer to
656
+ # [Tagging resources][1].
630
657
  #
631
658
  #
632
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys
633
- # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-med.html
634
659
  #
635
- # @option params [Array<Types::Tag>] :tags
636
- # Adds one or more tags, each in the form of a key:value pair, to a new
637
- # medical vocabulary at the time you create this new vocabulary.
660
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html
638
661
  #
639
662
  # @return [Types::CreateMedicalVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
640
663
  #
@@ -675,50 +698,59 @@ module Aws::TranscribeService
675
698
  req.send_request(options)
676
699
  end
677
700
 
678
- # Creates a new custom vocabulary that you can use to change the way
679
- # Amazon Transcribe handles transcription of an audio file.
701
+ # Creates a new custom vocabulary.
702
+ #
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.
707
+ #
708
+ # For more information on creating a custom vocabulary, see [Creating a
709
+ # custom vocabulary][1].
710
+ #
711
+ #
712
+ #
713
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html
680
714
  #
681
715
  # @option params [required, String] :vocabulary_name
682
- # The name of the vocabulary. The name must be unique within an Amazon
683
- # Web Services account. The name is case sensitive. If you try to create
684
- # a vocabulary with the same name as a previous vocabulary you will
685
- # receive a `ConflictException` error.
716
+ # The name of your new vocabulary.
717
+ #
718
+ # 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
721
+ # `ConflictException` error.
686
722
  #
687
723
  # @option params [required, String] :language_code
688
- # The language code of the vocabulary entries. For a list of languages
689
- # and their corresponding language codes, see table-language-matrix.
724
+ # The language code that represents the language of the entries in your
725
+ # 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].
690
728
  #
691
- # @option params [Array<String>] :phrases
692
- # An array of strings that contains the vocabulary entries.
693
729
  #
694
- # @option params [String] :vocabulary_file_uri
695
- # The S3 location of the text file that contains the definition of the
696
- # custom vocabulary. The URI must be in the same region as the API
697
- # endpoint that you are calling. The general form is:
698
- #
699
- # `https://s3.<Amazon Web
700
- # Services-region>.amazonaws.com/<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey>
701
- # `
702
730
  #
703
- # For example:
731
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
704
732
  #
705
- # `https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt`
733
+ # @option params [Array<String>] :phrases
734
+ # Use this flag to include a list of terms within your request.
706
735
  #
707
- # For more information about S3 object names, see [Object Keys][1] in
708
- # the *Amazon S3 Developer Guide*.
736
+ # Note that if you include `Phrases` in your request, you cannot use
737
+ # `VocabularyFileUri`; you must choose one or the other.
709
738
  #
710
- # For more information about custom vocabularies, see [Custom
711
- # vocabularies][2].
739
+ # @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.
712
743
  #
744
+ # Here's an example URI path:
713
745
  #
746
+ # `https://s3.us-east-1.amazonaws.com/my-s3-bucket/my-vocab-file.txt`
714
747
  #
715
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys
716
- # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html
748
+ # Note that if you include `VocabularyFileUri` in your request, you
749
+ # cannot use the `Phrases` flag; you must choose one or the other.
717
750
  #
718
751
  # @option params [Array<Types::Tag>] :tags
719
752
  # Adds one or more tags, each in the form of a key:value pair, to a new
720
- # Amazon Transcribe vocabulary at the time you create this new
721
- # vocabulary.
753
+ # custom vocabulary at the time you create this new vocabulary.
722
754
  #
723
755
  # @return [Types::CreateVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
724
756
  #
@@ -760,14 +792,17 @@ module Aws::TranscribeService
760
792
  req.send_request(options)
761
793
  end
762
794
 
763
- # Creates a new vocabulary filter that you can use to filter words, such
764
- # as profane words, from the output of a transcription job.
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.
765
798
  #
766
799
  # @option params [required, String] :vocabulary_filter_name
767
- # The vocabulary filter name. The name must be unique within the account
768
- # that contains it. If you try to create a vocabulary filter with the
769
- # same name as another vocabulary filter, you get a `ConflictException`
770
- # error.
800
+ # The name of your new vocabulary filter.
801
+ #
802
+ # 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,
805
+ # you get a `ConflictException` error.
771
806
  #
772
807
  # @option params [required, String] :language_code
773
808
  # The language code of the words in the vocabulary filter. All words in
@@ -775,12 +810,12 @@ module Aws::TranscribeService
775
810
  # only be used with transcription jobs in the specified language.
776
811
  #
777
812
  # @option params [Array<String>] :words
778
- # The words to use in the vocabulary filter. Only use characters from
779
- # the character set defined for custom vocabularies. For a list of
780
- # character sets, see [Character Sets for Custom Vocabularies][1].
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.
781
816
  #
782
- # If you provide a list of words in the `Words` parameter, you can't
783
- # use the `VocabularyFilterFileUri` parameter.
817
+ # Note that if you include `Words` in your request, you cannot use
818
+ # `VocabularyFilterFileUri`; you must choose one or the other.
784
819
  #
785
820
  #
786
821
  #
@@ -792,11 +827,10 @@ module Aws::TranscribeService
792
827
  # for custom vocabularies. For a list of character sets, see [Character
793
828
  # Sets for Custom Vocabularies][1].
794
829
  #
795
- # The specified file must be less than 50 KB of UTF-8 characters.
830
+ # Your vocabulary filter file must be less than 50 KB in size.
796
831
  #
797
- # If you provide the location of a list of words in the
798
- # `VocabularyFilterFileUri` parameter, you can't use the `Words`
799
- # parameter.
832
+ # Note that if you include `VocabularyFilterFileUri` in your request,
833
+ # you cannot use `Words`; you must choose one or the other.
800
834
  #
801
835
  #
802
836
  #
@@ -804,8 +838,7 @@ module Aws::TranscribeService
804
838
  #
805
839
  # @option params [Array<Types::Tag>] :tags
806
840
  # Adds one or more tags, each in the form of a key:value pair, to a new
807
- # Amazon Transcribe vocabulary filter at the time you create this new
808
- # vocabulary filter.
841
+ # vocabulary filter at the time you create this new vocabulary filter.
809
842
  #
810
843
  # @return [Types::CreateVocabularyFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
811
844
  #
@@ -843,11 +876,12 @@ module Aws::TranscribeService
843
876
  req.send_request(options)
844
877
  end
845
878
 
846
- # Deletes a call analytics category using its name.
879
+ # Deletes a call analytics category. To use this operation, specify the
880
+ # name of the category you want to delete using `CategoryName`.
847
881
  #
848
882
  # @option params [required, String] :category_name
849
- # The name of the call analytics category that you're choosing to
850
- # delete. The value is case sensitive.
883
+ # The name of the call analytics category you want to delete. Category
884
+ # names are case-sensitive.
851
885
  #
852
886
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
853
887
  #
@@ -866,10 +900,12 @@ module Aws::TranscribeService
866
900
  req.send_request(options)
867
901
  end
868
902
 
869
- # Deletes a call analytics job using its name.
903
+ # Deletes a call analytics job. To use this operation, specify the name
904
+ # of the job you want to delete using `CallAnalyticsJobName`.
870
905
  #
871
906
  # @option params [required, String] :call_analytics_job_name
872
- # The name of the call analytics job you want to delete.
907
+ # The name of the call analytics job you want to delete. Job names are
908
+ # case-sensitive.
873
909
  #
874
910
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
875
911
  #
@@ -888,10 +924,12 @@ module Aws::TranscribeService
888
924
  req.send_request(options)
889
925
  end
890
926
 
891
- # Deletes a custom language model using its name.
927
+ # Deletes a custom language model. To use this operation, specify the
928
+ # name of the language model you want to delete using `ModelName`.
892
929
  #
893
930
  # @option params [required, String] :model_name
894
- # The name of the model you're choosing to delete.
931
+ # The name of the model you want to delete. Model names are
932
+ # case-sensitive.
895
933
  #
896
934
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
897
935
  #
@@ -910,12 +948,13 @@ module Aws::TranscribeService
910
948
  req.send_request(options)
911
949
  end
912
950
 
913
- # Deletes a transcription job generated by Amazon Transcribe Medical and
914
- # any related information.
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`.
915
954
  #
916
955
  # @option params [required, String] :medical_transcription_job_name
917
- # The name you provide to the `DeleteMedicalTranscriptionJob` object to
918
- # delete a transcription job.
956
+ # The name of the medical transcription job you want to delete. Job
957
+ # names are case-sensitive.
919
958
  #
920
959
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
921
960
  #
@@ -934,10 +973,12 @@ module Aws::TranscribeService
934
973
  req.send_request(options)
935
974
  end
936
975
 
937
- # Deletes a vocabulary from Amazon Transcribe Medical.
976
+ # Deletes a custom medical vocabulary. To use this operation, specify
977
+ # the name of the vocabulary you want to delete using `VocabularyName`.
938
978
  #
939
979
  # @option params [required, String] :vocabulary_name
940
- # The name of the vocabulary that you want to delete.
980
+ # The name of the vocabulary that you want to delete. Vocabulary names
981
+ # are case-sensitive.
941
982
  #
942
983
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
943
984
  #
@@ -956,11 +997,13 @@ module Aws::TranscribeService
956
997
  req.send_request(options)
957
998
  end
958
999
 
959
- # Deletes a previously submitted transcription job along with any other
960
- # generated results such as the transcription, models, and so on.
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`.
961
1003
  #
962
1004
  # @option params [required, String] :transcription_job_name
963
- # The name of the transcription job to be deleted.
1005
+ # The name of the transcription job you want to delete. Job names are
1006
+ # case-sensitive.
964
1007
  #
965
1008
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
966
1009
  #
@@ -979,10 +1022,12 @@ module Aws::TranscribeService
979
1022
  req.send_request(options)
980
1023
  end
981
1024
 
982
- # Deletes a vocabulary from Amazon Transcribe.
1025
+ # Deletes a custom vocabulary. To use this operation, specify the name
1026
+ # of the vocabulary you want to delete using `VocabularyName`.
983
1027
  #
984
1028
  # @option params [required, String] :vocabulary_name
985
- # The name of the vocabulary to delete.
1029
+ # The name of the vocabulary you want to delete. Vocabulary names are
1030
+ # case-sensitive.
986
1031
  #
987
1032
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
988
1033
  #
@@ -1001,10 +1046,13 @@ module Aws::TranscribeService
1001
1046
  req.send_request(options)
1002
1047
  end
1003
1048
 
1004
- # Removes a vocabulary filter.
1049
+ # Deletes a vocabulary filter. To use this operation, specify the name
1050
+ # of the vocabulary filter you want to delete using
1051
+ # `VocabularyFilterName`.
1005
1052
  #
1006
1053
  # @option params [required, String] :vocabulary_filter_name
1007
- # The name of the vocabulary filter to remove.
1054
+ # The name of the vocabulary filter you want to delete. Vocabulary
1055
+ # filter names are case-sensitive.
1008
1056
  #
1009
1057
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1010
1058
  #
@@ -1023,18 +1071,21 @@ module Aws::TranscribeService
1023
1071
  req.send_request(options)
1024
1072
  end
1025
1073
 
1026
- # Gets information about a single custom language model. Use this
1027
- # information to see details about the language model in your Amazon Web
1028
- # Services account. You can also see whether the base language model
1029
- # used to create your custom language model has been updated. If Amazon
1074
+ # Provides information about a specific custom language model in your
1075
+ # Amazon Web Services account.
1076
+ #
1077
+ # This operation also shows if the base language model you used to
1078
+ # create your custom language model has been updated. If Amazon
1030
1079
  # Transcribe has updated the base model, you can create a new custom
1031
- # language model using the updated base model. If the language model
1032
- # wasn't created, you can use this operation to understand why Amazon
1033
- # Transcribe couldn't create it.
1080
+ # language model using the updated base model.
1081
+ #
1082
+ # 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.
1034
1085
  #
1035
1086
  # @option params [required, String] :model_name
1036
- # The name of the custom language model you submit to get more
1037
- # information.
1087
+ # The name of the custom language model you want described. Model names
1088
+ # are case-sensitive.
1038
1089
  #
1039
1090
  # @return [Types::DescribeLanguageModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1040
1091
  #
@@ -1072,8 +1123,8 @@ module Aws::TranscribeService
1072
1123
  # Retrieves information about a call analytics category.
1073
1124
  #
1074
1125
  # @option params [required, String] :category_name
1075
- # The name of the category you want information about. This value is
1076
- # case sensitive.
1126
+ # The name of the category you want information about. Category names
1127
+ # are case sensitive.
1077
1128
  #
1078
1129
  # @return [Types::GetCallAnalyticsCategoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1079
1130
  #
@@ -1147,12 +1198,14 @@ module Aws::TranscribeService
1147
1198
  req.send_request(options)
1148
1199
  end
1149
1200
 
1150
- # Returns information about a call analytics job. To see the status of
1151
- # the job, check the `CallAnalyticsJobStatus` field. If the status is
1152
- # `COMPLETED`, the job is finished and you can find the results at the
1153
- # location specified in the `TranscriptFileUri` field. If you enable
1154
- # personally identifiable information (PII) redaction, the redacted
1155
- # transcript appears in the `RedactedTranscriptFileUri` field.
1201
+ # Retrieves information about a call analytics job.
1202
+ #
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.
1156
1209
  #
1157
1210
  # @option params [required, String] :call_analytics_job_name
1158
1211
  # The name of the analytics job you want information about. This value
@@ -1212,14 +1265,16 @@ module Aws::TranscribeService
1212
1265
  req.send_request(options)
1213
1266
  end
1214
1267
 
1215
- # Returns information about a transcription job from Amazon Transcribe
1216
- # Medical. To see the status of the job, check the
1217
- # `TranscriptionJobStatus` field. If the status is `COMPLETED`, the job
1218
- # is finished. You find the results of the completed job in the
1219
- # `TranscriptFileUri` field.
1268
+ # Retrieves information about a medical transcription job.
1269
+ #
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.
1220
1274
  #
1221
1275
  # @option params [required, String] :medical_transcription_job_name
1222
- # The name of the medical transcription job.
1276
+ # The name of the medical transcription job you want information about.
1277
+ # This value is case sensitive.
1223
1278
  #
1224
1279
  # @return [Types::GetMedicalTranscriptionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1225
1280
  #
@@ -1270,8 +1325,8 @@ module Aws::TranscribeService
1270
1325
  # Retrieves information about a medical vocabulary.
1271
1326
  #
1272
1327
  # @option params [required, String] :vocabulary_name
1273
- # The name of the vocabulary that you want information about. The value
1274
- # is case sensitive.
1328
+ # The name of the medical vocabulary you want information about. This
1329
+ # value is case sensitive.
1275
1330
  #
1276
1331
  # @return [Types::GetMedicalVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1277
1332
  #
@@ -2329,7 +2384,7 @@ module Aws::TranscribeService
2329
2384
  # dictated speech, such as clinical notes.
2330
2385
  #
2331
2386
  # @option params [Array<Types::Tag>] :tags
2332
- # Add tags to an Amazon Transcribe medical transcription job.
2387
+ # Add tags to an Amazon Transcribe Medical transcription job.
2333
2388
  #
2334
2389
  # @return [Types::StartMedicalTranscriptionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2335
2390
  #
@@ -2933,13 +2988,11 @@ module Aws::TranscribeService
2933
2988
  # the resource that you are calling. The following is the format for a
2934
2989
  # URI:
2935
2990
  #
2936
- # `
2937
- # https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
2938
- # `
2991
+ # `https://s3.aws-region.amazonaws.com/bucket-name/keyprefix/objectkey`
2939
2992
  #
2940
2993
  # For example:
2941
2994
  #
2942
- # `https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt`
2995
+ # `https://s3.us-east-1.amazonaws.com/DOC-EXAMPLE-BUCKET/vocab.txt`
2943
2996
  #
2944
2997
  # For more information about Amazon S3 object names, see [Object
2945
2998
  # Keys][1] in the *Amazon S3 Developer Guide*.
@@ -3008,11 +3061,11 @@ module Aws::TranscribeService
3008
3061
  # custom vocabulary. The URI must be in the same region as the API
3009
3062
  # endpoint that you are calling. The general form is:
3010
3063
  #
3011
- # `https://s3.<aws-region>.amazonaws.com/<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey>`
3064
+ # `https://s3.aws-region.amazonaws.com/bucket-name/keyprefix/objectkey`
3012
3065
  #
3013
3066
  # For example:
3014
3067
  #
3015
- # `https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt`
3068
+ # `https://s3.us-east-1.amazonaws.com/DOC-EXAMPLE-BUCKET/vocab.txt`
3016
3069
  #
3017
3070
  # For more information about S3 object names, see [Object Keys][1] in
3018
3071
  # the *Amazon S3 Developer Guide*.
@@ -3134,7 +3187,7 @@ module Aws::TranscribeService
3134
3187
  params: params,
3135
3188
  config: config)
3136
3189
  context[:gem_name] = 'aws-sdk-transcribeservice'
3137
- context[:gem_version] = '1.70.0'
3190
+ context[:gem_version] = '1.73.0'
3138
3191
  Seahorse::Client::Request.new(handlers, context)
3139
3192
  end
3140
3193