aws-sdk-transcribeservice 1.92.0 → 1.93.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.
@@ -115,7 +115,7 @@ module Aws::TranscribeService
115
115
  # of supported languages and their associated language codes, refer to
116
116
  # the [Supported languages][1] table.
117
117
  #
118
- # If you don't know the language spoken in your media file, you can
118
+ # If you do not know the language spoken in your media file, you can
119
119
  # omit this field and let Amazon Transcribe automatically identify the
120
120
  # language of your media. To improve the accuracy of language
121
121
  # identification, you can include several language codes and Amazon
@@ -182,7 +182,8 @@ module Aws::TranscribeService
182
182
  # * `Unsupported media format`.
183
183
  #
184
184
  # The media format specified in `MediaFormat` isn't valid. Refer to
185
- # **MediaFormat** for a list of supported formats.
185
+ # refer to the `MediaFormat` parameter for a list of supported
186
+ # formats.
186
187
  #
187
188
  # * `The media format provided does not match the detected media
188
189
  # format`.
@@ -206,18 +207,16 @@ module Aws::TranscribeService
206
207
  # * `Invalid file size: file size too large`.
207
208
  #
208
209
  # The size of your media file is larger than what Amazon Transcribe
209
- # can process. For more information, refer to [Guidelines and
210
- # quotas][1].
210
+ # can process. For more information, refer to [Service quotas][1].
211
211
  #
212
212
  # * `Invalid number of channels: number of channels too large`.
213
213
  #
214
214
  # Your audio contains more channels than Amazon Transcribe is able
215
- # to process. For more information, refer to [Guidelines and
216
- # quotas][1].
215
+ # to process. For more information, refer to [Service quotas][1].
217
216
  #
218
217
  #
219
218
  #
220
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits
219
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe
221
220
  # @return [String]
222
221
  #
223
222
  # @!attribute [rw] data_access_role_arn
@@ -303,7 +302,7 @@ module Aws::TranscribeService
303
302
  #
304
303
  # The language of the specified custom language model must match the
305
304
  # language code that you specify in your transcription request. If the
306
- # languages don't match, the custom language model isn't applied.
305
+ # languages do not match, the custom language model isn't applied.
307
306
  # There are no errors or warnings associated with a language mismatch.
308
307
  # @return [String]
309
308
  #
@@ -311,7 +310,8 @@ module Aws::TranscribeService
311
310
  # Makes it possible to redact or flag specified personally
312
311
  # identifiable information (PII) in your transcript. If you use
313
312
  # `ContentRedaction`, you must also include the sub-parameters:
314
- # `PiiEntityTypes`, `RedactionOutput`, and `RedactionType`.
313
+ # `RedactionOutput` and `RedactionType`. You can optionally include
314
+ # `PiiEntityTypes` to choose which types of PII you want to redact.
315
315
  # @return [Types::ContentRedaction]
316
316
  #
317
317
  # @!attribute [rw] language_options
@@ -551,14 +551,16 @@ module Aws::TranscribeService
551
551
 
552
552
  # Makes it possible to redact or flag specified personally identifiable
553
553
  # information (PII) in your transcript. If you use `ContentRedaction`,
554
- # you must also include the sub-parameters: `PiiEntityTypes`,
555
- # `RedactionOutput`, and `RedactionType`.
554
+ # you must also include the sub-parameters: `RedactionOutput` and
555
+ # `RedactionType`. You can optionally include `PiiEntityTypes` to choose
556
+ # which types of PII you want to redact.
556
557
  #
557
558
  # @!attribute [rw] redaction_type
558
559
  # Specify the category of information you want to redact; `PII`
559
560
  # (personally identifiable information) is the only valid value. You
560
561
  # can use `PiiEntityTypes` to choose which types of PII you want to
561
- # redact.
562
+ # redact. If you do not include `PiiEntityTypes` in your request, all
563
+ # PII is redacted.
562
564
  # @return [String]
563
565
  #
564
566
  # @!attribute [rw] redaction_output
@@ -575,7 +577,8 @@ module Aws::TranscribeService
575
577
  # @!attribute [rw] pii_entity_types
576
578
  # Specify which types of personally identifiable information (PII) you
577
579
  # want to redact in your transcript. You can include as many types as
578
- # you'd like, or you can select `ALL`.
580
+ # you'd like, or you can select `ALL`. If you do not include
581
+ # `PiiEntityTypes` in your request, all PII is redacted.
579
582
  # @return [Array<String>]
580
583
  #
581
584
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ContentRedaction AWS API Documentation
@@ -1184,6 +1187,19 @@ module Aws::TranscribeService
1184
1187
  include Aws::Structure
1185
1188
  end
1186
1189
 
1190
+ # @!attribute [rw] medical_scribe_job_name
1191
+ # The name of the Medical Scribe job you want to delete. Job names are
1192
+ # case sensitive.
1193
+ # @return [String]
1194
+ #
1195
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteMedicalScribeJobRequest AWS API Documentation
1196
+ #
1197
+ class DeleteMedicalScribeJobRequest < Struct.new(
1198
+ :medical_scribe_job_name)
1199
+ SENSITIVE = []
1200
+ include Aws::Structure
1201
+ end
1202
+
1187
1203
  # @!attribute [rw] medical_transcription_job_name
1188
1204
  # The name of the medical transcription job you want to delete. Job
1189
1205
  # names are case sensitive.
@@ -1335,6 +1351,32 @@ module Aws::TranscribeService
1335
1351
  include Aws::Structure
1336
1352
  end
1337
1353
 
1354
+ # @!attribute [rw] medical_scribe_job_name
1355
+ # The name of the Medical Scribe job you want information about. Job
1356
+ # names are case sensitive.
1357
+ # @return [String]
1358
+ #
1359
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetMedicalScribeJobRequest AWS API Documentation
1360
+ #
1361
+ class GetMedicalScribeJobRequest < Struct.new(
1362
+ :medical_scribe_job_name)
1363
+ SENSITIVE = []
1364
+ include Aws::Structure
1365
+ end
1366
+
1367
+ # @!attribute [rw] medical_scribe_job
1368
+ # Provides detailed information about the specified Medical Scribe
1369
+ # job, including job status and, if applicable, failure reason
1370
+ # @return [Types::MedicalScribeJob]
1371
+ #
1372
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetMedicalScribeJobResponse AWS API Documentation
1373
+ #
1374
+ class GetMedicalScribeJobResponse < Struct.new(
1375
+ :medical_scribe_job)
1376
+ SENSITIVE = []
1377
+ include Aws::Structure
1378
+ end
1379
+
1338
1380
  # @!attribute [rw] medical_transcription_job_name
1339
1381
  # The name of the medical transcription job you want information
1340
1382
  # about. Job names are case sensitive.
@@ -1412,8 +1454,8 @@ module Aws::TranscribeService
1412
1454
  # @return [String]
1413
1455
  #
1414
1456
  # @!attribute [rw] download_uri
1415
- # The S3 location where the specified custom medical vocabulary is
1416
- # stored; use this URI to view or download the custom vocabulary.
1457
+ # The Amazon S3 location where the specified custom medical vocabulary
1458
+ # is stored; use this URI to view or download the custom vocabulary.
1417
1459
  # @return [String]
