aws-sdk-comprehendmedical 1.13.0 → 1.18.1

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 519c4a24186e7dc9553f80f8560620c2e5bdc8cb
4
- data.tar.gz: '09f528a63d12ccda460fa09c8bf60716bb6b9aa6'
2
+ SHA256:
3
+ metadata.gz: 76f1496c2139efa235d42b13c2ffc7e18deb1c972a41331fa4bff95d1eea1b40
4
+ data.tar.gz: a319861b5c9eee5d32322d5c1e4fb102d34e85d80937cfbe844896239dd0de02
5
5
  SHA512:
6
- metadata.gz: 723ca014455dcbe8d4a9f1b8c79b66016376adb1fdd7a8487555afeeb6e5317af80982f1273240da0f25c5c4d06c41588f347f22206ef4182928b209a5ae49f5
7
- data.tar.gz: 5124e92e641f713b409b4b478784043ab9db812da015c62eada880af154aac3ff30f696218ae69bc3c6c81bc392f2bccc86df7852fb9be4ab48d6f1c13209f2c
6
+ metadata.gz: 033c98df80ab2e789e5a4a35d739991298111013dd21d40868220c6cd72ff6010b950b1ff62a387b25c0880738d53b8a4686b3fff812bf5013a1f057c5fb2ff0
7
+ data.tar.gz: f3ae5059a4f613c16b23b90fd3ab5097da11f4448b1ad4ff7813b09a2a75c57fb045e34d0a9fd7038baa6ad5a5cabf694a48cdefbaad3fdc8c31b29554fc88d3
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-comprehendmedical/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # comprehend_medical = Aws::ComprehendMedical::Client.new
28
+ # resp = comprehend_medical.describe_entities_detection_v2_job(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from AWS Comprehend Medical all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from AWS Comprehend Medical are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::ComprehendMedical::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all AWS Comprehend Medical API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-comprehendmedical/customizations'
42
45
  # @service
43
46
  module Aws::ComprehendMedical
44
47
 
45
- GEM_VERSION = '1.13.0'
48
+ GEM_VERSION = '1.18.1'
46
49
 
47
50
  end
@@ -24,12 +24,25 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
24
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
25
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
26
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
27
+ require 'aws-sdk-core/plugins/http_checksum.rb'
27
28
  require 'aws-sdk-core/plugins/signature_v4.rb'
28
29
  require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
29
30
 
30
31
  Aws::Plugins::GlobalConfiguration.add_identifier(:comprehendmedical)
31
32
 
32
33
  module Aws::ComprehendMedical
34
+ # An API client for ComprehendMedical. To construct a client, you need to configure a `:region` and `:credentials`.
35
+ #
36
+ # client = Aws::ComprehendMedical::Client.new(
37
+ # region: region_name,
38
+ # credentials: credentials,
39
+ # # ...
40
+ # )
41
+ #
42
+ # For details on configuring region and credentials see
43
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
44
+ #
45
+ # See {#initialize} for a full list of supported configuration options.
33
46
  class Client < Seahorse::Client::Base
34
47
 
35
48
  include Aws::ClientStubs
@@ -57,6 +70,7 @@ module Aws::ComprehendMedical
57
70
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
58
71
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
59
72
  add_plugin(Aws::Plugins::TransferEncoding)
73
+ add_plugin(Aws::Plugins::HttpChecksum)
60
74
  add_plugin(Aws::Plugins::SignatureV4)
61
75
  add_plugin(Aws::Plugins::Protocols::JsonRpc)
62
76
 
@@ -93,7 +107,7 @@ module Aws::ComprehendMedical
93
107
  # @option options [required, String] :region
94
108
  # The AWS region to connect to. The configured `:region` is
95
109
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
110
+ # a default `:region` is searched for in the following locations:
97
111
  #
98
112
  # * `Aws.config[:region]`
99
113
  # * `ENV['AWS_REGION']`
@@ -108,6 +122,12 @@ module Aws::ComprehendMedical
108
122
  # When set to `true`, a thread polling for endpoints will be running in
