aws-sdk-transcribeservice 1.72.0 → 1.73.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: bdd08ceebc72a005ced9b654a6bcf01bb385537fd754fcf16b51bc3890450c66
4
- data.tar.gz: 61a254577d67b2f8d303e7b71c25b8df8bc2a16856600e4e9186ab5d9b47959a
3
+ metadata.gz: 4e083c52a24d45fcb9985817b76a21348a73e043eab5fd6d180de0176e9dae8f
4
+ data.tar.gz: 07dfd55ffc88bdf5ce9dea2be7a103243e236cb44a50ef87cd79bd08089aa7eb
5
5
  SHA512:
6
- metadata.gz: ab57d7c6fe28e7f16f51e89950020b0d2d66faa90e6202edc5b349b2d5b5c1a89418c852e9b9d6ffdd33729234a043007c98a7975b22eed874fee8e394214702
7
- data.tar.gz: 5c07a4d7c47da25bee24e4744170b8fbf748d70c16f03a318be31c287eb90b4b88dfcb86fba40cc00c96d92eb06a2dfde8f7a7d4d5f94774951e16081192e240
6
+ metadata.gz: 66629b5ed65caabcf6c0da108d330c84541e601c0ff5247860f38b8a05705b85325dce6d278749c23336ee48bdfc12bb1f5a527eaaa59b5ef86c722326c54d69
7
+ data.tar.gz: 8beb6453464772f286c7a11566240ca258651b98d2c91323d51b9c7036aec16d4da252f428e6c24c2e678ef3ecb306ab68fcf747f200fe2be884a9aaf3345b0f
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.73.0 (2022-03-10)
5
+ ------------------
6
+
7
+ * Feature - Documentation fix for API `StartMedicalTranscriptionJobRequest`, now showing min sample rate as 16khz
8
+
4
9
  1.72.0 (2022-02-24)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.72.0
1
+ 1.73.0
@@ -361,22 +361,27 @@ module Aws::TranscribeService
361
361
 
362
362
  # @!group API Operations
363
363
 
364
- # Creates an analytics category. Amazon Transcribe applies the
365
- # conditions specified by your analytics categories to your call
366
- # analytics jobs. For each analytics category, you specify one or more
367
- # rules. For example, you can specify a rule that the customer sentiment
368
- # was neutral or negative within that category. If you start a call
369
- # analytics job, Amazon Transcribe applies the category to the analytics
370
- # 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.
371
373
  #
372
374
  # @option params [required, String] :category_name
373
- # 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`.
374
377
  #
375
378
  # @option params [required, Array<Types::Rule>] :rules
376
- # To create a category, you must specify between 1 and 20 rules. For
377
- # each rule, you specify a filter to be applied to the attributes of the
378
- # call. For example, you can specify a sentiment filter to detect if the
379
- # 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.
380
385
  #
381
386
  # @return [Types::CreateCallAnalyticsCategoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
382
387
  #
@@ -522,34 +527,43 @@ module Aws::TranscribeService
522
527
  req.send_request(options)
523
528
  end
524
529
 
525
- # Creates a new custom language model. Use Amazon S3 prefixes to provide
526
- # the location of your input files. The time it takes to create your
527
- # 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.
528
536
  #
529
537
  # @option params [required, String] :language_code
530
- # The language of the input text you're using to train your custom
531
- # 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.
532
541
  #
533
542
  # @option params [required, String] :base_model_name
534
- # The Amazon Transcribe standard language model, or base model used to
535
- # 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.
536
546
  #
537
- # If you want to use your custom language model to transcribe audio with
538
- # a sample rate of 16,000 Hz or greater, choose `Wideband`.
539
- #
540
- # If you want to use your custom language model to transcribe audio with
541
- # 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`.
542
550
  #
543
551
  # @option params [required, String] :model_name
544
- # 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.
545
558
  #
546
559
  # @option params [required, Types::InputDataConfig] :input_data_config
