aws-sdk-transcribeservice 1.72.0 → 1.75.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -361,22 +361,50 @@ 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 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
371
391
  #
372
392
  # @option params [required, String] :category_name
373
- # The name that you choose for your category when you create it.
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.
374
400
  #
375
401
  # @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.
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
404
+ # category. For each rule, you specify a filter you want applied to the
405
+ # attributes of a call. For example, you can choose a sentiment filter
406
+ # that detects if a customer's sentiment was positive during the last
407
+ # 30 seconds of the call.
380
408
  #
381
409
  # @return [Types::CreateCallAnalyticsCategoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
382
410
  #
@@ -522,34 +550,87 @@ module Aws::TranscribeService
522
550
  req.send_request(options)
523
551
  end
524
552
 
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.
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
528
572
  #
529
573
  # @option params [required, String] :language_code
530
- # The language of the input text you're using to train your custom
531
- # language model.
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.
532
588
  #
533
- # @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.
536
589
  #
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
590
  #
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`.
591
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
592
+ #
593
+ # @option params [required, String] :base_model_name
594
+ # The Amazon Transcribe standard language model, or base model, used to
595
+ # create your custom language model. Amazon Transcribe offers two
596
+ # options for base models: Wideband and Narrowband.
597
+ #
598
+ # If the audio you want to transcribe has a sample rate of 16,000 Hz or
599
+ # greater, choose `WideBand`. To transcribe audio with a sample rate
600
+ # less than 16,000 Hz, choose `NarrowBand`.
542
601
  #
543
602
  # @option params [required, String] :model_name
544
- # The name you choose for your custom language model when you create it.
603
+ # A unique name, chosen by you, for your custom language model.
604
+ #
605
+ # This name is case sensitive, cannot contain spaces, and must be unique
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.
545
609
  #
546
610
  # @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.
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.
549
623
  #
550
624
  # @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.
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
553
634
  #
554
635
  # @return [Types::CreateLanguageModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
555
636
  #
@@ -597,48 +678,57 @@ module Aws::TranscribeService
597
678
  req.send_request(options)
598
679
  end
599
680
 
600
- # Creates a new custom vocabulary that you can use to modify how Amazon
601
- # Transcribe Medical transcribes your audio file.
681
+ # Creates a new custom medical vocabulary.
602
682
  #
603
- # @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
606
- # vocabulary with the same name as a previous vocabulary, you get a
607
- # `ConflictException` error.
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;
687
+ # `CreateMedicalVocabulary` does not support the `Phrases` flag.
608
688
  #
609
- # @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.
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.
614
693
  #
615
- # @option params [required, String] :vocabulary_file_uri
616
- # The location in Amazon S3 of the text file you use to define your
617
- # 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:
694
+ # For more information, see [Creating a custom vocabulary][2].
620
695
  #
621
- # `https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>`
622
696
  #
623
- # The following is an example URI for a vocabulary file that is stored
624
- # in Amazon S3:
625
697
  #
626
- # `https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt`
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
627
700
  #
628
- # For more information about Amazon S3 object names, see [Object
629
- # Keys][1] in the *Amazon S3 Developer Guide*.
701
+ # @option params [required, String] :vocabulary_name
702
+ # A unique name, chosen by you, for your new custom medical vocabulary.
630
703
  #
631
- # For more information about custom vocabularies, see [Medical Custom
632
- # Vocabularies][2].
704
+ # This name is case sensitive, cannot contain spaces, and must be unique
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.
633
708
  #
709
+ # @option params [required, String] :language_code
710
+ # The language code that represents the language of the entries in your
711
+ # custom vocabulary. US English (`en-US`) is the only language supported
712
+ # with Amazon Transcribe Medical.
634
713
  #
714
+ # @option params [required, String] :vocabulary_file_uri
715
+ # The Amazon S3 location (URI) of the text file that contains your
716
+ # custom medical vocabulary. The URI must be in the same Amazon Web
717
+ # Services Region as the resource you're calling.
635
718
  #
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
719
+ # Here's an example URI path:
720
+ # `s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt`
638
721
  #
639
722
  # @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.
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.
725
+ #
726
+ # To learn more about using tags with Amazon Transcribe, refer to
727
+ # [Tagging resources][1].
728
+ #
729
+ #
730
+ #
731
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html
642
732
  #
643
733
  # @return [Types::CreateMedicalVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
644
734
  #
@@ -679,50 +769,90 @@ module Aws::TranscribeService
679
769
  req.send_request(options)
680
770
  end
681
771
 
682
- # Creates a new custom vocabulary that you can use to change the way
683
- # Amazon Transcribe handles transcription of an audio file.
772
+ # Creates a new custom vocabulary.
773
+ #
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.
783
+ #
784
+ # For more information, see [Creating a custom vocabulary][2].
785
+ #
786
+ #
787
+ #
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
684
790
  #
685
791
  # @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.
792
+ # A unique name, chosen by you, for your new custom vocabulary.
793
+ #
794
+ # This name is case sensitive, cannot contain spaces, and must be unique
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
797
+ # `ConflictException` error.
690
798
  #
691
799
  # @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.
800
+ # The language code that represents the language of the entries in your
801
+ # custom vocabulary. Each vocabulary must contain terms in only one
802
+ # language.
694
803
  #
695
- # @option params [Array<String>] :phrases
696
- # An array of strings that contains the vocabulary entries.
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.
697
811
  #
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
812
  #
703
- # `https://s3.<Amazon Web
704
- # Services-region>.amazonaws.com/<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey>
705
- # `
706
813
  #
707
- # For example:
814
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
815
+ #
816
+ # @option params [Array<String>] :phrases
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.
708
822
  #
709
- # `https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt`
823
+ # Note that if you include `Phrases` in your request, you cannot use
824
+ # `VocabularyFileUri`; you must choose one or the other.
710
825
  #
711
- # For more information about S3 object names, see [Object Keys][1] in
712
- # the *Amazon S3 Developer Guide*.
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.
713
830
  #
714
- # For more information about custom vocabularies, see [Custom
715
- # vocabularies][2].
716
831
  #
717
832
  #
833
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html
834
+ #
835
+ # @option params [String] :vocabulary_file_uri
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.
839
+ #
840
+ # Here's an example URI path:
841
+ # `s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt`
718
842
  #
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
843
+ # Note that if you include `VocabularyFileUri` in your request, you
844
+ # cannot use the `Phrases` flag; you must choose one or the other.
721
845
  #
722
846
  # @option params [Array<Types::Tag>] :tags
723
- # 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.
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
726
856
  #
727
857
  # @return [Types::CreateVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
728
858
  #
@@ -764,52 +894,91 @@ module Aws::TranscribeService
764
894
  req.send_request(options)
765
895
  end
766
896
 
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.
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
769
915
  #
770
916
  # @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.
917
+ # A unique name, chosen by you, for your new custom vocabulary filter.
918
+ #
919
+ # This name is case sensitive, cannot contain spaces, and must be unique
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,
922
+ # you get a `ConflictException` error.
775
923
  #
776
924
  # @option params [required, String] :language_code
777
- # The language code of the words in the vocabulary filter. All words in
778
- # the filter must be in the same language. The vocabulary filter can
779
- # 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
780
940
  #
781
941
  # @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].
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.
948
+ #
949
+ # Note that if you include `Words` in your request, you cannot use
950
+ # `VocabularyFilterFileUri`; you must choose one or the other.
785
951
  #
786
- # If you provide a list of words in the `Words` parameter, you can't
787
- # use the `VocabularyFilterFileUri` parameter.
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.
788
956
  #
789
957
  #
790
958
  #
791
959
  # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html
792
960
  #
793
961
  # @option params [String] :vocabulary_filter_file_uri
794
- # The Amazon S3 location of a text file used as input to create the
795
- # vocabulary filter. Only use characters from the character set defined
796
- # for custom vocabularies. For a list of character sets, see [Character
797
- # 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.
798
965
  #
799
- # The specified file must be less than 50 KB of UTF-8 characters.
966
+ # Here's an example URI path:
967
+ # `s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt`
800
968
  #
801
- # If you provide the location of a list of words in the
802
- # `VocabularyFilterFileUri` parameter, you can't use the `Words`
803
- # parameter.
969
+ # Note that if you include `VocabularyFilterFileUri` in your request,
970
+ # you cannot use `Words`; you must choose one or the other.
804
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.
805
975
  #
976
+ # To learn more about using tags with Amazon Transcribe, refer to
977
+ # [Tagging resources][1].
806
978
  #
