aws-sdk-transcribeservice 1.92.0 → 1.93.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-transcribeservice/client.rb +437 -32
- data/lib/aws-sdk-transcribeservice/client_api.rb +148 -0
- data/lib/aws-sdk-transcribeservice/endpoints.rb +56 -0
- data/lib/aws-sdk-transcribeservice/plugins/endpoints.rb +8 -0
- data/lib/aws-sdk-transcribeservice/types.rb +709 -85
- data/lib/aws-sdk-transcribeservice.rb +1 -1
- metadata +1 -1
@@ -1180,6 +1180,31 @@ module Aws::TranscribeService
|
|
1180
1180
|
req.send_request(options)
|
1181
1181
|
end
|
1182
1182
|
|
1183
|
+
# Deletes a Medical Scribe job. To use this operation, specify the name
|
1184
|
+
# of the job you want to delete using `MedicalScribeJobName`. Job names
|
1185
|
+
# are case sensitive.
|
1186
|
+
#
|
1187
|
+
# @option params [required, String] :medical_scribe_job_name
|
1188
|
+
# The name of the Medical Scribe job you want to delete. Job names are
|
1189
|
+
# case sensitive.
|
1190
|
+
#
|
1191
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1192
|
+
#
|
1193
|
+
# @example Request syntax with placeholder values
|
1194
|
+
#
|
1195
|
+
# resp = client.delete_medical_scribe_job({
|
1196
|
+
# medical_scribe_job_name: "TranscriptionJobName", # required
|
1197
|
+
# })
|
1198
|
+
#
|
1199
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteMedicalScribeJob AWS API Documentation
|
1200
|
+
#
|
1201
|
+
# @overload delete_medical_scribe_job(params = {})
|
1202
|
+
# @param [Hash] params ({})
|
1203
|
+
def delete_medical_scribe_job(params = {}, options = {})
|
1204
|
+
req = build_request(:delete_medical_scribe_job, params)
|
1205
|
+
req.send_request(options)
|
1206
|
+
end
|
1207
|
+
|
1183
1208
|
# Deletes a medical transcription job. To use this operation, specify
|
1184
1209
|
# the name of the job you want to delete using
|
1185
1210
|
# `MedicalTranscriptionJobName`. Job names are case sensitive.
|
@@ -1512,6 +1537,66 @@ module Aws::TranscribeService
|
|
1512
1537
|
req.send_request(options)
|
1513
1538
|
end
|
1514
1539
|
|
1540
|
+
# Provides information about the specified Medical Scribe job.
|
1541
|
+
#
|
1542
|
+
# To view the status of the specified medical transcription job, check
|
1543
|
+
# the `MedicalScribeJobStatus` field. If the status is `COMPLETED`, the
|
1544
|
+
# job is finished. You can find the results at the location specified in
|
1545
|
+
# `MedicalScribeOutput`. If the status is `FAILED`, `FailureReason`
|
1546
|
+
# provides details on why your Medical Scribe job failed.
|
1547
|
+
#
|
1548
|
+
# To get a list of your Medical Scribe jobs, use the operation.
|
1549
|
+
#
|
1550
|
+
# @option params [required, String] :medical_scribe_job_name
|
1551
|
+
# The name of the Medical Scribe job you want information about. Job
|
1552
|
+
# names are case sensitive.
|
1553
|
+
#
|
1554
|
+
# @return [Types::GetMedicalScribeJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1555
|
+
#
|
1556
|
+
# * {Types::GetMedicalScribeJobResponse#medical_scribe_job #medical_scribe_job} => Types::MedicalScribeJob
|
1557
|
+
#
|
1558
|
+
# @example Request syntax with placeholder values
|
1559
|
+
#
|
1560
|
+
# resp = client.get_medical_scribe_job({
|
1561
|
+
# medical_scribe_job_name: "TranscriptionJobName", # required
|
1562
|
+
# })
|
1563
|
+
#
|
1564
|
+
# @example Response structure
|
1565
|
+
#
|
1566
|
+
# resp.medical_scribe_job.medical_scribe_job_name #=> String
|
1567
|
+
# resp.medical_scribe_job.medical_scribe_job_status #=> String, one of "QUEUED", "IN_PROGRESS", "FAILED", "COMPLETED"
|
1568
|
+
# resp.medical_scribe_job.language_code #=> String, one of "en-US"
|
1569
|
+
# resp.medical_scribe_job.media.media_file_uri #=> String
|
1570
|
+
# resp.medical_scribe_job.media.redacted_media_file_uri #=> String
|
1571
|
+
# resp.medical_scribe_job.medical_scribe_output.transcript_file_uri #=> String
|
1572
|
+
# resp.medical_scribe_job.medical_scribe_output.clinical_document_uri #=> String
|
1573
|
+
# resp.medical_scribe_job.start_time #=> Time
|
1574
|
+
# resp.medical_scribe_job.creation_time #=> Time
|
1575
|
+
# resp.medical_scribe_job.completion_time #=> Time
|
1576
|
+
# resp.medical_scribe_job.failure_reason #=> String
|
1577
|
+
# resp.medical_scribe_job.settings.show_speaker_labels #=> Boolean
|
1578
|
+
# resp.medical_scribe_job.settings.max_speaker_labels #=> Integer
|
1579
|
+
# resp.medical_scribe_job.settings.channel_identification #=> Boolean
|
1580
|
+
# resp.medical_scribe_job.settings.vocabulary_name #=> String
|
1581
|
+
# resp.medical_scribe_job.settings.vocabulary_filter_name #=> String
|
1582
|
+
# resp.medical_scribe_job.settings.vocabulary_filter_method #=> String, one of "remove", "mask", "tag"
|
1583
|
+
# resp.medical_scribe_job.data_access_role_arn #=> String
|
1584
|
+
# resp.medical_scribe_job.channel_definitions #=> Array
|
1585
|
+
# resp.medical_scribe_job.channel_definitions[0].channel_id #=> Integer
|
1586
|
+
# resp.medical_scribe_job.channel_definitions[0].participant_role #=> String, one of "PATIENT", "CLINICIAN"
|
1587
|
+
# resp.medical_scribe_job.tags #=> Array
|
1588
|
+
# resp.medical_scribe_job.tags[0].key #=> String
|
1589
|
+
# resp.medical_scribe_job.tags[0].value #=> String
|
1590
|
+
#
|
1591
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetMedicalScribeJob AWS API Documentation
|
1592
|
+
#
|
1593
|
+
# @overload get_medical_scribe_job(params = {})
|
1594
|
+
# @param [Hash] params ({})
|
1595
|
+
def get_medical_scribe_job(params = {}, options = {})
|
1596
|
+
req = build_request(:get_medical_scribe_job, params)
|
1597
|
+
req.send_request(options)
|
1598
|
+
end
|
1599
|
+
|
1515
1600
|
# Provides information about the specified medical transcription job.
|
1516
1601
|
#
|
1517
1602
|
# To view the status of the specified medical transcription job, check
|
@@ -1807,7 +1892,7 @@ module Aws::TranscribeService
|
|
1807
1892
|
# @option params [Integer] :max_results
|
1808
1893
|
# The maximum number of Call Analytics categories to return in each page
|
1809
1894
|
# of results. If there are fewer results than the value that you
|
1810
|
-
# specify, only the actual results are returned. If you
|
1895
|
+
# specify, only the actual results are returned. If you do not specify a
|
1811
1896
|
# value, a default of 5 is used.
|
1812
1897
|
#
|
1813
1898
|
# @return [Types::ListCallAnalyticsCategoriesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -1898,7 +1983,7 @@ module Aws::TranscribeService
|
|
1898
1983
|
#
|
1899
1984
|
# @option params [String] :status
|
1900
1985
|
# Returns only Call Analytics jobs with the specified status. Jobs are
|
1901
|
-
# ordered by creation date, with the newest job first. If you
|
1986
|
+
# ordered by creation date, with the newest job first. If you do not
|
1902
1987
|
# include `Status`, all Call Analytics jobs are returned.
|
1903
1988
|
#
|
1904
1989
|
# @option params [String] :job_name_contains
|
@@ -1915,7 +2000,7 @@ module Aws::TranscribeService
|
|
1915
2000
|
# @option params [Integer] :max_results
|
1916
2001
|
# The maximum number of Call Analytics jobs to return in each page of
|
1917
2002
|
# results. If there are fewer results than the value that you specify,
|
1918
|
-
# only the actual results are returned. If you
|
2003
|
+
# only the actual results are returned. If you do not specify a value, a
|
1919
2004
|
# default of 5 is used.
|
1920
2005
|
#
|
1921
2006
|
# @return [Types::ListCallAnalyticsJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -1967,7 +2052,7 @@ module Aws::TranscribeService
|
|
1967
2052
|
# @option params [String] :status_equals
|
1968
2053
|
# Returns only custom language models with the specified status.
|
1969
2054
|
# Language models are ordered by creation date, with the newest model
|
1970
|
-
# first. If you
|
2055
|
+
# first. If you do not include `StatusEquals`, all custom language
|
1971
2056
|
# models are returned.
|
1972
2057
|
#
|
1973
2058
|
# @option params [String] :name_contains
|
@@ -1984,7 +2069,7 @@ module Aws::TranscribeService
|
|
1984
2069
|
# @option params [Integer] :max_results
|
1985
2070
|
# The maximum number of custom language models to return in each page of
|
1986
2071
|
# results. If there are fewer results than the value that you specify,
|
1987
|
-
# only the actual results are returned. If you
|
2072
|
+
# only the actual results are returned. If you do not specify a value, a
|
1988
2073
|
# default of 5 is used.
|
1989
2074
|
#
|
1990
2075
|
# @return [Types::ListLanguageModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -2028,6 +2113,74 @@ module Aws::TranscribeService
|
|
2028
2113
|
req.send_request(options)
|
2029
2114
|
end
|
2030
2115
|
|
2116
|
+
# Provides a list of Medical Scribe jobs that match the specified
|
2117
|
+
# criteria. If no criteria are specified, all Medical Scribe jobs are
|
2118
|
+
# returned.
|
2119
|
+
#
|
2120
|
+
# To get detailed information about a specific Medical Scribe job, use
|
2121
|
+
# the operation.
|
2122
|
+
#
|
2123
|
+
# @option params [String] :status
|
2124
|
+
# Returns only Medical Scribe jobs with the specified status. Jobs are
|
2125
|
+
# ordered by creation date, with the newest job first. If you do not
|
2126
|
+
# include `Status`, all Medical Scribe jobs are returned.
|
2127
|
+
#
|
2128
|
+
# @option params [String] :job_name_contains
|
2129
|
+
# Returns only the Medical Scribe jobs that contain the specified
|
2130
|
+
# string. The search is not case sensitive.
|
2131
|
+
#
|
2132
|
+
# @option params [String] :next_token
|
2133
|
+
# If your `ListMedicalScribeJobs` request returns more results than can
|
2134
|
+
# be displayed, `NextToken` is displayed in the response with an
|
2135
|
+
# associated string. To get the next page of results, copy this string
|
2136
|
+
# and repeat your request, including `NextToken` with the value of the
|
2137
|
+
# copied string. Repeat as needed to view all your results.
|
2138
|
+
#
|
2139
|
+
# @option params [Integer] :max_results
|
2140
|
+
# The maximum number of Medical Scribe jobs to return in each page of
|
2141
|
+
# results. If there are fewer results than the value that you specify,
|
2142
|
+
# only the actual results are returned. If you do not specify a value, a
|
2143
|
+
# default of 5 is used.
|
2144
|
+
#
|
2145
|
+
# @return [Types::ListMedicalScribeJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2146
|
+
#
|
2147
|
+
# * {Types::ListMedicalScribeJobsResponse#status #status} => String
|
2148
|
+
# * {Types::ListMedicalScribeJobsResponse#next_token #next_token} => String
|
2149
|
+
# * {Types::ListMedicalScribeJobsResponse#medical_scribe_job_summaries #medical_scribe_job_summaries} => Array<Types::MedicalScribeJobSummary>
|
2150
|
+
#
|
2151
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2152
|
+
#
|
2153
|
+
# @example Request syntax with placeholder values
|
2154
|
+
#
|
2155
|
+
# resp = client.list_medical_scribe_jobs({
|
2156
|
+
# status: "QUEUED", # accepts QUEUED, IN_PROGRESS, FAILED, COMPLETED
|
2157
|
+
# job_name_contains: "TranscriptionJobName",
|
2158
|
+
# next_token: "NextToken",
|
2159
|
+
# max_results: 1,
|
2160
|
+
# })
|
2161
|
+
#
|
2162
|
+
# @example Response structure
|
2163
|
+
#
|
2164
|
+
# resp.status #=> String, one of "QUEUED", "IN_PROGRESS", "FAILED", "COMPLETED"
|
2165
|
+
# resp.next_token #=> String
|
2166
|
+
# resp.medical_scribe_job_summaries #=> Array
|
2167
|
+
# resp.medical_scribe_job_summaries[0].medical_scribe_job_name #=> String
|
2168
|
+
# resp.medical_scribe_job_summaries[0].creation_time #=> Time
|
2169
|
+
# resp.medical_scribe_job_summaries[0].start_time #=> Time
|
2170
|
+
# resp.medical_scribe_job_summaries[0].completion_time #=> Time
|
2171
|
+
# resp.medical_scribe_job_summaries[0].language_code #=> String, one of "en-US"
|
2172
|
+
# resp.medical_scribe_job_summaries[0].medical_scribe_job_status #=> String, one of "QUEUED", "IN_PROGRESS", "FAILED", "COMPLETED"
|
2173
|
+
# resp.medical_scribe_job_summaries[0].failure_reason #=> String
|
2174
|
+
#
|
2175
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListMedicalScribeJobs AWS API Documentation
|
2176
|
+
#
|
2177
|
+
# @overload list_medical_scribe_jobs(params = {})
|
2178
|
+
# @param [Hash] params ({})
|
2179
|
+
def list_medical_scribe_jobs(params = {}, options = {})
|
2180
|
+
req = build_request(:list_medical_scribe_jobs, params)
|
2181
|
+
req.send_request(options)
|
2182
|
+
end
|
2183
|
+
|
2031
2184
|
# Provides a list of medical transcription jobs that match the specified
|
2032
2185
|
# criteria. If no criteria are specified, all medical transcription jobs
|
2033
2186
|
# are returned.
|
@@ -2038,7 +2191,7 @@ module Aws::TranscribeService
|
|
2038
2191
|
# @option params [String] :status
|
2039
2192
|
# Returns only medical transcription jobs with the specified status.
|
2040
2193
|
# Jobs are ordered by creation date, with the newest job first. If you
|
2041
|
-
#
|
2194
|
+
# do not include `Status`, all medical transcription jobs are returned.
|
2042
2195
|
#
|
2043
2196
|
# @option params [String] :job_name_contains
|
2044
2197
|
# Returns only the medical transcription jobs that contain the specified
|
@@ -2054,7 +2207,7 @@ module Aws::TranscribeService
|
|
2054
2207
|
# @option params [Integer] :max_results
|
2055
2208
|
# The maximum number of medical transcription jobs to return in each
|
2056
2209
|
# page of results. If there are fewer results than the value that you
|
2057
|
-
# specify, only the actual results are returned. If you
|
2210
|
+
# specify, only the actual results are returned. If you do not specify a
|
2058
2211
|
# value, a default of 5 is used.
|
2059
2212
|
#
|
2060
2213
|
# @return [Types::ListMedicalTranscriptionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -2117,13 +2270,13 @@ module Aws::TranscribeService
|
|
2117
2270
|
# @option params [Integer] :max_results
|
2118
2271
|
# The maximum number of custom medical vocabularies to return in each
|
2119
2272
|
# page of results. If there are fewer results than the value that you
|
2120
|
-
# specify, only the actual results are returned. If you
|
2273
|
+
# specify, only the actual results are returned. If you do not specify a
|
2121
2274
|
# value, a default of 5 is used.
|
2122
2275
|
#
|
2123
2276
|
# @option params [String] :state_equals
|
2124
2277
|
# Returns only custom medical vocabularies with the specified state.
|
2125
2278
|
# Custom vocabularies are ordered by creation date, with the newest
|
2126
|
-
# vocabulary first. If you
|
2279
|
+
# vocabulary first. If you do not include `StateEquals`, all custom
|
2127
2280
|
# medical vocabularies are returned.
|
2128
2281
|
#
|
2129
2282
|
# @option params [String] :name_contains
|
@@ -2224,7 +2377,7 @@ module Aws::TranscribeService
|
|
2224
2377
|
#
|
2225
2378
|
# @option params [String] :status
|
2226
2379
|
# Returns only transcription jobs with the specified status. Jobs are
|
2227
|
-
# ordered by creation date, with the newest job first. If you
|
2380
|
+
# ordered by creation date, with the newest job first. If you do not
|
2228
2381
|
# include `Status`, all transcription jobs are returned.
|
2229
2382
|
#
|
2230
2383
|
# @option params [String] :job_name_contains
|
@@ -2241,7 +2394,7 @@ module Aws::TranscribeService
|
|
2241
2394
|
# @option params [Integer] :max_results
|
2242
2395
|
# The maximum number of transcription jobs to return in each page of
|
2243
2396
|
# results. If there are fewer results than the value that you specify,
|
2244
|
-
# only the actual results are returned. If you
|
2397
|
+
# only the actual results are returned. If you do not specify a value, a
|
2245
2398
|
# default of 5 is used.
|
2246
2399
|
#
|
2247
2400
|
# @return [Types::ListTranscriptionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -2315,13 +2468,13 @@ module Aws::TranscribeService
|
|
2315
2468
|
# @option params [Integer] :max_results
|
2316
2469
|
# The maximum number of custom vocabularies to return in each page of
|
2317
2470
|
# results. If there are fewer results than the value that you specify,
|
2318
|
-
# only the actual results are returned. If you
|
2471
|
+
# only the actual results are returned. If you do not specify a value, a
|
2319
2472
|
# default of 5 is used.
|
2320
2473
|
#
|
2321
2474
|
# @option params [String] :state_equals
|
2322
2475
|
# Returns only custom vocabularies with the specified state.
|
2323
2476
|
# Vocabularies are ordered by creation date, with the newest vocabulary
|
2324
|
-
# first. If you
|
2477
|
+
# first. If you do not include `StateEquals`, all custom medical
|
2325
2478
|
# vocabularies are returned.
|
2326
2479
|
#
|
2327
2480
|
# @option params [String] :name_contains
|
@@ -2381,7 +2534,7 @@ module Aws::TranscribeService
|
|
2381
2534
|
# @option params [Integer] :max_results
|
2382
2535
|
# The maximum number of custom vocabulary filters to return in each page
|
2383
2536
|
# of results. If there are fewer results than the value that you
|
2384
|
-
# specify, only the actual results are returned. If you
|
2537
|
+
# specify, only the actual results are returned. If you do not specify a
|
2385
2538
|
# value, a default of 5 is used.
|
2386
2539
|
#
|
2387
2540
|
# @option params [String] :name_contains
|
@@ -2505,11 +2658,11 @@ module Aws::TranscribeService
|
|
2505
2658
|
# transcription job using the `CallAnalyticsJobName` parameter.
|
2506
2659
|
#
|
2507
2660
|
# You can specify a KMS key to encrypt your output using the
|
2508
|
-
# `OutputEncryptionKMSKeyId` parameter. If you
|
2661
|
+
# `OutputEncryptionKMSKeyId` parameter. If you do not specify a KMS key,
|
2509
2662
|
# Amazon Transcribe uses the default Amazon S3 key for server-side
|
2510
2663
|
# encryption.
|
2511
2664
|
#
|
2512
|
-
# If you
|
2665
|
+
# If you do not specify `OutputLocation`, your transcript is placed in a
|
2513
2666
|
# service-managed Amazon S3 bucket and you are provided with a URI to
|
2514
2667
|
# access your transcript.
|
2515
2668
|
#
|
@@ -2542,7 +2695,7 @@ module Aws::TranscribeService
|
|
2542
2695
|
# 2. Use the ARN for the KMS key alias. For example,
|
2543
2696
|
# `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
|
2544
2697
|
#
|
2545
|
-
# If you
|
2698
|
+
# If you do not specify an encryption key, your output is encrypted with
|
2546
2699
|
# the default Amazon S3 key (SSE-S3).
|
2547
2700
|
#
|
2548
2701
|
# If you specify a KMS key to encrypt your output, you must also specify
|
@@ -2670,6 +2823,257 @@ module Aws::TranscribeService
|
|
2670
2823
|
req.send_request(options)
|
2671
2824
|
end
|
2672
2825
|
|
2826
|
+
# Transcribes patient-clinician conversations and generates clinical
|
2827
|
+
# notes.
|
2828
|
+
#
|
2829
|
+
# Amazon Web Services HealthScribe automatically provides rich
|
2830
|
+
# conversation transcripts, identifies speaker roles, classifies
|
2831
|
+
# dialogues, extracts medical terms, and generates preliminary clinical
|
2832
|
+
# notes. To learn more about these features, refer to [Amazon Web
|
2833
|
+
# Services HealthScribe][1].
|
2834
|
+
#
|
2835
|
+
# To make a `StartMedicalScribeJob` request, you must first upload your
|
2836
|
+
# media file into an Amazon S3 bucket; you can then specify the Amazon
|
2837
|
+
# S3 location of the file using the `Media` parameter.
|
2838
|
+
#
|
2839
|
+
# You must include the following parameters in your
|
2840
|
+
# `StartMedicalTranscriptionJob` request:
|
2841
|
+
#
|
2842
|
+
# * `DataAccessRoleArn`: The ARN of an IAM role with the these minimum
|
2843
|
+
# permissions: read permission on input file Amazon S3 bucket
|
2844
|
+
# specified in `Media`, write permission on the Amazon S3 bucket
|
2845
|
+
# specified in `OutputBucketName`, and full permissions on the KMS key
|
2846
|
+
# specified in `OutputEncryptionKMSKeyId` (if set). The role should
|
2847
|
+
# also allow `transcribe.amazonaws.com` to assume it.
|
2848
|
+
#
|
2849
|
+
# * `Media` (`MediaFileUri`): The Amazon S3 location of your media file.
|
2850
|
+
#
|
2851
|
+
# * `MedicalScribeJobName`: A custom name you create for your
|
2852
|
+
# MedicalScribe job that is unique within your Amazon Web Services
|
2853
|
+
# account.
|
2854
|
+
#
|
2855
|
+
# * `OutputBucketName`: The Amazon S3 bucket where you want your output
|
2856
|
+
# files stored.
|
2857
|
+
#
|
2858
|
+
# * `Settings`: A `MedicalScribeSettings` obect that must set exactly
|
2859
|
+
# one of `ShowSpeakerLabels` or `ChannelIdentification` to true. If
|
2860
|
+
# `ShowSpeakerLabels` is true, `MaxSpeakerLabels` must also be set.
|
2861
|
+
#
|
2862
|
+
# * `ChannelDefinitions`: A `MedicalScribeChannelDefinitions` array
|
2863
|
+
# should be set if and only if the `ChannelIdentification` value of
|
2864
|
+
# `Settings` is set to true.
|
2865
|
+
#
|
2866
|
+
#
|
2867
|
+
#
|
2868
|
+
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/health-scribe.html
|
2869
|
+
#
|
2870
|
+
# @option params [required, String] :medical_scribe_job_name
|
2871
|
+
# A unique name, chosen by you, for your Medical Scribe job.
|
2872
|
+
#
|
2873
|
+
# This name is case sensitive, cannot contain spaces, and must be unique
|
2874
|
+
# within an Amazon Web Services account. If you try to create a new job
|
2875
|
+
# with the same name as an existing job, you get a `ConflictException`
|
2876
|
+
# error.
|
2877
|
+
#
|
2878
|
+
# @option params [required, Types::Media] :media
|
2879
|
+
# Describes the Amazon S3 location of the media file you want to use in
|
2880
|
+
# your request.
|
2881
|
+
#
|
2882
|
+
# For information on supported media formats, refer to the `MediaFormat`
|
2883
|
+
# parameter or the [Media formats][1] section in the Amazon S3 Developer
|
2884
|
+
# Guide.
|
2885
|
+
#
|
2886
|
+
#
|
2887
|
+
#
|
2888
|
+
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio
|
2889
|
+
#
|
2890
|
+
# @option params [required, String] :output_bucket_name
|
2891
|
+
# The name of the Amazon S3 bucket where you want your Medical Scribe
|
2892
|
+
# output stored. Do not include the `S3://` prefix of the specified
|
2893
|
+
# bucket.
|
2894
|
+
#
|
2895
|
+
# Note that the role specified in the `DataAccessRoleArn` request
|
2896
|
+
# parameter must have permission to use the specified location. You can
|
2897
|
+
# change Amazon S3 permissions using the [Amazon Web Services Management
|
2898
|
+
# Console][1]. See also [Permissions Required for IAM User Roles][2].
|
2899
|
+
#
|
2900
|
+
#
|
2901
|
+
#
|
2902
|
+
# [1]: https://console.aws.amazon.com/s3
|
2903
|
+
# [2]: https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user
|
2904
|
+
#
|
2905
|
+
# @option params [String] :output_encryption_kms_key_id
|
2906
|
+
# The KMS key you want to use to encrypt your Medical Scribe output.
|
2907
|
+
#
|
2908
|
+
# If using a key located in the **current** Amazon Web Services account,
|
2909
|
+
# you can specify your KMS key in one of four ways:
|
2910
|
+
#
|
2911
|
+
# 1. Use the KMS key ID itself. For example,
|
2912
|
+
# `1234abcd-12ab-34cd-56ef-1234567890ab`.
|
2913
|
+
#
|
2914
|
+
# 2. Use an alias for the KMS key ID. For example,
|
2915
|
+
# `alias/ExampleAlias`.
|
2916
|
+
#
|
2917
|
+
# 3. Use the Amazon Resource Name (ARN) for the KMS key ID. For
|
2918
|
+
# example,
|
2919
|
+
# `arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
2920
|
+
#
|
2921
|
+
# 4. Use the ARN for the KMS key alias. For example,
|
2922
|
+
# `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
|
2923
|
+
#
|
2924
|
+
# If using a key located in a **different** Amazon Web Services account
|
2925
|
+
# than the current Amazon Web Services account, you can specify your KMS
|
2926
|
+
# key in one of two ways:
|
2927
|
+
#
|
2928
|
+
# 1. Use the ARN for the KMS key ID. For example,
|
2929
|
+
# `arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
|
2930
|
+
#
|
2931
|
+
# 2. Use the ARN for the KMS key alias. For example,
|
2932
|
+
# `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
|
2933
|
+
#
|
2934
|
+
# If you do not specify an encryption key, your output is encrypted with
|
2935
|
+
# the default Amazon S3 key (SSE-S3).
|
2936
|
+
#
|
2937
|
+
# Note that the role specified in the `DataAccessRoleArn` request
|
2938
|
+
# parameter must have permission to use the specified KMS key.
|
2939
|
+
#
|
2940
|
+
# @option params [Hash<String,String>] :kms_encryption_context
|
2941
|
+
# A map of plain text, non-secret key:value pairs, known as encryption
|
2942
|
+
# context pairs, that provide an added layer of security for your data.
|
2943
|
+
# For more information, see [KMS encryption context][1] and [Asymmetric
|
2944
|
+
# keys in KMS][2].
|
2945
|
+
#
|
2946
|
+
#
|
2947
|
+
#
|
2948
|
+
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context
|
2949
|
+
# [2]: https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html
|
2950
|
+
#
|
2951
|
+
# @option params [required, String] :data_access_role_arn
|
2952
|
+
# The Amazon Resource Name (ARN) of an IAM role that has permissions to
|
2953
|
+
# access the Amazon S3 bucket that contains your input files, write to
|
2954
|
+
# the output bucket, and use your KMS key if supplied. If the role that
|
2955
|
+
# you specify doesn’t have the appropriate permissions your request
|
2956
|
+
# fails.
|
2957
|
+
#
|
2958
|
+
# IAM role ARNs have the format
|
2959
|
+
# `arn:partition:iam::account:role/role-name-with-path`. For example:
|
2960
|
+
# `arn:aws:iam::111122223333:role/Admin`.
|
2961
|
+
#
|
2962
|
+
# For more information, see [IAM ARNs][1].
|
2963
|
+
#
|
2964
|
+
#
|
2965
|
+
#
|
2966
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns
|
2967
|
+
#
|
2968
|
+
# @option params [required, Types::MedicalScribeSettings] :settings
|
2969
|
+
# Makes it possible to control how your Medical Scribe job is processed
|
2970
|
+
# using a `MedicalScribeSettings` object. Specify
|
2971
|
+
# `ChannelIdentification` if `ChannelDefinitions` are set. Enabled
|
2972
|
+
# `ShowSpeakerLabels` if `ChannelIdentification` and
|
2973
|
+
# `ChannelDefinitions` are not set. One and only one of
|
2974
|
+
# `ChannelIdentification` and `ShowSpeakerLabels` must be set. If
|
2975
|
+
# `ShowSpeakerLabels` is set, `MaxSpeakerLabels` must also be set. Use
|
2976
|
+
# `Settings` to specify a vocabulary or vocabulary filter or both using
|
2977
|
+
# `VocabularyName`, `VocabularyFilterName`. `VocabularyFilterMethod`
|
2978
|
+
# must be specified if `VocabularyFilterName` is set.
|
2979
|
+
#
|
2980
|
+
# @option params [Array<Types::MedicalScribeChannelDefinition>] :channel_definitions
|
2981
|
+
# Makes it possible to specify which speaker is on which channel. For
|
2982
|
+
# example, if the clinician is the first participant to speak, you would
|
2983
|
+
# set `ChannelId` of the first `ChannelDefinition` in the list to `0`
|
2984
|
+
# (to indicate the first channel) and `ParticipantRole` to `CLINICIAN`
|
2985
|
+
# (to indicate that it's the clinician speaking). Then you would set
|
2986
|
+
# the `ChannelId` of the second `ChannelDefinition` in the list to `1`
|
2987
|
+
# (to indicate the second channel) and `ParticipantRole` to `PATIENT`
|
2988
|
+
# (to indicate that it's the patient speaking).
|
2989
|
+
#
|
2990
|
+
# @option params [Array<Types::Tag>] :tags
|
2991
|
+
# Adds one or more custom tags, each in the form of a key:value pair, to
|
2992
|
+
# the Medica Scribe job.
|
2993
|
+
#
|
2994
|
+
# To learn more about using tags with Amazon Transcribe, refer to
|
2995
|
+
# [Tagging resources][1].
|
2996
|
+
#
|
2997
|
+
#
|
2998
|
+
#
|
2999
|
+
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html
|
3000
|
+
#
|
3001
|
+
# @return [Types::StartMedicalScribeJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3002
|
+
#
|
3003
|
+
# * {Types::StartMedicalScribeJobResponse#medical_scribe_job #medical_scribe_job} => Types::MedicalScribeJob
|
3004
|
+
#
|
3005
|
+
# @example Request syntax with placeholder values
|
3006
|
+
#
|
3007
|
+
# resp = client.start_medical_scribe_job({
|
3008
|
+
# medical_scribe_job_name: "TranscriptionJobName", # required
|
3009
|
+
# media: { # required
|
3010
|
+
# media_file_uri: "Uri",
|
3011
|
+
# redacted_media_file_uri: "Uri",
|
3012
|
+
# },
|
3013
|
+
# output_bucket_name: "OutputBucketName", # required
|
3014
|
+
# output_encryption_kms_key_id: "KMSKeyId",
|
3015
|
+
# kms_encryption_context: {
|
3016
|
+
# "NonEmptyString" => "NonEmptyString",
|
3017
|
+
# },
|
3018
|
+
# data_access_role_arn: "DataAccessRoleArn", # required
|
3019
|
+
# settings: { # required
|
3020
|
+
# show_speaker_labels: false,
|
3021
|
+
# max_speaker_labels: 1,
|
3022
|
+
# channel_identification: false,
|
3023
|
+
# vocabulary_name: "VocabularyName",
|
3024
|
+
# vocabulary_filter_name: "VocabularyFilterName",
|
3025
|
+
# vocabulary_filter_method: "remove", # accepts remove, mask, tag
|
3026
|
+
# },
|
3027
|
+
# channel_definitions: [
|
3028
|
+
# {
|
3029
|
+
# channel_id: 1, # required
|
3030
|
+
# participant_role: "PATIENT", # required, accepts PATIENT, CLINICIAN
|
3031
|
+
# },
|
3032
|
+
# ],
|
3033
|
+
# tags: [
|
3034
|
+
# {
|
3035
|
+
# key: "TagKey", # required
|
3036
|
+
# value: "TagValue", # required
|
3037
|
+
# },
|
3038
|
+
# ],
|
3039
|
+
# })
|
3040
|
+
#
|
3041
|
+
# @example Response structure
|
3042
|
+
#
|
3043
|
+
# resp.medical_scribe_job.medical_scribe_job_name #=> String
|
3044
|
+
# resp.medical_scribe_job.medical_scribe_job_status #=> String, one of "QUEUED", "IN_PROGRESS", "FAILED", "COMPLETED"
|
3045
|
+
# resp.medical_scribe_job.language_code #=> String, one of "en-US"
|
3046
|
+
# resp.medical_scribe_job.media.media_file_uri #=> String
|
3047
|
+
# resp.medical_scribe_job.media.redacted_media_file_uri #=> String
|
3048
|
+
# resp.medical_scribe_job.medical_scribe_output.transcript_file_uri #=> String
|
3049
|
+
# resp.medical_scribe_job.medical_scribe_output.clinical_document_uri #=> String
|
3050
|
+
# resp.medical_scribe_job.start_time #=> Time
|
3051
|
+
# resp.medical_scribe_job.creation_time #=> Time
|
3052
|
+
# resp.medical_scribe_job.completion_time #=> Time
|
3053
|
+
# resp.medical_scribe_job.failure_reason #=> String
|
3054
|
+
# resp.medical_scribe_job.settings.show_speaker_labels #=> Boolean
|
3055
|
+
# resp.medical_scribe_job.settings.max_speaker_labels #=> Integer
|
3056
|
+
# resp.medical_scribe_job.settings.channel_identification #=> Boolean
|
3057
|
+
# resp.medical_scribe_job.settings.vocabulary_name #=> String
|
3058
|
+
# resp.medical_scribe_job.settings.vocabulary_filter_name #=> String
|
3059
|
+
# resp.medical_scribe_job.settings.vocabulary_filter_method #=> String, one of "remove", "mask", "tag"
|
3060
|
+
# resp.medical_scribe_job.data_access_role_arn #=> String
|
3061
|
+
# resp.medical_scribe_job.channel_definitions #=> Array
|
3062
|
+
# resp.medical_scribe_job.channel_definitions[0].channel_id #=> Integer
|
3063
|
+
# resp.medical_scribe_job.channel_definitions[0].participant_role #=> String, one of "PATIENT", "CLINICIAN"
|
3064
|
+
# resp.medical_scribe_job.tags #=> Array
|
3065
|
+
# resp.medical_scribe_job.tags[0].key #=> String
|
3066
|
+
# resp.medical_scribe_job.tags[0].value #=> String
|
3067
|
+
#
|
3068
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartMedicalScribeJob AWS API Documentation
|
3069
|
+
#
|
3070
|
+
# @overload start_medical_scribe_job(params = {})
|
3071
|
+
# @param [Hash] params ({})
|
3072
|
+
def start_medical_scribe_job(params = {}, options = {})
|
3073
|
+
req = build_request(:start_medical_scribe_job, params)
|
3074
|
+
req.send_request(options)
|
3075
|
+
end
|
3076
|
+
|
2673
3077
|
# Transcribes the audio from a medical dictation or conversation and
|
2674
3078
|
# applies any additional Request Parameters you choose to include in
|
2675
3079
|
# your request.
|
@@ -2682,7 +3086,7 @@ module Aws::TranscribeService
|
|
2682
3086
|
#
|
2683
3087
|
# To make a `StartMedicalTranscriptionJob` request, you must first
|
2684
3088
|
# upload your media file into an Amazon S3 bucket; you can then specify
|
2685
|
-
# the S3 location of the file using the `Media` parameter.
|
3089
|
+
# the Amazon S3 location of the file using the `Media` parameter.
|
2686
3090
|
#
|
2687
3091
|
# You must include the following parameters in your
|
2688
3092
|
# `StartMedicalTranscriptionJob` request:
|
@@ -2734,7 +3138,7 @@ module Aws::TranscribeService
|
|
2734
3138
|
# The sample rate, in hertz, of the audio track in your input media
|
2735
3139
|
# file.
|
2736
3140
|
#
|
2737
|
-
# If you
|
3141
|
+
# If you do not specify the media sample rate, Amazon Transcribe Medical
|
2738
3142
|
# determines it for you. If you specify the sample rate, it must match
|
2739
3143
|
# the rate detected by Amazon Transcribe Medical; if there's a mismatch
|
2740
3144
|
# between the value that you specify and the value detected, your job
|
@@ -2749,14 +3153,13 @@ module Aws::TranscribeService
|
|
2749
3153
|
# Describes the Amazon S3 location of the media file you want to use in
|
2750
3154
|
# your request.
|
2751
3155
|
#
|
2752
|
-
# For information on supported media formats, refer to the
|
2753
|
-
#
|
2754
|
-
#
|
3156
|
+
# For information on supported media formats, refer to the `MediaFormat`
|
3157
|
+
# parameter or the [Media formats][1] section in the Amazon S3 Developer
|
3158
|
+
# Guide.
|
2755
3159
|
#
|
2756
3160
|
#
|
2757
3161
|
#
|
2758
|
-
# [1]: https://docs.aws.amazon.com/
|
2759
|
-
# [2]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio
|
3162
|
+
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio
|
2760
3163
|
#
|
2761
3164
|
# @option params [required, String] :output_bucket_name
|
2762
3165
|
# The name of the Amazon S3 bucket where you want your medical
|
@@ -2846,7 +3249,7 @@ module Aws::TranscribeService
|
|
2846
3249
|
# 2. Use the ARN for the KMS key alias. For example,
|
2847
3250
|
# `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
|
2848
3251
|
#
|
2849
|
-
# If you
|
3252
|
+
# If you do not specify an encryption key, your output is encrypted with
|
2850
3253
|
# the default Amazon S3 key (SSE-S3).
|
2851
3254
|
#
|
2852
3255
|
# If you specify a KMS key to encrypt your output, you must also specify
|
@@ -3008,7 +3411,7 @@ module Aws::TranscribeService
|
|
3008
3411
|
# `IdentifyMultipleLanguages`: If you know the language of your media
|
3009
3412
|
# file, specify it using the `LanguageCode` parameter; you can find
|
3010
3413
|
# all valid language codes in the [Supported languages][2] table. If
|
3011
|
-
# you
|
3414
|
+
# you do not know the languages spoken in your media, use either
|
3012
3415
|
# `IdentifyLanguage` or `IdentifyMultipleLanguages` and let Amazon
|
3013
3416
|
# Transcribe identify the languages for you.
|
3014
3417
|
#
|
@@ -3056,7 +3459,7 @@ module Aws::TranscribeService
|
|
3056
3459
|
# The sample rate, in hertz, of the audio track in your input media
|
3057
3460
|
# file.
|
3058
3461
|
#
|
3059
|
-
# If you
|
3462
|
+
# If you do not specify the media sample rate, Amazon Transcribe
|
3060
3463
|
# determines it for you. If you specify the sample rate, it must match
|
3061
3464
|
# the rate detected by Amazon Transcribe. If there's a mismatch between
|
3062
3465
|
# the value that you specify and the value detected, your job fails. In
|
@@ -3090,7 +3493,7 @@ module Aws::TranscribeService
|
|
3090
3493
|
# Services Management Console][1]. See also [Permissions Required for
|
3091
3494
|
# IAM User Roles][2].
|
3092
3495
|
#
|
3093
|
-
# If you
|
3496
|
+
# If you do not specify `OutputBucketName`, your transcript is placed in
|
3094
3497
|
# a service-managed Amazon S3 bucket and you are provided with a URI to
|
3095
3498
|
# access your transcript.
|
3096
3499
|
#
|
@@ -3161,7 +3564,7 @@ module Aws::TranscribeService
|
|
3161
3564
|
# 2. Use the ARN for the KMS key alias. For example,
|
3162
3565
|
# `arn:aws:kms:region:account-ID:alias/ExampleAlias`.
|
3163
3566
|
#
|
3164
|
-
# If you
|
3567
|
+
# If you do not specify an encryption key, your output is encrypted with
|
3165
3568
|
# the default Amazon S3 key (SSE-S3).
|
3166
3569
|
#
|
3167
3570
|
# If you specify a KMS key to encrypt your output, you must also specify
|
@@ -3223,8 +3626,10 @@ module Aws::TranscribeService
|
|
3223
3626
|
# @option params [Types::ContentRedaction] :content_redaction
|
3224
3627
|
# Makes it possible to redact or flag specified personally identifiable
|
3225
3628
|
# information (PII) in your transcript. If you use `ContentRedaction`,
|
3226
|
-
# you must also include the sub-parameters: `
|
3227
|
-
# `
|
3629
|
+
# you must also include the sub-parameters: `RedactionOutput` and
|
3630
|
+
# `RedactionType`. You can optionally include `PiiEntityTypes` to choose
|
3631
|
+
# which types of PII you want to redact. If you do not include
|
3632
|
+
# `PiiEntityTypes` in your request, all PII is redacted.
|
3228
3633
|
#
|
3229
3634
|
# @option params [Boolean] :identify_language
|
3230
3635
|
# Enables automatic language identification in your transcription job
|
@@ -4003,7 +4408,7 @@ module Aws::TranscribeService
|
|
4003
4408
|
params: params,
|
4004
4409
|
config: config)
|
4005
4410
|
context[:gem_name] = 'aws-sdk-transcribeservice'
|
4006
|
-
context[:gem_version] = '1.
|
4411
|
+
context[:gem_version] = '1.93.0'
|
4007
4412
|
Seahorse::Client::Request.new(handlers, context)
|
4008
4413
|
end
|
4009
4414
|
|