aws-sdk-transcribeservice 1.76.0 → 1.78.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -30,7 +30,7 @@ require 'aws-sdk-core/plugins/http_checksum.rb'
30
30
  require 'aws-sdk-core/plugins/checksum_algorithm.rb'
31
31
  require 'aws-sdk-core/plugins/defaults_mode.rb'
32
32
  require 'aws-sdk-core/plugins/recursion_detection.rb'
33
- require 'aws-sdk-core/plugins/signature_v4.rb'
33
+ require 'aws-sdk-core/plugins/sign.rb'
34
34
  require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
35
35
 
36
36
  Aws::Plugins::GlobalConfiguration.add_identifier(:transcribeservice)
@@ -79,8 +79,9 @@ module Aws::TranscribeService
79
79
  add_plugin(Aws::Plugins::ChecksumAlgorithm)
80
80
  add_plugin(Aws::Plugins::DefaultsMode)
81
81
  add_plugin(Aws::Plugins::RecursionDetection)
82
- add_plugin(Aws::Plugins::SignatureV4)
82
+ add_plugin(Aws::Plugins::Sign)
83
83
  add_plugin(Aws::Plugins::Protocols::JsonRpc)
84
+ add_plugin(Aws::TranscribeService::Plugins::Endpoints)
84
85
 
85
86
  # @overload initialize(options)
86
87
  # @param [Hash] options
@@ -297,6 +298,19 @@ module Aws::TranscribeService
297
298
  # ** Please note ** When response stubbing is enabled, no HTTP
298
299
  # requests are made, and retries are disabled.
299
300
  #
301
+ # @option options [Aws::TokenProvider] :token_provider
302
+ # A Bearer Token Provider. This can be an instance of any one of the
303
+ # following classes:
304
+ #
305
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
306
+ # tokens.
307
+ #
308
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
309
+ # access token generated from `aws login`.
310
+ #
311
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
312
+ # will be used to search for tokens configured for your profile in shared configuration files.
313
+ #
300
314
  # @option options [Boolean] :use_dualstack_endpoint
301
315
  # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
302
316
  # will be used if available.
@@ -310,6 +324,9 @@ module Aws::TranscribeService
310
324
  # When `true`, request parameters are validated before
311
325
  # sending the request.
312
326
  #
327
+ # @option options [Aws::TranscribeService::EndpointProvider] :endpoint_provider
328
+ # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::TranscribeService::EndpointParameters`
329
+ #
313
330
  # @option options [URI::HTTP,String] :http_proxy A proxy to send
314
331
  # requests through. Formatted like 'http://proxy.com:123'.
315
332
  #
@@ -363,10 +380,17 @@ module Aws::TranscribeService
363
380
 
364
381
  # Creates a new Call Analytics category.
365
382
  #
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.
383
+ # All categories are automatically applied to your Call Analytics
384
+ # transcriptions. Note that in order to apply categories to your
385
+ # transcriptions, you must create them before submitting your
386
+ # transcription request, as categories cannot be applied retroactively.
387
+ #
388
+ # When creating a new category, you can use the `InputType` parameter to
389
+ # label the category as a batch category (`POST_CALL`) or a streaming
390
+ # category (`REAL_TIME`). Batch categories can only be applied to batch
391
+ # transcriptions and streaming categories can only be applied to
392
+ # streaming transcriptions. If you do not include `InputType`, your
393
+ # category is created as a batch category by default.
370
394
  #
371
395
  # Call Analytics categories are composed of rules. For each category,
372
396
  # you must create between 1 and 20 rules. Rules can include these
@@ -374,20 +398,14 @@ module Aws::TranscribeService
374
398
  #
375
399
  # To update an existing category, see .
376
400
  #
377
- # To learn more about:
378
- #
379
- # * Call Analytics categories, see [Creating categories][1]
401
+ # To learn more about Call Analytics categories, see [Creating
402
+ # categories for batch transcriptions][1] and [Creating categories for
403
+ # streaming transcriptions][2].
380
404
  #
381
- # * Using rules, see [Rule criteria][2] and refer to the data type
382
405
  #
383
- # * Call Analytics, see [Analyzing call center audio with Call
384
- # Analytics][3]
385
406
  #
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
407
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html
408
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html
391
409
  #
392
410
  # @option params [required, String] :category_name
393
411
  # A unique name, chosen by you, for your Call Analytics category. It's
@@ -399,12 +417,27 @@ module Aws::TranscribeService
399
417
  # Category names are case sensitive.
400
418
  #
401
419
  # @option params [required, Array<Types::Rule>] :rules
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.
420
+ # Rules define a Call Analytics category. When creating a new category,
421
+ # you must create between 1 and 20 rules for that category. For each
422
+ # rule, you specify a filter you want applied to the attributes of a
423
+ # call. For example, you can choose a sentiment filter that detects if a
424
+ # customer's sentiment was positive during the last 30 seconds of the
425
+ # call.
426
+ #
427
+ # @option params [String] :input_type
428
+ # Choose whether you want to create a streaming or a batch category for
429
+ # your Call Analytics transcription.
430
+ #
431
+ # Specifying `POST_CALL` assigns your category to batch transcriptions;
432
+ # categories with this input type cannot be applied to streaming
433
+ # (real-time) transcriptions.
434
+ #
435
+ # Specifying `REAL_TIME` assigns your category to streaming
436
+ # transcriptions; categories with this input type cannot be applied to
437
+ # batch (post-call) transcriptions.
438
+ #
439
+ # If you do not include `InputType`, your category is created as a batch
440
+ # category by default.
408
441
  #
409
442
  # @return [Types::CreateCallAnalyticsCategoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
410
443
  #
@@ -486,6 +519,7 @@ module Aws::TranscribeService
486
519
  # },
487
520
  # },
488
521
  # ],
522
+ # input_type: "REAL_TIME", # accepts REAL_TIME, POST_CALL
489
523
  # })
490
524
  #
491
525
  # @example Response structure
@@ -540,6 +574,7 @@ module Aws::TranscribeService
540
574
  # resp.category_properties.rules[0].sentiment_filter.negate #=> Boolean
541
575
  # resp.category_properties.create_time #=> Time
542
576
  # resp.category_properties.last_update_time #=> Time
577
+ # resp.category_properties.input_type #=> String, one of "REAL_TIME", "POST_CALL"
543
578
  #
544
579
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateCallAnalyticsCategory AWS API Documentation
545
580
  #
@@ -552,7 +587,7 @@ module Aws::TranscribeService
552
587
 
553
588
  # Creates a new custom language model.
554
589
  #
555
- # When creating a new language model, you must specify:
590
+ # When creating a new custom language model, you must specify:
556
591
  #
557
592
  # * If you want a Wideband (audio sample rates over 16,000 Hz) or