807
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html
808
979
  #
809
- # @option params [Array<Types::Tag>] :tags
810
- # 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.
980
+ #
981
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html
813
982
  #
814
983
  # @return [Types::CreateVocabularyFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
815
984
  #
@@ -847,11 +1016,13 @@ module Aws::TranscribeService
847
1016
  req.send_request(options)
848
1017
  end
849
1018
 
850
- # Deletes a call analytics category using its name.
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.
851
1022
  #
852
1023
  # @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.
1024
+ # The name of the Call Analytics category you want to delete. Category
1025
+ # names are case sensitive.
855
1026
  #
856
1027
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
857
1028
  #
@@ -870,10 +1041,13 @@ module Aws::TranscribeService
870
1041
  req.send_request(options)
871
1042
  end
872
1043
 
873
- # Deletes a call analytics job using its name.
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.
874
1047
  #
875
1048
  # @option params [required, String] :call_analytics_job_name
876
- # The name of the call analytics job you want to delete.
1049
+ # The name of the Call Analytics job you want to delete. Job names are
1050
+ # case sensitive.
877
1051
  #
878
1052
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
879
1053
  #
@@ -892,10 +1066,13 @@ module Aws::TranscribeService
892
1066
  req.send_request(options)
893
1067
  end
894
1068
 
895
- # Deletes a custom language model using its name.
1069
+ # Deletes a custom language model. To use this operation, specify the
1070
+ # name of the language model you want to delete using `ModelName`.
1071
+ # Language model names are case sensitive.
896
1072
  #
897
1073
  # @option params [required, String] :model_name
898
- # The name of the model you're choosing to delete.
1074
+ # The name of the custom language model you want to delete. Model names
1075
+ # are case sensitive.
899
1076
  #
900
1077
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
901
1078
  #
@@ -914,12 +1091,13 @@ module Aws::TranscribeService
914
1091
  req.send_request(options)
915
1092
  end
916
1093
 
917
- # Deletes a transcription job generated by Amazon Transcribe Medical and
918
- # any related information.
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.
919
1097
  #
920
1098
  # @option params [required, String] :medical_transcription_job_name
921
- # The name you provide to the `DeleteMedicalTranscriptionJob` object to
922
- # delete a transcription job.
1099
+ # The name of the medical transcription job you want to delete. Job
1100
+ # names are case sensitive.
923
1101
  #
924
1102
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
925
1103
  #
@@ -938,10 +1116,13 @@ module Aws::TranscribeService
938
1116
  req.send_request(options)
939
1117
  end
940
1118
 
941
- # Deletes a vocabulary from Amazon Transcribe Medical.
1119
+ # Deletes a custom medical vocabulary. To use this operation, specify
1120
+ # the name of the vocabulary you want to delete using `VocabularyName`.
1121
+ # Vocabulary names are case sensitive.
942
1122
  #
943
1123
  # @option params [required, String] :vocabulary_name
944
- # The name of the vocabulary that you want to delete.
1124
+ # The name of the custom medical vocabulary you want to delete.
1125
+ # Vocabulary names are case sensitive.
945
1126
  #
946
1127
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
947
1128
  #
@@ -960,11 +1141,13 @@ module Aws::TranscribeService
960
1141
  req.send_request(options)
961
1142
  end
962
1143
 
963
- # Deletes a previously submitted transcription job along with any other
964
- # generated results such as the transcription, models, and so on.
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.
965
1147
  #
966
1148
  # @option params [required, String] :transcription_job_name
967
- # The name of the transcription job to be deleted.
1149
+ # The name of the transcription job you want to delete. Job names are
1150
+ # case sensitive.
968
1151
  #
969
1152
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
970
1153
  #
@@ -983,10 +1166,13 @@ module Aws::TranscribeService
983
1166
  req.send_request(options)
984
1167
  end
985
1168
 
986
- # Deletes a vocabulary from Amazon Transcribe.
1169
+ # Deletes a custom vocabulary. To use this operation, specify the name
1170
+ # of the vocabulary you want to delete using `VocabularyName`.
1171
+ # Vocabulary names are case sensitive.
987
1172
  #
988
1173
  # @option params [required, String] :vocabulary_name
989
- # The name of the vocabulary to delete.
1174
+ # The name of the custom vocabulary you want to delete. Vocabulary names
1175
+ # are case sensitive.
990
1176
  #
991
1177
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
992
1178
  #
@@ -1005,10 +1191,13 @@ module Aws::TranscribeService
1005
1191
  req.send_request(options)
1006
1192
  end
1007
1193
 
1008
- # Removes a vocabulary filter.
1194
+ # Deletes a vocabulary filter. To use this operation, specify the name
1195
+ # of the vocabulary filter you want to delete using
1196
+ # `VocabularyFilterName`. Vocabulary filter names are case sensitive.
1009
1197
  #
1010
1198
  # @option params [required, String] :vocabulary_filter_name
1011
- # The name of the vocabulary filter to remove.
1199
+ # The name of the custom vocabulary filter you want to delete.
1200
+ # Vocabulary filter names are case sensitive.
1012
1201
  #
1013
1202
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1014
1203
  #
@@ -1027,18 +1216,22 @@ module Aws::TranscribeService
1027
1216
  req.send_request(options)
1028
1217
  end
1029
1218
 
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
1219
+ # Provides information about the specified custom language model.
1220
+ #
1221
+ # This operation also shows if the base language model you used to
1222
+ # create your custom language model has been updated. If Amazon
1034
1223
  # 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.
1224
+ # language model using the updated base model.
1225
+ #
1226
+ # If you tried to create a new custom language model and the request
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.
1038
1231
  #
1039
1232
  # @option params [required, String] :model_name
1040
- # The name of the custom language model you submit to get more
1041
- # information.
1233
+ # The name of the custom language model you want information about.
1234
+ # Model names are case sensitive.
1042
1235
  #
1043
1236
  # @return [Types::DescribeLanguageModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1044
1237
  #
@@ -1073,11 +1266,13 @@ module Aws::TranscribeService
1073
1266
  req.send_request(options)
1074
1267
  end
1075
1268
 
1076
- # 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.
1077
1272
  #
1078
1273
  # @option params [required, String] :category_name
1079
- # The name of the category you want information about. This value is
1080
- # case sensitive.
1274
+ # The name of the Call Analytics category you want information about.
1275
+ # Category names are case sensitive.
1081
1276
  #
1082
1277
  # @return [Types::GetCallAnalyticsCategoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1083
1278
  #
@@ -1151,16 +1346,27 @@ module Aws::TranscribeService
1151
1346
  req.send_request(options)
1152
1347
  end
1153
1348
 
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.
1349
+ # Provides information about the specified Call Analytics job.
1350
+ #
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.
1160
1366
  #
1161
1367
  # @option params [required, String] :call_analytics_job_name
1162
- # The name of the analytics job you want information about. This value
1163
- # is case sensitive.
1368
+ # The name of the Call Analytics job you want information about. Job
1369
+ # names are case sensitive.
1164
1370
  #
1165
1371
  # @return [Types::GetCallAnalyticsJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1166
1372
  #
@@ -1216,14 +1422,19 @@ module Aws::TranscribeService
1216
1422
  req.send_request(options)
1217
1423
  end
1218
1424
 
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.
1425
+ # Provides information about the specified medical transcription job.
1426
+ #
1427
+ # To view the status of the specified medical transcription job, check
1428
+ # the `TranscriptionJobStatus` field. If the status is `COMPLETED`, the
1429
+ # job is finished and you can find the results at the location specified
1430
+ # in `TranscriptFileUri`. If the status is `FAILED`, `FailureReason`
1431
+ # provides details on why your transcription job failed.
1432
+ #
1433
+ # To get a list of your medical transcription jobs, use the operation.
1224
1434
  #
1225
1435
  # @option params [required, String] :medical_transcription_job_name
1226
- # The name of the medical transcription job.
1436
+ # The name of the medical transcription job you want information about.
1437
+ # Job names are case sensitive.
1227
1438
  #
1228
1439
  # @return [Types::GetMedicalTranscriptionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1229
1440
  #
@@ -1271,11 +1482,18 @@ module Aws::TranscribeService
1271
1482
  req.send_request(options)
1272
1483
  end
1273
1484
 
1274
- # 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.
1275
1493
  #
1276
1494
  # @option params [required, String] :vocabulary_name
1277
- # The name of the vocabulary that you want information about. The value
1278
- # is case sensitive.
1495
+ # The name of the custom medical vocabulary you want information about.
1496
+ # Vocabulary names are case sensitive.
1279
1497
  #