1418
1460
  #
1419
1461
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetMedicalVocabularyResponse AWS API Documentation
@@ -1548,8 +1590,8 @@ module Aws::TranscribeService
1548
1590
  # @return [String]
1549
1591
  #
1550
1592
  # @!attribute [rw] download_uri
1551
- # The S3 location where the custom vocabulary is stored; use this URI
1552
- # to view or download the custom vocabulary.
1593
+ # The Amazon S3 location where the custom vocabulary is stored; use
1594
+ # this URI to view or download the custom vocabulary.
1553
1595
  # @return [String]
1554
1596
  #
1555
1597
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetVocabularyResponse AWS API Documentation
@@ -1801,7 +1843,7 @@ module Aws::TranscribeService
1801
1843
  #
1802
1844
  # The language of the specified custom vocabulary must match the
1803
1845
  # language code that you specify in your transcription request. If the
1804
- # languages don't match, the custom vocabulary isn't applied. There
1846
+ # languages do not match, the custom vocabulary isn't applied. There
1805
1847
  # are no errors or warnings associated with a language mismatch.
1806
1848
  # @return [String]
1807
1849
  #
@@ -1812,7 +1854,7 @@ module Aws::TranscribeService
1812
1854
  #
1813
1855
  # The language of the specified custom vocabulary filter must match
1814
1856
  # the language code that you specify in your transcription request. If
1815
- # the languages don't match, the custom vocabulary filter isn't
1857
+ # the languages do not match, the custom vocabulary filter isn't
1816
1858
  # applied. There are no errors or warnings associated with a language
1817
1859
  # mismatch.
1818
1860
  #
@@ -1827,7 +1869,7 @@ module Aws::TranscribeService
1827
1869
  #
1828
1870
  # The language of the specified custom language model must match the
1829
1871
  # language code that you specify in your transcription request. If the
1830
- # languages don't match, the custom language model isn't applied.
1872
+ # languages do not match, the custom language model isn't applied.
1831
1873
  # There are no errors or warnings associated with a language mismatch.
1832
1874
  # @return [String]
1833
1875
  #
@@ -1890,7 +1932,7 @@ module Aws::TranscribeService
1890
1932
  # the language of your training and tuning data.
1891
1933
  #
1892
1934
  # For a list of supported languages and their associated language
1893
- # codes, refer to the [Supported languages][1] table. Note that U.S.
1935
+ # codes, refer to the [Supported languages][1] table. Note that US
1894
1936
  # English (`en-US`) is the only language supported with Amazon
1895
1937
  # Transcribe Medical.
1896
1938
  #
@@ -1982,7 +2024,7 @@ module Aws::TranscribeService
1982
2024
  # @!attribute [rw] max_results
1983
2025
  # The maximum number of Call Analytics categories to return in each
1984
2026
  # page of results. If there are fewer results than the value that you
1985
- # specify, only the actual results are returned. If you don't specify
2027
+ # specify, only the actual results are returned. If you do not specify
1986
2028
  # a value, a default of 5 is used.
1987
2029
  # @return [Integer]
1988
2030
  #
@@ -2020,7 +2062,7 @@ module Aws::TranscribeService
2020
2062
 
2021
2063
  # @!attribute [rw] status
2022
2064
  # Returns only Call Analytics jobs with the specified status. Jobs are
2023
- # ordered by creation date, with the newest job first. If you don't
2065
+ # ordered by creation date, with the newest job first. If you do not
2024
2066
  # include `Status`, all Call Analytics jobs are returned.
2025
2067
  # @return [String]
2026
2068
  #
@@ -2040,7 +2082,7 @@ module Aws::TranscribeService
2040
2082
  # @!attribute [rw] max_results
2041
2083
  # The maximum number of Call Analytics jobs to return in each page of
2042
2084
  # results. If there are fewer results than the value that you specify,
2043
- # only the actual results are returned. If you don't specify a value,
2085
+ # only the actual results are returned. If you do not specify a value,
2044
2086
  # a default of 5 is used.
2045
2087
  # @return [Integer]
2046
2088
  #
@@ -2087,7 +2129,7 @@ module Aws::TranscribeService
2087
2129
  # @!attribute [rw] status_equals
2088
2130
  # Returns only custom language models with the specified status.
2089
2131
  # Language models are ordered by creation date, with the newest model
2090
- # first. If you don't include `StatusEquals`, all custom language
2132
+ # first. If you do not include `StatusEquals`, all custom language
2091
2133
  # models are returned.
2092
2134
  # @return [String]
2093
2135
  #
@@ -2107,7 +2149,7 @@ module Aws::TranscribeService
2107
2149
  # @!attribute [rw] max_results
2108
2150
  # The maximum number of custom language models to return in each page
2109
2151
  # of results. If there are fewer results than the value that you
2110
- # specify, only the actual results are returned. If you don't specify
2152
+ # specify, only the actual results are returned. If you do not specify
2111
2153
  # a value, a default of 5 is used.
2112
2154
  # @return [Integer]
2113
2155
  #
@@ -2145,10 +2187,76 @@ module Aws::TranscribeService
2145
2187
  include Aws::Structure
2146
2188
  end
2147
2189
 
2190
+ # @!attribute [rw] status
2191
+ # Returns only Medical Scribe jobs with the specified status. Jobs are
2192
+ # ordered by creation date, with the newest job first. If you do not
2193
+ # include `Status`, all Medical Scribe jobs are returned.
2194
+ # @return [String]
2195
+ #
2196
+ # @!attribute [rw] job_name_contains
2197
+ # Returns only the Medical Scribe jobs that contain the specified
2198
+ # string. The search is not case sensitive.
2199
+ # @return [String]
2200
+ #
2201
+ # @!attribute [rw] next_token
2202
+ # If your `ListMedicalScribeJobs` request returns more results than
2203
+ # can be displayed, `NextToken` is displayed in the response with an
2204
+ # associated string. To get the next page of results, copy this string
2205
+ # and repeat your request, including `NextToken` with the value of the
2206
+ # copied string. Repeat as needed to view all your results.
2207
+ # @return [String]
2208
+ #
2209
+ # @!attribute [rw] max_results
2210
+ # The maximum number of Medical Scribe jobs to return in each page of
2211
+ # results. If there are fewer results than the value that you specify,
2212
+ # only the actual results are returned. If you do not specify a value,
2213
+ # a default of 5 is used.
2214
+ # @return [Integer]
2215
+ #
2216
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListMedicalScribeJobsRequest AWS API Documentation
2217
+ #
2218
+ class ListMedicalScribeJobsRequest < Struct.new(
2219
+ :status,
2220
+ :job_name_contains,
2221
+ :next_token,
2222
+ :max_results)
2223
+ SENSITIVE = []
2224
+ include Aws::Structure
2225
+ end
2226
+
2227
+ # @!attribute [rw] status
2228
+ # Lists all Medical Scribe jobs that have the status specified in your
2229
+ # request. Jobs are ordered by creation date, with the newest job
2230
+ # first.
2231
+ # @return [String]
2232
+ #
2233
+ # @!attribute [rw] next_token
2234
+ # If `NextToken` is present in your response, it indicates that not
2235
+ # all results are displayed. To view the next set of results, copy the
2236
+ # string associated with the `NextToken` parameter in your results
2237
+ # output, then run your request again including `NextToken` with the
2238
+ # value of the copied string. Repeat as needed to view all your
2239
+ # results.
2240
+ # @return [String]
2241
+ #
2242
+ # @!attribute [rw] medical_scribe_job_summaries
2243
+ # Provides a summary of information about each result.
2244
+ # @return [Array<Types::MedicalScribeJobSummary>]
2245
+ #
2246
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListMedicalScribeJobsResponse AWS API Documentation
2247
+ #
2248
+ class ListMedicalScribeJobsResponse < Struct.new(
2249
+ :status,
2250
+ :next_token,
2251
+ :medical_scribe_job_summaries)
2252
+ SENSITIVE = []
2253
+ include Aws::Structure
2254
+ end
2255
+
2148
2256
  # @!attribute [rw] status
