aws-sdk-transcribeservice 1.38.0 → 1.43.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d8448c1b3a410217b70f6a42c33e5a282f3bec5a5bb17d80aaa14791b5e8c1f9
4
- data.tar.gz: da367399c9369face3ad9ecbd60c0d14e560c542f8ff216ee1f0b748c7c33cd0
3
+ metadata.gz: 34a77bbddc061a311f076e4800b9d6fb94f002f69c0cc9db1277e8e024ff8d8d
4
+ data.tar.gz: 82893555da00e81a678b7e27e57945c10e6c1164753c3a70d497cf02674d345f
5
5
  SHA512:
6
- metadata.gz: eb4c5658022da2943cb84be75fd75042170431fdc3578bce17ae0e85be658287beed249677874500d9f190e4881bd9163c52d9495f78bb79160d1890513b1a41
7
- data.tar.gz: 91fe54f5d339547a9d27bd44a8314d8ea74aad5ed40b1c6a2d00e0cc3a866db5b3c8024073c4b1590f958966b23abf6fc1beea2a345c90a84414bbbf39168ab6
6
+ metadata.gz: eaca9c8306ea6fcfb818a0e4c7214da6f6282d45eada1de1e1ebf6ac4f1495d4194f634a1a2411a939bf3d3519b493dc28b0bc2625708cace507eff16de3aa9c
7
+ data.tar.gz: eacf06904e184d526e756691c69795c49bedd160980cc6196305c735ca67915505292e96f3f1ae20d47a6794c66e0af3433f354bd7f782d96a3db9b2689f634f
@@ -25,7 +25,7 @@ require_relative 'aws-sdk-transcribeservice/customizations'
25
25
  # structure.
26
26
  #
27
27
  # transcribe_service = Aws::TranscribeService::Client.new
28
- # resp = transcribe_service.create_vocabulary(params)
28
+ # resp = transcribe_service.create_medical_vocabulary(params)
29
29
  #
30
30
  # See {Client} for more information.
31
31
  #
@@ -45,6 +45,6 @@ require_relative 'aws-sdk-transcribeservice/customizations'
45
45
  # @service
46
46
  module Aws::TranscribeService
47
47
 
48
- GEM_VERSION = '1.38.0'
48
+ GEM_VERSION = '1.43.0'
49
49
 
50
50
  end
@@ -105,7 +105,7 @@ module Aws::TranscribeService
105
105
  # @option options [required, String] :region
106
106
  # The AWS region to connect to. The configured `:region` is
107
107
  # used to determine the service `:endpoint`. When not passed,
108
- # a default `:region` is search for in the following locations:
108
+ # a default `:region` is searched for in the following locations:
109
109
  #
110
110
  # * `Aws.config[:region]`
111
111
  # * `ENV['AWS_REGION']`
@@ -161,7 +161,7 @@ module Aws::TranscribeService
161
161
  # @option options [String] :endpoint
162
162
  # The client endpoint is normally constructed from the `:region`
163
163
  # option. You should only configure an `:endpoint` when connecting
164
- # to test endpoints. This should be avalid HTTP(S) URI.
164
+ # to test endpoints. This should be a valid HTTP(S) URI.
165
165
  #
166
166
  # @option options [Integer] :endpoint_cache_max_entries (1000)
167
167
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -176,7 +176,7 @@ module Aws::TranscribeService
176
176
  # requests fetching endpoints information. Defaults to 60 sec.
177
177
  #
178
178
  # @option options [Boolean] :endpoint_discovery (false)
179
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
179
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
180
180
  #
181
181
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
182
182
  # The log formatter.
@@ -279,8 +279,7 @@ module Aws::TranscribeService
279
279
  #
280
280
  # @option options [Integer] :http_read_timeout (60) The default
281
281
  # number of seconds to wait for response data. This value can
282
- # safely be set
283
- # per-request on the session yielded by {#session_for}.
282
+ # safely be set per-request on the session.
284
283
  #
285
284
  # @option options [Float] :http_idle_timeout (5) The number of
286
285
  # seconds a connection is allowed to sit idle before it is
@@ -292,7 +291,7 @@ module Aws::TranscribeService
292
291
  # request body. This option has no effect unless the request has
293
292
  # "Expect" header set to "100-continue". Defaults to `nil` which
294
293
  # disables this behaviour. This value can safely be set per
295
- # request on the session yielded by {#session_for}.
294
+ # request on the session.
296
295
  #
297
296
  # @option options [Boolean] :http_wire_trace (false) When `true`,
298
297
  # HTTP debug output will be sent to the `:logger`.
@@ -319,12 +318,87 @@ module Aws::TranscribeService
319
318
 
320
319
  # @!group API Operations
321
320
 