1280
1498
  # @return [Types::GetMedicalVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1281
1499
  #
@@ -1310,15 +1528,22 @@ module Aws::TranscribeService
1310
1528
  req.send_request(options)
1311
1529
  end
1312
1530
 
1313
- # Returns information about a transcription job. To see the status of
1314
- # the job, check the `TranscriptionJobStatus` field. If the status is
1315
- # `COMPLETED`, the job is finished and you can find the results at the
1316
- # location specified in the `TranscriptFileUri` field. If you enable
1317
- # content redaction, the redacted transcript appears in
1318
- # `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.
1319
1543
  #
1320
1544
  # @option params [required, String] :transcription_job_name
1321
- # The name of the job.
1545
+ # The name of the transcription job you want information about. Job
1546
+ # names are case sensitive.
1322
1547
  #
1323
1548
  # @return [Types::GetTranscriptionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1324
1549
  #
@@ -1361,9 +1586,13 @@ module Aws::TranscribeService
1361
1586
  # resp.transcription_job.content_redaction.pii_entity_types #=> Array
1362
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"
1363
1588
  # resp.transcription_job.identify_language #=> Boolean
1589
+ # resp.transcription_job.identify_multiple_languages #=> Boolean
1364
1590
  # resp.transcription_job.language_options #=> Array
1365
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"
1366
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
1367
1596
  # resp.transcription_job.tags #=> Array
1368
1597
  # resp.transcription_job.tags[0].key #=> String
1369
1598
  # resp.transcription_job.tags[0].value #=> String
@@ -1371,6 +1600,7 @@ module Aws::TranscribeService
1371
1600
  # resp.transcription_job.subtitles.formats[0] #=> String, one of "vtt", "srt"
1372
1601
  # resp.transcription_job.subtitles.subtitle_file_uris #=> Array
1373
1602
  # resp.transcription_job.subtitles.subtitle_file_uris[0] #=> String
1603
+ # resp.transcription_job.subtitles.output_start_index #=> Integer
1374
1604
  # resp.transcription_job.language_id_settings #=> Hash
1375
1605
  # resp.transcription_job.language_id_settings["LanguageCode"].vocabulary_name #=> String
1376
1606
  # resp.transcription_job.language_id_settings["LanguageCode"].vocabulary_filter_name #=> String
@@ -1385,11 +1615,18 @@ module Aws::TranscribeService
1385
1615
  req.send_request(options)
1386
1616
  end
1387
1617
 
1388
- # 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.
1389
1626
  #
1390
1627
  # @option params [required, String] :vocabulary_name
1391
- # The name of the vocabulary to return information about. The name is
1392
- # case sensitive.
1628
+ # The name of the custom vocabulary you want information about.
1629
+ # Vocabulary names are case sensitive.
1393
1630
  #
1394
1631
  # @return [Types::GetVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1395
1632
  #
@@ -1424,10 +1661,18 @@ module Aws::TranscribeService
1424
1661
  req.send_request(options)
1425
1662
  end
1426
1663
 
1427
- # 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.
1428
1672
  #
1429
1673
  # @option params [required, String] :vocabulary_filter_name
1430
- # 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.
1431
1676
  #
1432
1677
  # @return [Types::GetVocabularyFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1433
1678
  #
@@ -1458,20 +1703,24 @@ module Aws::TranscribeService
1458
1703
  req.send_request(options)
1459
1704
  end
1460
1705
 
1461
- # Provides more information about the call analytics categories that
1462
- # you've created. You can use the information in this list to find a
1463
- # specific category. You can then use the operation to get more
1464
- # 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.
1465
1711
  #
1466
1712
  # @option params [String] :next_token
1467
- # When included, `NextToken`fetches the next set of categories if the
1468
- # 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.
1469
1718
  #
1470
1719
  # @option params [Integer] :max_results
1471
- # The maximum number of categories to return in each page of results. If
1472
- # there are fewer results than the value you specify, only the actual
1473
- # results are returned. If you do not specify a value, the default of 5
1474
- # 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.
1475
1724
  #
1476
1725
  # @return [Types::ListCallAnalyticsCategoriesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1477
1726
  #
@@ -1551,27 +1800,33 @@ module Aws::TranscribeService
1551
1800
  req.send_request(options)
1552
1801
  end
1553
1802
 
1554
- # List call analytics jobs with a specified status or substring that
1555
- # 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.
1556
1809
  #
1557
1810
  # @option params [String] :status
1558
- # When specified, returns only call analytics jobs with the specified
1559
- # status. Jobs are ordered by creation date, with the most recent jobs
1560
- # returned first. If you don't specify a status, Amazon Transcribe
1561
- # 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.
1562
1814
  #
1563
1815
  # @option params [String] :job_name_contains
1564
- # When specified, the jobs returned in the list are limited to jobs
1565
- # 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.
1566
1818
  #
1567
1819
  # @option params [String] :next_token
1568
- # If you receive a truncated result in the previous request of , include
1569
- # `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.
1570
1825
  #
1571
1826
  # @option params [Integer] :max_results
1572
- # 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
1573
1828
  # results. If there are fewer results than the value you specify, only
1574
- # 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
1575
1830
  # default of 5 is used.
1576
1831
  #
1577
1832
  # @return [Types::ListCallAnalyticsJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -1613,29 +1868,34 @@ module Aws::TranscribeService
1613
1868
  req.send_request(options)
1614
1869
  end
1615
1870
 
1616
- # Provides more information about the custom language models you've
1617
- # created. You can use the information in this list to find a specific
1618
- # custom language model. You can then use the operation to get more
1619
- # 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.
1620
1877
  #
1621
1878
  # @option params [String] :status_equals
1622
- # When specified, returns only custom language models with the specified
1623
- # status. Language models are ordered by creation date, with the newest
1624
- # models first. If you don't specify a status, Amazon Transcribe
1625
- # 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.
1626
1883
  #
1627
1884
  # @option params [String] :name_contains
1628
- # When specified, the custom language model names returned contain the
1629
- # substring you've specified.
1885
+ # Returns only the custom language models that contain the specified
1886
+ # string. The search is not case sensitive.
1630
1887
  #
1631
1888
  # @option params [String] :next_token
1632
- # When included, fetches the next set of jobs if the result of the
1633
- # 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.
1634
1894
  #
1635
1895
  # @option params [Integer] :max_results
1636
- # 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
1637
1897
  # results. If there are fewer results than the value you specify, only
1638
- # 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
1639
1899
  # default of 5 is used.
1640
1900
  #
1641
1901
  # @return [Types::ListLanguageModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -1679,29 +1939,34 @@ module Aws::TranscribeService
1679
1939
  req.send_request(options)
1680
1940
  end
1681
1941
 
1682
- # Lists medical transcription jobs with a specified status or substring
1683
- # 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.
1684
1948
  #
1685
1949
  # @option params [String] :status
1686
- # When specified, returns only medical transcription jobs with the
1687
- # specified status. Jobs are ordered by creation date, with the newest
1688
- # jobs returned first. If you don't specify a status, Amazon Transcribe
1689
- # 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.
1690
1953
  #
1691
1954
  # @option params [String] :job_name_contains
1692
- # When specified, the jobs returned in the list are limited to jobs
1693
- # 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.
1694
1957
  #
1695
1958
  # @option params [String] :next_token
1696
- # If you a receive a truncated result in the previous request of
1697
- # `ListMedicalTranscriptionJobs`, include `NextToken` to fetch the next
1698
- # 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.
1699
1964
  #
1700
1965
  # @option params [Integer] :max_results
1701
1966
  # The maximum number of medical transcription jobs to return in each
1702
1967
  # page of results. If there are fewer results than the value you
1703
- # specify, only the actual results are returned. If you do not specify a
1704
- # 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.
1705
1970
  #
1706
1971
  # @return [Types::ListMedicalTranscriptionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1707
1972
  #
@@ -1746,30 +2011,35 @@ module Aws::TranscribeService
1746
2011
  req.send_request(options)
1747
2012
  end
1748
2013
 
1749
- # Returns a list of vocabularies that match the specified criteria. If
1750
- # you don't enter a value in any of the request parameters, returns the
1751
- # 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.
1752
2020
  #
1753
2021
  # @option params [String] :next_token
1754
- # If the result of your previous request to `ListMedicalVocabularies`
1755
- # was truncated, include the `NextToken` to fetch the next set of
1756
- # 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.
1757
2027
  #
1758
2028
  # @option params [Integer] :max_results