2149
2257
  # Returns only medical transcription jobs with the specified status.
2150
2258
  # Jobs are ordered by creation date, with the newest job first. If you
2151
- # don't include `Status`, all medical transcription jobs are
2259
+ # do not include `Status`, all medical transcription jobs are
2152
2260
  # returned.
2153
2261
  # @return [String]
2154
2262
  #
@@ -2168,7 +2276,7 @@ module Aws::TranscribeService
2168
2276
  # @!attribute [rw] max_results
2169
2277
  # The maximum number of medical transcription jobs to return in each
2170
2278
  # page of results. If there are fewer results than the value that you
2171
- # specify, only the actual results are returned. If you don't specify
2279
+ # specify, only the actual results are returned. If you do not specify
2172
2280
  # a value, a default of 5 is used.
2173
2281
  # @return [Integer]
2174
2282
  #
@@ -2223,14 +2331,14 @@ module Aws::TranscribeService
2223
2331
  # @!attribute [rw] max_results
2224
2332
  # The maximum number of custom medical vocabularies to return in each
2225
2333
  # page of results. If there are fewer results than the value that you
2226
- # specify, only the actual results are returned. If you don't specify
2334
+ # specify, only the actual results are returned. If you do not specify
2227
2335
  # a value, a default of 5 is used.
2228
2336
  # @return [Integer]
2229
2337
  #
2230
2338
  # @!attribute [rw] state_equals
2231
2339
  # Returns only custom medical vocabularies with the specified state.
2232
2340
  # Custom vocabularies are ordered by creation date, with the newest
2233
- # vocabulary first. If you don't include `StateEquals`, all custom
2341
+ # vocabulary first. If you do not include `StateEquals`, all custom
2234
2342
  # medical vocabularies are returned.
2235
2343
  # @return [String]
2236
2344
  #
@@ -2321,7 +2429,7 @@ module Aws::TranscribeService
2321
2429
 
2322
2430
  # @!attribute [rw] status
2323
2431
  # Returns only transcription jobs with the specified status. Jobs are
2324
- # ordered by creation date, with the newest job first. If you don't
2432
+ # ordered by creation date, with the newest job first. If you do not
2325
2433
  # include `Status`, all transcription jobs are returned.
2326
2434
  # @return [String]
2327
2435
  #
@@ -2341,7 +2449,7 @@ module Aws::TranscribeService
2341
2449
  # @!attribute [rw] max_results
2342
2450
  # The maximum number of transcription jobs to return in each page of
2343
2451
  # results. If there are fewer results than the value that you specify,
2344
- # only the actual results are returned. If you don't specify a value,
2452
+ # only the actual results are returned. If you do not specify a value,
2345
2453
  # a default of 5 is used.
2346
2454
  # @return [Integer]
2347
2455
  #
@@ -2396,14 +2504,14 @@ module Aws::TranscribeService
2396
2504
  # @!attribute [rw] max_results
2397
2505
  # The maximum number of custom vocabularies to return in each page of
2398
2506
  # results. If there are fewer results than the value that you specify,
2399
- # only the actual results are returned. If you don't specify a value,
2507
+ # only the actual results are returned. If you do not specify a value,
2400
2508
  # a default of 5 is used.
2401
2509
  # @return [Integer]
2402
2510
  #
2403
2511
  # @!attribute [rw] state_equals
2404
2512
  # Returns only custom vocabularies with the specified state.
2405
2513
  # Vocabularies are ordered by creation date, with the newest
2406
- # vocabulary first. If you don't include `StateEquals`, all custom
2514
+ # vocabulary first. If you do not include `StateEquals`, all custom
2407
2515
  # medical vocabularies are returned.
2408
2516
  # @return [String]
2409
2517
  #
@@ -2464,7 +2572,7 @@ module Aws::TranscribeService
2464
2572
  # @!attribute [rw] max_results
2465
2573
  # The maximum number of custom vocabulary filters to return in each
2466
2574
  # page of results. If there are fewer results than the value that you
2467
- # specify, only the actual results are returned. If you don't specify
2575
+ # specify, only the actual results are returned. If you do not specify
2468
2576
  # a value, a default of 5 is used.
2469
2577
  # @return [Integer]
2470
2578
  #
@@ -2509,14 +2617,13 @@ module Aws::TranscribeService
2509
2617
  # Describes the Amazon S3 location of the media file you want to use in
2510
2618
  # your request.
2511
2619
  #
2512
- # For information on supported media formats, refer to the
2513
- # [MediaFormat][1] parameter or the [Media formats][2] section in the
2514
- # Amazon S3 Developer Guide.
2620
+ # For information on supported media formats, refer to the `MediaFormat`
2621
+ # parameter or the [Media formats][1] section in the Amazon S3 Developer
2622
+ # Guide.
2515
2623
  #
2516
2624
  #
2517
2625
  #
2518
- # [1]: https://docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat
2519
- # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio
2626
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio
2520
2627
  #
2521
2628
  # @!attribute [rw] media_file_uri
2522
2629
  # The Amazon S3 location of the media file you want to transcribe. For
@@ -2557,6 +2664,368 @@ module Aws::TranscribeService
2557
2664
  include Aws::Structure
2558
2665
  end
2559
2666
 