321
+ # Creates a new custom vocabulary that you can use to change how Amazon
322
+ # Transcribe Medical transcribes your audio file.
323
+ #
324
+ # @option params [required, String] :vocabulary_name
325
+ # The name of the custom vocabulary. This case-sensitive name must be
326
+ # unique within an AWS account. If you try to create a vocabulary with
327
+ # the same name as a previous vocabulary you will receive a
328
+ # `ConflictException` error.
329
+ #
330
+ # @option params [required, String] :language_code
331
+ # The language code used for the entries within your custom vocabulary.
332
+ # The language code of your custom vocabulary must match the language
333
+ # code of your transcription job. US English (en-US) is the only
334
+ # language code available for Amazon Transcribe Medical.
335
+ #
336
+ # @option params [required, String] :vocabulary_file_uri
337
+ # The Amazon S3 location of the text file you use to define your custom
338
+ # vocabulary. The URI must be in the same AWS region as the API endpoint
339
+ # you're calling. Enter information about your `VocabularyFileUri` in
340
+ # the following format:
341
+ #
342
+ # `
343
+ # https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
344
+ # `
345
+ #
346
+ # This is an example of a vocabulary file uri location in Amazon S3:
347
+ #
348
+ # `https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt`
349
+ #
350
+ # For more information about S3 object names, see [Object Keys][1] in
351
+ # the *Amazon S3 Developer Guide*.
352
+ #
353
+ # For more information about custom vocabularies, see [Medical Custom
354
+ # Vocabularies][2].
355
+ #
356
+ #
357
+ #
358
+ # [1]: http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys
359
+ # [2]: http://docs.aws.amazon.com/transcribe/latest/dg/how-it-works.html#how-vocabulary-med
360
+ #
361
+ # @return [Types::CreateMedicalVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
362
+ #
363
+ # * {Types::CreateMedicalVocabularyResponse#vocabulary_name #vocabulary_name} => String
364
+ # * {Types::CreateMedicalVocabularyResponse#language_code #language_code} => String
365
+ # * {Types::CreateMedicalVocabularyResponse#vocabulary_state #vocabulary_state} => String
366
+ # * {Types::CreateMedicalVocabularyResponse#last_modified_time #last_modified_time} => Time
367
+ # * {Types::CreateMedicalVocabularyResponse#failure_reason #failure_reason} => String
368
+ #
369
+ # @example Request syntax with placeholder values
370
+ #
371
+ # resp = client.create_medical_vocabulary({
372
+ # vocabulary_name: "VocabularyName", # required
373
+ # language_code: "en-US", # required, accepts en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR, fr-FR, it-IT, ko-KR, es-ES, en-IN, hi-IN, ar-SA, ru-RU, zh-CN, nl-NL, id-ID, ta-IN, fa-IR, en-IE, en-AB, en-WL, pt-PT, te-IN, tr-TR, de-CH, he-IL, ms-MY, ja-JP, ar-AE
374
+ # vocabulary_file_uri: "Uri", # required
375
+ # })
376
+ #
377
+ # @example Response structure
378
+ #
379
+ # resp.vocabulary_name #=> String
380
+ # resp.language_code #=> String, one of "en-US", "es-US", "en-AU", "fr-CA", "en-GB", "de-DE", "pt-BR", "fr-FR", "it-IT", "ko-KR", "es-ES", "en-IN", "hi-IN", "ar-SA", "ru-RU", "zh-CN", "nl-NL", "id-ID", "ta-IN", "fa-IR", "en-IE", "en-AB", "en-WL", "pt-PT", "te-IN", "tr-TR", "de-CH", "he-IL", "ms-MY", "ja-JP", "ar-AE"
381
+ # resp.vocabulary_state #=> String, one of "PENDING", "READY", "FAILED"
382
+ # resp.last_modified_time #=> Time
383
+ # resp.failure_reason #=> String
384
+ #
385
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateMedicalVocabulary AWS API Documentation
386
+ #
387
+ # @overload create_medical_vocabulary(params = {})
388
+ # @param [Hash] params ({})
389
+ def create_medical_vocabulary(params = {}, options = {})
390
+ req = build_request(:create_medical_vocabulary, params)
391
+ req.send_request(options)
392
+ end
393
+
322
394
  # Creates a new custom vocabulary that you can use to change the way
323
395
  # Amazon Transcribe handles transcription of an audio file.
324
396
  #
325
397
  # @option params [required, String] :vocabulary_name
326
398
  # The name of the vocabulary. The name must be unique within an AWS
327
- # account. The name is case-sensitive.
399
+ # account. The name is case-sensitive. If you try to create a vocabulary
400
+ # with the same name as a previous vocabulary you will receive a
401
+ # `ConflictException` error.
328
402
  #
329
403
  # @option params [required, String] :language_code
330
404
  # The language code of the vocabulary entries.
@@ -337,14 +411,6 @@ module Aws::TranscribeService
337
411
  # custom vocabulary. The URI must be in the same region as the API
338
412
  # endpoint that you are calling. The general form is
339
413
  #
340
- # `
341
- # https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
342
- # `
343
- #
344
- # For example:
345
- #
346
- # `https://s3.us-east-1.amazonaws.com/examplebucket/vocab.txt`
347
- #
348
414
  # For more information about S3 object names, see [Object Keys][1] in
349
415
  # the *Amazon S3 Developer Guide*.
350
416
  #
@@ -395,7 +461,9 @@ module Aws::TranscribeService
395
461
  #
396
462
  # @option params [required, String] :vocabulary_filter_name
397
463
  # The vocabulary filter name. The name must be unique within the account
398
- # that contains it.
464
+ # that contains it.If you try to create a vocabulary filter with the
465
+ # same name as a previous vocabulary filter you will receive a
466
+ # `ConflictException` error.
399
467
  #
400
468
  # @option params [required, String] :language_code
401
469
  # The language code of the words in the vocabulary filter. All words in
@@ -460,6 +528,52 @@ module Aws::TranscribeService
460
528
  req.send_request(options)
461
529
  end
462
530
 