1759
- # The maximum number of vocabularies to return in each page of results.
1760
- # If there are fewer results than the value you specify, only the actual
1761
- # results are returned. If you do not specify a value, the default of 5
1762
- # 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.
1763
2033
  #
1764
2034
  # @option params [String] :state_equals
1765
- # When specified, returns only vocabularies with the `VocabularyState`
1766
- # equal to the specified vocabulary state. Use this field to see which
1767
- # 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.
1768
2039
  #
1769
2040
  # @option params [String] :name_contains
1770
- # Returns vocabularies whose names contain the specified string. The
1771
- # search is not case sensitive. `ListMedicalVocabularies` returns both
1772
- # "`vocabularyname`" and "`VocabularyName`".
2041
+ # Returns only the custom medical vocabularies that contain the
2042
+ # specified string. The search is not case sensitive.
1773
2043
  #
1774
2044
  # @return [Types::ListMedicalVocabulariesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1775
2045
  #
@@ -1807,15 +2077,24 @@ module Aws::TranscribeService
1807
2077
  req.send_request(options)
1808
2078
  end
1809
2079
 
1810
- # Lists all tags associated with a given transcription job, vocabulary,
1811
- # 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
1812
2089
  #
1813
2090
  # @option params [required, String] :resource_arn
1814
- # Lists all tags associated with a given Amazon Resource Name (ARN).
1815
- # ARNs have the format
1816
- # `arn:partition:service:region:account-id:resource-type/resource-id`
1817
- # (for example,
1818
- # `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
+ #
1819
2098
  # Valid values for `resource-type` are: `transcription-job`,
1820
2099
  # `medical-transcription-job`, `vocabulary`, `medical-vocabulary`,
1821
2100
  # `vocabulary-filter`, and `language-model`.
@@ -1847,26 +2126,34 @@ module Aws::TranscribeService
1847
2126
  req.send_request(options)
1848
2127
  end
1849
2128
 
1850
- # 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.
1851
2135
  #
1852
2136
  # @option params [String] :status
1853
- # When specified, returns only transcription jobs with the specified
1854
- # status. Jobs are ordered by creation date, with the newest jobs
1855
- # returned first. If you don’t specify a status, Amazon Transcribe
1856
- # 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.
1857
2140
  #
1858
2141
  # @option params [String] :job_name_contains
1859
- # When specified, the jobs returned in the list are limited to jobs
1860
- # whose name contains the specified string.
2142
+ # Returns only the transcription jobs that contain the specified string.
2143
+ # The search is not case sensitive.
1861
2144
  #
1862
2145
  # @option params [String] :next_token
1863
- # If the result of the previous request to `ListTranscriptionJobs` is
1864
- # 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.
1865
2151
  #
1866
2152
  # @option params [Integer] :max_results
1867
- # The maximum number of jobs to return in each page of results. If there
1868
- # are fewer results than the value you specify, only the actual results
1869
- # 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.
1870
2157
  #
1871
2158
  # @return [Types::ListTranscriptionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1872
2159
  #
@@ -1904,7 +2191,11 @@ module Aws::TranscribeService
1904
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"
1905
2192
  # resp.transcription_job_summaries[0].model_settings.language_model_name #=> String
1906
2193
  # resp.transcription_job_summaries[0].identify_language #=> Boolean
2194
+ # resp.transcription_job_summaries[0].identify_multiple_languages #=> Boolean
1907
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
1908
2199
  #
1909
2200
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListTranscriptionJobs AWS API Documentation
1910
2201
  #
@@ -1915,28 +2206,35 @@ module Aws::TranscribeService
1915
2206
  req.send_request(options)
1916
2207
  end
1917
2208
 
1918
- # Returns a list of vocabularies that match the specified criteria. If
1919
- # 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.
1920
2215
  #
1921
2216
  # @option params [String] :next_token
1922
- # If the result of the previous request to `ListVocabularies` was
1923
- # 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.
1924
2222
  #
1925
2223
  # @option params [Integer] :max_results
1926
- # The maximum number of vocabularies to return in each page of results.
1927
- # If there are fewer results than the value you specify, only the actual
1928
- # results are returned. If you do not specify a value, the default of 5
1929
- # 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.
1930
2228
  #
1931
2229
  # @option params [String] :state_equals
1932
- # When specified, only returns vocabularies with the `VocabularyState`
1933
- # 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.
1934
2234
  #
1935
2235
  # @option params [String] :name_contains
1936
- # When specified, the vocabularies returned in the list are limited to
1937
- # vocabularies whose name contains the specified string. The search is
1938
- # not case sensitive, `ListVocabularies` returns both "vocabularyname"
1939
- # and "VocabularyName" in the response list.
2236
+ # Returns only the custom vocabularies that contain the specified
2237
+ # string. The search is not case sensitive.
1940
2238
  #
1941
2239
  # @return [Types::ListVocabulariesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1942
2240
  #
@@ -1974,22 +2272,29 @@ module Aws::TranscribeService
1974
2272
  req.send_request(options)
1975
2273
  end
1976
2274
 
1977
- # 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.
1978
2281
  #
1979
2282
  # @option params [String] :next_token
1980
- # If the result of the previous request to `ListVocabularyFilters` was
1981
- # truncated, include the `NextToken` to fetch the next set of
1982
- # 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.
1983
2288
  #
1984
2289
  # @option params [Integer] :max_results
1985
- # The maximum number of filters to return in each page of results. If
1986
- # there are fewer results than the value you specify, only the actual
1987
- # results are returned. If you do not specify a value, the default of 5
1988
- # 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.
1989
2294
  #
1990
2295
  # @option params [String] :name_contains
1991
- # Filters the response so that it only contains vocabulary filters whose
1992
- # name contains the specified string.
2296
+ # Returns only the custom vocabulary filters that contain the specified
2297
+ # string. The search is not case sensitive.
1993
2298
  #
1994
2299
  # @return [Types::ListVocabularyFiltersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1995
2300
  #
@@ -2023,102 +2328,161 @@ module Aws::TranscribeService
2023
2328
  req.send_request(options)
2024
2329
  end
2025
2330
 
2026
- # Starts an asynchronous analytics job that not only transcribes the
2027
- # audio recording of a caller and agent, but also returns additional
2028
- # insights. These insights include how quickly or loudly the caller or
2029
- # agent was speaking. To retrieve additional insights with your
2030
- # analytics jobs, create categories. A category is a way to classify
2031
- # analytics jobs based on attributes, such as a customer's sentiment or
2032
- # a particular phrase being used during the call. For more information,
2033
- # 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.
2034
2333
  #
2035
- # @option params [required, String] :call_analytics_job_name
2036
- # The name of the call analytics job. You can't use the string "." or
2037
- # ".." by themselves as the job name. The name must also be unique
2038
- # within an Amazon Web Services account. If you try to create a call
2039
- # analytics job with the same name as a previous call analytics job, you
2040
- # 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].
2041
2340
  #
2042
- # @option params [required, Types::Media] :media
2043
- # 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].
2044
2346
  #
2045
- # @option params [String] :output_location
2046
- # The Amazon S3 location where the output of the call analytics job is
2047
- # stored. You can provide the following location types to store the
2048
- # 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.
2362
+ #
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.
2049
2366
  #
2050
- # * s3://DOC-EXAMPLE-BUCKET1
2367
+ # * `Media` (`MediaFileUri` or `RedactedMediaFileUri`): The Amazon S3
2368
+ # location of your media file.
2051
2369
  #
2052
- # If you specify a bucket, Amazon Transcribe saves the output of the
2053
- # analytics job as a JSON file at the root level of the bucket.
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.
2054
2375
  #
2055
- # * s3://DOC-EXAMPLE-BUCKET1/folder/
2376
+ # </note>
2056
2377
  #
2057
- # f you specify a path, Amazon Transcribe saves the output of the
2058
- # analytics job as
2059
- # s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json.
2060
2378
  #
2061
- # If you specify a folder, you must provide a trailing slash.
2062
2379
  #
2063
- # * s3://DOC-EXAMPLE-BUCKET1/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
2064
2383
  #