558
593
  # Narrowband (audio sample rates under 16,000 Hz) base model
@@ -564,27 +599,21 @@ module Aws::TranscribeService
564
599
  #
565
600
  # * A unique name for your model
566
601
  #
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
572
- #
573
602
  # @option params [required, String] :language_code
574
603
  # 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.
604
+ # custom language model must contain terms in only one language, and the
605
+ # language you select for your custom language model must match the
606
+ # language of your training and tuning data.
578
607
  #
579
608
  # For a list of supported languages and their associated language codes,
580
- # refer to the [Supported languages][1] table. Note that U.S. English
609
+ # refer to the [Supported languages][1] table. Note that US English
581
610
  # (`en-US`) is the only language supported with Amazon Transcribe
582
611
  # Medical.
583
612
  #
584
613
  # 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.
614
+ # same language as the model. For example, if you create a custom
615
+ # language model using US English (`en-US`), you can only apply this
616
+ # model to files that contain English audio.
588
617
  #
589
618
  #
590
619
  #
@@ -604,8 +633,8 @@ module Aws::TranscribeService
604
633
  #
605
634
  # This name is case sensitive, cannot contain spaces, and must be unique
606
635
  # 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.
636
+ # custom language model with the same name as an existing custom
637
+ # language model, you get a `ConflictException` error.
609
638
  #
610
639
  # @option params [required, Types::InputDataConfig] :input_data_config
611
640
  # Contains the Amazon S3 location of the training data you want to use
@@ -680,31 +709,31 @@ module Aws::TranscribeService
680
709
 
681
710
  # Creates a new custom medical vocabulary.
682
711
  #
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
712
+ # Before creating a new custom medical vocabulary, you must first upload
713
+ # a text file that contains your new entries, phrases, and terms into an
685
714
  # Amazon S3 bucket. Note that this differs from , where you can include
686
715
  # a list of terms within your request using the `Phrases` flag;
687
716
  # `CreateMedicalVocabulary` does not support the `Phrases` flag.
688
717
  #
689
718
  # Each language has a character set that contains all allowed characters
690
719
  # for that specific language. If you use unsupported characters, your
691
- # vocabulary request fails. Refer to [Character Sets for Custom
720
+ # custom vocabulary request fails. Refer to [Character Sets for Custom
692
721
  # Vocabularies][1] to get the character set for your language.
693
722
  #
694
- # For more information, see [Creating a custom vocabulary][2].
723
+ # For more information, see [Custom vocabularies][2].
695
724
  #
696
725
  #
697
726
  #
698
727
  # [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
728
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html
700
729
  #
701
730
  # @option params [required, String] :vocabulary_name
702
731
  # A unique name, chosen by you, for your new custom medical vocabulary.
703
732
  #
704
733
  # This name is case sensitive, cannot contain spaces, and must be unique
705
734
  # 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.
735
+ # custom medical vocabulary with the same name as an existing custom
736
+ # medical vocabulary, you get a `ConflictException` error.
708
737
  #
709
738
  # @option params [required, String] :language_code
710
739
  # The language code that represents the language of the entries in your
@@ -721,7 +750,8 @@ module Aws::TranscribeService
721
750
  #
722
751
  # @option params [Array<Types::Tag>] :tags
723
752
  # 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.
753
+ # a new custom medical vocabulary at the time you create this new custom
754
+ # vocabulary.
725
755
  #
726
756
  # To learn more about using tags with Amazon Transcribe, refer to
727
757
  # [Tagging resources][1].
@@ -771,40 +801,40 @@ module Aws::TranscribeService
771
801
 
772
802
  # Creates a new custom vocabulary.
773
803
  #
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.
804
+ # When creating a new custom vocabulary, you can either upload a text
805
+ # file that contains your new entries, phrases, and terms into an Amazon
806
+ # S3 bucket and include the URI in your request. Or you can include a
807
+ # list of terms directly in your request using the `Phrases` flag.
778
808
  #
779
809
  # Each language has a character set that contains all allowed characters
780
810
  # for that specific language. If you use unsupported characters, your
781
- # vocabulary request fails. Refer to [Character Sets for Custom
811
+ # custom vocabulary request fails. Refer to [Character Sets for Custom
782
812
  # Vocabularies][1] to get the character set for your language.
783
813
  #
784
- # For more information, see [Creating a custom vocabulary][2].
814
+ # For more information, see [Custom vocabularies][2].
785
815
  #
786
816
  #
787
817
  #
788
818
  # [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
819
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html
790
820
  #
791
821
  # @option params [required, String] :vocabulary_name
792
822
  # A unique name, chosen by you, for your new custom vocabulary.
793
823
  #
794
824
  # This name is case sensitive, cannot contain spaces, and must be unique
795
825
  # 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.
826
+ # custom vocabulary with the same name as an existing custom vocabulary,
827
+ # you get a `ConflictException` error.
798
828
  #
799
829
  # @option params [required, String] :language_code
800
830
  # 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.
831
+ # custom vocabulary. Each custom vocabulary must contain terms in only
832
+ # one language.
803
833
  #
804
834
  # 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.
835
+ # language as the custom vocabulary. For example, if you create a custom
836
+ # vocabulary using US English (`en-US`), you can only apply this custom
837
+ # vocabulary to files that contain English audio.
808
838
  #
809
839
  # For a list of supported languages and their associated language codes,
810
840
  # refer to the [Supported languages][1] table.
@@ -814,19 +844,20 @@ module Aws::TranscribeService
814
844
  # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
815
845
  #
816
846
  # @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.
847
+ # Use this parameter if you want to create your custom vocabulary by
848
+ # including all desired terms, as comma-separated values, within your
849
+ # request. The other option for creating your custom vocabulary is to
850
+ # save your entries in a text file and upload them to an Amazon S3
851
+ # bucket, then specify the location of your file using the
852
+ # `VocabularyFileUri` parameter.
822
853
  #
823
854
  # Note that if you include `Phrases` in your request, you cannot use
824
855
  # `VocabularyFileUri`; you must choose one or the other.
825
856
  #
826
857
  # Each language has a character set that contains all allowed characters
827
858
  # 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.
859
+ # custom vocabulary filter request fails. Refer to [Character Sets for
860
+ # Custom Vocabularies][1] to get the character set for your language.
830
861
  #
831
862
  #
832
863
  #
@@ -845,7 +876,8 @@ module Aws::TranscribeService
845
876
  #
846
877
  # @option params [Array<Types::Tag>] :tags
847
878
  # 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.
879
+ # a new custom vocabulary at the time you create this new custom
880
+ # vocabulary.
849
881
  #
850
882
  # To learn more about using tags with Amazon Transcribe, refer to
851
883
  # [Tagging resources][1].
@@ -896,17 +928,16 @@ module Aws::TranscribeService
896
928
 