109
123
  # the background every 60 secs (default). Defaults to `false`.
110
124
  #
125
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
126
+ # Used only in `adaptive` retry mode. When true, the request will sleep
127
+ # until there is sufficent client side capacity to retry the request.
128
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
129
+ # not retry instead of sleeping.
130
+ #
111
131
  # @option options [Boolean] :client_side_monitoring (false)
112
132
  # When `true`, client-side metrics will be collected for all API requests from
113
133
  # this client.
@@ -132,6 +152,10 @@ module Aws::ComprehendMedical
132
152
  # When `true`, an attempt is made to coerce request parameters into
133
153
  # the required types.
134
154
  #
155
+ # @option options [Boolean] :correct_clock_skew (true)
156
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
157
+ # a clock skew correction and retry requests with skewed client clocks.
158
+ #
135
159
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
160
  # Set to true to disable SDK automatically adding host prefix
137
161
  # to default service endpoint when available.
@@ -139,7 +163,7 @@ module Aws::ComprehendMedical
139
163
  # @option options [String] :endpoint
140
164
  # The client endpoint is normally constructed from the `:region`
141
165
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
166
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
143
167
  #
144
168
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
169
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +178,7 @@ module Aws::ComprehendMedical
154
178
  # requests fetching endpoints information. Defaults to 60 sec.
155
179
  #
156
180
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
181
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
182
  #
159
183
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
184
  # The log formatter.
@@ -166,15 +190,29 @@ module Aws::ComprehendMedical
166
190
  # The Logger instance to send log messages to. If this option
167
191
  # is not set, logging will be disabled.
168
192
  #
193
+ # @option options [Integer] :max_attempts (3)
194
+ # An integer representing the maximum number attempts that will be made for
195
+ # a single request, including the initial attempt. For example,
196
+ # setting this value to 5 will result in a request being retried up to
197
+ # 4 times. Used in `standard` and `adaptive` retry modes.
198
+ #
169
199
  # @option options [String] :profile ("default")
170
200
  # Used when loading credentials from the shared credentials file
171
201
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
202
  #
203
+ # @option options [Proc] :retry_backoff
204
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
205
+ # This option is only used in the `legacy` retry mode.
206
+ #
173
207
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
208
+ # The base delay in seconds used by the default backoff function. This option
209
+ # is only used in the `legacy` retry mode.
175
210
  #
176
211
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
212
+ # A delay randomiser function used by the default backoff function.
213
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
214
+ # otherwise a Proc that takes and returns a number. This option is only used
215
+ # in the `legacy` retry mode.
178
216
  #
179
217
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
218
  #
@@ -182,11 +220,30 @@ module Aws::ComprehendMedical
182
220
  # The maximum number of times to retry failed requests. Only
183
221
  # ~ 500 level server errors and certain ~ 400 level client errors
184
222
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
223
+ # checksum errors, networking errors, timeout errors, auth errors,
224
+ # endpoint discovery, and errors from expired credentials.
225
+ # This option is only used in the `legacy` retry mode.
187
226
  #
188
227
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
228
+ # The maximum number of seconds to delay between retries (0 for no limit)
229
+ # used by the default backoff function. This option is only used in the
230
+ # `legacy` retry mode.
231
+ #
232
+ # @option options [String] :retry_mode ("legacy")
233
+ # Specifies which retry algorithm to use. Values are:
234
+ #
235
+ # * `legacy` - The pre-existing retry behavior. This is default value if
236
+ # no retry mode is provided.
237
+ #
238
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
239
+ # This includes support for retry quotas, which limit the number of
240
+ # unsuccessful retries a client can make.
241
+ #
242
+ # * `adaptive` - An experimental retry mode that includes all the
243
+ # functionality of `standard` mode along with automatic client side
244
+ # throttling. This is a provisional mode that may change behavior
245
+ # in the future.
246
+ #
190
247
  #
191
248
  # @option options [String] :secret_access_key
192
249
  #