2667
+ # Indicates which speaker is on which channel. The options are
2668
+ # `CLINICIAN` and `PATIENT`
2669
+ #
2670
+ # @!attribute [rw] channel_id
2671
+ # Specify the audio channel you want to define.
2672
+ # @return [Integer]
2673
+ #
2674
+ # @!attribute [rw] participant_role
2675
+ # Specify the participant that you want to flag. The options are
2676
+ # `CLINICIAN` and `PATIENT`
2677
+ # @return [String]
2678
+ #
2679
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/MedicalScribeChannelDefinition AWS API Documentation
2680
+ #
2681
+ class MedicalScribeChannelDefinition < Struct.new(
2682
+ :channel_id,
2683
+ :participant_role)
2684
+ SENSITIVE = []
2685
+ include Aws::Structure
2686
+ end
2687
+
2688
+ # Provides detailed information about a Medical Scribe job.
2689
+ #
2690
+ # To view the status of the specified Medical Scribe job, check the
2691
+ # `MedicalScribeJobStatus` field. If the status is `COMPLETED`, the job
2692
+ # is finished and you can find the results at the locations specified in
2693
+ # `MedicalScribeOutput`. If the status is `FAILED`, `FailureReason`
2694
+ # provides details on why your Medical Scribe job failed.
2695
+ #
2696
+ # @!attribute [rw] medical_scribe_job_name
2697
+ # The name of the Medical Scribe job. Job names are case sensitive and
2698
+ # must be unique within an Amazon Web Services account.
2699
+ # @return [String]
2700
+ #
2701
+ # @!attribute [rw] medical_scribe_job_status
2702
+ # Provides the status of the specified Medical Scribe job.
2703
+ #
2704
+ # If the status is `COMPLETED`, the job is finished and you can find
2705
+ # the results at the location specified in `MedicalScribeOutput` If
2706
+ # the status is `FAILED`, `FailureReason` provides details on why your
2707
+ # Medical Scribe job failed.
2708
+ # @return [String]
2709
+ #
2710
+ # @!attribute [rw] language_code
2711
+ # The language code used to create your Medical Scribe job. US English
2712
+ # (`en-US`) is the only supported language for Medical Scribe jobs.
2713
+ # @return [String]
2714
+ #
2715
+ # @!attribute [rw] media
2716
+ # Describes the Amazon S3 location of the media file you want to use
2717
+ # in your request.
2718
+ #
2719
+ # For information on supported media formats, refer to the
2720
+ # `MediaFormat` parameter or the [Media formats][1] section in the
2721
+ # Amazon S3 Developer Guide.
2722
+ #
2723
+ #
2724
+ #
2725
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio
2726
+ # @return [Types::Media]
2727
+ #
2728
+ # @!attribute [rw] medical_scribe_output
2729
+ # The location of the output of your Medical Scribe job.
2730
+ # `ClinicalDocumentUri` holds the Amazon S3 URI for the Clinical
2731
+ # Document and `TranscriptFileUri` holds the Amazon S3 URI for the
2732
+ # Transcript.
2733
+ # @return [Types::MedicalScribeOutput]
2734
+ #
2735
+ # @!attribute [rw] start_time
2736
+ # The date and time your Medical Scribe job began processing.
2737
+ #
2738
+ # Timestamps are in the format `YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC`. For
2739
+ # example, `2022-05-04T12:32:58.789000-07:00` represents a Medical
2740
+ # Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.
2741
+ # @return [Time]
2742
+ #
2743
+ # @!attribute [rw] creation_time
2744
+ # The date and time the specified Medical Scribe job request was made.
2745
+ #
2746
+ # Timestamps are in the format `YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC`. For
2747
+ # example, `2022-05-04T12:32:58.761000-07:00` represents a Medical
2748
+ # Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.
2749
+ # @return [Time]
2750
+ #
2751
+ # @!attribute [rw] completion_time
2752
+ # The date and time the specified Medical Scribe job finished
2753
+ # processing.
2754
+ #
2755
+ # Timestamps are in the format `YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC`. For
2756
+ # example, `2022-05-04T12:32:58.761000-07:00` represents a Medical
2757
+ # Scribe job that finished processing at 12:32 PM UTC-7 on May 4,
2758
+ # 2022.
2759
+ # @return [Time]
2760
+ #
2761
+ # @!attribute [rw] failure_reason
2762
+ # If `MedicalScribeJobStatus` is `FAILED`, `FailureReason` contains
2763
+ # information about why the transcription job failed. See also:
2764
+ # [Common Errors][1].
2765
+ #
2766
+ #
2767
+ #
2768
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html
2769
+ # @return [String]
2770
+ #
2771
+ # @!attribute [rw] settings
2772
+ # Makes it possible to control how your Medical Scribe job is
2773
+ # processed using a `MedicalScribeSettings` object. Specify
2774
+ # `ChannelIdentification` if `ChannelDefinitions` are set. Enabled
2775
+ # `ShowSpeakerLabels` if `ChannelIdentification` and
2776
+ # `ChannelDefinitions` are not set. One and only one of
2777
+ # `ChannelIdentification` and `ShowSpeakerLabels` must be set. If
2778
+ # `ShowSpeakerLabels` is set, `MaxSpeakerLabels` must also be set. Use
2779
+ # `Settings` to specify a vocabulary or vocabulary filter or both
2780
+ # using `VocabularyName`, `VocabularyFilterName`.
2781
+ # `VocabularyFilterMethod` must be specified if `VocabularyFilterName`
2782
+ # is set.
2783
+ # @return [Types::MedicalScribeSettings]
2784
+ #
2785
+ # @!attribute [rw] data_access_role_arn
2786
+ # The Amazon Resource Name (ARN) of an IAM role that has permissions
2787
+ # to access the Amazon S3 bucket that contains your input files, write
2788
+ # to the output bucket, and use your KMS key if supplied. If the role
2789
+ # that you specify doesn’t have the appropriate permissions your
2790
+ # request fails.
2791
+ #
2792
+ # IAM role ARNs have the format
2793
+ # `arn:partition:iam::account:role/role-name-with-path`. For example:
2794
+ # `arn:aws:iam::111122223333:role/Admin`.
2795
+ #
2796
+ # For more information, see [IAM ARNs][1].
2797
+ #
2798
+ #
2799
+ #
2800
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns
2801
+ # @return [String]
2802
+ #
2803
+ # @!attribute [rw] channel_definitions
2804
+ # Makes it possible to specify which speaker is on which channel. For
2805
+ # example, if the clinician is the first participant to speak, you
2806
+ # would set `ChannelId` of the first `ChannelDefinition` in the list
2807
+ # to `0` (to indicate the first channel) and `ParticipantRole` to
2808
+ # `CLINICIAN` (to indicate that it's the clinician speaking). Then
2809
+ # you would set the `ChannelId` of the second `ChannelDefinition` in
2810
+ # the list to `1` (to indicate the second channel) and
2811
+ # `ParticipantRole` to `PATIENT` (to indicate that it's the patient
2812
+ # speaking).
2813
+ # @return [Array<Types::MedicalScribeChannelDefinition>]
2814
+ #
2815
+ # @!attribute [rw] tags
2816
+ # Adds one or more custom tags, each in the form of a key:value pair,
2817
+ # to the Medica Scribe job.
2818
+ #
2819
+ # To learn more about using tags with Amazon Transcribe, refer to
2820
+ # [Tagging resources][1].
2821
+ #
2822
+ #
2823
+ #
2824
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html
2825
+ # @return [Array<Types::Tag>]
2826
+ #
2827
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/MedicalScribeJob AWS API Documentation
2828
+ #
2829
+ class MedicalScribeJob < Struct.new(
2830
+ :medical_scribe_job_name,
2831
+ :medical_scribe_job_status,
2832
+ :language_code,
2833
+ :media,
2834
+ :medical_scribe_output,
2835
+ :start_time,
2836
+ :creation_time,
2837
+ :completion_time,
2838
+ :failure_reason,
2839
+ :settings,
2840
+ :data_access_role_arn,
2841
+ :channel_definitions,
2842
+ :tags)
2843
+ SENSITIVE = []
2844
+ include Aws::Structure
2845
+ end
2846
+
2847
+ # Provides detailed information about a specific Medical Scribe job.
2848
+ #
2849
+ # @!attribute [rw] medical_scribe_job_name
2850
+ # The name of the Medical Scribe job. Job names are case sensitive and
2851
+ # must be unique within an Amazon Web Services account.
2852
+ # @return [String]
2853
+ #
2854
+ # @!attribute [rw] creation_time
2855
+ # The date and time the specified Medical Scribe job request was made.
2856
+ #
2857
+ # Timestamps are in the format `YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC`. For
2858
+ # example, `2022-05-04T12:32:58.761000-07:00` represents a Medical
2859
+ # Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.
2860
+ # @return [Time]
2861
+ #
2862
+ # @!attribute [rw] start_time
2863
+ # The date and time your Medical Scribe job began processing.
2864
+ #
2865
+ # Timestamps are in the format `YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC`. For
2866
+ # example, `2022-05-04T12:32:58.789000-07:00` represents a Medical
2867
+ # Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.
2868
+ # @return [Time]
2869
+ #
2870
+ # @!attribute [rw] completion_time
2871
+ # The date and time the specified Medical Scribe job finished
2872
+ # processing.
2873
+ #
2874
+ # Timestamps are in the format `YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC`. For
2875
+ # example, `2022-05-04T12:32:58.761000-07:00` represents a Medical
2876
+ # Scribe job that finished processing at 12:32 PM UTC-7 on May 4,
2877
+ # 2022.
2878
+ # @return [Time]
2879
+ #
2880
+ # @!attribute [rw] language_code
2881
+ # The language code used to create your Medical Scribe job. US English
2882
+ # (`en-US`) is the only supported language for Medical Scribe jobs.
2883
+ # @return [String]
2884
+ #
2885
+ # @!attribute [rw] medical_scribe_job_status
2886
+ # Provides the status of the specified Medical Scribe job.
2887
+ #
2888
+ # If the status is `COMPLETED`, the job is finished and you can find
2889
+ # the results at the location specified in `MedicalScribeOutput` If
2890
+ # the status is `FAILED`, `FailureReason` provides details on why your
2891
+ # Medical Scribe job failed.
2892
+ # @return [String]
2893
+ #
2894
+ # @!attribute [rw] failure_reason
2895
+ # If `MedicalScribeJobStatus` is `FAILED`, `FailureReason` contains
2896
+ # information about why the transcription job failed. See also:
2897
+ # [Common Errors][1].
2898
+ #
2899
+ #
2900
+ #
2901
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html
2902
+ # @return [String]
2903
+ #
2904
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/MedicalScribeJobSummary AWS API Documentation
2905
+ #
2906
+ class MedicalScribeJobSummary < Struct.new(
2907
+ :medical_scribe_job_name,
2908
+ :creation_time,
2909
+ :start_time,
2910
+ :completion_time,
2911
+ :language_code,
2912
+ :medical_scribe_job_status,
2913
+ :failure_reason)
2914
+ SENSITIVE = []
2915
+ include Aws::Structure
2916
+ end
2917
+
2918
+ # The location of the output of your Medical Scribe job.
2919
+ # `ClinicalDocumentUri` holds the Amazon S3 URI for the Clinical
2920
+ # Document and `TranscriptFileUri` holds the Amazon S3 URI for the
2921
+ # Transcript.
2922
+ #
2923
+ # @!attribute [rw] transcript_file_uri
2924
+ # Holds the Amazon S3 URI for the Transcript.
2925
+ # @return [String]
2926
+ #
2927
+ # @!attribute [rw] clinical_document_uri
2928
+ # Holds the Amazon S3 URI for the Clinical Document.
2929
+ # @return [String]
2930
+ #
2931
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/MedicalScribeOutput AWS API Documentation
2932
+ #
2933
+ class MedicalScribeOutput < Struct.new(
2934
+ :transcript_file_uri,
2935
+ :clinical_document_uri)
2936
+ SENSITIVE = []
2937
+ include Aws::Structure
2938
+ end
2939
+
2940
+ # Makes it possible to control how your Medical Scribe job is processed
2941
+ # using a `MedicalScribeSettings` object. Specify
2942
+ # `ChannelIdentification` if `ChannelDefinitions` are set. Enabled
2943
+ # `ShowSpeakerLabels` if `ChannelIdentification` and
2944
+ # `ChannelDefinitions` are not set. One and only one of
2945
+ # `ChannelIdentification` and `ShowSpeakerLabels` must be set. If
2946
+ # `ShowSpeakerLabels` is set, `MaxSpeakerLabels` must also be set. Use
2947
+ # `Settings` to specify a vocabulary or vocabulary filter or both using
2948
+ # `VocabularyName`, `VocabularyFilterName`. `VocabularyFilterMethod`
2949
+ # must be specified if `VocabularyFilterName` is set.
2950
+ #
2951
+ # @!attribute [rw] show_speaker_labels
2952
+ # Enables speaker partitioning (diarization) in your Medical Scribe
2953
+ # output. Speaker partitioning labels the speech from individual
2954
+ # speakers in your media file.
2955
+ #
2956
+ # If you enable `ShowSpeakerLabels` in your request, you must also
2957
+ # include `MaxSpeakerLabels`.
2958
+ #
2959
+ # For more information, see [Partitioning speakers (diarization)][1].
2960
+ #
2961
+ #
2962
+ #
2963
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html
2964
+ # @return [Boolean]
2965
+ #
2966
+ # @!attribute [rw] max_speaker_labels
2967
+ # Specify the maximum number of speakers you want to partition in your
2968
+ # media.
2969
+ #
2970
+ # Note that if your media contains more speakers than the specified
2971
+ # number, multiple speakers are treated as a single speaker.
2972
+ #
2973
+ # If you specify the `MaxSpeakerLabels` field, you must set the
2974
+ # `ShowSpeakerLabels` field to true.
2975
+ # @return [Integer]
2976
+ #
2977
+ # @!attribute [rw] channel_identification
2978
+ # Enables channel identification in multi-channel audio.
2979
+ #
2980
+ # Channel identification transcribes the audio on each channel
2981
+ # independently, then appends the output for each channel into one
2982
+ # transcript.
2983
+ #
2984
+ # For more information, see [Transcribing multi-channel audio][1].
2985
+ #
2986
+ #
2987
+ #
2988
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html
2989
+ # @return [Boolean]
2990
+ #
2991
+ # @!attribute [rw] vocabulary_name
2992
+ # The name of the custom vocabulary you want to include in your
2993
+ # Medical Scribe request. Custom vocabulary names are case sensitive.
2994
+ # @return [String]
2995
+ #
2996
+ # @!attribute [rw] vocabulary_filter_name
2997
+ # The name of the custom vocabulary filter you want to include in your
2998
+ # Medical Scribe request. Custom vocabulary filter names are case
2999
+ # sensitive.
3000
+ #
3001
+ # Note that if you include `VocabularyFilterName` in your request, you
3002
+ # must also include `VocabularyFilterMethod`.
3003
+ # @return [String]
3004
+ #
3005
+ # @!attribute [rw] vocabulary_filter_method
3006
+ # Specify how you want your custom vocabulary filter applied to your
3007
+ # transcript.
3008
+ #
3009
+ # To replace words with `***`, choose `mask`.
3010
+ #
3011
+ # To delete words, choose `remove`.
3012
+ #
3013
+ # To flag words without changing them, choose `tag`.
3014
+ # @return [String]
3015
+ #
3016
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/MedicalScribeSettings AWS API Documentation
3017
+ #
3018
+ class MedicalScribeSettings < Struct.new(
3019
+ :show_speaker_labels,
3020
+ :max_speaker_labels,
3021
+ :channel_identification,
3022
+ :vocabulary_name,
3023
+ :vocabulary_filter_name,
3024
+ :vocabulary_filter_method)
3025
+ SENSITIVE = []
3026
+ include Aws::Structure
3027
+ end
3028
+
2560
3029
  # Provides you with the Amazon S3 URI you can use to access your