897
929
  # Creates a new custom vocabulary filter.
898
930
  #
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.
931
+ # You can use custom vocabulary filters to mask, delete, or flag
932
+ # specific words from your transcript. Custom vocabulary filters are
933
+ # commonly used to mask profanity in transcripts.
902
934
  #
903
935
  # Each language has a character set that contains all allowed characters
904
936
  # 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.
937
+ # custom vocabulary filter request fails. Refer to [Character Sets for
938
+ # Custom Vocabularies][1] to get the character set for your language.
907
939
  #
908
- # For more information, see [Using vocabulary filtering with unwanted
909
- # words][2].
940
+ # For more information, see [Vocabulary filtering][2].
910
941
  #
911
942
  #
912
943
  #
@@ -918,18 +949,18 @@ module Aws::TranscribeService
918
949
  #
919
950
  # This name is case sensitive, cannot contain spaces, and must be unique
920
951
  # 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.
952
+ # custom vocabulary filter with the same name as an existing custom
953
+ # vocabulary filter, you get a `ConflictException` error.
923
954
  #
924
955
  # @option params [required, String] :language_code
925
956
  # 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.
957
+ # vocabulary filter. Each custom vocabulary filter must contain terms in
958
+ # only one language.
928
959
  #
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.
960
+ # A custom vocabulary filter can only be used to transcribe files in the
961
+ # same language as the filter. For example, if you create a custom
962
+ # vocabulary filter using US English (`en-US`), you can only apply this
963
+ # filter to files that contain English audio.
933
964
  #
934
965
  # For a list of supported languages and their associated language codes,
935
966
  # refer to the [Supported languages][1] table.
@@ -939,8 +970,8 @@ module Aws::TranscribeService
939
970
  # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
940
971
  #
941
972
  # @option params [Array<String>] :words
942
- # Use this parameter if you want to create your vocabulary filter by
943
- # including all desired terms, as comma-separated values, within your
973
+ # Use this parameter if you want to create your custom vocabulary filter
974
+ # by including all desired terms, as comma-separated values, within your
944
975
  # request. The other option for creating your vocabulary filter is to
945
976
  # save your entries in a text file and upload them to an Amazon S3
946
977
  # bucket, then specify the location of your file using the
@@ -951,8 +982,8 @@ module Aws::TranscribeService
951
982
  #
952
983
  # Each language has a character set that contains all allowed characters
953
984
  # 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.
985
+ # custom vocabulary filter request fails. Refer to [Character Sets for
986
+ # Custom Vocabularies][1] to get the character set for your language.
956
987
  #
957
988
  #
958
989
  #
@@ -971,7 +1002,8 @@ module Aws::TranscribeService
971
1002
  #
972
1003
  # @option params [Array<Types::Tag>] :tags
973
1004
  # 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.
1005
+ # a new custom vocabulary filter at the time you create this new
1006
+ # vocabulary filter.
975
1007
  #
976
1008
  # To learn more about using tags with Amazon Transcribe, refer to
977
1009
  # [Tagging resources][1].
@@ -1068,7 +1100,7 @@ module Aws::TranscribeService
1068
1100
 
1069
1101
  # Deletes a custom language model. To use this operation, specify the
1070
1102
  # name of the language model you want to delete using `ModelName`.
1071
- # Language model names are case sensitive.
1103
+ # custom language model names are case sensitive.
1072
1104
  #
1073
1105
  # @option params [required, String] :model_name
1074
1106
  # The name of the custom language model you want to delete. Model names
@@ -1117,12 +1149,12 @@ module Aws::TranscribeService
1117
1149
  end
1118
1150
 
1119
1151
  # 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.
1152
+ # the name of the custom vocabulary you want to delete using
1153
+ # `VocabularyName`. Custom vocabulary names are case sensitive.
1122
1154
  #
1123
1155
  # @option params [required, String] :vocabulary_name
1124
- # The name of the custom medical vocabulary you want to delete.
1125
- # Vocabulary names are case sensitive.
1156
+ # The name of the custom medical vocabulary you want to delete. Custom
1157
+ # medical vocabulary names are case sensitive.
1126
1158
  #
1127
1159
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1128
1160
  #
@@ -1167,12 +1199,12 @@ module Aws::TranscribeService
1167
1199
  end
1168
1200
 
1169
1201
  # 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.
1202
+ # of the custom vocabulary you want to delete using `VocabularyName`.
1203
+ # Custom vocabulary names are case sensitive.
1172
1204
  #
1173
1205
  # @option params [required, String] :vocabulary_name
1174
- # The name of the custom vocabulary you want to delete. Vocabulary names
1175
- # are case sensitive.
1206
+ # The name of the custom vocabulary you want to delete. Custom
1207
+ # vocabulary names are case sensitive.
1176
1208
  #
1177
1209
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1178
1210
  #
@@ -1191,13 +1223,14 @@ module Aws::TranscribeService
1191
1223
  req.send_request(options)
1192
1224
  end
1193
1225
 
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.
1226
+ # Deletes a custom vocabulary filter. To use this operation, specify the
1227
+ # name of the custom vocabulary filter you want to delete using
1228
+ # `VocabularyFilterName`. Custom vocabulary filter names are case
1229
+ # sensitive.
1197
1230
  #
1198
1231
  # @option params [required, String] :vocabulary_filter_name
1199
- # The name of the custom vocabulary filter you want to delete.
1200
- # Vocabulary filter names are case sensitive.
1232
+ # The name of the custom vocabulary filter you want to delete. Custom
1233
+ # vocabulary filter names are case sensitive.
1201
1234
  #
1202
1235
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1203
1236
  #
@@ -1218,7 +1251,7 @@ module Aws::TranscribeService
1218
1251
 
1219
1252
  # Provides information about the specified custom language model.
1220
1253
  #
1221
- # This operation also shows if the base language model you used to
1254
+ # This operation also shows if the base language model that you used to
1222
1255
  # create your custom language model has been updated. If Amazon
1223
1256
  # Transcribe has updated the base model, you can create a new custom
1224
1257
  # language model using the updated base model.
@@ -1227,8 +1260,6 @@ module Aws::TranscribeService
1227
1260
  # wasn't successful, you can use `DescribeLanguageModel` to help
1228
1261
  # identify the reason for this failure.
1229
1262
  #
1230
- # To get a list of your custom language models, use the operation.
1231
- #
1232
1263
  # @option params [required, String] :model_name
1233
1264
  # The name of the custom language model you want information about.
1234
1265
  # Model names are case sensitive.
@@ -1336,6 +1367,7 @@ module Aws::TranscribeService
1336
1367
  # resp.category_properties.rules[0].sentiment_filter.negate #=> Boolean
1337
1368
  # resp.category_properties.create_time #=> Time
