aws-sdk-transcribeservice 1.38.0 → 1.39.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -6,13 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::TranscribeService
9
- # This class provides a resource oriented interface for TranscribeService.
10
- # To create a resource object:
11
- # resource = Aws::TranscribeService::Resource.new(region: 'us-west-2')
12
- # You can supply a client object with custom configuration that will be used for all resource operations.
13
- # If you do not pass +:client+, a default client will be constructed.
14
- # client = Aws::TranscribeService::Client.new(region: 'us-west-2')
15
- # resource = Aws::TranscribeService::Resource.new(client: client)
9
+
16
10
  class Resource
17
11
 
18
12
  # @param options ({})
@@ -42,13 +42,6 @@ module Aws::TranscribeService
42
42
 
43
43
  # Settings for content redaction within a transcription job.
44
44
  #
45
- # You can redact transcripts in US English (en-us). For more information
46
- # see: [Automatic Content Redaction][1]
47
- #
48
- #
49
- #
50
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/content-redaction.html
51
- #
52
45
  # @note When making an API call, you may pass ContentRedaction
53
46
  # data as a hash:
54
47
  #
@@ -63,15 +56,14 @@ module Aws::TranscribeService
63
56
  # @return [String]
64
57
  #
65
58
  # @!attribute [rw] redaction_output
66
- # Request parameter where you choose whether to output only the
67
- # redacted transcript or generate an additional unredacted transcript.
59
+ # The output transcript file stored in either the default S3 bucket or
60
+ # in a bucket you specify.
68
61
  #
69
- # When you choose `redacted` Amazon Transcribe outputs a JSON file
70
- # with only the redacted transcript and related information.
62
+ # When you choose `redacted` Amazon Transcribe outputs only the
63
+ # redacted transcript.
71
64
  #
72
65
  # When you choose `redacted_and_unredacted` Amazon Transcribe outputs
73
- # a JSON file with the unredacted transcript and related information
74
- # in addition to the JSON file with the redacted transcript.
66
+ # both the redacted and unredacted transcripts.
75
67
  # @return [String]
76
68
  #
77
69
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ContentRedaction AWS API Documentation
@@ -256,6 +248,25 @@ module Aws::TranscribeService
256
248
  include Aws::Structure
257
249
  end
258
250
 
251
+ # @note When making an API call, you may pass DeleteMedicalTranscriptionJobRequest
252
+ # data as a hash:
253
+ #
254
+ # {
255
+ # medical_transcription_job_name: "TranscriptionJobName", # required
256
+ # }
257
+ #
258
+ # @!attribute [rw] medical_transcription_job_name
259
+ # The name you provide to the `DeleteMedicalTranscriptionJob` object
260
+ # to delete a transcription job.
261
+ # @return [String]
262
+ #
263
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteMedicalTranscriptionJobRequest AWS API Documentation
264
+ #
265
+ class DeleteMedicalTranscriptionJobRequest < Struct.new(
266
+ :medical_transcription_job_name)
267
+ include Aws::Structure
268
+ end
269
+
259
270
  # @note When making an API call, you may pass DeleteTranscriptionJobRequest
260
271
  # data as a hash:
261
272
  #
@@ -310,6 +321,36 @@ module Aws::TranscribeService
310
321
  include Aws::Structure
311
322
  end
312
323
 