@@ -219,16 +276,15 @@ module Aws::ComprehendMedical
219
276
  # requests through. Formatted like 'http://proxy.com:123'.
220
277
  #
221
278
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
279
+ # seconds to wait when opening a HTTP session before raising a
223
280
  # `Timeout::Error`.
224
281
  #
225
282
  # @option options [Integer] :http_read_timeout (60) The default
226
283
  # number of seconds to wait for response data. This value can
227
- # safely be set
228
- # per-request on the session yeidled by {#session_for}.
284
+ # safely be set per-request on the session.
229
285
  #
230
286
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
287
+ # seconds a connection is allowed to sit idle before it is
232
288
  # considered stale. Stale connections are closed and removed
233
289
  # from the pool before making a request.
234
290
  #
@@ -237,7 +293,7 @@ module Aws::ComprehendMedical
237
293
  # request body. This option has no effect unless the request has
238
294
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
295
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
296
+ # request on the session.
241
297
  #
242
298
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
299
  # HTTP debug output will be sent to the `:logger`.
@@ -310,6 +366,52 @@ module Aws::ComprehendMedical
310
366
  req.send_request(options)
311
367
  end
312
368
 
369
+ # Gets the properties associated with an InferICD10CM job. Use this
370
+ # operation to get the status of an inference job.
371
+ #
372
+ # @option params [required, String] :job_id
373
+ # The identifier that Amazon Comprehend Medical generated for the job.
374
+ # `The StartICD10CMInferenceJob` operation returns this identifier in
375
+ # its response.
376
+ #
377
+ # @return [Types::DescribeICD10CMInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
378
+ #
379
+ # * {Types::DescribeICD10CMInferenceJobResponse#comprehend_medical_async_job_properties #comprehend_medical_async_job_properties} => Types::ComprehendMedicalAsyncJobProperties
380
+ #
381
+ # @example Request syntax with placeholder values
382
+ #
383
+ # resp = client.describe_icd10cm_inference_job({
384
+ # job_id: "JobId", # required
385
+ # })
386
+ #
387
+ # @example Response structure
388
+ #
389
+ # resp.comprehend_medical_async_job_properties.job_id #=> String
390
+ # resp.comprehend_medical_async_job_properties.job_name #=> String
391
+ # resp.comprehend_medical_async_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
392
+ # resp.comprehend_medical_async_job_properties.message #=> String
393
+ # resp.comprehend_medical_async_job_properties.submit_time #=> Time
394
+ # resp.comprehend_medical_async_job_properties.end_time #=> Time
395
+ # resp.comprehend_medical_async_job_properties.expiration_time #=> Time
396
+ # resp.comprehend_medical_async_job_properties.input_data_config.s3_bucket #=> String
397
+ # resp.comprehend_medical_async_job_properties.input_data_config.s3_key #=> String
398
+ # resp.comprehend_medical_async_job_properties.output_data_config.s3_bucket #=> String
399
+ # resp.comprehend_medical_async_job_properties.output_data_config.s3_key #=> String
400
+ # resp.comprehend_medical_async_job_properties.language_code #=> String, one of "en"
401
+ # resp.comprehend_medical_async_job_properties.data_access_role_arn #=> String
402
+ # resp.comprehend_medical_async_job_properties.manifest_file_path #=> String
403
+ # resp.comprehend_medical_async_job_properties.kms_key #=> String
404
+ # resp.comprehend_medical_async_job_properties.model_version #=> String
405
+ #
406
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeICD10CMInferenceJob AWS API Documentation
407
+ #
408
+ # @overload describe_icd10cm_inference_job(params = {})
409
+ # @param [Hash] params ({})
410
+ def describe_icd10cm_inference_job(params = {}, options = {})
411
+ req = build_request(:describe_icd10cm_inference_job, params)
412
+ req.send_request(options)
413
+ end
414
+
313
415
  # Gets the properties associated with a protected health information
314
416
  # (PHI) detection job. Use this operation to get the status of a
315
417
  # detection job.
@@ -357,6 +459,52 @@ module Aws::ComprehendMedical
357
459
  req.send_request(options)