1338
1369
  # resp.category_properties.last_update_time #=> Time
1370
+ # resp.category_properties.input_type #=> String, one of "REAL_TIME", "POST_CALL"
1339
1371
  #
1340
1372
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetCallAnalyticsCategory AWS API Documentation
1341
1373
  #
@@ -1426,8 +1458,8 @@ module Aws::TranscribeService
1426
1458
  #
1427
1459
  # To view the status of the specified medical transcription job, check
1428
1460
  # 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`
1461
+ # job is finished. You can find the results at the location specified in
1462
+ # `TranscriptFileUri`. If the status is `FAILED`, `FailureReason`
1431
1463
  # provides details on why your transcription job failed.
1432
1464
  #
1433
1465
  # To get a list of your medical transcription jobs, use the operation.
@@ -1484,16 +1516,16 @@ module Aws::TranscribeService
1484
1516
 
1485
1517
  # Provides information about the specified custom medical vocabulary.
1486
1518
  #
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.
1519
+ # To view the status of the specified custom medical vocabulary, check
1520
+ # the `VocabularyState` field. If the status is `READY`, your custom
1521
+ # vocabulary is available to use. If the status is `FAILED`,
1522
+ # `FailureReason` provides details on why your vocabulary failed.
1491
1523
  #
1492
1524
  # To get a list of your custom medical vocabularies, use the operation.
1493
1525
  #
1494
1526
  # @option params [required, String] :vocabulary_name
1495
1527
  # The name of the custom medical vocabulary you want information about.
1496
- # Vocabulary names are case sensitive.
1528
+ # Custom medical vocabulary names are case sensitive.
1497
1529
  #
1498
1530
  # @return [Types::GetMedicalVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1499
1531
  #
@@ -1532,7 +1564,7 @@ module Aws::TranscribeService
1532
1564
  #
1533
1565
  # To view the status of the specified transcription job, check the
1534
1566
  # `TranscriptionJobStatus` field. If the status is `COMPLETED`, the job
1535
- # is finished and you can find the results at the location specified in
1567
+ # is finished. You can find the results at the location specified in
1536
1568
  # `TranscriptFileUri`. If the status is `FAILED`, `FailureReason`
1537
1569
  # provides details on why your transcription job failed.
1538
1570
  #
@@ -1617,16 +1649,16 @@ module Aws::TranscribeService
1617
1649
 
1618
1650
  # Provides information about the specified custom vocabulary.
1619
1651
  #
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.
1652
+ # To view the status of the specified custom vocabulary, check the
1653
+ # `VocabularyState` field. If the status is `READY`, your custom
1654
+ # vocabulary is available to use. If the status is `FAILED`,
1655
+ # `FailureReason` provides details on why your custom vocabulary failed.
1624
1656
  #
1625
1657
  # To get a list of your custom vocabularies, use the operation.
1626
1658
  #
1627
1659
  # @option params [required, String] :vocabulary_name
1628
- # The name of the custom vocabulary you want information about.
1629
- # Vocabulary names are case sensitive.
1660
+ # The name of the custom vocabulary you want information about. Custom
1661
+ # vocabulary names are case sensitive.
1630
1662
  #
1631
1663
  # @return [Types::GetVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1632
1664
  #
@@ -1663,16 +1695,11 @@ module Aws::TranscribeService
1663
1695
 
1664
1696
  # Provides information about the specified custom vocabulary filter.
1665
1697
  #
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
1698
  # To get a list of your custom vocabulary filters, use the operation.
1672
1699
  #
1673
1700
  # @option params [required, String] :vocabulary_filter_name
1674
1701
  # The name of the custom vocabulary filter you want information about.
1675
- # Vocabulary filter names are case sensitive.
1702
+ # Custom vocabulary filter names are case sensitive.
1676
1703
  #
1677
1704
  # @return [Types::GetVocabularyFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1678
1705
  #
@@ -1718,9 +1745,9 @@ module Aws::TranscribeService
1718
1745
  #
1719
1746
  # @option params [Integer] :max_results
1720
1747
  # 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.
1748
+ # of results. If there are fewer results than the value that you
1749
+ # specify, only the actual results are returned. If you don't specify a
1750
+ # value, a default of 5 is used.
1724
1751
  #
1725
1752
  # @return [Types::ListCallAnalyticsCategoriesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1726
1753
  #
@@ -1790,6 +1817,7 @@ module Aws::TranscribeService
1790
1817
  # resp.categories[0].rules[0].sentiment_filter.negate #=> Boolean
1791
1818
  # resp.categories[0].create_time #=> Time
1792
1819
  # resp.categories[0].last_update_time #=> Time
1820
+ # resp.categories[0].input_type #=> String, one of "REAL_TIME", "POST_CALL"
1793
1821
  #
1794
1822
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListCallAnalyticsCategories AWS API Documentation
1795
1823
  #
@@ -1825,8 +1853,8 @@ module Aws::TranscribeService
1825
1853
  #
1826
1854
  # @option params [Integer] :max_results
1827
1855
  # The maximum number of Call Analytics jobs to return in each page of
1828
- # results. If there are fewer results than the value you specify, only
1829
- # the actual results are returned. If you don't specify a value, a
1856
+ # results. If there are fewer results than the value that you specify,
1857
+ # only the actual results are returned. If you don't specify a value, a
1830
1858
  # default of 5 is used.
1831
1859
  #
1832
1860
  # @return [Types::ListCallAnalyticsJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -1869,7 +1897,7 @@ module Aws::TranscribeService
1869
1897
  end
1870
1898
 
1871
1899
  # Provides a list of custom language models that match the specified
1872
- # criteria. If no criteria are specified, all language models are
1900
+ # criteria. If no criteria are specified, all custom language models are
1873
1901
  # returned.
1874
1902
  #
1875
1903
  # To get detailed information about a specific custom language model,
@@ -1894,8 +1922,8 @@ module Aws::TranscribeService
1894
1922
  #
1895
1923
  # @option params [Integer] :max_results
1896
1924
  # The maximum number of custom language models to return in each page of
1897
- # results. If there are fewer results than the value you specify, only
1898
- # the actual results are returned. If you don't specify a value, a
1925
+ # results. If there are fewer results than the value that you specify,
1926
+ # only the actual results are returned. If you don't specify a value, a
1899
1927
  # default of 5 is used.
1900
1928
  #
1901
1929
  # @return [Types::ListLanguageModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -1964,7 +1992,7 @@ module Aws::TranscribeService
1964
1992
  #
1965
1993
  # @option params [Integer] :max_results
1966
1994
  # The maximum number of medical transcription jobs to return in each
1967
- # page of results. If there are fewer results than the value you
1995
+ # page of results. If there are fewer results than the value that you
1968
1996
  # specify, only the actual results are returned. If you don't specify a