2561
3030
  # transcript.
2562
3031
  #
@@ -2618,13 +3087,12 @@ module Aws::TranscribeService
2618
3087
  # in your request.
2619
3088
  #
2620
3089
  # For information on supported media formats, refer to the
2621
- # [MediaFormat][1] parameter or the [Media formats][2] section in the
3090
+ # `MediaFormat` parameter or the [Media formats][1] section in the
2622
3091
  # Amazon S3 Developer Guide.
2623
3092
  #
2624
3093
  #
2625
3094
  #
2626
- # [1]: https://docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat
2627
- # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio
3095
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio
2628
3096
  # @return [Types::Media]
2629
3097
  #
2630
3098
  # @!attribute [rw] transcript
@@ -2671,7 +3139,8 @@ module Aws::TranscribeService
2671
3139
  # * `Unsupported media format`.
2672
3140
  #
2673
3141
  # The media format specified in `MediaFormat` isn't valid. Refer to
2674
- # **MediaFormat** for a list of supported formats.
3142
+ # refer to the `MediaFormat` parameter for a list of supported
3143
+ # formats.
2675
3144
  #
2676
3145
  # * `The media format provided does not match the detected media
2677
3146
  # format`.
@@ -2695,18 +3164,16 @@ module Aws::TranscribeService
2695
3164
  # * `Invalid file size: file size too large`.