358
460
  end
359
461
 
462
+ # Gets the properties associated with an InferRxNorm job. Use this
463
+ # operation to get the status of an inference job.
464
+ #
465
+ # @option params [required, String] :job_id
466
+ # The identifier that Amazon Comprehend Medical generated for the job.
467
+ # The StartRxNormInferenceJob operation returns this identifier in its
468
+ # response.
469
+ #
470
+ # @return [Types::DescribeRxNormInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
471
+ #
472
+ # * {Types::DescribeRxNormInferenceJobResponse#comprehend_medical_async_job_properties #comprehend_medical_async_job_properties} => Types::ComprehendMedicalAsyncJobProperties
473
+ #
474
+ # @example Request syntax with placeholder values
475
+ #
476
+ # resp = client.describe_rx_norm_inference_job({
477
+ # job_id: "JobId", # required
478
+ # })
479
+ #
480
+ # @example Response structure
481
+ #
482
+ # resp.comprehend_medical_async_job_properties.job_id #=> String
483
+ # resp.comprehend_medical_async_job_properties.job_name #=> String
484
+ # resp.comprehend_medical_async_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
485
+ # resp.comprehend_medical_async_job_properties.message #=> String
486
+ # resp.comprehend_medical_async_job_properties.submit_time #=> Time
487
+ # resp.comprehend_medical_async_job_properties.end_time #=> Time
488
+ # resp.comprehend_medical_async_job_properties.expiration_time #=> Time
489
+ # resp.comprehend_medical_async_job_properties.input_data_config.s3_bucket #=> String
490
+ # resp.comprehend_medical_async_job_properties.input_data_config.s3_key #=> String
491
+ # resp.comprehend_medical_async_job_properties.output_data_config.s3_bucket #=> String
492
+ # resp.comprehend_medical_async_job_properties.output_data_config.s3_key #=> String
493
+ # resp.comprehend_medical_async_job_properties.language_code #=> String, one of "en"
494
+ # resp.comprehend_medical_async_job_properties.data_access_role_arn #=> String
495
+ # resp.comprehend_medical_async_job_properties.manifest_file_path #=> String
496
+ # resp.comprehend_medical_async_job_properties.kms_key #=> String
497
+ # resp.comprehend_medical_async_job_properties.model_version #=> String
498
+ #
499
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeRxNormInferenceJob AWS API Documentation
500
+ #
501
+ # @overload describe_rx_norm_inference_job(params = {})
502
+ # @param [Hash] params ({})
503
+ def describe_rx_norm_inference_job(params = {}, options = {})
504
+ req = build_request(:describe_rx_norm_inference_job, params)
505
+ req.send_request(options)
506
+ end
507
+
360
508
  # The `DetectEntities` operation is deprecated. You should use the
361
509
  # DetectEntitiesV2 operation instead.
362
510
  #
@@ -763,6 +911,68 @@ module Aws::ComprehendMedical
763
911
  req.send_request(options)
764
912
  end
765
913
 