2065
- # If you provide a path that has the filename specified, Amazon
2066
- # Transcribe saves the output of the analytics job as
2067
- # s3://DOC-EXAMPLEBUCKET1/folder/filename.json.
2384
+ # @option params [required, String] :call_analytics_job_name
2385
+ # A unique name, chosen by you, for your Call Analytics job.
2386
+ #
2387
+ # This name is case sensitive, cannot contain spaces, and must be unique
2388
+ # within an Amazon Web Services account. If you try to create a new job
2389
+ # with the same name as an existing job, you get a `ConflictException`
2390
+ # error.
2391
+ #
2392
+ # @option params [required, Types::Media] :media
2393
+ # Describes the Amazon S3 location of the media file you want to use in
2394
+ # your request.
2395
+ #
2396
+ # @option params [String] :output_location
2397
+ # The Amazon S3 location where you want your Call Analytics
2398
+ # transcription output stored. You can use any of the following formats
2399
+ # to specify the output location:
2400
+ #
2401
+ # 1. s3://DOC-EXAMPLE-BUCKET
2402
+ #
2403
+ # 2. s3://DOC-EXAMPLE-BUCKET/my-output-folder/
2068
2404
  #
2069
- # You can specify an Amazon Web Services Key Management Service (KMS)
2070
- # key to encrypt the output of our analytics job using the
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
2071
2412
  # `OutputEncryptionKMSKeyId` parameter. If you don't specify a KMS key,
2072
2413
  # Amazon Transcribe uses the default Amazon S3 key for server-side
2073
- # encryption of the analytics job output that is placed in your S3
2074
- # 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.
2075
2419
  #
2076
2420
  # @option params [String] :output_encryption_kms_key_id
2077
- # The Amazon Resource Name (ARN) of the Amazon Web Services Key
2078
- # Management Service key used to encrypt the output of the call
2079
- # analytics job. The user calling the operation must have permission to
2080
- # 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:
2081
2425
  #
2082
- # You use either of the following to identify an Amazon Web Services KMS
2083
- # key in the current account:
2426
+ # 1. Use the KMS key ID itself. For example,
2427
+ # `1234abcd-12ab-34cd-56ef-1234567890ab`.
2084
2428
  #
2085
- # * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
2429
+ # 2. Use an alias for the KMS key ID. For example,
2430
+ # `alias/ExampleAlias`.
2086
2431
  #
2087
- # * KMS Key Alias: "alias/ExampleAlias"
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`.
2088
2435
  #
2089
- # You can use either of the following to identify a KMS key in the
2090
- # current account or another account:
2436
+ # 4. Use the ARN for the KMS key alias. For example,
2437
+ # `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
2091
2438
  #
2092
- # * Amazon Resource Name (ARN) of a KMS key in the current account or
2093
- # another account: "arn:aws:kms:region:account
2094
- # ID:key/1234abcd-12ab-34cd-56ef1234567890ab"
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:
2095
2442
  #
2096
- # * ARN of a KMS Key Alias:
2097
- # "arn:aws:kms:region:accountID:alias/ExampleAlias"
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`.
2098
2445
  #
2099
- # If you don't specify an encryption key, the output of the call
2100
- # analytics job is encrypted with the default Amazon S3 key (SSE-S3).
2446
+ # 2. Use the ARN for the KMS key alias. For example,
2447
+ # `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
2448
+ #
2449
+ # If you don't specify an encryption key, your output is encrypted with
2450
+ # the default Amazon S3 key (SSE-S3).
2101
2451
  #
2102
2452
  # If you specify a KMS key to encrypt your output, you must also specify
2103
- # 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`.
2104
2467
  #
2105
- # @option params [required, String] :data_access_role_arn
2106
- # The Amazon Resource Name (ARN) of a role that has access to the S3
2107
- # bucket that contains your input files. Amazon Transcribe assumes this
2108
- # role to read queued audio files. If you have specified an output S3
2109
- # bucket for your transcription results, this role should have access to
2110
- # the output bucket as well.
2468
+ # For more information, see [IAM ARNs][1].
2469
+ #
2470
+ #
2471
+ #
2472
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns
2111
2473
  #
2112
2474
  # @option params [Types::CallAnalyticsJobSettings] :settings
2113
- # A `Settings` object that provides optional settings for a call
2114
- # 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.
2115
2479
  #
2116
2480
  # @option params [Array<Types::ChannelDefinition>] :channel_definitions
2117
- # When you start a call analytics job, you must pass an array that maps
2118
- # the agent and the customer to specific audio channels. The values you
2119
- # can assign to a channel are 0 and 1. The agent and the customer must
2120
- # each have their own channel. You can't assign more than one channel
2121
- # 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).
2122
2486
  #
2123
2487
  # @return [Types::StartCallAnalyticsJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2124
2488
  #
@@ -2134,7 +2498,7 @@ module Aws::TranscribeService
2134
2498
  # },
2135
2499
  # output_location: "Uri",
2136
2500
  # output_encryption_kms_key_id: "KMSKeyId",
2137
- # data_access_role_arn: "DataAccessRoleArn", # required
2501
+ # data_access_role_arn: "DataAccessRoleArn",
2138
2502
  # settings: {
2139
2503
  # vocabulary_name: "VocabularyName",
2140
2504
  # vocabulary_filter_name: "VocabularyFilterName",
@@ -2206,134 +2570,236 @@ module Aws::TranscribeService
2206
2570
  req.send_request(options)
2207
2571
  end
2208
2572
 
2209
- # 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
2210
2615
  #
2211
2616
  # @option params [required, String] :medical_transcription_job_name
2212
- # The name of the medical transcription job. You can't use the strings
2213
- # "`.`" or "`..`" by themselves as the job name. The name must also
2214
- # be unique within an Amazon Web Services account. If you try to create
2215
- # a medical transcription job with the same name as a previous medical
2216
- # 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.
2217
2626
  #
2218
2627
  # @option params [required, String] :language_code
2219
- # The language code for the language spoken in the input media file. US
2220
- # English (en-US) is the valid value for medical transcription jobs. Any
2221
- # other value you enter for language code results in a
2222
- # `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.
2223
2632
  #
2224
2633
  # @option params [Integer] :media_sample_rate_hertz
2225
- # 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.
2226
2636
  #
2227
- # If you do not specify the media sample rate, Amazon Transcribe Medical
2228
- # determines the sample rate. If you specify the sample rate, it must
2229
- # match the rate detected by Amazon Transcribe Medical. In most cases,
2230
- # you should leave the `MediaSampleRateHertz` field blank and let Amazon
2231
- # 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.
2232
2643
  #
2233
2644
  # @option params [String] :media_format
2234
- # The audio format of the input media file.
2645
+ # Specify the format of your input media file.
2235
2646
  #
2236
2647
  # @option params [required, Types::Media] :media
2237
- # 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.
2238
2650
  #
2239
2651
  # @option params [required, String] :output_bucket_name
2240
- # The Amazon S3 location where the transcription is stored.
2241
- #
2242
- # You must set `OutputBucketName` for Amazon Transcribe Medical to store
2243
- # the transcription results. Your transcript appears in the S3 location
2244
- # you specify. When you call the GetMedicalTranscriptionJob, the
2245
- # operation returns this location in the `TranscriptFileUri` field. The
2246
- # S3 bucket must have permissions that allow Amazon Transcribe Medical
2247
- # to put files in the bucket. For more information, see [Permissions
2248
- # Required for IAM User Roles][1].
2249
- #
2250
- # You can specify an Amazon Web Services Key Management Service (KMS)
2251
- # key to encrypt the output of your transcription using the
2252
- # `OutputEncryptionKMSKeyId` parameter. If you don't specify a KMS key,
2253
- # Amazon Transcribe Medical uses the default Amazon S3 key for
2254
- # server-side encryption of transcripts that are placed in your S3
2255
- # 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/`.
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].
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.
2256
2674
  #
2257
2675
  #
2258
2676
  #
2259
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user
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
2260
2679
  #
2261
2680
  # @option params [String] :output_key
2262
- # You can specify a location in an Amazon S3 bucket to store the output
2263
- # of your medical transcription job.
2264
- #
2265
- # If you don't specify an output key, Amazon Transcribe Medical stores
2266
- # the output of your transcription job in the Amazon S3 bucket you
2267
- # specified. By default, the object key is
2268
- # "your-transcription-job-name.json".
2269
- #
2270
- # You can use output keys to specify the Amazon S3 prefix and file name
2271
- # of the transcription output. For example, specifying the Amazon S3
2272
- # prefix, "folder1/folder2/", as an output key would lead to the
2273
- # output being stored as
2274
- # "folder1/folder2/your-transcription-job-name.json". If you specify
2275
- # "my-other-job-name.json" as the output key, the object key is
2276
- # changed to "my-other-job-name.json". You can use an output key to
2277
- # change both the prefix and the file name, for example
2278
- # "folder/my-other-job-name.json".
2279
- #
2280
- # If you specify an output key, you must also specify an S3 bucket in
2281
- # 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.
2282
2712
  #