324
+ # @note When making an API call, you may pass GetMedicalTranscriptionJobRequest
325
+ # data as a hash:
326
+ #
327
+ # {
328
+ # medical_transcription_job_name: "TranscriptionJobName", # required
329
+ # }
330
+ #
331
+ # @!attribute [rw] medical_transcription_job_name
332
+ # The name of the medical transcription job.
333
+ # @return [String]
334
+ #
335
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetMedicalTranscriptionJobRequest AWS API Documentation
336
+ #
337
+ class GetMedicalTranscriptionJobRequest < Struct.new(
338
+ :medical_transcription_job_name)
339
+ include Aws::Structure
340
+ end
341
+
342
+ # @!attribute [rw] medical_transcription_job
343
+ # An object that contains the results of the medical transcription
344
+ # job.
345
+ # @return [Types::MedicalTranscriptionJob]
346
+ #
347
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetMedicalTranscriptionJobResponse AWS API Documentation
348
+ #
349
+ class GetMedicalTranscriptionJobResponse < Struct.new(
350
+ :medical_transcription_job)
351
+ include Aws::Structure
352
+ end
353
+
313
354
  # @note When making an API call, you may pass GetTranscriptionJobRequest
314
355
  # data as a hash:
315
356
  #
@@ -470,10 +511,10 @@ module Aws::TranscribeService
470
511
  # @!attribute [rw] allow_deferred_execution
471
512
  # Indicates whether a job should be queued by Amazon Transcribe when
472
513
  # the concurrent execution limit is exceeded. When the
473
- # `AllowDeferredExecution` field is true, jobs are queued and will be
474
- # executed when the number of executing jobs falls below the
475
- # concurrent execution limit. If the field is false, Amazon Transcribe
476
- # returns a `LimitExceededException` exception.
514
+ # `AllowDeferredExecution` field is true, jobs are queued and executed
515
+ # when the number of executing jobs falls below the concurrent
516
+ # execution limit. If the field is false, Amazon Transcribe returns a
517
+ # `LimitExceededException` exception.
477
518
  #
478
519
  # If you specify the `AllowDeferredExecution` field, you must specify
479
520
  # the `DataAccessRoleArn` field.
@@ -481,10 +522,10 @@ module Aws::TranscribeService
481
522
  #
482
523
  # @!attribute [rw] data_access_role_arn
483
524
  # The Amazon Resource Name (ARN) of a role that has access to the S3
484
- # bucket that contains the input files. Amazon Transcribe will assume
485
- # this role to read queued media files. If you have specified an
486
- # output S3 bucket for the transcription results, this role should
487
- # have access to the output bucket as well.
525
+ # bucket that contains the input files. Amazon Transcribe assumes this
526
+ # role to read queued media files. If you have specified an output S3
527
+ # bucket for the transcription results, this role should have access
528
+ # to the output bucket as well.
488
529
  #
489
530
  # If you specify the `AllowDeferredExecution` field, you must specify
490
531
  # the `DataAccessRoleArn` field.
@@ -512,6 +553,78 @@ module Aws::TranscribeService
512
553
  include Aws::Structure
513
554
  end
514
555
 