1969
1997
  # value, a default of 5 is used.
1970
1998
  #
@@ -2027,15 +2055,15 @@ module Aws::TranscribeService
2027
2055
  #
2028
2056
  # @option params [Integer] :max_results
2029
2057
  # The maximum number of custom medical vocabularies to return in each
2030
- # page of results. If there are fewer results than the value you
2058
+ # page of results. If there are fewer results than the value that you
2031
2059
  # specify, only the actual results are returned. If you don't specify a
2032
2060
  # value, a default of 5 is used.
2033
2061
  #
2034
2062
  # @option params [String] :state_equals
2035
2063
  # 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.
2064
+ # Custom vocabularies are ordered by creation date, with the newest
2065
+ # vocabulary first. If you don't include `StateEquals`, all custom
2066
+ # medical vocabularies are returned.
2039
2067
  #
2040
2068
  # @option params [String] :name_contains
2041
2069
  # Returns only the custom medical vocabularies that contain the
@@ -2093,7 +2121,7 @@ module Aws::TranscribeService
2093
2121
  # `arn:partition:service:region:account-id:resource-type/resource-id`.
2094
2122
  #
2095
2123
  # For example,
2096
- # `arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name`.
2124
+ # `arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name`.
2097
2125
  #
2098
2126
  # Valid values for `resource-type` are: `transcription-job`,
2099
2127
  # `medical-transcription-job`, `vocabulary`, `medical-vocabulary`,
@@ -2151,8 +2179,8 @@ module Aws::TranscribeService
2151
2179
  #
2152
2180
  # @option params [Integer] :max_results
2153
2181
  # 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
2182
+ # results. If there are fewer results than the value that you specify,
2183
+ # only the actual results are returned. If you don't specify a value, a
2156
2184
  # default of 5 is used.
2157
2185
  #
2158
2186
  # @return [Types::ListTranscriptionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -2222,8 +2250,8 @@ module Aws::TranscribeService
2222
2250
  #
2223
2251
  # @option params [Integer] :max_results
2224
2252
  # 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
2253
+ # results. If there are fewer results than the value that you specify,
2254
+ # only the actual results are returned. If you don't specify a value, a
2227
2255
  # default of 5 is used.
2228
2256
  #
2229
2257
  # @option params [String] :state_equals
@@ -2288,9 +2316,9 @@ module Aws::TranscribeService
2288
2316
  #
2289
2317
  # @option params [Integer] :max_results
2290
2318
  # 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.
2319
+ # of results. If there are fewer results than the value that you
2320
+ # specify, only the actual results are returned. If you don't specify a
2321
+ # value, a default of 5 is used.
2294
2322
  #
2295
2323
  # @option params [String] :name_contains
2296
2324
  # Returns only the custom vocabulary filters that contain the specified
@@ -2331,18 +2359,19 @@ module Aws::TranscribeService
2331
2359
  # Transcribes the audio from a customer service call and applies any
2332
2360
  # additional Request Parameters you choose to include in your request.
2333
2361
  #
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].
2362
+ # In addition to many standard transcription features, Call Analytics
2363
+ # provides you with call characteristics, call summarization, speaker
2364
+ # sentiment, and optional redaction of your text transcript and your
2365
+ # audio file. You can also apply custom categories to flag specified
2366
+ # conditions. To learn more about these features and insights, refer to
2367
+ # [Analyzing call center audio with Call Analytics][1].
2340
2368
  #
2341
2369
  # If you want to apply categories to your Call Analytics job, you must
2342
2370
  # create them before submitting your job request. Categories cannot be
2343
2371
  # retroactively applied to a job. To create a new category, use the
2344
2372
  # operation. To learn more about Call Analytics categories, see
2345
- # [Creating categories][2].
2373
+ # [Creating categories for batch transcriptions][2] and [Creating
2374
+ # categories for streaming transcriptions][3].
2346
2375
  #
2347
2376
  # To make a `StartCallAnalyticsJob` request, you must first upload your
2348
2377
  # media file into an Amazon S3 bucket; you can then specify the Amazon
@@ -2354,10 +2383,10 @@ module Aws::TranscribeService
2354
2383
  # * `region`\: The Amazon Web Services Region where you are making your
2355
2384
  # request. For a list of Amazon Web Services Regions supported with
2356
2385
  # Amazon Transcribe, refer to [Amazon Transcribe endpoints and
2357
- # quotas][3].
2386
+ # quotas][4].
2358
2387
  #
2359
- # * `CallAnalyticsJobName`\: A custom name you create for your
2360
- # transcription job that is unique within your Amazon Web Services
2388
+ # * `CallAnalyticsJobName`\: A custom name that you create for your
2389
+ # transcription job that's unique within your Amazon Web Services
2361
2390
  # account.
2362
2391
  #
2363
2392
  # * `DataAccessRoleArn`\: The Amazon Resource Name (ARN) of an IAM role
@@ -2378,8 +2407,9 @@ module Aws::TranscribeService
2378
2407
  #
2379
2408
  #
2380
2409
  # [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
2410
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html
2411
+ # [3]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html
2412
+ # [4]: https://docs.aws.amazon.com/general/latest/gr/transcribe.html
2383
2413
  #
2384
2414
  # @option params [required, String] :call_analytics_job_name
2385
2415
  # A unique name, chosen by you, for your Call Analytics job.
@@ -2391,7 +2421,7 @@ module Aws::TranscribeService
2391
2421
  #
2392
2422
  # @option params [required, Types::Media] :media
2393
2423
  # Describes the Amazon S3 location of the media file you want to use in
2394
- # your request.
2424
+ # your Call Analytics request.
2395
2425
  #
2396
2426
  # @option params [String] :output_location
2397
2427
  # The Amazon S3 location where you want your Call Analytics
@@ -2458,8 +2488,8 @@ module Aws::TranscribeService
2458
2488
  # @option params [String] :data_access_role_arn
2459
2489
  # The Amazon Resource Name (ARN) of an IAM role that has permissions to
2460
2490
  # 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.
2491
+ # role that you specify doesn’t have the appropriate permissions to
2492
+ # access the specified Amazon S3 location, your request fails.
2463
2493
  #
2464
2494
  # IAM role ARNs have the format
2465
2495
  # `arn:partition:iam::account:role/role-name-with-path`. For example:
@@ -2478,9 +2508,9 @@ module Aws::TranscribeService
2478
2508
  # job.
2479
2509
  #
2480
2510
  # @option params [Array<Types::ChannelDefinition>] :channel_definitions
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
2511
+ # Makes it possible to specify which speaker is on which channel. For
2512
+ # example, if your agent is the first participant to speak, you would
2513
+ # set `ChannelId` to `0` (to indicate the first channel) and
2484
2514
  # `ParticipantRole` to `AGENT` (to indicate that it's the agent