547
- # Contains the data access role and the Amazon S3 prefixes to read the
548
- # 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.
549
563
  #
550
564
  # @option params [Array<Types::Tag>] :tags
551
- # Adds one or more tags, each in the form of a key:value pair, to a new
552
- # 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: .
553
567
  #
554
568
  # @return [Types::CreateLanguageModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
555
569
  #
@@ -597,48 +611,53 @@ module Aws::TranscribeService
597
611
  req.send_request(options)
598
612
  end
599
613
 
600
- # Creates a new custom vocabulary that you can use to modify how Amazon
601
- # 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
602
628
  #
603
629
  # @option params [required, String] :vocabulary_name
604
- # The name of the custom vocabulary. This case-sensitive name must be
605
- # 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
606
634
  # vocabulary with the same name as a previous vocabulary, you get a
607
635
  # `ConflictException` error.
608
636
  #
609
637
  # @option params [required, String] :language_code
610
- # The language code for the language used for the entries in your custom
611
- # vocabulary. The language code of your custom vocabulary must match the
612
- # language code of your transcription job. US English (en-US) is the
613
- # 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.
614
641
  #
615
642
  # @option params [required, String] :vocabulary_file_uri
616
- # 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
617
644
  # custom vocabulary. The URI must be in the same Amazon Web Services
618
- # Region as the resource that you're calling. Enter information about
619
- # your `VocabularyFileUri` in the following format:
620
- #
621
- # `https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>`
622
- #
623
- # The following is an example URI for a vocabulary file that is stored
624
- # in Amazon S3:
645
+ # Region as the resource that you're calling.
625
646
  #
626
- # `https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt`
647
+ # Here's an example URI path:
627
648
  #
628
- # For more information about Amazon S3 object names, see [Object
629
- # Keys][1] in the *Amazon S3 Developer Guide*.
649
+ # `https://s3.us-east-1.amazonaws.com/my-s3-bucket/my-vocab-file.txt`
630
650
  #
631
- # For more information about custom vocabularies, see [Medical Custom
632
- # 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.
633
654
  #
655
+ # To learn more about using tags with Amazon Transcribe, refer to
656
+ # [Tagging resources][1].
634
657
  #
635
658
  #
636
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys
637
- # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-med.html
638
659
  #
639
- # @option params [Array<Types::Tag>] :tags
640
- # Adds one or more tags, each in the form of a key:value pair, to a new
641
- # medical vocabulary at the time you create this new vocabulary.
660
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html
642
661
  #
643
662
  # @return [Types::CreateMedicalVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
644
663
  #
@@ -679,50 +698,59 @@ module Aws::TranscribeService
679
698
  req.send_request(options)
680
699
  end
681
700
 
682
- # Creates a new custom vocabulary that you can use to change the way
683
- # 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
684
714
  #
685
715
  # @option params [required, String] :vocabulary_name
686
- # The name of the vocabulary. The name must be unique within an Amazon
687
- # Web Services account. The name is case sensitive. If you try to create
688
- # a vocabulary with the same name as a previous vocabulary you will
689
- # 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.
690
722
  #
691
723
  # @option params [required, String] :language_code
692
- # The language code of the vocabulary entries. For a list of languages
693
- # 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].
694
728
  #
695
- # @option params [Array<String>] :phrases
696
- # An array of strings that contains the vocabulary entries.
697
729
  #
698
- # @option params [String] :vocabulary_file_uri
699
- # The S3 location of the text file that contains the definition of the
700
- # custom vocabulary. The URI must be in the same region as the API
701
- # endpoint that you are calling. The general form is:
702
- #
703
- # `https://s3.<Amazon Web
704
- # Services-region>.amazonaws.com/<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey>
705
- # `
706
730
  #
707
- # For example:
731
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
708
732
  #
709
- # `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.
710
735
  #