2696
3165
  #
2697
3166
  # The size of your media file is larger than what Amazon Transcribe
2698
- # can process. For more information, refer to [Guidelines and
2699
- # quotas][1].
3167
+ # can process. For more information, refer to [Service quotas][1].
2700
3168
  #
2701
3169
  # * `Invalid number of channels: number of channels too large`.
2702
3170
  #
2703
3171
  # Your audio contains more channels than Amazon Transcribe is able
2704
- # to process. For more information, refer to [Guidelines and
2705
- # quotas][1].
3172
+ # to process. For more information, refer to [Service quotas][1].
2706
3173
  #
2707
3174
  #
2708
3175
  #
2709
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits
3176
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe
2710
3177
  # @return [String]
2711
3178
  #
2712
3179
  # @!attribute [rw] settings
@@ -2884,10 +3351,6 @@ module Aws::TranscribeService
2884
3351
  # If you enable `ShowSpeakerLabels` in your request, you must also
2885
3352
  # include `MaxSpeakerLabels`.
2886
3353
  #
2887
- # You can't include `ShowSpeakerLabels` and `ChannelIdentification`
2888
- # in the same request. Including both parameters returns a
2889
- # `BadRequestException`.
2890
- #
2891
3354
  # For more information, see [Partitioning speakers (diarization)][1].
2892
3355
  #
2893
3356
  #
@@ -2917,10 +3380,6 @@ module Aws::TranscribeService
2917
3380
  # identification, your audio is transcribed in a continuous manner and
2918
3381
  # your transcript does not separate the speech by channel.
2919
3382
  #
2920
- # You can't include both `ShowSpeakerLabels` and
2921
- # `ChannelIdentification` in the same request. Including both
2922
- # parameters returns a `BadRequestException`.
2923
- #
2924
3383
  # For more information, see [Transcribing multi-channel audio][1].
2925
3384
  #
2926
3385
  #
@@ -2968,7 +3427,7 @@ module Aws::TranscribeService
2968
3427
  #
2969
3428
  # The language of the specified custom vocabulary must match the
2970
3429
  # language code that you specify in your transcription request. If the
2971
- # languages don't match, the custom vocabulary isn't applied. There
3430
+ # languages do not match, the custom vocabulary isn't applied. There
2972
3431
  # are no errors or warnings associated with a language mismatch. US
2973
3432
  # English (`en-US`) is the only valid language for Amazon Transcribe
2974
3433
  # Medical.
@@ -3003,7 +3462,7 @@ module Aws::TranscribeService
3003
3462
  #
3004
3463
  # The language of the specified custom language model must match the
3005
3464
  # language code that you specify in your transcription request. If the
3006
- # languages don't match, the custom language model isn't applied.
3465
+ # languages do not match, the custom language model isn't applied.
3007
3466
  # There are no errors or warnings associated with a language mismatch.
3008
3467
  # @return [String]
3009
3468
  #
@@ -3274,10 +3733,6 @@ module Aws::TranscribeService
3274
3733
  # If you enable `ShowSpeakerLabels` in your request, you must also
3275
3734
  # include `MaxSpeakerLabels`.
3276
3735
  #
3277
- # You can't include both `ShowSpeakerLabels` and
3278
- # `ChannelIdentification` in the same request. Including both
3279
- # parameters returns a `BadRequestException`.
3280
- #
3281
3736
  # For more information, see [Partitioning speakers (diarization)][1].
3282
3737
  #
3283
3738
  #
@@ -3303,10 +3758,6 @@ module Aws::TranscribeService
3303
3758
  # independently, then appends the output for each channel into one
3304
3759
  # transcript.
3305
3760
  #
3306
- # You can't include both `ShowSpeakerLabels` and
3307
- # `ChannelIdentification` in the same request. Including both
3308
- # parameters returns a `BadRequestException`.
3309
- #
3310
3761
  # For more information, see [Transcribing multi-channel audio][1].
3311
3762
  #
3312
3763
  #
@@ -3417,11 +3868,11 @@ module Aws::TranscribeService
3417
3868
  # your transcription job using the `CallAnalyticsJobName` parameter.
3418
3869
  #
3419
3870
  # You can specify a KMS key to encrypt your output using the
3420
- # `OutputEncryptionKMSKeyId` parameter. If you don't specify a KMS
3871
+ # `OutputEncryptionKMSKeyId` parameter. If you do not specify a KMS
3421
3872
  # key, Amazon Transcribe uses the default Amazon S3 key for
3422
3873
  # server-side encryption.
3423
3874
  #
3424
- # If you don't specify `OutputLocation`, your transcript is placed in
3875
+ # If you do not specify `OutputLocation`, your transcript is placed in
3425
3876
  # a service-managed Amazon S3 bucket and you are provided with a URI