914
+ # Gets a list of InferICD10CM jobs that you have submitted.
915
+ #
916
+ # @option params [Types::ComprehendMedicalAsyncJobFilter] :filter
917
+ # Filters the jobs that are returned. You can filter jobs based on their
918
+ # names, status, or the date and time that they were submitted. You can
919
+ # only set one filter at a time.
920
+ #
921
+ # @option params [String] :next_token
922
+ # Identifies the next page of results to return.
923
+ #
924
+ # @option params [Integer] :max_results
925
+ # The maximum number of results to return in each page. The default is
926
+ # 100.
927
+ #
928
+ # @return [Types::ListICD10CMInferenceJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
929
+ #
930
+ # * {Types::ListICD10CMInferenceJobsResponse#comprehend_medical_async_job_properties_list #comprehend_medical_async_job_properties_list} => Array&lt;Types::ComprehendMedicalAsyncJobProperties&gt;
931
+ # * {Types::ListICD10CMInferenceJobsResponse#next_token #next_token} => String
932
+ #
933
+ # @example Request syntax with placeholder values
934
+ #
935
+ # resp = client.list_icd10cm_inference_jobs({
936
+ # filter: {
937
+ # job_name: "JobName",
938
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
939
+ # submit_time_before: Time.now,
940
+ # submit_time_after: Time.now,
941
+ # },
942
+ # next_token: "String",
943
+ # max_results: 1,
944
+ # })
945
+ #
946
+ # @example Response structure
947
+ #
948
+ # resp.comprehend_medical_async_job_properties_list #=> Array
949
+ # resp.comprehend_medical_async_job_properties_list[0].job_id #=> String
950
+ # resp.comprehend_medical_async_job_properties_list[0].job_name #=> String
951
+ # resp.comprehend_medical_async_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
952
+ # resp.comprehend_medical_async_job_properties_list[0].message #=> String
953
+ # resp.comprehend_medical_async_job_properties_list[0].submit_time #=> Time
954
+ # resp.comprehend_medical_async_job_properties_list[0].end_time #=> Time
955
+ # resp.comprehend_medical_async_job_properties_list[0].expiration_time #=> Time
956
+ # resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_bucket #=> String
957
+ # resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_key #=> String
958
+ # resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_bucket #=> String
959
+ # resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_key #=> String
960
+ # resp.comprehend_medical_async_job_properties_list[0].language_code #=> String, one of "en"
961
+ # resp.comprehend_medical_async_job_properties_list[0].data_access_role_arn #=> String
962
+ # resp.comprehend_medical_async_job_properties_list[0].manifest_file_path #=> String
963
+ # resp.comprehend_medical_async_job_properties_list[0].kms_key #=> String
964
+ # resp.comprehend_medical_async_job_properties_list[0].model_version #=> String
965
+ # resp.next_token #=> String
966
+ #
967
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListICD10CMInferenceJobs AWS API Documentation
968
+ #
969
+ # @overload list_icd10cm_inference_jobs(params = {})
970
+ # @param [Hash] params ({})
971
+ def list_icd10cm_inference_jobs(params = {}, options = {})
972
+ req = build_request(:list_icd10cm_inference_jobs, params)
973
+ req.send_request(options)
974
+ end
975
+
766
976
  # Gets a list of protected health information (PHI) detection jobs that
767
977
  # you have submitted.
768
978
  #
@@ -826,6 +1036,67 @@ module Aws::ComprehendMedical
826
1036
  req.send_request(options)
827
1037
  end
828
1038
 