711
- # For more information about S3 object names, see [Object Keys][1] in
712
- # 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.
713
738
  #
714
- # For more information about custom vocabularies, see [Custom
715
- # 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.
716
743
  #
744
+ # Here's an example URI path:
717
745
  #
746
+ # `https://s3.us-east-1.amazonaws.com/my-s3-bucket/my-vocab-file.txt`
718
747
  #
719
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys
720
- # [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.
721
750
  #
722
751
  # @option params [Array<Types::Tag>] :tags
723
752
  # Adds one or more tags, each in the form of a key:value pair, to a new
724
- # Amazon Transcribe vocabulary at the time you create this new
725
- # vocabulary.
753
+ # custom vocabulary at the time you create this new vocabulary.
726
754
  #
727
755
  # @return [Types::CreateVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
728
756
  #
@@ -764,14 +792,17 @@ module Aws::TranscribeService
764
792
  req.send_request(options)
765
793
  end
766
794
 
767
- # Creates a new vocabulary filter that you can use to filter words, such
768
- # 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.
769
798
  #
770
799
  # @option params [required, String] :vocabulary_filter_name
771
- # The vocabulary filter name. The name must be unique within the account
772
- # that contains it. If you try to create a vocabulary filter with the
773
- # same name as another vocabulary filter, you get a `ConflictException`
774
- # 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.
775
806
  #
776
807
  # @option params [required, String] :language_code
777
808
  # The language code of the words in the vocabulary filter. All words in
@@ -779,12 +810,12 @@ module Aws::TranscribeService
779
810
  # only be used with transcription jobs in the specified language.
780
811
  #
781
812
  # @option params [Array<String>] :words
782
- # The words to use in the vocabulary filter. Only use characters from
783
- # the character set defined for custom vocabularies. For a list of
784
- # 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.
785
816
  #
786
- # If you provide a list of words in the `Words` parameter, you can't
787
- # 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.
788
819
  #
789
820
  #
790
821
  #
@@ -796,11 +827,10 @@ module Aws::TranscribeService
796
827
  # for custom vocabularies. For a list of character sets, see [Character
797
828
  # Sets for Custom Vocabularies][1].
798
829
  #
799
- # 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.
800
831
  #
801
- # If you provide the location of a list of words in the
802
- # `VocabularyFilterFileUri` parameter, you can't use the `Words`
803
- # parameter.
832
+ # Note that if you include `VocabularyFilterFileUri` in your request,
833
+ # you cannot use `Words`; you must choose one or the other.
804
834
  #
805
835
  #
806
836
  #
@@ -808,8 +838,7 @@ module Aws::TranscribeService
808
838
  #
809
839
  # @option params [Array<Types::Tag>] :tags
810
840
  # Adds one or more tags, each in the form of a key:value pair, to a new
811
- # Amazon Transcribe vocabulary filter at the time you create this new
812
- # vocabulary filter.
841
+ # vocabulary filter at the time you create this new vocabulary filter.
813
842
  #
814
843
  # @return [Types::CreateVocabularyFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
815
844
  #
@@ -847,11 +876,12 @@ module Aws::TranscribeService
847
876
  req.send_request(options)
848
877
  end
849
878
 
850
- # 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`.
851
881
  #
852
882
  # @option params [required, String] :category_name
853
- # The name of the call analytics category that you're choosing to
854
- # delete. The value is case sensitive.
883
+ # The name of the call analytics category you want to delete. Category
884
+ # names are case-sensitive.
855
885
  #
856
886
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
857
887
  #
@@ -870,10 +900,12 @@ module Aws::TranscribeService
870
900
  req.send_request(options)
871
901
  end
872
902
 
873
- # 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`.
874
905
  #
875
906
  # @option params [required, String] :call_analytics_job_name
876
- # 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.
877
909
  #
878
910
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
879
911
  #
@@ -892,10 +924,12 @@ module Aws::TranscribeService
892
924
  req.send_request(options)