556
+ # @note When making an API call, you may pass ListMedicalTranscriptionJobsRequest
557
+ # data as a hash:
558
+ #
559
+ # {
560
+ # status: "QUEUED", # accepts QUEUED, IN_PROGRESS, FAILED, COMPLETED
561
+ # job_name_contains: "TranscriptionJobName",
562
+ # next_token: "NextToken",
563
+ # max_results: 1,
564
+ # }
565
+ #
566
+ # @!attribute [rw] status
567
+ # When specified, returns only medical transcription jobs with the
568
+ # specified status. Jobs are ordered by creation date, with the newest
569
+ # jobs returned first. If you don't specify a status, Amazon
570
+ # Transcribe Medical returns all transcription jobs ordered by
571
+ # creation date.
572
+ # @return [String]
573
+ #
574
+ # @!attribute [rw] job_name_contains
575
+ # When specified, the jobs returned in the list are limited to jobs
576
+ # whose name contains the specified string.
577
+ # @return [String]
578
+ #
579
+ # @!attribute [rw] next_token
580
+ # If you a receive a truncated result in the previous request of
581
+ # `ListMedicalTranscriptionJobs`, include `NextToken` to fetch the
582
+ # next set of jobs.
583
+ # @return [String]
584
+ #
585
+ # @!attribute [rw] max_results
586
+ # The maximum number of medical transcription jobs to return in the
587
+ # response. IF there are fewer results in the list, this response
588
+ # contains only the actual results.
589
+ # @return [Integer]
590
+ #
591
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListMedicalTranscriptionJobsRequest AWS API Documentation
592
+ #
593
+ class ListMedicalTranscriptionJobsRequest < Struct.new(
594
+ :status,
595
+ :job_name_contains,
596
+ :next_token,
597
+ :max_results)
598
+ include Aws::Structure
599
+ end
600
+
601
+ # @!attribute [rw] status
602
+ # The requested status of the medical transcription jobs returned.
603
+ # @return [String]
604
+ #
605
+ # @!attribute [rw] next_token
606
+ # The `ListMedicalTranscriptionJobs` operation returns a page of jobs
607
+ # at a time. The maximum size of the page is set by the `MaxResults`
608
+ # parameter. If the number of jobs exceeds what can fit on a page,
609
+ # Amazon Transcribe Medical returns the `NextPage` token. Include the
610
+ # token in the next request to the `ListMedicalTranscriptionJobs`
611
+ # operation to return in the next page of jobs.
612
+ # @return [String]
613
+ #
614
+ # @!attribute [rw] medical_transcription_job_summaries
615
+ # A list of objects containing summary information for a transcription
616
+ # job.
617
+ # @return [Array<Types::MedicalTranscriptionJobSummary>]
618
+ #
619
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListMedicalTranscriptionJobsResponse AWS API Documentation
620
+ #
621
+ class ListMedicalTranscriptionJobsResponse < Struct.new(
622
+ :status,
623
+ :next_token,
624
+ :medical_transcription_job_summaries)
625
+ include Aws::Structure
626
+ end
627
+
515
628
  # @note When making an API call, you may pass ListTranscriptionJobsRequest
516
629
  # data as a hash:
517
630
  #
@@ -611,8 +724,8 @@ module Aws::TranscribeService
611
724
  # @!attribute [rw] name_contains
612
725
  # When specified, the vocabularies returned in the list are limited to
613
726
  # vocabularies whose name contains the specified string. The search is
614
- # case-insensitive, `ListVocabularies` will return both
615
- # "vocabularyname" and "VocabularyName" in the response list.
727
+ # case-insensitive, `ListVocabularies` returns both "vocabularyname"
728
+ # and "VocabularyName" in the response list.
616
729
  # @return [String]
617
730
  #
618
731
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListVocabulariesRequest AWS API Documentation
@@ -697,7 +810,7 @@ module Aws::TranscribeService
697
810
  # @return [String]
698
811
  #
699
812
  # @!attribute [rw] vocabulary_filters
700
- # The list of vocabulary filters. It will contain at most `MaxResults`
813
+ # The list of vocabulary filters. It contains at most `MaxResults`
701
814
  # number of filters. If there are more filters, call the
702
815
  # `ListVocabularyFilters` operation again with the `NextToken`
703
816
  # parameter in the request set to the value of the `NextToken` field
@@ -749,6 +862,298 @@ module Aws::TranscribeService
749
862
  include Aws::Structure
750
863
  end
751
864
 