531
+ # Deletes a transcription job generated by Amazon Transcribe Medical and
532
+ # any related information.
533
+ #
534
+ # @option params [required, String] :medical_transcription_job_name
535
+ # The name you provide to the `DeleteMedicalTranscriptionJob` object to
536
+ # delete a transcription job.
537
+ #
538
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
539
+ #
540
+ # @example Request syntax with placeholder values
541
+ #
542
+ # resp = client.delete_medical_transcription_job({
543
+ # medical_transcription_job_name: "TranscriptionJobName", # required
544
+ # })
545
+ #
546
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteMedicalTranscriptionJob AWS API Documentation
547
+ #
548
+ # @overload delete_medical_transcription_job(params = {})
549
+ # @param [Hash] params ({})
550
+ def delete_medical_transcription_job(params = {}, options = {})
551
+ req = build_request(:delete_medical_transcription_job, params)
552
+ req.send_request(options)
553
+ end
554
+
555
+ # Deletes a vocabulary from Amazon Transcribe Medical.
556
+ #
557
+ # @option params [required, String] :vocabulary_name
558
+ # The name of the vocabulary you are choosing to delete.
559
+ #
560
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
561
+ #
562
+ # @example Request syntax with placeholder values
563
+ #
564
+ # resp = client.delete_medical_vocabulary({
565
+ # vocabulary_name: "VocabularyName", # required
566
+ # })
567
+ #
568
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteMedicalVocabulary AWS API Documentation
569
+ #
570
+ # @overload delete_medical_vocabulary(params = {})
571
+ # @param [Hash] params ({})
572
+ def delete_medical_vocabulary(params = {}, options = {})
573
+ req = build_request(:delete_medical_vocabulary, params)
574
+ req.send_request(options)
575
+ end
576
+
463
577
  # Deletes a previously submitted transcription job along with any other
464
578
  # generated results such as the transcription, models, and so on.
465
579
  #
@@ -527,6 +641,95 @@ module Aws::TranscribeService
527
641
  req.send_request(options)
528
642
  end
529
643
 
644
+ # Returns information about a transcription job from Amazon Transcribe
645
+ # Medical. To see the status of the job, check the
646
+ # `TranscriptionJobStatus` field. If the status is `COMPLETED`, the job
647
+ # is finished. You find the results of the completed job in the
648
+ # `TranscriptFileUri` field.
649
+ #
650
+ # @option params [required, String] :medical_transcription_job_name
651
+ # The name of the medical transcription job.
652
+ #
653
+ # @return [Types::GetMedicalTranscriptionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
654
+ #
655
+ # * {Types::GetMedicalTranscriptionJobResponse#medical_transcription_job #medical_transcription_job} => Types::MedicalTranscriptionJob
656
+ #
657
+ # @example Request syntax with placeholder values
658
+ #
659
+ # resp = client.get_medical_transcription_job({
660
+ # medical_transcription_job_name: "TranscriptionJobName", # required
661
+ # })
662
+ #
663
+ # @example Response structure
664
+ #
665
+ # resp.medical_transcription_job.medical_transcription_job_name #=> String
666
+ # resp.medical_transcription_job.transcription_job_status #=> String, one of "QUEUED", "IN_PROGRESS", "FAILED", "COMPLETED"
667
+ # resp.medical_transcription_job.language_code #=> String, one of "en-US", "es-US", "en-AU", "fr-CA", "en-GB", "de-DE", "pt-BR", "fr-FR", "it-IT", "ko-KR", "es-ES", "en-IN", "hi-IN", "ar-SA", "ru-RU", "zh-CN", "nl-NL", "id-ID", "ta-IN", "fa-IR", "en-IE", "en-AB", "en-WL", "pt-PT", "te-IN", "tr-TR", "de-CH", "he-IL", "ms-MY", "ja-JP", "ar-AE"
668
+ # resp.medical_transcription_job.media_sample_rate_hertz #=> Integer
669
+ # resp.medical_transcription_job.media_format #=> String, one of "mp3", "mp4", "wav", "flac"
670
+ # resp.medical_transcription_job.media.media_file_uri #=> String
671
+ # resp.medical_transcription_job.transcript.transcript_file_uri #=> String
672
+ # resp.medical_transcription_job.start_time #=> Time
673
+ # resp.medical_transcription_job.creation_time #=> Time
674
+ # resp.medical_transcription_job.completion_time #=> Time
675
+ # resp.medical_transcription_job.failure_reason #=> String
676
+ # resp.medical_transcription_job.settings.show_speaker_labels #=> Boolean
677
+ # resp.medical_transcription_job.settings.max_speaker_labels #=> Integer
678
+ # resp.medical_transcription_job.settings.channel_identification #=> Boolean
679
+ # resp.medical_transcription_job.settings.show_alternatives #=> Boolean
680
+ # resp.medical_transcription_job.settings.max_alternatives #=> Integer
681
+ # resp.medical_transcription_job.settings.vocabulary_name #=> String
682
+ # resp.medical_transcription_job.specialty #=> String, one of "PRIMARYCARE"
683
+ # resp.medical_transcription_job.type #=> String, one of "CONVERSATION", "DICTATION"
684
+ #
685
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetMedicalTranscriptionJob AWS API Documentation
686
+ #
687
+ # @overload get_medical_transcription_job(params = {})
688
+ # @param [Hash] params ({})
689
+ def get_medical_transcription_job(params = {}, options = {})
690
+ req = build_request(:get_medical_transcription_job, params)
691
+ req.send_request(options)
692
+ end
693
+
694
+ # Retrieve information about a medical vocabulary.
695
+ #
696
+ # @option params [required, String] :vocabulary_name
697
+ # The name of the vocabulary you are trying to get information about.
698
+ # The value you enter for this request is case-sensitive.
699
+ #
700
+ # @return [Types::GetMedicalVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
701
+ #
702
+ # * {Types::GetMedicalVocabularyResponse#vocabulary_name #vocabulary_name} => String
703
+ # * {Types::GetMedicalVocabularyResponse#language_code #language_code} => String
704
+ # * {Types::GetMedicalVocabularyResponse#vocabulary_state #vocabulary_state} => String
705
+ # * {Types::GetMedicalVocabularyResponse#last_modified_time #last_modified_time} => Time
706
+ # * {Types::GetMedicalVocabularyResponse#failure_reason #failure_reason} => String
707
+ # * {Types::GetMedicalVocabularyResponse#download_uri #download_uri} => String
708
+ #
709
+ # @example Request syntax with placeholder values
710
+ #
711
+ # resp = client.get_medical_vocabulary({
712
+ # vocabulary_name: "VocabularyName", # required
713
+ # })
714
+ #
715
+ # @example Response structure
716
+ #
717
+ # resp.vocabulary_name #=> String
718
+ # resp.language_code #=> String, one of "en-US", "es-US", "en-AU", "fr-CA", "en-GB", "de-DE", "pt-BR", "fr-FR", "it-IT", "ko-KR", "es-ES", "en-IN", "hi-IN", "ar-SA", "ru-RU", "zh-CN", "nl-NL", "id-ID", "ta-IN", "fa-IR", "en-IE", "en-AB", "en-WL", "pt-PT", "te-IN", "tr-TR", "de-CH", "he-IL", "ms-MY", "ja-JP", "ar-AE"
719
+ # resp.vocabulary_state #=> String, one of "PENDING", "READY", "FAILED"
720
+ # resp.last_modified_time #=> Time
721
+ # resp.failure_reason #=> String
722
+ # resp.download_uri #=> String
723
+ #
724
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetMedicalVocabulary AWS API Documentation
725
+ #
726
+ # @overload get_medical_vocabulary(params = {})
727
+ # @param [Hash] params ({})
728
+ def get_medical_vocabulary(params = {}, options = {})
729
+ req = build_request(:get_medical_vocabulary, params)
730
+ req.send_request(options)
731
+ end
732
+
530
733
  # Returns information about a transcription job. To see the status of