1039
+ # Gets a list of InferRxNorm jobs that you have submitted.
1040
+ #
1041
+ # @option params [Types::ComprehendMedicalAsyncJobFilter] :filter
1042
+ # Filters the jobs that are returned. You can filter jobs based on their
1043
+ # names, status, or the date and time that they were submitted. You can
1044
+ # only set one filter at a time.
1045
+ #
1046
+ # @option params [String] :next_token
1047
+ # Identifies the next page of results to return.
1048
+ #
1049
+ # @option params [Integer] :max_results
1050
+ # Identifies the next page of results to return.
1051
+ #
1052
+ # @return [Types::ListRxNormInferenceJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1053
+ #
1054
+ # * {Types::ListRxNormInferenceJobsResponse#comprehend_medical_async_job_properties_list #comprehend_medical_async_job_properties_list} => Array&lt;Types::ComprehendMedicalAsyncJobProperties&gt;
1055
+ # * {Types::ListRxNormInferenceJobsResponse#next_token #next_token} => String
1056
+ #
1057
+ # @example Request syntax with placeholder values
1058
+ #
1059
+ # resp = client.list_rx_norm_inference_jobs({
1060
+ # filter: {
1061
+ # job_name: "JobName",
1062
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
1063
+ # submit_time_before: Time.now,
1064
+ # submit_time_after: Time.now,
1065
+ # },
1066
+ # next_token: "String",
1067
+ # max_results: 1,
1068
+ # })
1069
+ #
1070
+ # @example Response structure
1071
+ #
1072
+ # resp.comprehend_medical_async_job_properties_list #=> Array
1073
+ # resp.comprehend_medical_async_job_properties_list[0].job_id #=> String
1074
+ # resp.comprehend_medical_async_job_properties_list[0].job_name #=> String
1075
+ # resp.comprehend_medical_async_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
1076
+ # resp.comprehend_medical_async_job_properties_list[0].message #=> String
1077
+ # resp.comprehend_medical_async_job_properties_list[0].submit_time #=> Time
1078
+ # resp.comprehend_medical_async_job_properties_list[0].end_time #=> Time
1079
+ # resp.comprehend_medical_async_job_properties_list[0].expiration_time #=> Time
1080
+ # resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_bucket #=> String
1081
+ # resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_key #=> String
1082
+ # resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_bucket #=> String
1083
+ # resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_key #=> String
1084
+ # resp.comprehend_medical_async_job_properties_list[0].language_code #=> String, one of "en"
1085
+ # resp.comprehend_medical_async_job_properties_list[0].data_access_role_arn #=> String
1086
+ # resp.comprehend_medical_async_job_properties_list[0].manifest_file_path #=> String
1087
+ # resp.comprehend_medical_async_job_properties_list[0].kms_key #=> String
1088
+ # resp.comprehend_medical_async_job_properties_list[0].model_version #=> String
1089
+ # resp.next_token #=> String
1090
+ #
1091
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListRxNormInferenceJobs AWS API Documentation
1092
+ #
1093
+ # @overload list_rx_norm_inference_jobs(params = {})
1094
+ # @param [Hash] params ({})
1095
+ def list_rx_norm_inference_jobs(params = {}, options = {})
1096
+ req = build_request(:list_rx_norm_inference_jobs, params)
1097
+ req.send_request(options)
1098
+ end
1099
+
829
1100
  # Starts an asynchronous medical entity detection job for a collection
830
1101
  # of documents. Use the `DescribeEntitiesDetectionV2Job` operation to
831
1102
  # track the status of a job.
@@ -899,6 +1170,79 @@ module Aws::ComprehendMedical
899
1170
  req.send_request(options)
900
1171
  end
901
1172
 
1173
+ # Starts an asynchronous job to detect medical conditions and link them
1174
+ # to the ICD-10-CM ontology. Use the `DescribeICD10CMInferenceJob`
1175
+ # operation to track the status of a job.
1176
+ #
1177
+ # @option params [required, Types::InputDataConfig] :input_data_config
1178
+ # Specifies the format and location of the input data for the job.
1179
+ #
1180
+ # @option params [required, Types::OutputDataConfig] :output_data_config
1181
+ # Specifies where to send the output files.
1182
+ #
1183
+ # @option params [required, String] :data_access_role_arn
1184
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
1185
+ # Management (IAM) role that grants Amazon Comprehend Medical read
1186
+ # access to your input data. For more information, see [ Role-Based
1187
+ # Permissions Required for Asynchronous Operations][1].
1188
+ #
1189
+ #
1190
+ #
1191
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med
1192
+ #
1193
+ # @option params [String] :job_name
1194
+ # The identifier of the job.
1195
+ #
1196
+ # @option params [String] :client_request_token
1197
+ # A unique identifier for the request. If you don't set the client
1198
+ # request token, Amazon Comprehend Medical generates one.
1199
+ #
1200
+ # **A suitable default value is auto-generated.** You should normally
1201
+ # not need to pass this option.**
1202
+ #
1203
+ # @option params [String] :kms_key
1204
+ # An AWS Key Management Service key to encrypt your output files. If you
1205
+ # do not specify a key, the files are written in plain text.
1206
+ #
1207
+ # @option params [required, String] :language_code
1208
+ # The language of the input documents. All documents must be in the same
1209
+ # language.
1210
+ #
1211
+ # @return [Types::StartICD10CMInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1212
+ #
1213
+ # * {Types::StartICD10CMInferenceJobResponse#job_id #job_id} => String
1214
+ #
1215
+ # @example Request syntax with placeholder values
1216
+ #
1217
+ # resp = client.start_icd10cm_inference_job({
1218
+ # input_data_config: { # required
1219
+ # s3_bucket: "S3Bucket", # required
1220
+ # s3_key: "S3Key",
1221
+ # },
1222
+ # output_data_config: { # required
1223
+ # s3_bucket: "S3Bucket", # required
1224
+ # s3_key: "S3Key",
1225
+ # },
1226
+ # data_access_role_arn: "IamRoleArn", # required
1227
+ # job_name: "JobName",
1228
+ # client_request_token: "ClientRequestTokenString",
1229
+ # kms_key: "KMSKey",
1230
+ # language_code: "en", # required, accepts en
1231
+ # })
1232
+ #
1233
+ # @example Response structure
1234
+ #
1235
+ # resp.job_id #=> String
1236
+ #
1237
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartICD10CMInferenceJob AWS API Documentation
1238
+ #
1239
+ # @overload start_icd10cm_inference_job(params = {})
1240
+ # @param [Hash] params ({})
1241
+ def start_icd10cm_inference_job(params = {}, options = {})
1242
+ req = build_request(:start_icd10cm_inference_job, params)
1243
+ req.send_request(options)
1244
+ end
1245
+
902
1246
  # Starts an asynchronous job to detect protected health information