3426
3877
  # to access your transcript.
3427
3878
  # @return [String]
@@ -3455,7 +3906,7 @@ module Aws::TranscribeService
3455
3906
  # 2. Use the ARN for the KMS key alias. For example,
3456
3907
  # `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
3457
3908
  #
3458
- # If you don't specify an encryption key, your output is encrypted
3909
+ # If you do not specify an encryption key, your output is encrypted
3459
3910
  # with the default Amazon S3 key (SSE-S3).
3460
3911
  #
3461
3912
  # If you specify a KMS key to encrypt your output, you must also
@@ -3524,6 +3975,178 @@ module Aws::TranscribeService
3524
3975
  include Aws::Structure
3525
3976
  end
3526
3977
 
3978
+ # @!attribute [rw] medical_scribe_job_name
3979
+ # A unique name, chosen by you, for your Medical Scribe job.
3980
+ #
3981
+ # This name is case sensitive, cannot contain spaces, and must be
3982
+ # unique within an Amazon Web Services account. If you try to create a
3983
+ # new job with the same name as an existing job, you get a
3984
+ # `ConflictException` error.
3985
+ # @return [String]
3986
+ #
3987
+ # @!attribute [rw] media
3988
+ # Describes the Amazon S3 location of the media file you want to use
3989
+ # in your request.
3990
+ #
3991
+ # For information on supported media formats, refer to the
3992
+ # `MediaFormat` parameter or the [Media formats][1] section in the
3993
+ # Amazon S3 Developer Guide.
3994
+ #
3995
+ #
3996
+ #
3997
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio
3998
+ # @return [Types::Media]
3999
+ #
4000
+ # @!attribute [rw] output_bucket_name
4001
+ # The name of the Amazon S3 bucket where you want your Medical Scribe
4002
+ # output stored. Do not include the `S3://` prefix of the specified
4003
+ # bucket.
4004
+ #
4005
+ # Note that the role specified in the `DataAccessRoleArn` request
4006
+ # parameter must have permission to use the specified location. You
4007
+ # can change Amazon S3 permissions using the [Amazon Web Services
4008
+ # Management Console][1]. See also [Permissions Required for IAM User
4009
+ # Roles][2].
4010
+ #
4011
+ #
4012
+ #
4013
+ # [1]: https://console.aws.amazon.com/s3
4014
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user
4015
+ # @return [String]
4016
+ #
4017
+ # @!attribute [rw] output_encryption_kms_key_id
4018
+ # The KMS key you want to use to encrypt your Medical Scribe output.
4019
+ #
4020
+ # If using a key located in the **current** Amazon Web Services
4021
+ # account, you can specify your KMS key in one of four ways:
4022
+ #
4023
+ # 1. Use the KMS key ID itself. For example,
4024
+ # `1234abcd-12ab-34cd-56ef-1234567890ab`.
4025
+ #
4026
+ # 2. Use an alias for the KMS key ID. For example,
4027
+ # `alias/ExampleAlias`.
4028
+ #
4029
+ # 3. Use the Amazon Resource Name (ARN) for the KMS key ID. For
4030
+ # example,
4031
+ # `arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
4032
+ #
4033
+ # 4. Use the ARN for the KMS key alias. For example,
4034
+ # `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
4035
+ #
4036
+ # If using a key located in a **different** Amazon Web Services
4037
+ # account than the current Amazon Web Services account, you can
4038
+ # specify your KMS key in one of two ways:
4039
+ #
4040
+ # 1. Use the ARN for the KMS key ID. For example,
4041
+ # `arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
4042
+ #
4043
+ # 2. Use the ARN for the KMS key alias. For example,
4044
+ # `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
4045
+ #
4046
+ # If you do not specify an encryption key, your output is encrypted
4047
+ # with the default Amazon S3 key (SSE-S3).
4048
+ #
4049
+ # Note that the role specified in the `DataAccessRoleArn` request
4050
+ # parameter must have permission to use the specified KMS key.
4051
+ # @return [String]
4052
+ #
4053
+ # @!attribute [rw] kms_encryption_context
4054
+ # A map of plain text, non-secret key:value pairs, known as encryption
4055
+ # context pairs, that provide an added layer of security for your
4056
+ # data. For more information, see [KMS encryption context][1] and
4057
+ # [Asymmetric keys in KMS][2].
4058
+ #
4059
+ #
4060
+ #
4061
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context
4062
+ # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html
4063
+ # @return [Hash<String,String>]
4064
+ #
4065
+ # @!attribute [rw] data_access_role_arn
4066
+ # The Amazon Resource Name (ARN) of an IAM role that has permissions
4067
+ # to access the Amazon S3 bucket that contains your input files, write
4068
+ # to the output bucket, and use your KMS key if supplied. If the role
4069
+ # that you specify doesn’t have the appropriate permissions your
4070
+ # request fails.
4071
+ #
4072
+ # IAM role ARNs have the format
4073
+ # `arn:partition:iam::account:role/role-name-with-path`. For example:
4074
+ # `arn:aws:iam::111122223333:role/Admin`.
4075
+ #
4076
+ # For more information, see [IAM ARNs][1].
4077
+ #
4078
+ #
4079
+ #
4080
+ # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns
4081
+ # @return [String]
4082
+ #
4083
+ # @!attribute [rw] settings
4084
+ # Makes it possible to control how your Medical Scribe job is
4085
+ # processed using a `MedicalScribeSettings` object. Specify
4086
+ # `ChannelIdentification` if `ChannelDefinitions` are set. Enabled
4087
+ # `ShowSpeakerLabels` if `ChannelIdentification` and
4088
+ # `ChannelDefinitions` are not set. One and only one of
4089
+ # `ChannelIdentification` and `ShowSpeakerLabels` must be set. If
4090
+ # `ShowSpeakerLabels` is set, `MaxSpeakerLabels` must also be set. Use
4091
+ # `Settings` to specify a vocabulary or vocabulary filter or both
4092
+ # using `VocabularyName`, `VocabularyFilterName`.
4093
+ # `VocabularyFilterMethod` must be specified if `VocabularyFilterName`
4094
+ # is set.
4095
+ # @return [Types::MedicalScribeSettings]
4096
+ #
4097
+ # @!attribute [rw] channel_definitions
4098
+ # Makes it possible to specify which speaker is on which channel. For
4099
+ # example, if the clinician is the first participant to speak, you
4100
+ # would set `ChannelId` of the first `ChannelDefinition` in the list
4101
+ # to `0` (to indicate the first channel) and `ParticipantRole` to
4102
+ # `CLINICIAN` (to indicate that it's the clinician speaking). Then
4103
+ # you would set the `ChannelId` of the second `ChannelDefinition` in
4104
+ # the list to `1` (to indicate the second channel) and
4105
+ # `ParticipantRole` to `PATIENT` (to indicate that it's the patient
4106
+ # speaking).
4107
+ # @return [Array<Types::MedicalScribeChannelDefinition>]
4108
+ #
4109
+ # @!attribute [rw] tags
4110
+ # Adds one or more custom tags, each in the form of a key:value pair,
4111
+ # to the Medica Scribe job.
4112
+ #
4113
+ # To learn more about using tags with Amazon Transcribe, refer to
4114
+ # [Tagging resources][1].
4115
+ #
4116
+ #
4117
+ #
4118
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html
4119
+ # @return [Array<Types::Tag>]
4120
+ #
4121
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartMedicalScribeJobRequest AWS API Documentation
4122
+ #
4123
+ class StartMedicalScribeJobRequest < Struct.new(
4124
+ :medical_scribe_job_name,
4125
+ :media,
4126
+ :output_bucket_name,
4127
+ :output_encryption_kms_key_id,
4128
+ :kms_encryption_context,
4129
+ :data_access_role_arn,
4130
+ :settings,
4131
+ :channel_definitions,
4132
+ :tags)
4133
+ SENSITIVE = []
4134
+ include Aws::Structure
4135
+ end
4136
+
4137
+ # @!attribute [rw] medical_scribe_job
4138
+ # Provides detailed information about the current Medical Scribe job,
4139
+ # including job status and, if applicable, failure reason.
4140
+ # @return [Types::MedicalScribeJob]
4141
+ #
4142
+ # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartMedicalScribeJobResponse AWS API Documentation
4143
+ #
4144
+ class StartMedicalScribeJobResponse < Struct.new(
4145
+ :medical_scribe_job)
4146
+ SENSITIVE = []
4147
+ include Aws::Structure
4148
+ end
4149
+
3527
4150
  # @!attribute [rw] medical_transcription_job_name