531
734
  # the job, check the `TranscriptionJobStatus` field. If the status is
532
735
  # `COMPLETED`, the job is finished and you can find the results at the
@@ -656,6 +859,128 @@ module Aws::TranscribeService
656
859
  req.send_request(options)
657
860
  end
658
861
 
862
+ # Lists medical transcription jobs with a specified status or substring
863
+ # that matches their names.
864
+ #
865
+ # @option params [String] :status
866
+ # When specified, returns only medical transcription jobs with the
867
+ # specified status. Jobs are ordered by creation date, with the newest
868
+ # jobs returned first. If you don't specify a status, Amazon Transcribe
869
+ # Medical returns all transcription jobs ordered by creation date.
870
+ #
871
+ # @option params [String] :job_name_contains
872
+ # When specified, the jobs returned in the list are limited to jobs
873
+ # whose name contains the specified string.
874
+ #
875
+ # @option params [String] :next_token
876
+ # If you a receive a truncated result in the previous request of
877
+ # `ListMedicalTranscriptionJobs`, include `NextToken` to fetch the next
878
+ # set of jobs.
879
+ #
880
+ # @option params [Integer] :max_results
881
+ # The maximum number of medical transcription jobs to return in the
882
+ # response. IF there are fewer results in the list, this response
883
+ # contains only the actual results.
884
+ #
885
+ # @return [Types::ListMedicalTranscriptionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
886
+ #
887
+ # * {Types::ListMedicalTranscriptionJobsResponse#status #status} => String
888
+ # * {Types::ListMedicalTranscriptionJobsResponse#next_token #next_token} => String
889
+ # * {Types::ListMedicalTranscriptionJobsResponse#medical_transcription_job_summaries #medical_transcription_job_summaries} => Array&lt;Types::MedicalTranscriptionJobSummary&gt;
890
+ #
891
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
892
+ #
893
+ # @example Request syntax with placeholder values
894
+ #
895
+ # resp = client.list_medical_transcription_jobs({
896
+ # status: "QUEUED", # accepts QUEUED, IN_PROGRESS, FAILED, COMPLETED
897
+ # job_name_contains: "TranscriptionJobName",
898
+ # next_token: "NextToken",
899
+ # max_results: 1,
900
+ # })
901
+ #
902
+ # @example Response structure
903
+ #
904
+ # resp.status #=> String, one of "QUEUED", "IN_PROGRESS", "FAILED", "COMPLETED"
905
+ # resp.next_token #=> String
906
+ # resp.medical_transcription_job_summaries #=> Array
907
+ # resp.medical_transcription_job_summaries[0].medical_transcription_job_name #=> String
908
+ # resp.medical_transcription_job_summaries[0].creation_time #=> Time
909
+ # resp.medical_transcription_job_summaries[0].start_time #=> Time
910
+ # resp.medical_transcription_job_summaries[0].completion_time #=> Time
911
+ # resp.medical_transcription_job_summaries[0].language_code #=> String, one of "en-US", "es-US", "en-AU", "fr-CA", "en-GB", "de-DE", "pt-BR", "fr-FR", "it-IT", "ko-KR", "es-ES", "en-IN", "hi-IN", "ar-SA", "ru-RU", "zh-CN", "nl-NL", "id-ID", "ta-IN", "fa-IR", "en-IE", "en-AB", "en-WL", "pt-PT", "te-IN", "tr-TR", "de-CH", "he-IL", "ms-MY", "ja-JP", "ar-AE"
912
+ # resp.medical_transcription_job_summaries[0].transcription_job_status #=> String, one of "QUEUED", "IN_PROGRESS", "FAILED", "COMPLETED"
913
+ # resp.medical_transcription_job_summaries[0].failure_reason #=> String
914
+ # resp.medical_transcription_job_summaries[0].output_location_type #=> String, one of "CUSTOMER_BUCKET", "SERVICE_BUCKET"
915
+ # resp.medical_transcription_job_summaries[0].specialty #=> String, one of "PRIMARYCARE"
916
+ # resp.medical_transcription_job_summaries[0].type #=> String, one of "CONVERSATION", "DICTATION"
917
+ #
918
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListMedicalTranscriptionJobs AWS API Documentation
919
+ #
920
+ # @overload list_medical_transcription_jobs(params = {})
921
+ # @param [Hash] params ({})
922
+ def list_medical_transcription_jobs(params = {}, options = {})
923
+ req = build_request(:list_medical_transcription_jobs, params)
924
+ req.send_request(options)
925
+ end
926
+
927
+ # Returns a list of vocabularies that match the specified criteria. You
928
+ # get the entire list of vocabularies if you don't enter a value in any
929
+ # of the request parameters.
930
+ #
931
+ # @option params [String] :next_token
932
+ # If the result of your previous request to `ListMedicalVocabularies`
933
+ # was truncated, include the `NextToken` to fetch the next set of jobs.
934
+ #
935
+ # @option params [Integer] :max_results
936
+ # The maximum number of vocabularies to return in the response.
937
+ #
938
+ # @option params [String] :state_equals
939
+ # When specified, only returns vocabularies with the `VocabularyState`
940
+ # equal to the specified vocabulary state.
941
+ #
942
+ # @option params [String] :name_contains
943
+ # Returns vocabularies in the list whose name contains the specified
944
+ # string. The search is case-insensitive, `ListMedicalVocabularies`
945
+ # returns both "vocabularyname" and "VocabularyName" in the response
946
+ # list.
947
+ #
948
+ # @return [Types::ListMedicalVocabulariesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
949
+ #
950
+ # * {Types::ListMedicalVocabulariesResponse#status #status} => String
951
+ # * {Types::ListMedicalVocabulariesResponse#next_token #next_token} => String
952
+ # * {Types::ListMedicalVocabulariesResponse#vocabularies #vocabularies} => Array&lt;Types::VocabularyInfo&gt;
953
+ #
954
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
955
+ #
956
+ # @example Request syntax with placeholder values
957
+ #
958
+ # resp = client.list_medical_vocabularies({
959
+ # next_token: "NextToken",
960
+ # max_results: 1,
961
+ # state_equals: "PENDING", # accepts PENDING, READY, FAILED
962
+ # name_contains: "VocabularyName",
963
+ # })
964
+ #
965
+ # @example Response structure
966
+ #
967
+ # resp.status #=> String, one of "PENDING", "READY", "FAILED"
968
+ # resp.next_token #=> String
969
+ # resp.vocabularies #=> Array
970
+ # resp.vocabularies[0].vocabulary_name #=> String
971
+ # resp.vocabularies[0].language_code #=> String, one of "en-US", "es-US", "en-AU", "fr-CA", "en-GB", "de-DE", "pt-BR", "fr-FR", "it-IT", "ko-KR", "es-ES", "en-IN", "hi-IN", "ar-SA", "ru-RU", "zh-CN", "nl-NL", "id-ID", "ta-IN", "fa-IR", "en-IE", "en-AB", "en-WL", "pt-PT", "te-IN", "tr-TR", "de-CH", "he-IL", "ms-MY", "ja-JP", "ar-AE"
972
+ # resp.vocabularies[0].last_modified_time #=> Time
973
+ # resp.vocabularies[0].vocabulary_state #=> String, one of "PENDING", "READY", "FAILED"
974
+ #
975
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListMedicalVocabularies AWS API Documentation
976
+ #
977
+ # @overload list_medical_vocabularies(params = {})
978
+ # @param [Hash] params ({})
979
+ def list_medical_vocabularies(params = {}, options = {})
980
+ req = build_request(:list_medical_vocabularies, params)
981
+ req.send_request(options)
982
+ end
983
+
659
984
  # Lists transcription jobs with the specified status.