2485
2515
  # speaking).
2486
2516
  #
@@ -2574,11 +2604,11 @@ module Aws::TranscribeService
2574
2604
  # applies any additional Request Parameters you choose to include in
2575
2605
  # your request.
2576
2606
  #
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].
2607
+ # In addition to many standard transcription features, Amazon Transcribe
2608
+ # Medical provides you with a robust medical vocabulary and, optionally,
2609
+ # content identification, which adds flags to personal health
2610
+ # information (PHI). To learn more about these features, refer to [How
2611
+ # Amazon Transcribe Medical works][1].
2582
2612
  #
2583
2613
  # To make a `StartMedicalTranscriptionJob` request, you must first
2584
2614
  # upload your media file into an Amazon S3 bucket; you can then specify
@@ -2615,7 +2645,7 @@ module Aws::TranscribeService
2615
2645
  #
2616
2646
  # @option params [required, String] :medical_transcription_job_name
2617
2647
  # 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
2648
+ # name that you specify is also used as the default name of your
2619
2649
  # transcription output file. If you want to specify a different name for
2620
2650
  # your transcription output, use the `OutputKey` parameter.
2621
2651
  #
@@ -2631,15 +2661,16 @@ module Aws::TranscribeService
2631
2661
  # results in a `BadRequestException` error.
2632
2662
  #
2633
2663
  # @option params [Integer] :media_sample_rate_hertz
2634
- # The sample rate, in Hertz, of the audio track in your input media
2664
+ # The sample rate, in hertz, of the audio track in your input media
2635
2665
  # file.
2636
2666
  #
2637
2667
  # If you don't specify the media sample rate, Amazon Transcribe Medical
2638
2668
  # determines it for you. If you specify the sample rate, it must match
2639
2669
  # 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.
2670
+ # between the value that you specify and the value detected, your job
2671
+ # fails. Therefore, in most cases, it's advised to omit
2672
+ # `MediaSampleRateHertz` and let Amazon Transcribe Medical determine the
2673
+ # sample rate.
2643
2674
  #
2644
2675
  # @option params [String] :media_format
2645
2676
  # Specify the format of your input media file.
@@ -2648,6 +2679,15 @@ module Aws::TranscribeService
2648
2679
  # Describes the Amazon S3 location of the media file you want to use in
2649
2680
  # your request.
2650
2681
  #
2682
+ # For information on supported media formats, refer to the
2683
+ # [MediaFormat][1] parameter or the [Media formats][2] section in the
2684
+ # Amazon S3 Developer Guide.
2685
+ #
2686
+ #
2687
+ #
2688
+ # [1]: https://docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat
2689
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio
2690
+ #
2651
2691
  # @option params [required, String] :output_bucket_name
2652
2692
  # The name of the Amazon S3 bucket where you want your medical
2653
2693
  # transcription output stored. Do not include the `S3://` prefix of the
@@ -2668,10 +2708,6 @@ module Aws::TranscribeService
2668
2708
  # Services Management Console][1]. See also [Permissions Required for
2669
2709
  # IAM User Roles][2].
2670
2710
  #
2671
- # If you don't specify `OutputBucketName`, your transcript is placed in
2672
- # a service-managed Amazon S3 bucket and you are provided with a URI to
2673
- # access your transcript.
2674
- #
2675
2711
  #
2676
2712
  #
2677
2713
  # [1]: https://console.aws.amazon.com/s3
@@ -2763,7 +2799,7 @@ module Aws::TranscribeService
2763
2799
  # @option params [Types::MedicalTranscriptionSetting] :settings
2764
2800
  # Specify additional optional settings in your request, including
2765
2801
  # channel identification, alternative transcriptions, and speaker
2766
- # labeling; allows you to apply custom vocabularies to your
2802
+ # partitioning. You can use that to apply custom vocabularies to your
2767
2803
  # transcription job.
2768
2804
  #
2769
2805
  # @option params [String] :content_identification_type
@@ -2912,10 +2948,10 @@ module Aws::TranscribeService
2912
2948
  # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
2913
2949
  #
2914
2950
  # @option params [required, String] :transcription_job_name
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.
2951
+ # A unique name, chosen by you, for your transcription job. The name
2952
+ # that you specify is also used as the default name of your
2953
+ # transcription output file. If you want to specify a different name for
2954
+ # your transcription output, use the `OutputKey` parameter.
2919
2955
  #
2920
2956
  # This name is case sensitive, cannot contain spaces, and must be unique
2921
2957
  # within an Amazon Web Services account. If you try to create a new job
@@ -2947,15 +2983,15 @@ module Aws::TranscribeService
2947
2983
  # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
2948
2984
  #
2949
2985
  # @option params [Integer] :media_sample_rate_hertz
2950
- # The sample rate, in Hertz, of the audio track in your input media
2986
+ # The sample rate, in hertz, of the audio track in your input media
2951
2987
  # file.
2952
2988
  #
2953
2989
  # If you don't specify the media sample rate, Amazon Transcribe
2954
2990
  # 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.
2991
+ # the rate detected by Amazon Transcribe. If there's a mismatch between
2992
+ # the value that you specify and the value detected, your job fails. In
2993
+ # most cases, you can omit `MediaSampleRateHertz` and let Amazon
2994
+ # Transcribe determine the sample rate.
2959
2995
  #
2960
2996
  # @option params [String] :media_format
2961
2997
  # Specify the format of your input media file.
@@ -3077,8 +3113,9 @@ module Aws::TranscribeService
3077
3113
  #
3078
3114
  # @option params [Types::Settings] :settings
3079
3115
  # 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.
3116
+ # channel identification, alternative transcriptions, speaker
3117
+ # partitioning. You can use that to apply custom vocabularies and
3118
+ # vocabulary filters.
3082
3119
  #
3083
3120
  # If you want to include a custom vocabulary or a custom vocabulary
3084
3121
  # filter (or both) with your request but **do not** want to use
@@ -3104,7 +3141,7 @@ module Aws::TranscribeService
3104
3141
  # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html
3105
3142
  #
3106
3143
  # @option params [Types::JobExecutionSettings] :job_execution_settings
3107
- # Allows you to control how your transcription job is processed.
3144
+ # Makes it possible to control how your transcription job is processed.
3108
3145
  # Currently, the only `JobExecutionSettings` modification you can choose
3109
3146
  # is enabling job queueing using the `AllowDeferredExecution`
3110
3147
  # sub-parameter.
@@ -3114,24 +3151,28 @@ module Aws::TranscribeService
3114
3151
  # `DataAccessRoleArn`.
3115
3152
  #
3116
3153
  # @option params [Types::ContentRedaction] :content_redaction