2283
2713
  # @option params [String] :output_encryption_kms_key_id
2284
- # The Amazon Resource Name (ARN) of the Amazon Web Services Key
2285
- # Management Service (KMS) key used to encrypt the output of the
2286
- # transcription job. The user calling the StartMedicalTranscriptionJob
2287
- # 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.
2288
2716
  #
2289
- # You use either of the following to identify a KMS key in the current
2290
- # account:
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:
2291
2719
  #
2292
- # * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
2720
+ # 1. Use the KMS key ID itself. For example,
2721
+ # `1234abcd-12ab-34cd-56ef-1234567890ab`.
2293
2722
  #
2294
- # * KMS Key Alias: "alias/ExampleAlias"
2723
+ # 2. Use an alias for the KMS key ID. For example,
2724
+ # `alias/ExampleAlias`.
2295
2725
  #
2296
- # You can use either of the following to identify a KMS key in the
2297
- # current account or another account:
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`.
2298
2729
  #
2299
- # * Amazon Resource Name (ARN) of a KMS key in the current account or
2300
- # another account:
2301
- # "arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"
2730
+ # 4. Use the ARN for the KMS key alias. For example,
2731
+ # `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
2302
2732
  #
2303
- # * ARN of a KMS Key Alias: "arn:aws:kms:region:account
2304
- # ID:alias/ExampleAlias"
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:
2305
2736
  #
2306
- # If you don't specify an encryption key, the output of the medical
2307
- # transcription job is encrypted with the default Amazon S3 key
2308
- # (SSE-S3).
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`.
2739
+ #
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).
2309
2745
  #
2310
2746
  # If you specify a KMS key to encrypt your output, you must also specify
2311
- # 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.
2312
2751
  #
2313
2752
  # @option params [Hash<String,String>] :kms_encryption_context
2314
2753
  # A map of plain text, non-secret key:value pairs, known as encryption
2315
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
2316
2762
  #
2317
2763
  # @option params [Types::MedicalTranscriptionSetting] :settings
2318
- # 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.
2319
2768
  #
2320
2769
  # @option params [String] :content_identification_type
2321
- # You can configure Amazon Transcribe Medical to label content in the
2322
- # transcription output. If you specify `PHI`, Amazon Transcribe Medical
2323
- # labels the personal health information (PHI) that it identifies in the
2324
- # 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
2325
2777
  #
2326
2778
  # @option params [required, String] :specialty
2327
- # 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 .
2328
2782
  #
2329
2783
  # @option params [required, String] :type
2330
- # The type of speech in the input audio. `CONVERSATION` refers to
2331
- # conversations between two or more speakers, e.g., a conversations
2332
- # between doctors and patients. `DICTATION` refers to single-speaker
2333
- # 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.
2334
2792
  #
2335
2793
  # @option params [Array<Types::Tag>] :tags
2336
- # 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
2337
2803
  #
2338
2804
  # @return [Types::StartMedicalTranscriptionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2339
2805
  #
@@ -2411,162 +2877,347 @@ module Aws::TranscribeService
2411
2877
  req.send_request(options)
2412
2878
  end
2413
2879
 
2414
- # 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
2415
2913
  #
2416
2914
  # @option params [required, String] :transcription_job_name
2417
- # The name of the job. You can't use the strings "`.`" or "`..`" by
2418
- # themselves as the job name. The name must also be unique within an
2419
- # Amazon Web Services account. If you try to create a transcription job
2420
- # with the same name as a previous transcription job, you get a
2421
- # `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.
2422
2924
  #
2423
2925
  # @option params [String] :language_code
2424
- # The language code for the language used in the input media file.
2926
+ # The language code that represents the language spoken in the input
2927
+ # media file.
2928
+ #
2929
+ # If you're unsure of the language spoken in your media file, consider
2930
+ # using `IdentifyLanguage` or `IdentifyMultipleLanguages` to enable
2931
+ # automatic language identification.
2932
+ #
2933
+ # Note that you must include one of `LanguageCode`, `IdentifyLanguage`,
2934
+ # or `IdentifyMultipleLanguages` in your request. If you include more
2935
+ # than one of these parameters, your transcription job fails.
2936
+ #
2937
+ # For a list of supported languages and their associated language codes,
2938
+ # refer to the [Supported languages][1] table.
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.
2425
2942
  #
2426
- # To transcribe speech in Modern Standard Arabic (ar-SA), your audio or
2427
- # video file must be encoded at a sample rate of 16,000 Hz or higher.
2943
+ # </note>
2944
+ #
2945
+ #
2946
+ #
2947
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
2428
2948
  #
2429
2949
  # @option params [Integer] :media_sample_rate_hertz
2430
- # 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.
2431
2952
  #
2432
- # If you do not specify the media sample rate, Amazon Transcribe
2433
- # determines the sample rate. If you specify the sample rate, it must
2434
- # match the sample rate detected by Amazon Transcribe. In most cases,
2435
- # you should leave the `MediaSampleRateHertz` field blank and let Amazon
2436
- # 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.
2437
2959
  #
2438
2960
  # @option params [String] :media_format
2439
- # The format of the input media file.
2961
+ # Specify the format of your input media file.
2440
2962
  #
2441
2963
  # @option params [required, Types::Media] :media
2442
- # 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.
2443
2966
  #
2444
2967
  # @option params [String] :output_bucket_name
2445
- # The location where the transcription is stored.
2446
- #
2447
- # If you set the `OutputBucketName`, Amazon Transcribe puts the
2448
- # transcript in the specified S3 bucket. When you call the
2449
- # GetTranscriptionJob operation, the operation returns this location in
2450
- # the `TranscriptFileUri` field. If you enable content redaction, the
2451
- # redacted transcript appears in `RedactedTranscriptFileUri`. If you
2452
- # enable content redaction and choose to output an unredacted
2453
- # transcript, that transcript's location still appears in the
2454
- # `TranscriptFileUri`. The S3 bucket must have permissions that allow
2455
- # Amazon Transcribe to put files in the bucket. For more information,
2456
- # see [Permissions Required for IAM User Roles][1].
2457
- #
2458
- # You can specify an Amazon Web Services Key Management Service (KMS)
2459
- # key to encrypt the output of your transcription using the
2460
- # `OutputEncryptionKMSKeyId` parameter. If you don't specify a KMS key,
2461
- # Amazon Transcribe uses the default Amazon S3 key for server-side
2462
- # 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/`.
2463
2981
  #
2464
- # If you don't set the `OutputBucketName`, Amazon Transcribe generates
2465
- # a pre-signed URL, a shareable URL that provides secure access to your
2466
- # transcription, and returns it in the `TranscriptFileUri` field. Use
2467
- # this URL to download the transcription.
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].
2468
2986
  #
2987
+ # If you don't specify `OutputBucketName`, your transcript is placed in
2988
+ # a service-managed Amazon S3 bucket and you are provided with a URI to
2989
+ # access your transcript.
2469
2990
  #
2470
2991
  #
2471
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user
2992
+ #
2993
+ # [1]: https://console.aws.amazon.com/s3
2994
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user
2472
2995
  #
2473
2996
  # @option params [String] :output_key
2474
- # You can specify a location in an Amazon S3 bucket to store the output
2475
- # of your transcription job.
2476
- #
2477
- # If you don't specify an output key, Amazon Transcribe stores the
2478
- # output of your transcription job in the Amazon S3 bucket you
2479
- # specified. By default, the object key is
2480
- # "your-transcription-job-name.json".
2481
- #
2482
- # You can use output keys to specify the Amazon S3 prefix and file name
2483
- # of the transcription output. For example, specifying the Amazon S3
2484
- # prefix, "folder1/folder2/", as an output key would lead to the
2485
- # output being stored as
2486
- # "folder1/folder2/your-transcription-job-name.json". If you specify
2487
- # "my-other-job-name.json" as the output key, the object key is
2488
- # changed to "my-other-job-name.json". You can use an output key to
2489
- # change both the prefix and the file name, for example
2490
- # "folder/my-other-job-name.json".
2491
- #
2492
- # If you specify an output key, you must also specify an S3 bucket in
2493
- # 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.
2494
3028
  #
2495
3029
  # @option params [String] :output_encryption_kms_key_id