3528
4151
  # A unique name, chosen by you, for your medical transcription job.
3529
4152
  # The name that you specify is also used as the default name of your
@@ -3547,7 +4170,7 @@ module Aws::TranscribeService
3547
4170
  # The sample rate, in hertz, of the audio track in your input media
3548
4171
  # file.
3549
4172
  #
3550
- # If you don't specify the media sample rate, Amazon Transcribe
4173
+ # If you do not specify the media sample rate, Amazon Transcribe
3551
4174
  # Medical determines it for you. If you specify the sample rate, it
3552
4175
  # must match the rate detected by Amazon Transcribe Medical; if
3553
4176
  # there's a mismatch between the value that you specify and the value
@@ -3565,13 +4188,12 @@ module Aws::TranscribeService
3565
4188
  # in your request.
3566
4189
  #
3567
4190
  # For information on supported media formats, refer to the
3568
- # [MediaFormat][1] parameter or the [Media formats][2] section in the
4191
+ # `MediaFormat` parameter or the [Media formats][1] section in the
3569
4192
  # Amazon S3 Developer Guide.
3570
4193
  #
3571
4194
  #
3572
4195
  #
3573
- # [1]: https://docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat
3574
- # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio
4196
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio
3575
4197
  # @return [Types::Media]
3576
4198
  #
3577
4199
  # @!attribute [rw] output_bucket_name
@@ -3664,7 +4286,7 @@ module Aws::TranscribeService
3664
4286
  # 2. Use the ARN for the KMS key alias. For example,
3665
4287
  # `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
3666
4288
  #
3667
- # If you don't specify an encryption key, your output is encrypted
4289
+ # If you do not specify an encryption key, your output is encrypted
3668
4290
  # with the default Amazon S3 key (SSE-S3).
3669
4291
  #
3670
4292
  # If you specify a KMS key to encrypt your output, you must also
@@ -3810,7 +4432,7 @@ module Aws::TranscribeService
3810
4432
  # The sample rate, in hertz, of the audio track in your input media
3811
4433
  # file.
3812
4434
  #
3813
- # If you don't specify the media sample rate, Amazon Transcribe
4435
+ # If you do not specify the media sample rate, Amazon Transcribe
3814
4436
  # determines it for you. If you specify the sample rate, it must match
3815
4437
  # the rate detected by Amazon Transcribe. If there's a mismatch
3816
4438
  # between the value that you specify and the value detected, your job
@@ -3847,7 +4469,7 @@ module Aws::TranscribeService
3847
4469
  # [Amazon Web Services Management Console][1]. See also [Permissions
3848
4470
  # Required for IAM User Roles][2].
3849
4471
  #
3850
- # If you don't specify `OutputBucketName`, your transcript is placed
4472
+ # If you do not specify `OutputBucketName`, your transcript is placed
3851
4473
  # in a service-managed Amazon S3 bucket and you are provided with a
3852
4474
  # URI to access your transcript.
3853
4475
  #
@@ -3920,7 +4542,7 @@ module Aws::TranscribeService
3920
4542
  # 2. Use the ARN for the KMS key alias. For example,
3921
4543
  # `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
3922
4544
  #
3923
- # If you don't specify an encryption key, your output is encrypted
4545
+ # If you do not specify an encryption key, your output is encrypted
3924
4546
  # with the default Amazon S3 key (SSE-S3).
3925
4547
  #
3926
4548
  # If you specify a KMS key to encrypt your output, you must also
@@ -3988,7 +4610,10 @@ module Aws::TranscribeService
3988
4610
  # Makes it possible to redact or flag specified personally
3989
4611
  # identifiable information (PII) in your transcript. If you use
3990
4612
  # `ContentRedaction`, you must also include the sub-parameters:
3991
- # `PiiEntityTypes`, `RedactionOutput`, and `RedactionType`.
4613
+ # `RedactionOutput` and `RedactionType`. You can optionally include
4614
+ # `PiiEntityTypes` to choose which types of PII you want to redact. If
4615
+ # you do not include `PiiEntityTypes` in your request, all PII is
4616
+ # redacted.
3992
4617
  # @return [Types::ContentRedaction]
3993
4618
  #
3994
4619
  # @!attribute [rw] identify_language
@@ -4583,7 +5208,8 @@ module Aws::TranscribeService
4583
5208
  # * `Unsupported media format`.
4584
5209
  #
4585
5210
  # The media format specified in `MediaFormat` isn't valid. Refer to
4586
- # **MediaFormat** for a list of supported formats.
5211
+ # refer to the `MediaFormat` parameter for a list of supported
5212
+ # formats.
4587
5213
  #
4588
5214
  # * `The media format provided does not match the detected media
4589
5215
  # format`.
@@ -4607,18 +5233,16 @@ module Aws::TranscribeService
4607
5233
  # * `Invalid file size: file size too large`.
4608
5234
  #
4609
5235
  # The size of your media file is larger than what Amazon Transcribe
4610
- # can process. For more information, refer to [Guidelines and
4611
- # quotas][1].
5236
+ # can process. For more information, refer to [Service quotas][1].
4612
5237
  #
4613
5238
  # * `Invalid number of channels: number of channels too large`.
4614
5239
  #
4615
5240
  # Your audio contains more channels than Amazon Transcribe is able
4616
- # to process. For more information, refer to [Guidelines and
4617
- # quotas][1].
5241
+ # to process. For more information, refer to [Service quotas][1].
4618
5242
  #
4619
5243
  #
4620
5244
  #
4621
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits
5245
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe
4622
5246
  # @return [String]
4623
5247
  #
4624
5248
  # @!attribute [rw] settings