893
925
  end
894
926
 
895
- # 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`.
896
929
  #
897
930
  # @option params [required, String] :model_name
898
- # 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.
899
933
  #
900
934
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
901
935
  #
@@ -914,12 +948,13 @@ module Aws::TranscribeService
914
948
  req.send_request(options)
915
949
  end
916
950
 
917
- # Deletes a transcription job generated by Amazon Transcribe Medical and
918
- # 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`.
919
954
  #
920
955
  # @option params [required, String] :medical_transcription_job_name
921
- # The name you provide to the `DeleteMedicalTranscriptionJob` object to
922
- # delete a transcription job.
956
+ # The name of the medical transcription job you want to delete. Job
957
+ # names are case-sensitive.
923
958
  #
924
959
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
925
960
  #
@@ -938,10 +973,12 @@ module Aws::TranscribeService
938
973
  req.send_request(options)
939
974
  end
940
975
 
941
- # 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`.
942
978
  #
943
979
  # @option params [required, String] :vocabulary_name
944
- # 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.
945
982
  #
946
983
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
947
984
  #
@@ -960,11 +997,13 @@ module Aws::TranscribeService
960
997
  req.send_request(options)
961
998
  end
962
999
 
963
- # Deletes a previously submitted transcription job along with any other
964
- # 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`.
965
1003
  #
966
1004
  # @option params [required, String] :transcription_job_name
967
- # 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.
968
1007
  #
969
1008
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
970
1009
  #
@@ -983,10 +1022,12 @@ module Aws::TranscribeService
983
1022
  req.send_request(options)
984
1023
  end
985
1024
 
986
- # 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`.
987
1027
  #
988
1028
  # @option params [required, String] :vocabulary_name
989
- # The name of the vocabulary to delete.
1029
+ # The name of the vocabulary you want to delete. Vocabulary names are
1030
+ # case-sensitive.
990
1031
  #
991
1032
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
992
1033
  #
@@ -1005,10 +1046,13 @@ module Aws::TranscribeService
1005
1046
  req.send_request(options)
1006
1047
  end
1007
1048
 
1008
- # 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`.
1009
1052
  #
1010
1053
  # @option params [required, String] :vocabulary_filter_name
1011
- # 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.
1012
1056
  #
1013
1057
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1014
1058
  #
@@ -1027,18 +1071,21 @@ module Aws::TranscribeService
1027
1071
  req.send_request(options)
1028
1072
  end
1029
1073
 
1030
- # Gets information about a single custom language model. Use this
1031
- # information to see details about the language model in your Amazon Web
1032
- # Services account. You can also see whether the base language model
1033
- # 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
1034
1079
  # Transcribe has updated the base model, you can create a new custom
1035
- # language model using the updated base model. If the language model
1036
- # wasn't created, you can use this operation to understand why Amazon
1037
- # 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.
1038
1085
  #
1039
1086
  # @option params [required, String] :model_name
1040
- # The name of the custom language model you submit to get more
1041
- # information.
1087
+ # The name of the custom language model you want described. Model names
1088
+ # are case-sensitive.
1042
1089
  #
1043
1090
  # @return [Types::DescribeLanguageModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1044
1091
  #
@@ -1076,8 +1123,8 @@ module Aws::TranscribeService
1076
1123
  # Retrieves information about a call analytics category.
1077
1124
  #
1078
1125
  # @option params [required, String] :category_name
1079
- # The name of the category you want information about. This value is
1080
- # case sensitive.
1126
+ # The name of the category you want information about. Category names
1127
+ # are case sensitive.
1081
1128
  #
1082
1129
  # @return [Types::GetCallAnalyticsCategoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1083
1130
  #
@@ -1151,12 +1198,14 @@ module Aws::TranscribeService
1151
1198
  req.send_request(options)
1152
1199
  end
1153
1200
 