865
+ # Identifies the location of a medical transcript.
866
+ #
867
+ # @!attribute [rw] transcript_file_uri
868
+ # The S3 object location of the medical transcript.
869
+ #
870
+ # Use this URI to access the medical transcript. This URI points to
871
+ # the S3 bucket you created to store the medical transcript.
872
+ # @return [String]
873
+ #
874
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/MedicalTranscript AWS API Documentation
875
+ #
876
+ class MedicalTranscript < Struct.new(
877
+ :transcript_file_uri)
878
+ include Aws::Structure
879
+ end
880
+
881
+ # The data structure that containts the information for a medical
882
+ # transcription job.
883
+ #
884
+ # @!attribute [rw] medical_transcription_job_name
885
+ # The name for a given medical transcription job.
886
+ # @return [String]
887
+ #
888
+ # @!attribute [rw] transcription_job_status
889
+ # The completion status of a medical transcription job.
890
+ # @return [String]
891
+ #
892
+ # @!attribute [rw] language_code
893
+ # The language code for the language spoken in the source audio file.
894
+ # US English (en-US) is the only supported language for medical
895
+ # transcriptions. Any other value you enter for language code results
896
+ # in a `BadRequestException` error.
897
+ # @return [String]
898
+ #
899
+ # @!attribute [rw] media_sample_rate_hertz
900
+ # The sample rate, in Hertz, of the source audio containing medical
901
+ # information.
902
+ #
903
+ # If you don't specify the sample rate, Amazon Transcribe Medical
904
+ # determines it for you. If you choose to specify the sample rate, it
905
+ # must match the rate detected by Amazon Transcribe Medical. In most
906
+ # cases, you should leave the `MediaSampleHertz` blank and let Amazon
907
+ # Transcribe Medical determine the sample rate.
908
+ # @return [Integer]
909
+ #
910
+ # @!attribute [rw] media_format
911
+ # The format of the input media file.
912
+ # @return [String]
913
+ #
914
+ # @!attribute [rw] media
915
+ # Describes the input media file in a transcription request.
916
+ # @return [Types::Media]
917
+ #
918
+ # @!attribute [rw] transcript
919
+ # An object that contains the `MedicalTranscript`. The
920
+ # `MedicalTranscript` contains the `TranscriptFileUri`.
921
+ # @return [Types::MedicalTranscript]
922
+ #
923
+ # @!attribute [rw] start_time
924
+ # A timestamp that shows when the job started processing.
925
+ # @return [Time]
926
+ #
927
+ # @!attribute [rw] creation_time
928
+ # A timestamp that shows when the job was created.
929
+ # @return [Time]
930
+ #
931
+ # @!attribute [rw] completion_time
932
+ # A timestamp that shows when the job was completed.
933
+ # @return [Time]
934
+ #
935
+ # @!attribute [rw] failure_reason
936
+ # If the `TranscriptionJobStatus` field is `FAILED`, this field
937
+ # contains information about why the job failed.
938
+ #
939
+ # The `FailureReason` field contains one of the following values:
940
+ #
941
+ # * `Unsupported media format`- The media format specified in the
942
+ # `MediaFormat` field of the request isn't valid. See the
943
+ # description of the `MediaFormat` field for a list of valid values.
944
+ #
945
+ # * `The media format provided does not match the detected media
946
+ # format`- The media format of the audio file doesn't match the
947
+ # format specified in the `MediaFormat` field in the request. Check
948
+ # the media format of your media file and make sure the two values
949
+ # match.
950
+ #
951
+ # * `Invalid sample rate for audio file`- The sample rate specified in
952
+ # the `MediaSampleRateHertz` of the request isn't valid. The sample
953
+ # rate must be between 8000 and 48000 Hertz.
954
+ #
955
+ # * `The sample rate provided does not match the detected sample
956
+ # rate`- The sample rate in the audio file doesn't match the sample
957
+ # rate specified in the `MediaSampleRateHertz` field in the request.
958
+ # Check the sample rate of your media file and make sure that the
959
+ # two values match.
960
+ #
961
+ # * `Invalid file size: file size too large`- The size of your audio
962
+ # file is larger than what Amazon Transcribe Medical can process.
963
+ # For more information, see [Guidlines and Quotas][1] in the *Amazon
964
+ # Transcribe Medical Guide*
965
+ #
966
+ # * `Invalid number of channels: number of channels too large`- Your
967
+ # audio contains more channels than Amazon Transcribe Medical is
968
+ # configured to process. To request additional channels, see [Amazon
969
+ # Transcribe Medical Endpoints and Quotas][2] in the *Amazon Web
970
+ # Services General Reference*
971
+ #
972
+ #
973
+ #
974
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits
975
+ # [2]: https://docs.aws.amazon.com/general/latest/gr/transcribe-medical.html
976
+ # @return [String]
977
+ #
978
+ # @!attribute [rw] settings
979
+ # Object that contains object.
980
+ # @return [Types::MedicalTranscriptionSetting]
981
+ #
982
+ # @!attribute [rw] specialty
983
+ # The medical specialty of any clinicians providing a dictation or
984
+ # having a conversation. `PRIMARYCARE` is the only available setting
985
+ # for this object. This specialty enables you to generate
986
+ # transcriptions for the following medical fields:
987
+ #
988
+ # * Family Medicine
989
+ #
990
+ # ^
991
+ # @return [String]
992
+ #
993
+ # @!attribute [rw] type
994
+ # The type of speech in the transcription job. `CONVERSATION` is
995
+ # generally used for patient-physician dialogues. `DICTATION` is the
996
+ # setting for physicians speaking their notes after seeing a patient.
997
+ # For more information, see how-it-works-med
998
+ # @return [String]
999
+ #
1000
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/MedicalTranscriptionJob AWS API Documentation
1001
+ #
1002
+ class MedicalTranscriptionJob < Struct.new(
1003
+ :medical_transcription_job_name,
1004
+ :transcription_job_status,
1005
+ :language_code,
1006
+ :media_sample_rate_hertz,
1007
+ :media_format,
1008
+ :media,
1009
+ :transcript,
1010
+ :start_time,
1011
+ :creation_time,
1012
+ :completion_time,
1013
+ :failure_reason,
1014
+ :settings,
1015
+ :specialty,
1016
+ :type)
1017
+ include Aws::Structure
1018
+ end
1019
+
1020
+ # Provides summary information about a transcription job.
1021
+ #
1022
+ # @!attribute [rw] medical_transcription_job_name
1023
+ # The name of a medical transcription job.
1024
+ # @return [String]
1025
+ #
1026
+ # @!attribute [rw] creation_time
1027
+ # A timestamp that shows when the medical transcription job was
1028
+ # created.
1029
+ # @return [Time]
1030
+ #
1031
+ # @!attribute [rw] start_time
1032
+ # A timestamp that shows when the job began processing.
1033
+ # @return [Time]
1034
+ #
1035
+ # @!attribute [rw] completion_time
1036
+ # A timestamp that shows when the job was completed.
1037
+ # @return [Time]
1038
+ #
1039
+ # @!attribute [rw] language_code
1040
+ # The language of the transcript in the source audio file.
1041
+ # @return [String]
1042
+ #
1043
+ # @!attribute [rw] transcription_job_status
1044
+ # The status of the medical transcription job.
1045
+ # @return [String]
1046
+ #
1047
+ # @!attribute [rw] failure_reason
1048
+ # If the `TranscriptionJobStatus` field is `FAILED`, a description of
1049
+ # the error.
1050
+ # @return [String]
1051
+ #
1052
+ # @!attribute [rw] output_location_type
1053
+ # Indicates the location of the transcription job's output.
1054
+ #
1055
+ # The `CUSTOMER_BUCKET` is the S3 location provided in the
1056
+ # `OutputBucketName` field when the
1057
+ # @return [String]
1058
+ #
1059
+ # @!attribute [rw] specialty
1060
+ # The medical specialty of the transcription job. `Primary care` is
1061
+ # the only valid value.
1062
+ # @return [String]
1063
+ #
1064
+ # @!attribute [rw] type
1065
+ # The speech of the clinician in the input audio.
1066
+ # @return [String]
1067
+ #
1068
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/MedicalTranscriptionJobSummary AWS API Documentation
1069
+ #
1070
+ class MedicalTranscriptionJobSummary < Struct.new(
1071
+ :medical_transcription_job_name,
1072
+ :creation_time,
1073
+ :start_time,
1074
+ :completion_time,
1075
+ :language_code,
1076
+ :transcription_job_status,
1077
+ :failure_reason,
1078
+ :output_location_type,
1079
+ :specialty,
1080
+ :type)
1081
+ include Aws::Structure
1082
+ end
1083
+
1084
+ # Optional settings for the StartMedicalTranscriptionJob operation.
1085
+ #
1086
+ # @note When making an API call, you may pass MedicalTranscriptionSetting
1087
+ # data as a hash:
1088
+ #
1089
+ # {
1090
+ # show_speaker_labels: false,
1091
+ # max_speaker_labels: 1,
1092
+ # channel_identification: false,
1093
+ # show_alternatives: false,
1094
+ # max_alternatives: 1,
1095
+ # }
1096
+ #
1097
+ # @!attribute [rw] show_speaker_labels
1098
+ # Determines whether the transcription job uses speaker recognition to
1099
+ # identify different speakers in the input audio. Speaker recongition
1100
+ # labels individual speakers in the audio file. If you set the
1101
+ # `ShowSpeakerLabels` field to true, you must also set the maximum
1102
+ # number of speaker labels in the `MaxSpeakerLabels` field.
1103
+ #
1104
+ # You can't set both `ShowSpeakerLabels` and `ChannelIdentification`
1105
+ # in the same request. If you set both, your request returns a
1106
+ # `BadRequestException`.
1107
+ # @return [Boolean]
1108
+ #
1109
+ # @!attribute [rw] max_speaker_labels
1110
+ # The maximum number of speakers to identify in the input audio. If
1111
+ # there are more speakers in the audio than this number, multiple
1112
+ # speakers are identified as a single speaker. If you specify the
1113
+ # `MaxSpeakerLabels` field, you must set the `ShowSpeakerLabels` field
1114
+ # to true.
1115
+ # @return [Integer]
1116
+ #
1117
+ # @!attribute [rw] channel_identification
1118
+ # Instructs Amazon Transcribe Medical to process each audio channel
1119
+ # separately and then merge the transcription output of each channel
1120
+ # into a single transcription.
1121
+ #
1122
+ # Amazon Transcribe Medical also produces a transcription of each item
1123
+ # detected on an audio channel, including the start time and end time
1124
+ # of the item and alternative transcriptions of item. The alternative
1125
+ # transcriptions also come with confidence scores provided by Amazon
1126
+ # Transcribe Medical.
1127
+ #
1128
+ # You can't set both `ShowSpeakerLabels` and `ChannelIdentification`
1129
+ # in the same request. If you set both, your request returns a
1130
+ # `BadRequestException`
1131
+ # @return [Boolean]
1132
+ #
1133
+ # @!attribute [rw] show_alternatives
1134
+ # Determines whether alternative transcripts are generated along with
1135
+ # the transcript that has the highest confidence. If you set
1136
+ # `ShowAlternatives` field to true, you must also set the maximum
1137
+ # number of alternatives to return in the `MaxAlternatives` field.
1138
+ # @return [Boolean]
1139
+ #
1140
+ # @!attribute [rw] max_alternatives
1141
+ # The maximum number of alternatives that you tell the service to
1142
+ # return. If you specify the `MaxAlternatives` field, you must set the
1143
+ # `ShowAlternatives` field to true.
1144
+ # @return [Integer]
1145
+ #
1146
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/MedicalTranscriptionSetting AWS API Documentation
1147
+ #
1148
+ class MedicalTranscriptionSetting < Struct.new(
1149
+ :show_speaker_labels,
1150
+ :max_speaker_labels,
1151
+ :channel_identification,
1152
+ :show_alternatives,
1153
+ :max_alternatives)
1154
+ include Aws::Structure
1155
+ end
1156
+
752
1157
  # We can't find the requested resource. Check the name and try your