660
985
  #
661
986
  # @option params [String] :status
@@ -683,6 +1008,8 @@ module Aws::TranscribeService
683
1008
  # * {Types::ListTranscriptionJobsResponse#next_token #next_token} => String
684
1009
  # * {Types::ListTranscriptionJobsResponse#transcription_job_summaries #transcription_job_summaries} => Array&lt;Types::TranscriptionJobSummary&gt;
685
1010
  #
1011
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1012
+ #
686
1013
  # @example Request syntax with placeholder values
687
1014
  #
688
1015
  # resp = client.list_transcription_jobs({
@@ -736,8 +1063,8 @@ module Aws::TranscribeService
736
1063
  # @option params [String] :name_contains
737
1064
  # When specified, the vocabularies returned in the list are limited to
738
1065
  # vocabularies whose name contains the specified string. The search is
739
- # case-insensitive, `ListVocabularies` will return both
740
- # "vocabularyname" and "VocabularyName" in the response list.
1066
+ # case-insensitive, `ListVocabularies` returns both "vocabularyname"
1067
+ # and "VocabularyName" in the response list.
741
1068
  #
742
1069
  # @return [Types::ListVocabulariesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
743
1070
  #
@@ -745,6 +1072,8 @@ module Aws::TranscribeService
745
1072
  # * {Types::ListVocabulariesResponse#next_token #next_token} => String
746
1073
  # * {Types::ListVocabulariesResponse#vocabularies #vocabularies} => Array&lt;Types::VocabularyInfo&gt;
747
1074
  #
1075
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1076
+ #
748
1077
  # @example Request syntax with placeholder values
749
1078
  #
750
1079
  # resp = client.list_vocabularies({
@@ -756,7 +1085,7 @@ module Aws::TranscribeService
756
1085
  #
757
1086
  # @example Response structure
758
1087
  #
759
- # resp.status #=> String, one of "QUEUED", "IN_PROGRESS", "FAILED", "COMPLETED"
1088
+ # resp.status #=> String, one of "PENDING", "READY", "FAILED"
760
1089
  # resp.next_token #=> String