1154
- # Returns information about a call analytics job. To see the status of
1155
- # the job, check the `CallAnalyticsJobStatus` field. If the status is
1156
- # `COMPLETED`, the job is finished and you can find the results at the
1157
- # location specified in the `TranscriptFileUri` field. If you enable
1158
- # personally identifiable information (PII) redaction, the redacted
1159
- # 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.
1160
1209
  #
1161
1210
  # @option params [required, String] :call_analytics_job_name
1162
1211
  # The name of the analytics job you want information about. This value
@@ -1216,14 +1265,16 @@ module Aws::TranscribeService
1216
1265
  req.send_request(options)
1217
1266
  end
1218
1267
 
1219
- # Returns information about a transcription job from Amazon Transcribe
1220
- # Medical. To see the status of the job, check the
1221
- # `TranscriptionJobStatus` field. If the status is `COMPLETED`, the job
1222
- # is finished. You find the results of the completed job in the
1223
- # `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.
1224
1274
  #
1225
1275
  # @option params [required, String] :medical_transcription_job_name
1226
- # 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.
1227
1278
  #
1228
1279
  # @return [Types::GetMedicalTranscriptionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1229
1280
  #
@@ -1274,8 +1325,8 @@ module Aws::TranscribeService
1274
1325
  # Retrieves information about a medical vocabulary.
1275
1326
  #
1276
1327
  # @option params [required, String] :vocabulary_name
1277
- # The name of the vocabulary that you want information about. The value
1278
- # is case sensitive.
1328
+ # The name of the medical vocabulary you want information about. This
1329
+ # value is case sensitive.
1279
1330
  #
1280
1331
  # @return [Types::GetMedicalVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1281
1332
  #
@@ -2333,7 +2384,7 @@ module Aws::TranscribeService
2333
2384
  # dictated speech, such as clinical notes.
2334
2385
  #
2335
2386
  # @option params [Array<Types::Tag>] :tags
2336
- # Add tags to an Amazon Transcribe medical transcription job.
2387
+ # Add tags to an Amazon Transcribe Medical transcription job.
2337
2388
  #
2338
2389
  # @return [Types::StartMedicalTranscriptionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2339
2390
  #
@@ -2937,13 +2988,11 @@ module Aws::TranscribeService
2937
2988
  # the resource that you are calling. The following is the format for a
2938
2989
  # URI:
2939
2990
  #
2940
- # `
2941
- # https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
2942
- # `
2991
+ # `https://s3.aws-region.amazonaws.com/bucket-name/keyprefix/objectkey`
2943
2992
  #
2944
2993
  # For example:
2945
2994
  #
2946
- # `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`
2947
2996
  #
2948
2997
  # For more information about Amazon S3 object names, see [Object
2949
2998
  # Keys][1] in the *Amazon S3 Developer Guide*.
@@ -3012,11 +3061,11 @@ module Aws::TranscribeService
3012
3061
  # custom vocabulary. The URI must be in the same region as the API
3013
3062
  # endpoint that you are calling. The general form is:
3014
3063
  #
3015
- # `https://s3.<aws-region>.amazonaws.com/<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey>`
3064
+ # `https://s3.aws-region.amazonaws.com/bucket-name/keyprefix/objectkey`
3016
3065
  #
3017
3066
  # For example:
3018
3067
  #
3019
- # `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`
3020
3069
  #
3021
3070
  # For more information about S3 object names, see [Object Keys][1] in
3022
3071
  # the *Amazon S3 Developer Guide*.
@@ -3138,7 +3187,7 @@ module Aws::TranscribeService
3138
3187
  params: params,
3139
3188
  config: config)
3140
3189
  context[:gem_name] = 'aws-sdk-transcribeservice'
3141
- context[:gem_version] = '1.72.0'
3190
+ context[:gem_version] = '1.73.0'
3142
3191
  Seahorse::Client::Request.new(handlers, context)
3143
3192
  end
3144
3193