903
1247
  # (PHI). Use the `DescribePHIDetectionJob` operation to track the status
904
1248
  # of a job.
@@ -972,6 +1316,79 @@ module Aws::ComprehendMedical
972
1316
  req.send_request(options)
973
1317
  end
974
1318
 
1319
+ # Starts an asynchronous job to detect medication entities and link them
1320
+ # to the RxNorm ontology. Use the `DescribeRxNormInferenceJob` operation
1321
+ # to track the status of a job.
1322
+ #
1323
+ # @option params [required, Types::InputDataConfig] :input_data_config
1324
+ # Specifies the format and location of the input data for the job.
1325
+ #
1326
+ # @option params [required, Types::OutputDataConfig] :output_data_config
1327
+ # Specifies where to send the output files.
1328
+ #
1329
+ # @option params [required, String] :data_access_role_arn
1330
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
1331
+ # Management (IAM) role that grants Amazon Comprehend Medical read
1332
+ # access to your input data. For more information, see [ Role-Based
1333
+ # Permissions Required for Asynchronous Operations][1].
1334
+ #
1335
+ #
1336
+ #
1337
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med
1338
+ #
1339
+ # @option params [String] :job_name
1340
+ # The identifier of the job.
1341
+ #
1342
+ # @option params [String] :client_request_token
1343
+ # A unique identifier for the request. If you don't set the client
1344
+ # request token, Amazon Comprehend Medical generates one.
1345
+ #
1346
+ # **A suitable default value is auto-generated.** You should normally
1347
+ # not need to pass this option.**
1348
+ #
1349
+ # @option params [String] :kms_key
1350
+ # An AWS Key Management Service key to encrypt your output files. If you
1351
+ # do not specify a key, the files are written in plain text.
1352
+ #
1353
+ # @option params [required, String] :language_code
1354
+ # The language of the input documents. All documents must be in the same
1355
+ # language.
1356
+ #
1357
+ # @return [Types::StartRxNormInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1358
+ #
1359
+ # * {Types::StartRxNormInferenceJobResponse#job_id #job_id} => String
1360
+ #
1361
+ # @example Request syntax with placeholder values
1362
+ #
1363
+ # resp = client.start_rx_norm_inference_job({
1364
+ # input_data_config: { # required
1365
+ # s3_bucket: "S3Bucket", # required
1366
+ # s3_key: "S3Key",
1367
+ # },
1368
+ # output_data_config: { # required
1369
+ # s3_bucket: "S3Bucket", # required
1370
+ # s3_key: "S3Key",
1371
+ # },
1372
+ # data_access_role_arn: "IamRoleArn", # required
1373
+ # job_name: "JobName",
1374
+ # client_request_token: "ClientRequestTokenString",
1375
+ # kms_key: "KMSKey",
1376
+ # language_code: "en", # required, accepts en
1377
+ # })
1378
+ #
1379
+ # @example Response structure
1380
+ #
1381
+ # resp.job_id #=> String
1382
+ #
1383
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartRxNormInferenceJob AWS API Documentation
1384
+ #
1385
+ # @overload start_rx_norm_inference_job(params = {})
1386
+ # @param [Hash] params ({})
1387
+ def start_rx_norm_inference_job(params = {}, options = {})
1388
+ req = build_request(:start_rx_norm_inference_job, params)
1389
+ req.send_request(options)
1390
+ end
1391
+
975
1392
  # Stops a medical entities detection job in progress.