2496
- # The Amazon Resource Name (ARN) of the Amazon Web Services Key
2497
- # Management Service (KMS) key used to encrypt the output of the
2498
- # transcription job. The user calling the `StartTranscriptionJob`
2499
- # operation must have permission to use the specified KMS key.
3030
+ # The KMS key you want to use to encrypt your transcription output.
3031
+ #
3032
+ # If using a key located in the **current** Amazon Web Services account,
3033
+ # you can specify your KMS key in one of four ways:
3034
+ #
3035
+ # 1. Use the KMS key ID itself. For example,
3036
+ # `1234abcd-12ab-34cd-56ef-1234567890ab`.
2500
3037
  #
2501
- # You can use either of the following to identify a KMS key in the
2502
- # current account:
3038
+ # 2. Use an alias for the KMS key ID. For example,
3039
+ # `alias/ExampleAlias`.
2503
3040
  #
2504
- # * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
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`.
2505
3044
  #
2506
- # * KMS Key Alias: "alias/ExampleAlias"
3045
+ # 4. Use the ARN for the KMS key alias. For example,
3046
+ # `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
2507
3047
  #
2508
- # You can use either of the following to identify a KMS key in the
2509
- # current account or another account:
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:
2510
3051
  #
2511
- # * Amazon Resource Name (ARN) of a KMS Key:
2512
- # "arn:aws:kms:region:account
2513
- # ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"
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`.
2514
3054
  #
2515
- # * ARN of a KMS Key Alias:
2516
- # "arn:aws:kms:region:account-ID:alias/ExampleAlias"
3055
+ # 2. Use the ARN for the KMS key alias. For example,
3056
+ # `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
2517
3057
  #
2518
- # If you don't specify an encryption key, the output of the
2519
- # transcription job is encrypted with the default Amazon S3 key
2520
- # (SSE-S3).
3058
+ # If you don't specify an encryption key, your output is encrypted with
3059
+ # the default Amazon S3 key (SSE-S3).
2521
3060
  #
2522
3061
  # If you specify a KMS key to encrypt your output, you must also specify
2523
- # 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.
2524
3066
  #
2525
3067
  # @option params [Hash<String,String>] :kms_encryption_context
2526
3068
  # A map of plain text, non-secret key:value pairs, known as encryption
2527
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
2528
3077
  #
2529
3078
  # @option params [Types::Settings] :settings
2530
- # A `Settings` object that provides optional settings for a
2531
- # 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
+ # `
2532
3094
  #
2533
3095
  # @option params [Types::ModelSettings] :model_settings
2534
- # Choose the custom language model you use for your transcription job in
2535
- # 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
2536
3105
  #
2537
3106
  # @option params [Types::JobExecutionSettings] :job_execution_settings
2538
- # Provides information about how a transcription job is executed. Use
2539
- # this field to indicate that the job can be queued for deferred
2540
- # execution if the concurrency limit is reached and there are no slots
2541
- # 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`.
2542
3115
  #
2543
3116
  # @option params [Types::ContentRedaction] :content_redaction
2544
- # 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`.
2545
3121
  #
2546
3122
  # @option params [Boolean] :identify_language
2547
- # Set this field to `true` to enable automatic language identification.
2548
- # Automatic language identification is disabled by default. You receive
2549
- # a `BadRequestException` error if you enter a value for a
2550
- # `LanguageCode`.
3123
+ # Enables automatic language identification in your transcription job
3124
+ # request.
3125
+ #
3126
+ # If you include `IdentifyLanguage`, you can optionally include a list
3127
+ # of language codes, using `LanguageOptions`, that you think may be
3128
+ # present in your media file. Including language options can improve
3129
+ # transcription accuracy.
3130
+ #
3131
+ # If you want to apply a custom language model, a custom vocabulary, or
3132
+ # a custom vocabulary filter to your automatic language identification
3133
+ # request, include `LanguageIdSettings` with the relevant sub-parameters
3134
+ # (`VocabularyName`, `LanguageModelName`, and `VocabularyFilterName`).
3135
+ #
3136
+ # Note that you must include one of `LanguageCode`, `IdentifyLanguage`,
3137
+ # or `IdentifyMultipleLanguages` in your request. If you include more
3138
+ # than one of these parameters, your transcription job fails.
3139
+ #
3140
+ # @option params [Boolean] :identify_multiple_languages
3141
+ # Enables automatic multi-language identification in your transcription
3142
+ # job request. Use this parameter if your media file contains more than
3143
+ # one language.
3144
+ #
3145
+ # If you include `IdentifyMultipleLanguages`, you can optionally include
3146
+ # a list of language codes, using `LanguageOptions`, that you think may
3147
+ # be present in your media file. Including language options can improve
3148
+ # transcription accuracy.
3149
+ #
3150
+ # If you want to apply a custom vocabulary or a custom vocabulary filter
3151
+ # to your automatic language identification request, include
3152
+ # `LanguageIdSettings` with the relevant sub-parameters
3153
+ # (`VocabularyName` and `VocabularyFilterName`).
3154
+ #
3155
+ # Note that you must include one of `LanguageCode`, `IdentifyLanguage`,
3156
+ # or `IdentifyMultipleLanguages` in your request. If you include more
3157
+ # than one of these parameters, your transcription job fails.
2551
3158
  #
2552
3159
  # @option params [Array<String>] :language_options
2553
- # An object containing a list of languages that might be present in your
2554
- # collection of audio files. Automatic language identification chooses a
2555
- # 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
+ #
2556
3173
  #
2557
- # To transcribe speech in Modern Standard Arabic (ar-SA), your audio or
2558
- # 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
2559
3176
  #
2560
3177
  # @option params [Types::Subtitles] :subtitles
2561
- # 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.
2562
3180
  #
2563
3181
  # @option params [Array<Types::Tag>] :tags
2564
- # 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
2565
3191
  #
2566
3192
  # @option params [Hash<String,Types::LanguageIdSettings>] :language_id_settings
2567
- # The language identification settings associated with your
2568
- # transcription job. These settings include `VocabularyName`,
2569
- # `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
+ # `
2570
3221
  #
2571
3222
  # @return [Types::StartTranscriptionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2572
3223
  #
@@ -2612,9 +3263,11 @@ module Aws::TranscribeService
2612
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
2613
3264
  # },
2614
3265
  # identify_language: false,
3266
+ # identify_multiple_languages: false,
2615
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
2616
3268
  # subtitles: {
2617
3269
  # formats: ["vtt"], # accepts vtt, srt
3270
+ # output_start_index: 1,
2618
3271
  # },
2619
3272
  # tags: [
2620
3273
  # {
@@ -2662,9 +3315,13 @@ module Aws::TranscribeService
2662
3315
  # resp.transcription_job.content_redaction.pii_entity_types #=> Array
2663
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"
2664
3317
  # resp.transcription_job.identify_language #=> Boolean
3318
+ # resp.transcription_job.identify_multiple_languages #=> Boolean
2665
3319
  # resp.transcription_job.language_options #=> Array
2666
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"
2667
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
2668
3325
  # resp.transcription_job.tags #=> Array
2669
3326
  # resp.transcription_job.tags[0].key #=> String
2670
3327
  # resp.transcription_job.tags[0].value #=> String
@@ -2672,6 +3329,7 @@ module Aws::TranscribeService
2672
3329
  # resp.transcription_job.subtitles.formats[0] #=> String, one of "vtt", "srt"
2673
3330
  # resp.transcription_job.subtitles.subtitle_file_uris #=> Array
2674
3331
  # resp.transcription_job.subtitles.subtitle_file_uris[0] #=> String
3332
+ # resp.transcription_job.subtitles.output_start_index #=> Integer
2675
3333
  # resp.transcription_job.language_id_settings #=> Hash
2676
3334
  # resp.transcription_job.language_id_settings["LanguageCode"].vocabulary_name #=> String
2677
3335
  # resp.transcription_job.language_id_settings["LanguageCode"].vocabulary_filter_name #=> String
@@ -2686,20 +3344,38 @@ module Aws::TranscribeService
2686
3344
  req.send_request(options)
2687
3345
  end
2688
3346
 
2689
- # 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
2690
3356
  #
2691
3357
  # @option params [required, String] :resource_arn
2692
- # The Amazon Resource Name (ARN) of the Amazon Transcribe resource you
2693
- # want to tag. ARNs have the format
2694
- # `arn:partition:service:region:account-id:resource-type/resource-id`
2695
- # (for example,
2696
- # `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
+ #
2697
3365
  # Valid values for `resource-type` are: `transcription-job`,
2698
3366
  # `medical-transcription-job`, `vocabulary`, `medical-vocabulary`,
2699
3367
  # `vocabulary-filter`, and `language-model`.
2700
3368
  #