3117
- # Allows you to redact or flag specified personally identifiable
3154
+ # Makes it possible to redact or flag specified personally identifiable
3118
3155
  # information (PII) in your transcript. If you use `ContentRedaction`,
3119
3156
  # you must also include the sub-parameters: `PiiEntityTypes`,
3120
3157
  # `RedactionOutput`, and `RedactionType`.
3121
3158
  #
3122
3159
  # @option params [Boolean] :identify_language
3123
3160
  # Enables automatic language identification in your transcription job
3124
- # request.
3161
+ # request. Use this parameter if your media file contains only one
3162
+ # language. If your media contains multiple languages, use
3163
+ # `IdentifyMultipleLanguages` instead.
3125
3164
  #
3126
3165
  # If you include `IdentifyLanguage`, you can optionally include a list
3127
3166
  # of language codes, using `LanguageOptions`, that you think may be
3128
- # present in your media file. Including language options can improve
3129
- # transcription accuracy.
3167
+ # present in your media file. Including `LanguageOptions` restricts
3168
+ # `IdentifyLanguage` to only the language options that you specify,
3169
+ # which can improve transcription accuracy.
3130
3170
  #
3131
3171
  # If you want to apply a custom language model, a custom vocabulary, or
3132
3172
  # a custom vocabulary filter to your automatic language identification
3133
3173
  # request, include `LanguageIdSettings` with the relevant sub-parameters
3134
3174
  # (`VocabularyName`, `LanguageModelName`, and `VocabularyFilterName`).
3175
+ # If you include `LanguageIdSettings`, also include `LanguageOptions`.
3135
3176
  #
3136
3177
  # Note that you must include one of `LanguageCode`, `IdentifyLanguage`,
3137
3178
  # or `IdentifyMultipleLanguages` in your request. If you include more
@@ -3140,17 +3181,20 @@ module Aws::TranscribeService
3140
3181
  # @option params [Boolean] :identify_multiple_languages
3141
3182
  # Enables automatic multi-language identification in your transcription
3142
3183
  # job request. Use this parameter if your media file contains more than
3143
- # one language.
3184
+ # one language. If your media contains only one language, use
3185
+ # `IdentifyLanguage` instead.
3144
3186
  #
3145
3187
  # If you include `IdentifyMultipleLanguages`, you can optionally include
3146
3188
  # 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.
3189
+ # be present in your media file. Including `LanguageOptions` restricts
3190
+ # `IdentifyLanguage` to only the language options that you specify,
3191
+ # which can improve transcription accuracy.
3149
3192
  #
3150
3193
  # If you want to apply a custom vocabulary or a custom vocabulary filter
3151
3194
  # to your automatic language identification request, include
3152
3195
  # `LanguageIdSettings` with the relevant sub-parameters
3153
- # (`VocabularyName` and `VocabularyFilterName`).
3196
+ # (`VocabularyName` and `VocabularyFilterName`). If you include
3197
+ # `LanguageIdSettings`, also include `LanguageOptions`.
3154
3198
  #
3155
3199
  # Note that you must include one of `LanguageCode`, `IdentifyLanguage`,
3156
3200
  # or `IdentifyMultipleLanguages` in your request. If you include more
@@ -3158,7 +3202,7 @@ module Aws::TranscribeService
3158
3202
  #
3159
3203
  # @option params [Array<String>] :language_options
3160
3204
  # You can specify two or more language codes that represent the
3161
- # languages you think may be present in your media; including more than
3205
+ # languages you think may be present in your media. Including more than
3162
3206
  # five is not recommended. If you're unsure what languages are present,
3163
3207
  # do not include this parameter.
3164
3208
  #
@@ -3190,31 +3234,34 @@ module Aws::TranscribeService
3190
3234
  # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html
3191
3235
  #
3192
3236
  # @option params [Hash<String,Types::LanguageIdSettings>] :language_id_settings
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.
3237
+ # If using automatic language identification in your request and you
3238
+ # want to apply a custom language model, a custom vocabulary, or a
3239
+ # custom vocabulary filter, include `LanguageIdSettings` with the
3240
+ # relevant sub-parameters (`VocabularyName`, `LanguageModelName`, and
3241
+ # `VocabularyFilterName`). Note that multi-language identification
3242
+ # (`IdentifyMultipleLanguages`) doesn't support custom language models.
3243
+ #
3244
+ # `LanguageIdSettings` supports two to five language codes. Each
3245
+ # language code you include can have an associated custom language
3246
+ # model, custom vocabulary, and custom vocabulary filter. The language
3247
+ # codes that you specify must match the languages of the associated
3248
+ # custom language models, custom vocabularies, and custom vocabulary
3249
+ # filters.
3250
+ #
3251
+ # It's recommended that you include `LanguageOptions` when using
3252
+ # `LanguageIdSettings` to ensure that the correct language dialect is
3253
+ # identified. For example, if you specify a custom vocabulary that is in
3254
+ # `en-US` but Amazon Transcribe determines that the language spoken in
3255
+ # your media is `en-AU`, your custom vocabulary *is not* applied to your
3256
+ # transcription. If you include `LanguageOptions` and include `en-US` as
3257
+ # the only English language dialect, your custom vocabulary *is* applied
3258
+ # to your transcription.
3212
3259
  #
3213
3260
  # If you want to include a custom language model with your request but
3214
3261
  # **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
3262
+ # the ` parameter with the LanguageModelName sub-parameter. If you want
3263
+ # to include a custom vocabulary or a custom vocabulary filter (or both)
3264
+ # with your request but do not want to use automatic language
3218
3265
  # identification, use instead the parameter with the VocabularyName or
3219
3266
  # VocabularyFilterName (or both) sub-parameter.</p>
3220
3267
  # `
@@ -3360,7 +3407,7 @@ module Aws::TranscribeService
3360
3407
  # `arn:partition:service:region:account-id:resource-type/resource-id`.
3361
3408
  #
3362
3409
  # For example,
3363
- # `arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name`.
3410
+ # `arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name`.
3364
3411
  #
3365
3412
  # Valid values for `resource-type` are: `transcription-job`,
3366
3413
  # `medical-transcription-job`, `vocabulary`, `medical-vocabulary`,
@@ -3412,7 +3459,7 @@ module Aws::TranscribeService
3412
3459
  # `arn:partition:service:region:account-id:resource-type/resource-id`.
3413
3460
  #
3414
3461
  # For example,
3415
- # `arn:aws:transcribe:us-west-2:account-id:transcription-job/transcription-job-name`.
3462
+ # `arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name`.
3416
3463
  #
3417
3464
  # Valid values for `resource-type` are: `transcription-job`,
3418
3465
  # `medical-transcription-job`, `vocabulary`, `medical-vocabulary`,