976
1393
  #
977
1394
  # @option params [required, String] :job_id
@@ -1000,6 +1417,34 @@ module Aws::ComprehendMedical
1000
1417
  req.send_request(options)
1001
1418
  end
1002
1419
 
1420
+ # Stops an InferICD10CM inference job in progress.
1421
+ #
1422
+ # @option params [required, String] :job_id
1423
+ # The identifier of the job.
1424
+ #
1425
+ # @return [Types::StopICD10CMInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1426
+ #
1427
+ # * {Types::StopICD10CMInferenceJobResponse#job_id #job_id} => String
1428
+ #
1429
+ # @example Request syntax with placeholder values
1430
+ #
1431
+ # resp = client.stop_icd10cm_inference_job({
1432
+ # job_id: "JobId", # required
1433
+ # })
1434
+ #
1435
+ # @example Response structure
1436
+ #
1437
+ # resp.job_id #=> String
1438
+ #
1439
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopICD10CMInferenceJob AWS API Documentation
1440
+ #
1441
+ # @overload stop_icd10cm_inference_job(params = {})
1442
+ # @param [Hash] params ({})
1443
+ def stop_icd10cm_inference_job(params = {}, options = {})
1444
+ req = build_request(:stop_icd10cm_inference_job, params)
1445
+ req.send_request(options)
1446
+ end
1447
+
1003
1448
  # Stops a protected health information (PHI) detection job in progress.
1004
1449
  #
1005
1450
  # @option params [required, String] :job_id
@@ -1028,6 +1473,34 @@ module Aws::ComprehendMedical
1028
1473
  req.send_request(options)
1029
1474
  end
1030
1475
 
1476
+ # Stops an InferRxNorm inference job in progress.
1477
+ #
1478
+ # @option params [required, String] :job_id
1479
+ # The identifier of the job.
1480
+ #
1481
+ # @return [Types::StopRxNormInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1482
+ #
1483
+ # * {Types::StopRxNormInferenceJobResponse#job_id #job_id} => String
1484
+ #
1485
+ # @example Request syntax with placeholder values
1486
+ #
1487
+ # resp = client.stop_rx_norm_inference_job({
1488
+ # job_id: "JobId", # required
1489
+ # })
1490
+ #
1491
+ # @example Response structure
1492
+ #
1493
+ # resp.job_id #=> String
1494
+ #
1495
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopRxNormInferenceJob AWS API Documentation
1496
+ #
1497
+ # @overload stop_rx_norm_inference_job(params = {})
1498
+ # @param [Hash] params ({})
1499
+ def stop_rx_norm_inference_job(params = {}, options = {})
1500
+ req = build_request(:stop_rx_norm_inference_job, params)
1501
+ req.send_request(options)
1502
+ end
1503
+
1031
1504
  # @!endgroup
1032
1505
 
1033
1506
  # @param params ({})
@@ -1041,7 +1514,7 @@ module Aws::ComprehendMedical
1041
1514
  params: params,
1042
1515
  config: config)
1043
1516
  context[:gem_name] = 'aws-sdk-comprehendmedical'
1044
- context[:gem_version] = '1.13.0'
1517
+ context[:gem_version] = '1.18.1'
1045
1518
  Seahorse::Client::Request.new(handlers, context)
1046
1519
  end
1047
1520