2701
3369
  # @option params [required, Array<Types::Tag>] :tags
2702
- # 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
2703
3379
  #
2704
3380
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2705
3381
  #
@@ -2724,21 +3400,27 @@ module Aws::TranscribeService
2724
3400
  req.send_request(options)
2725
3401
  end
2726
3402
 
2727
- # 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`.
2728
3408
  #
2729
3409
  # @option params [required, String] :resource_arn
2730
3410
  # The Amazon Resource Name (ARN) of the Amazon Transcribe resource you
2731
3411
  # want to remove tags from. ARNs have the format
2732
- # `arn:partition:service:region:account-id:resource-type/resource-id`
2733
- # (for example,
2734
- # `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
+ #
2735
3417
  # Valid values for `resource-type` are: `transcription-job`,
2736
3418
  # `medical-transcription-job`, `vocabulary`, `medical-vocabulary`,
2737
3419
  # `vocabulary-filter`, and `language-model`.
2738
3420
  #
2739
3421
  # @option params [required, Array<String>] :tag_keys
2740
- # A list of tag keys you want to remove from a specified Amazon
2741
- # Transcribe resource.
3422
+ # Removes the specified tag keys from the specified Amazon Transcribe
3423
+ # resource.
2742
3424
  #
2743
3425
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2744
3426
  #
@@ -2758,19 +3440,21 @@ module Aws::TranscribeService
2758
3440
  req.send_request(options)
2759
3441
  end
2760
3442
 
2761
- # Updates the call analytics category with new values. The
2762
- # `UpdateCallAnalyticsCategory` operation overwrites all of the existing
2763
- # 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 .
2764
3449
  #
2765
3450
  # @option params [required, String] :category_name
2766
- # The name of the analytics category to update. The name is case
2767
- # sensitive. If you try to update a call analytics category with the
2768
- # same name as a previous category you will receive a
2769
- # `ConflictException` error.
3451
+ # The name of the Call Analytics category you want to update. Category
3452
+ # names are case sensitive.
2770
3453
  #
2771
3454
  # @option params [required, Array<Types::Rule>] :rules
2772
- # The rules used for the updated analytics category. The rules that you
2773
- # 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.
2774
3458
  #
2775
3459
  # @return [Types::UpdateCallAnalyticsCategoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2776
3460
  #
@@ -2916,45 +3600,26 @@ module Aws::TranscribeService
2916
3600
  req.send_request(options)
2917
3601
  end
2918
3602
 
2919
- # Updates a vocabulary with new values that you provide in a different
2920
- # text file from the one you used to create the vocabulary. The
2921
- # `UpdateMedicalVocabulary` operation overwrites all of the existing
2922
- # 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.
2923
3606
  #
2924
3607
  # @option params [required, String] :vocabulary_name
2925
- # The name of the vocabulary to update. The name is case sensitive. If
2926
- # you try to update a vocabulary with the same name as a vocabulary
2927
- # 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.
2928
3610
  #
2929
3611
  # @option params [required, String] :language_code
2930
- # The language code of the language used for the entries in the updated
2931
- # vocabulary. U.S. English (en-US) is the only valid language code in
2932
- # 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.
2933
3615
  #
2934
3616
  # @option params [String] :vocabulary_file_uri
2935
- # The location in Amazon S3 of the text file that contains your custom
2936
- # vocabulary. The URI must be in the same Amazon Web Services Region as
2937
- # the resource that you are calling. The following is the format for a
2938
- # URI:
2939
- #
2940
- # `
2941
- # https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
2942
- # `
2943
- #
2944
- # For example:
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.
2945
3620
  #
2946
- # `https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt`
2947
- #
2948
- # For more information about Amazon S3 object names, see [Object
2949
- # Keys][1] in the *Amazon S3 Developer Guide*.
2950
- #
2951
- # For more information about custom vocabularies in Amazon Transcribe
2952
- # Medical, see [Medical Custom Vocabularies][2].
2953
- #
2954
- #
2955
- #
2956
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys
2957
- # [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`
2958
3623
  #
2959
3624
  # @return [Types::UpdateMedicalVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2960
3625
  #
@@ -2987,47 +3652,60 @@ module Aws::TranscribeService
2987
3652
  req.send_request(options)
2988
3653
  end
2989
3654
 
2990
- # Updates an existing vocabulary with new values. The `UpdateVocabulary`
2991
- # operation overwrites all of the existing information with the values
2992
- # 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.
2993
3658
  #
2994
3659
  # @option params [required, String] :vocabulary_name
2995
- # The name of the vocabulary to update. The name is case sensitive. If
2996
- # you try to update a vocabulary with the same name as a previous
2997
- # vocabulary you will receive a `ConflictException` error.
3660
+ # The name of the custom vocabulary you want to update. Vocabulary names
3661
+ # are case sensitive.
2998
3662
  #
2999
3663
  # @option params [required, String] :language_code
3000
- # The language code of the vocabulary entries. For a list of languages
3001
- # 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.
3002
3675
  #
3003
3676
  #
3004
3677
  #
3005
3678
  # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
3006
3679
  #
3007
3680
  # @option params [Array<String>] :phrases
3008
- # An array of strings containing the vocabulary entries.
3009
- #
3010
- # @option params [String] :vocabulary_file_uri
3011
- # The S3 location of the text file that contains the definition of the
3012
- # custom vocabulary. The URI must be in the same region as the API
3013
- # 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.
3014
3686
  #
3015
- # `https://s3.<aws-region>.amazonaws.com/<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey>`
3687
+ # Note that if you include `Phrases` in your request, you cannot use
3688
+ # `VocabularyFileUri`; you must choose one or the other.
3016
3689
  #
3017
- # 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.
3018
3694
  #
3019
- # `https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt`
3020
3695
  #
3021
- # For more information about S3 object names, see [Object Keys][1] in
3022
- # the *Amazon S3 Developer Guide*.
3023
3696
  #
3024
- # For more information about custom vocabularies, see [Custom
3025
- # Vocabularies][2].
3697
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html
3026
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.
3027
3703
  #
3704
+ # Here's an example URI path:
3705
+ # `s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt`
3028
3706
  #
3029
- # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys
3030
- # [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.
3031
3709
  #
3032
3710
  # @return [Types::UpdateVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3033
3711
  #
@@ -3061,40 +3739,44 @@ module Aws::TranscribeService
3061
3739
  req.send_request(options)
3062
3740
  end
3063
3741
 
3064
- # 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.
3065
3745
  #
3066
3746
  # @option params [required, String] :vocabulary_filter_name
3067
- # The name of the vocabulary filter to update. If you try to update a
3068
- # vocabulary filter with the same name as another vocabulary filter, you
3069
- # get a `ConflictException` error.
3747
+ # The name of the custom vocabulary filter you want to update.
3748
+ # Vocabulary filter names are case sensitive.
3070
3749
  #
3071
3750
  # @option params [Array<String>] :words
3072
- # The words to use in the vocabulary filter. Only use characters from
3073
- # the character set defined for custom vocabularies. For a list of
3074
- # 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.
3075
3760
  #
3076
- # If you provide a list of words in the `Words` parameter, you can't
3077
- # 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.
3078
3765
  #
3079
3766
  #
3080
3767
  #
3081
3768
  # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html
3082
3769
  #
3083
3770
  # @option params [String] :vocabulary_filter_file_uri
3084
- # The Amazon S3 location of a text file used as input to create the
3085
- # vocabulary filter. Only use characters from the character set defined
3086
- # for custom vocabularies. For a list of character sets, see [Character
3087
- # Sets for Custom Vocabularies][1].
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.
3088
3774
  #
3089
- # The specified file must be less than 50 KB of UTF-8 characters.
3775
+ # Here's an example URI path:
3776
+ # `s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt`
3090
3777
  #
3091
- # If you provide the location of a list of words in the
3092
- # `VocabularyFilterFileUri` parameter, you can't use the `Words`
3093
- # parameter.
3094
- #
3095
- #
3096
- #
3097
- # [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.
3098
3780
  #
3099
3781
  # @return [Types::UpdateVocabularyFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3100
3782
  #
@@ -3138,7 +3820,7 @@ module Aws::TranscribeService
3138
3820
  params: params,
3139
3821
  config: config)
3140
3822
  context[:gem_name] = 'aws-sdk-transcribeservice'
3141
- context[:gem_version] = '1.72.0'
3823
+ context[:gem_version] = '1.75.0'
3142
3824
  Seahorse::Client::Request.new(handlers, context)
3143
3825
  end
3144
3826