@@ -3456,6 +3503,13 @@ module Aws::TranscribeService
3456
3503
  # provide in this field replace the ones that are currently being used
3457
3504
  # in the specified category.
3458
3505
  #
3506
+ # @option params [String] :input_type
3507
+ # Choose whether you want to update a streaming or a batch Call
3508
+ # Analytics category. The input type you specify must match the input
3509
+ # type specified when the category was created. For example, if you
3510
+ # created a category with the `POST_CALL` input type, you must use
3511
+ # `POST_CALL` as the input type when updating this category.
3512
+ #
3459
3513
  # @return [Types::UpdateCallAnalyticsCategoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3460
3514
  #
3461
3515
  # * {Types::UpdateCallAnalyticsCategoryResponse#category_properties #category_properties} => Types::CategoryProperties
@@ -3536,6 +3590,7 @@ module Aws::TranscribeService
3536
3590
  # },
3537
3591
  # },
3538
3592
  # ],
3593
+ # input_type: "REAL_TIME", # accepts REAL_TIME, POST_CALL
3539
3594
  # })
3540
3595
  #
3541
3596
  # @example Response structure
@@ -3590,6 +3645,7 @@ module Aws::TranscribeService
3590
3645
  # resp.category_properties.rules[0].sentiment_filter.negate #=> Boolean
3591
3646
  # resp.category_properties.create_time #=> Time
3592
3647
  # resp.category_properties.last_update_time #=> Time
3648
+ # resp.category_properties.input_type #=> String, one of "REAL_TIME", "POST_CALL"
3593
3649
  #
3594
3650
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateCallAnalyticsCategory AWS API Documentation
3595
3651
  #
@@ -3602,11 +3658,11 @@ module Aws::TranscribeService
3602
3658
 
3603
3659
  # Updates an existing custom medical vocabulary with new values. This
3604
3660
  # operation overwrites all existing information with your new values;
3605
- # you cannot append new terms onto an existing vocabulary.
3661
+ # you cannot append new terms onto an existing custom vocabulary.
3606
3662
  #
3607
3663
  # @option params [required, String] :vocabulary_name
3608
- # The name of the custom medical vocabulary you want to update.
3609
- # Vocabulary names are case sensitive.
3664
+ # The name of the custom medical vocabulary you want to update. Custom
3665
+ # medical vocabulary names are case sensitive.
3610
3666
  #
3611
3667
  # @option params [required, String] :language_code
3612
3668
  # The language code that represents the language of the entries in the
@@ -3654,21 +3710,21 @@ module Aws::TranscribeService
3654
3710
 
3655
3711
  # Updates an existing custom vocabulary with new values. This operation
3656
3712
  # overwrites all existing information with your new values; you cannot
3657
- # append new terms onto an existing vocabulary.
3713
+ # append new terms onto an existing custom vocabulary.
3658
3714
  #
3659
3715
  # @option params [required, String] :vocabulary_name
3660
- # The name of the custom vocabulary you want to update. Vocabulary names
3661
- # are case sensitive.
3716
+ # The name of the custom vocabulary you want to update. Custom
3717
+ # vocabulary names are case sensitive.
3662
3718
  #
3663
3719
  # @option params [required, String] :language_code
3664
3720
  # 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.
3721
+ # custom vocabulary you want to update. Each custom vocabulary must
3722
+ # contain terms in only one language.
3667
3723
  #
3668
3724
  # 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.
3725
+ # language as the custom vocabulary. For example, if you create a custom
3726
+ # vocabulary using US English (`en-US`), you can only apply this custom
3727
+ # vocabulary to files that contain English audio.
3672
3728
  #
3673
3729
  # For a list of supported languages and their associated language codes,
3674
3730
  # refer to the [Supported languages][1] table.
@@ -3678,19 +3734,20 @@ module Aws::TranscribeService
3678
3734
  # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
3679
3735
  #
3680
3736
  # @option params [Array<String>] :phrases
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.
3737
+ # Use this parameter if you want to update your custom vocabulary by
3738
+ # including all desired terms, as comma-separated values, within your
3739
+ # request. The other option for updating your custom vocabulary is to
3740
+ # save your entries in a text file and upload them to an Amazon S3
3741
+ # bucket, then specify the location of your file using the
3742
+ # `VocabularyFileUri` parameter.
3686
3743
  #
3687
3744
  # Note that if you include `Phrases` in your request, you cannot use
3688
3745
  # `VocabularyFileUri`; you must choose one or the other.
3689
3746
  #
3690
3747
  # Each language has a character set that contains all allowed characters
3691
3748
  # 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.
3749
+ # custom vocabulary filter request fails. Refer to [Character Sets for
3750
+ # Custom Vocabularies][1] to get the character set for your language.
3694
3751
  #
3695
3752
  #
3696
3753
  #
@@ -3741,15 +3798,15 @@ module Aws::TranscribeService
3741
3798
 
3742
3799
  # Updates an existing custom vocabulary filter with a new list of words.
3743
3800
  # The new list you provide overwrites all previous entries; you cannot
3744
- # append new terms onto an existing vocabulary filter.
3801
+ # append new terms onto an existing custom vocabulary filter.
3745
3802
  #
3746
3803
  # @option params [required, String] :vocabulary_filter_name
3747
- # The name of the custom vocabulary filter you want to update.
3748
- # Vocabulary filter names are case sensitive.
3804
+ # The name of the custom vocabulary filter you want to update. Custom
3805
+ # vocabulary filter names are case sensitive.
3749
3806
  #
3750
3807
  # @option params [Array<String>] :words
3751
- # Use this parameter if you want to update your vocabulary filter by
3752
- # including all desired terms, as comma-separated values, within your
3808
+ # Use this parameter if you want to update your custom vocabulary filter
3809
+ # by including all desired terms, as comma-separated values, within your
3753
3810
  # request. The other option for updating your vocabulary filter is to
3754
3811
  # save your entries in a text file and upload them to an Amazon S3
3755
3812
  # bucket, then specify the location of your file using the
@@ -3760,8 +3817,8 @@ module Aws::TranscribeService
3760
3817
  #
3761
3818
  # Each language has a character set that contains all allowed characters
3762
3819
  # 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.
3820
+ # custom vocabulary filter request fails. Refer to [Character Sets for
3821
+ # Custom Vocabularies][1] to get the character set for your language.
3765
3822
  #
3766
3823
  #
3767
3824
  #
@@ -3820,7 +3877,7 @@ module Aws::TranscribeService
3820
3877
  params: params,
3821
3878
  config: config)
3822
3879
  context[:gem_name] = 'aws-sdk-transcribeservice'
3823
- context[:gem_version] = '1.76.0'
3880
+ context[:gem_version] = '1.78.0'
3824
3881
  Seahorse::Client::Request.new(handlers, context)
3825
3882
  end
3826
3883