761
1090
  # resp.vocabularies #=> Array
762
1091
  # resp.vocabularies[0].vocabulary_name #=> String
@@ -794,6 +1123,8 @@ module Aws::TranscribeService
794
1123
  # * {Types::ListVocabularyFiltersResponse#next_token #next_token} => String
795
1124
  # * {Types::ListVocabularyFiltersResponse#vocabulary_filters #vocabulary_filters} => Array&lt;Types::VocabularyFilterInfo&gt;
796
1125
  #
1126
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1127
+ #
797
1128
  # @example Request syntax with placeholder values
798
1129
  #
799
1130
  # resp = client.list_vocabulary_filters({
@@ -819,12 +1150,166 @@ module Aws::TranscribeService
819
1150
  req.send_request(options)
820
1151
  end
821
1152
 
1153
+ # Start a batch job to transcribe medical speech to text.
1154
+ #
1155
+ # @option params [required, String] :medical_transcription_job_name
1156
+ # The name of the medical transcription job. You can't use the strings
1157
+ # "." or ".." by themselves as the job name. The name must also be
1158
+ # unique within an AWS account. If you try to create a medical
1159
+ # transcription job with the same name as a previous medical
1160
+ # transcription job you will receive a `ConflictException` error.
1161
+ #
1162
+ # @option params [required, String] :language_code
1163
+ # The language code for the language spoken in the input media file. US
1164
+ # English (en-US) is the valid value for medical transcription jobs. Any
1165
+ # other value you enter for language code results in a
1166
+ # `BadRequestException` error.
1167
+ #
1168
+ # @option params [Integer] :media_sample_rate_hertz
1169
+ # The sample rate, in Hertz, of the audio track in the input media file.
1170
+ #
1171
+ # If you do not specify the media sample rate, Amazon Transcribe Medical
1172
+ # determines the sample rate. If you specify the sample rate, it must
1173
+ # match the rate detected by Amazon Transcribe Medical. In most cases,
1174
+ # you should leave the `MediaSampleRateHertz` field blank and let Amazon
1175
+ # Transcribe Medical determine the sample rate.
1176
+ #
1177
+ # @option params [String] :media_format
1178
+ # The audio format of the input media file.
1179
+ #
1180
+ # @option params [required, Types::Media] :media
1181
+ # Describes the input media file in a transcription request.
1182
+ #
1183
+ # @option params [required, String] :output_bucket_name
1184
+ # The Amazon S3 location where the transcription is stored.
1185
+ #
1186
+ # You must set `OutputBucketName` for Amazon Transcribe Medical to store
1187
+ # the transcription results. Your transcript appears in the S3 location
1188
+ # you specify. When you call the GetMedicalTranscriptionJob, the
1189
+ # operation returns this location in the `TranscriptFileUri` field. The
1190
+ # S3 bucket must have permissions that allow Amazon Transcribe Medical
1191
+ # to put files in the bucket. For more information, see [Permissions
1192
+ # Required for IAM User Roles][1].
1193
+ #
1194
+ # You can specify an AWS Key Management Service (KMS) key to encrypt the
1195
+ # output of your transcription using the `OutputEncryptionKMSKeyId`
1196
+ # parameter. If you don't specify a KMS key, Amazon Transcribe Medical
1197
+ # uses the default Amazon S3 key for server-side encryption of
1198
+ # transcripts that are placed in your S3 bucket.
1199
+ #
1200
+ #
1201
+ #
1202
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user
1203
+ #
1204
+ # @option params [String] :output_encryption_kms_key_id
1205
+ # The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS)
1206
+ # key used to encrypt the output of the transcription job. The user
1207
+ # calling the StartMedicalTranscriptionJob operation must have
1208
+ # permission to use the specified KMS key.
1209
+ #
1210
+ # You use either of the following to identify a KMS key in the current
1211
+ # account:
1212
+ #
1213
+ # * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
1214
+ #
1215
+ # * KMS Key Alias: "alias/ExampleAlias"
1216
+ #
1217
+ # You can use either of the following to identify a KMS key in the
1218
+ # current account or another account:
1219
+ #
1220
+ # * Amazon Resource Name (ARN) of a KMS key in the current account or
1221
+ # another account: "arn:aws:kms:region:account
1222
+ # ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"
1223
+ #
1224
+ # * ARN of a KMS Key Alias: "arn:aws:kms:region:account
1225
+ # ID:alias/ExampleAlias"
1226
+ #
1227
+ # If you don't specify an encryption key, the output of the medical
1228
+ # transcription job is encrypted with the default Amazon S3 key
1229
+ # (SSE-S3).
1230
+ #
1231
+ # If you specify a KMS key to encrypt your output, you must also specify
1232
+ # an output location in the `OutputBucketName` parameter.
1233
+ #
1234
+ # @option params [Types::MedicalTranscriptionSetting] :settings
1235
+ # Optional settings for the medical transcription job.
1236
+ #
1237
+ # @option params [required, String] :specialty
1238
+ # The medical specialty of any clinician speaking in the input media.
1239
+ #
1240
+ # @option params [required, String] :type
1241
+ # The type of speech in the input audio. `CONVERSATION` refers to
1242
+ # conversations between two or more speakers, e.g., a conversations
1243
+ # between doctors and patients. `DICTATION` refers to single-speaker
1244
+ # dictated speech, e.g., for clinical notes.
1245
+ #
1246
+ # @return [Types::StartMedicalTranscriptionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1247
+ #
1248
+ # * {Types::StartMedicalTranscriptionJobResponse#medical_transcription_job #medical_transcription_job} => Types::MedicalTranscriptionJob
1249
+ #
1250
+ # @example Request syntax with placeholder values
1251
+ #
1252
+ # resp = client.start_medical_transcription_job({
1253
+ # medical_transcription_job_name: "TranscriptionJobName", # required
1254
+ # language_code: "en-US", # required, accepts en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR, fr-FR, it-IT, ko-KR, es-ES, en-IN, hi-IN, ar-SA, ru-RU, zh-CN, nl-NL, id-ID, ta-IN, fa-IR, en-IE, en-AB, en-WL, pt-PT, te-IN, tr-TR, de-CH, he-IL, ms-MY, ja-JP, ar-AE
1255
+ # media_sample_rate_hertz: 1,
1256
+ # media_format: "mp3", # accepts mp3, mp4, wav, flac
1257
+ # media: { # required
1258
+ # media_file_uri: "Uri",
1259
+ # },
1260
+ # output_bucket_name: "OutputBucketName", # required
1261
+ # output_encryption_kms_key_id: "KMSKeyId",
1262
+ # settings: {
1263
+ # show_speaker_labels: false,
1264
+ # max_speaker_labels: 1,
1265
+ # channel_identification: false,
1266
+ # show_alternatives: false,
1267
+ # max_alternatives: 1,
1268
+ # vocabulary_name: "VocabularyName",
1269
+ # },
1270
+ # specialty: "PRIMARYCARE", # required, accepts PRIMARYCARE
1271
+ # type: "CONVERSATION", # required, accepts CONVERSATION, DICTATION
1272
+ # })
1273
+ #
1274
+ # @example Response structure
1275
+ #
1276
+ # resp.medical_transcription_job.medical_transcription_job_name #=> String
1277
+ # resp.medical_transcription_job.transcription_job_status #=> String, one of "QUEUED", "IN_PROGRESS", "FAILED", "COMPLETED"
1278
+ # resp.medical_transcription_job.language_code #=> String, one of "en-US", "es-US", "en-AU", "fr-CA", "en-GB", "de-DE", "pt-BR", "fr-FR", "it-IT", "ko-KR", "es-ES", "en-IN", "hi-IN", "ar-SA", "ru-RU", "zh-CN", "nl-NL", "id-ID", "ta-IN", "fa-IR", "en-IE", "en-AB", "en-WL", "pt-PT", "te-IN", "tr-TR", "de-CH", "he-IL", "ms-MY", "ja-JP", "ar-AE"
1279
+ # resp.medical_transcription_job.media_sample_rate_hertz #=> Integer
1280
+ # resp.medical_transcription_job.media_format #=> String, one of "mp3", "mp4", "wav", "flac"
1281
+ # resp.medical_transcription_job.media.media_file_uri #=> String
1282
+ # resp.medical_transcription_job.transcript.transcript_file_uri #=> String
1283
+ # resp.medical_transcription_job.start_time #=> Time
1284
+ # resp.medical_transcription_job.creation_time #=> Time
1285
+ # resp.medical_transcription_job.completion_time #=> Time
1286
+ # resp.medical_transcription_job.failure_reason #=> String
1287
+ # resp.medical_transcription_job.settings.show_speaker_labels #=> Boolean
1288
+ # resp.medical_transcription_job.settings.max_speaker_labels #=> Integer
1289
+ # resp.medical_transcription_job.settings.channel_identification #=> Boolean
1290
+ # resp.medical_transcription_job.settings.show_alternatives #=> Boolean
1291
+ # resp.medical_transcription_job.settings.max_alternatives #=> Integer
1292
+ # resp.medical_transcription_job.settings.vocabulary_name #=> String
1293
+ # resp.medical_transcription_job.specialty #=> String, one of "PRIMARYCARE"
1294
+ # resp.medical_transcription_job.type #=> String, one of "CONVERSATION", "DICTATION"
1295
+ #
1296
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartMedicalTranscriptionJob AWS API Documentation
1297
+ #
1298
+ # @overload start_medical_transcription_job(params = {})
1299
+ # @param [Hash] params ({})
1300
+ def start_medical_transcription_job(params = {}, options = {})
1301
+ req = build_request(:start_medical_transcription_job, params)
1302
+ req.send_request(options)
1303
+ end
1304
+
822
1305
  # Starts an asynchronous job to transcribe speech to text.