753
1158
  # request again.
754
1159
  #
@@ -798,7 +1203,7 @@ module Aws::TranscribeService
798
1203
  # @!attribute [rw] max_speaker_labels
799
1204
  # The maximum number of speakers to identify in the input audio. If
800
1205
  # there are more speakers in the audio than this number, multiple
801
- # speakers will be identified as a single speaker. If you specify the
1206
+ # speakers are identified as a single speaker. If you specify the
802
1207
  # `MaxSpeakerLabels` field, you must set the `ShowSpeakerLabels` field
803
1208
  # to true.
804
1209
  # @return [Integer]
@@ -858,6 +1263,158 @@ module Aws::TranscribeService
858
1263
  include Aws::Structure
859
1264
  end
860
1265
 
1266
+ # @note When making an API call, you may pass StartMedicalTranscriptionJobRequest
1267
+ # data as a hash:
1268
+ #
1269
+ # {
1270
+ # medical_transcription_job_name: "TranscriptionJobName", # required
1271
+ # 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
1272
+ # media_sample_rate_hertz: 1,
1273
+ # media_format: "mp3", # accepts mp3, mp4, wav, flac
1274
+ # media: { # required
1275
+ # media_file_uri: "Uri",
1276
+ # },
1277
+ # output_bucket_name: "OutputBucketName", # required
1278
+ # output_encryption_kms_key_id: "KMSKeyId",
1279
+ # settings: {
1280
+ # show_speaker_labels: false,
1281
+ # max_speaker_labels: 1,
1282
+ # channel_identification: false,
1283
+ # show_alternatives: false,
1284
+ # max_alternatives: 1,
1285
+ # },
1286
+ # specialty: "PRIMARYCARE", # required, accepts PRIMARYCARE
1287
+ # type: "CONVERSATION", # required, accepts CONVERSATION, DICTATION
1288
+ # }
1289
+ #
1290
+ # @!attribute [rw] medical_transcription_job_name
1291
+ # The name of the medical transcription job. You can't use the
1292
+ # strings "." or ".." by themselves as the job name. The name must
1293
+ # also be unique within an AWS account.
1294
+ # @return [String]
1295
+ #
1296
+ # @!attribute [rw] language_code
1297
+ # The language code for the language spoken in the input media file.
1298
+ # US English (en-US) is the valid value for medical transcription
1299
+ # jobs. Any other value you enter for language code results in a
1300
+ # `BadRequestException` error.
1301
+ # @return [String]
1302
+ #
1303
+ # @!attribute [rw] media_sample_rate_hertz
1304
+ # The sample rate, in Hertz, of the audio track in the input media
1305
+ # file.
1306
+ #
1307
+ # If you do not specify the media sample rate, Amazon Transcribe
1308
+ # Medical determines the sample rate. If you specify the sample rate,
1309
+ # it must match the rate detected by Amazon Transcribe Medical. In
1310
+ # most cases, you should leave the `MediaSampleRateHertz` field blank
1311
+ # and let Amazon Transcribe Medical determine the sample rate.
1312
+ # @return [Integer]
1313
+ #
1314
+ # @!attribute [rw] media_format
1315
+ # The audio format of the input media file.
1316
+ # @return [String]
1317
+ #
1318
+ # @!attribute [rw] media
1319
+ # Describes the input media file in a transcription request.
1320
+ # @return [Types::Media]
1321
+ #
1322
+ # @!attribute [rw] output_bucket_name
1323
+ # The Amazon S3 location where the transcription is stored.
1324
+ #
1325
+ # You must set `OutputBucketName` for Amazon Transcribe Medical to
1326
+ # store the transcription results. Your transcript appears in the S3
1327
+ # location you specify. When you call the GetMedicalTranscriptionJob,
1328
+ # the operation returns this location in the `TranscriptFileUri`
1329
+ # field. The S3 bucket must have permissions that allow Amazon
1330
+ # Transcribe Medical to put files in the bucket. For more information,
1331
+ # see [Permissions Required for IAM User Roles][1].
1332
+ #
1333
+ # You can specify an AWS Key Management Service (KMS) key to encrypt
1334
+ # the output of your transcription using the
1335
+ # `OutputEncryptionKMSKeyId` parameter. If you don't specify a KMS
1336
+ # key, Amazon Transcribe Medical uses the default Amazon S3 key for
1337
+ # server-side encryption of transcripts that are placed in your S3
1338
+ # bucket.
1339
+ #
1340
+ #
1341
+ #
1342
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user
1343
+ # @return [String]
1344
+ #
1345
+ # @!attribute [rw] output_encryption_kms_key_id
1346
+ # The Amazon Resource Name (ARN) of the AWS Key Management Service
1347
+ # (KMS) key used to encrypt the output of the transcription job. The
1348
+ # user calling the StartMedicalTranscriptionJob operation must have
1349
+ # permission to use the specified KMS key.
1350
+ #
1351
+ # You use either of the following to identify a KMS key in the current
1352
+ # account:
1353
+ #
1354
+ # * KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
1355
+ #
1356
+ # * KMS Key Alias: "alias/ExampleAlias"
1357
+ #
1358
+ # You can use either of the following to identify a KMS key in the
1359
+ # current account or another account:
1360
+ #
1361
+ # * Amazon Resource Name (ARN) of a KMS key in the current account or
1362
+ # another account: "arn:aws:kms:region:account
1363
+ # ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"
1364
+ #
1365
+ # * ARN of a KMS Key Alias: "arn:aws:kms:region:account
1366
+ # ID:alias/ExampleAlias"
1367
+ #
1368
+ # If you don't specify an encryption key, the output of the medical
1369
+ # transcription job is encrypted with the default Amazon S3 key
1370
+ # (SSE-S3).
1371
+ #
1372
+ # If you specify a KMS key to encrypt your output, you must also
1373
+ # specify an output location in the `OutputBucketName` parameter.
1374
+ # @return [String]
1375
+ #
1376
+ # @!attribute [rw] settings
1377
+ # Optional settings for the medical transcription job.
1378
+ # @return [Types::MedicalTranscriptionSetting]
1379
+ #
1380
+ # @!attribute [rw] specialty
1381
+ # The medical specialty of any clinician speaking in the input media.
1382
+ # @return [String]
1383
+ #
1384
+ # @!attribute [rw] type
1385
+ # The speech of clinician in the input audio. `CONVERSATION` refers to
1386
+ # conversations clinicians have with patients. `DICTATION` refers to
1387
+ # medical professionals dictating their notes about a patient
1388
+ # encounter.
1389
+ # @return [String]
1390
+ #
1391
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartMedicalTranscriptionJobRequest AWS API Documentation
1392
+ #
1393
+ class StartMedicalTranscriptionJobRequest < Struct.new(
1394
+ :medical_transcription_job_name,
1395
+ :language_code,
1396
+ :media_sample_rate_hertz,
1397
+ :media_format,
1398
+ :media,
1399
+ :output_bucket_name,
1400
+ :output_encryption_kms_key_id,
1401
+ :settings,
1402
+ :specialty,
1403
+ :type)
1404
+ include Aws::Structure
1405
+ end
1406
+
1407
+ # @!attribute [rw] medical_transcription_job
1408
+ # A batch job submitted to transcribe medical speech to text.
1409
+ # @return [Types::MedicalTranscriptionJob]
1410
+ #
1411
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartMedicalTranscriptionJobResponse AWS API Documentation
1412
+ #
1413
+ class StartMedicalTranscriptionJobResponse < Struct.new(
1414
+ :medical_transcription_job)
1415
+ include Aws::Structure
1416
+ end
1417
+
861
1418
  # @note When making an API call, you may pass StartTranscriptionJobRequest
862
1419
  # data as a hash:
863
1420
  #