823
1306
  #
824
1307
  # @option params [required, String] :transcription_job_name
825
1308
  # The name of the job. Note that you can't use the strings "." or
826
1309
  # ".." by themselves as the job name. The name must also be unique
827
- # within an AWS account.
1310
+ # within an AWS account. If you try to create a transcription job with
1311
+ # the same name as a previous transcription job you will receive a
1312
+ # `ConflictException` error.
828
1313
  #
829
1314
  # @option params [required, String] :language_code
830
1315
  # The language code for the language used in the input media file.
@@ -988,12 +1473,83 @@ module Aws::TranscribeService
988
1473
  req.send_request(options)
989
1474
  end
990
1475
 
1476
+ # Updates an existing vocabulary with new values in a different text
1477
+ # file. The `UpdateMedicalVocabulary` operation overwrites all of the
1478
+ # existing information with the values that you provide in the request.
1479
+ #
1480
+ # @option params [required, String] :vocabulary_name
1481
+ # The name of the vocabulary to update. The name is case-sensitive. If
1482
+ # you try to update a vocabulary with the same name as a previous
1483
+ # vocabulary you will receive a `ConflictException` error.
1484
+ #
1485
+ # @option params [required, String] :language_code
1486
+ # The language code of the entries in the updated vocabulary. US English
1487
+ # (en-US) is the only valid language code in Amazon Transcribe Medical.
1488
+ #
1489
+ # @option params [String] :vocabulary_file_uri
1490
+ # The Amazon S3 location of the text file containing the definition of
1491
+ # the custom vocabulary. The URI must be in the same AWS region as the
1492
+ # API endpoint you are calling. You can see the fields you need to enter
1493
+ # for you Amazon S3 location in the example URI here:
1494
+ #
1495
+ # `
1496
+ # https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
1497
+ # `
1498
+ #
1499
+ # For example:
1500
+ #
1501
+ # `https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt`
1502
+ #
1503
+ # For more information about S3 object names, see [Object Keys][1] in
1504
+ # the *Amazon S3 Developer Guide*.
1505
+ #
1506
+ # For more information about custom vocabularies in Amazon Transcribe
1507
+ # Medical, see [Medical Custom Vocabularies][2].
1508
+ #
1509
+ #
1510
+ #
1511
+ # [1]: http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys
1512
+ # [2]: http://docs.aws.amazon.com/transcribe/latest/dg/how-it-works.html#how-vocabulary
1513
+ #
1514
+ # @return [Types::UpdateMedicalVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1515
+ #
1516
+ # * {Types::UpdateMedicalVocabularyResponse#vocabulary_name #vocabulary_name} => String
1517
+ # * {Types::UpdateMedicalVocabularyResponse#language_code #language_code} => String
1518
+ # * {Types::UpdateMedicalVocabularyResponse#last_modified_time #last_modified_time} => Time
1519
+ # * {Types::UpdateMedicalVocabularyResponse#vocabulary_state #vocabulary_state} => String
1520
+ #
1521
+ # @example Request syntax with placeholder values
1522
+ #
1523
+ # resp = client.update_medical_vocabulary({
1524
+ # vocabulary_name: "VocabularyName", # required
1525
+ # language_code: "en-US", # required, accepts en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR, fr-FR, it-IT, ko-KR, es-ES, en-IN, hi-IN, ar-SA, ru-RU, zh-CN, nl-NL, id-ID, ta-IN, fa-IR, en-IE, en-AB, en-WL, pt-PT, te-IN, tr-TR, de-CH, he-IL, ms-MY, ja-JP, ar-AE
1526
+ # vocabulary_file_uri: "Uri",
1527
+ # })
1528
+ #
1529
+ # @example Response structure
1530
+ #
1531
+ # resp.vocabulary_name #=> String
1532
+ # resp.language_code #=> String, one of "en-US", "es-US", "en-AU", "fr-CA", "en-GB", "de-DE", "pt-BR", "fr-FR", "it-IT", "ko-KR", "es-ES", "en-IN", "hi-IN", "ar-SA", "ru-RU", "zh-CN", "nl-NL", "id-ID", "ta-IN", "fa-IR", "en-IE", "en-AB", "en-WL", "pt-PT", "te-IN", "tr-TR", "de-CH", "he-IL", "ms-MY", "ja-JP", "ar-AE"
1533
+ # resp.last_modified_time #=> Time
1534
+ # resp.vocabulary_state #=> String, one of "PENDING", "READY", "FAILED"
1535
+ #
1536
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateMedicalVocabulary AWS API Documentation
1537
+ #
1538
+ # @overload update_medical_vocabulary(params = {})
1539
+ # @param [Hash] params ({})
1540
+ def update_medical_vocabulary(params = {}, options = {})
1541
+ req = build_request(:update_medical_vocabulary, params)
1542
+ req.send_request(options)
1543
+ end
1544
+
991
1545
  # Updates an existing vocabulary with new values. The `UpdateVocabulary`
992
1546
  # operation overwrites all of the existing information with the values
993
1547
  # that you provide in the request.
994
1548
  #
995
1549
  # @option params [required, String] :vocabulary_name
996
- # The name of the vocabulary to update. The name is case-sensitive.
1550
+ # The name of the vocabulary to update. The name is case-sensitive. If
1551
+ # you try to update a vocabulary with the same name as a previous
1552
+ # vocabulary you will receive a `ConflictException` error.
997
1553
  #
998
1554
  # @option params [required, String] :language_code
999
1555
  # The language code of the vocabulary entries.
@@ -1006,14 +1562,8 @@ module Aws::TranscribeService
1006
1562
  # custom vocabulary. The URI must be in the same region as the API
1007
1563
  # endpoint that you are calling. The general form is
1008
1564
  #
1009
- # `
1010
- # https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
1011
- # `
1012
- #
1013
1565
  # For example:
1014
1566
  #
1015
- # `https://s3.us-east-1.amazonaws.com/examplebucket/vocab.txt`
1016
- #
1017
1567
  # For more information about S3 object names, see [Object Keys][1] in
1018
1568
  # the *Amazon S3 Developer Guide*.
1019
1569
  #
@@ -1060,7 +1610,9 @@ module Aws::TranscribeService
1060
1610
  # Updates a vocabulary filter with a new list of filtered words.
1061
1611
  #
1062
1612
  # @option params [required, String] :vocabulary_filter_name
1063
- # The name of the vocabulary filter to update.
1613
+ # The name of the vocabulary filter to update. If you try to update a
1614
+ # vocabulary filter with the same name as a previous vocabulary filter
1615
+ # you will receive a `ConflictException` error.
1064
1616
  #
1065
1617
  # @option params [Array<String>] :words
1066
1618
  # The words to use in the vocabulary filter. Only use characters from
@@ -1132,7 +1684,7 @@ module Aws::TranscribeService
1132
1684
  params: params,
1133
1685
  config: config)
1134
1686
  context[:gem_name] = 'aws-sdk-transcribeservice'
1135
- context[:gem_version] = '1.38.0'
1687
+ context[:gem_version] = '1.43.0'
1136
1688
  Seahorse::Client::Request.new(handlers, context)
1137
1689
  end
1138
1690