aws-sdk-comprehendmedical 1.6.0 → 1.12.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -58,6 +58,22 @@ module Aws::ComprehendMedical
58
58
 
59
59
  end
60
60
 
61
+ class ResourceNotFoundException < ServiceError
62
+
63
+ # @param [Seahorse::Client::RequestContext] context
64
+ # @param [String] message
65
+ # @param [Aws::ComprehendMedical::Types::ResourceNotFoundException] data
66
+ def initialize(context, message, data = Aws::EmptyStructure.new)
67
+ super(context, message, data)
68
+ end
69
+
70
+ # @return [String]
71
+ def message
72
+ @message || @data[:message]
73
+ end
74
+
75
+ end
76
+
61
77
  class ServiceUnavailableException < ServiceError
62
78
 
63
79
  # @param [Seahorse::Client::RequestContext] context
@@ -106,5 +122,21 @@ module Aws::ComprehendMedical
106
122
 
107
123
  end
108
124
 
125
+ class ValidationException < ServiceError
126
+
127
+ # @param [Seahorse::Client::RequestContext] context
128
+ # @param [String] message
129
+ # @param [Aws::ComprehendMedical::Types::ValidationException] data
130
+ def initialize(context, message, data = Aws::EmptyStructure.new)
131
+ super(context, message, data)
132
+ end
133
+
134
+ # @return [String]
135
+ def message
136
+ @message || @data[:message]
137
+ end
138
+
139
+ end
140
+
109
141
  end
110
142
  end
@@ -19,12 +19,12 @@ module Aws::ComprehendMedical
19
19
  # @return [String]
20
20
  #
21
21
  # @!attribute [rw] score
22
- # The level of confidence that Comprehend Medical has that the segment
23
- # of text is correctly recognized as an attribute.
22
+ # The level of confidence that Amazon Comprehend Medical has that the
23
+ # segment of text is correctly recognized as an attribute.
24
24
  # @return [Float]
25
25
  #
26
26
  # @!attribute [rw] relationship_score
27
- # The level of confidence that Comprehend Medical has that this
27
+ # The level of confidence that Amazon Comprehend Medical has that this
28
28
  # attribute is correctly related to this entity.
29
29
  # @return [Float]
30
30
  #
@@ -68,6 +68,204 @@ module Aws::ComprehendMedical
68
68
  include Aws::Structure
69
69
  end
70
70
 
71
+ # Provides information for filtering a list of detection jobs.
72
+ #
73
+ # @note When making an API call, you may pass ComprehendMedicalAsyncJobFilter
74
+ # data as a hash:
75
+ #
76
+ # {
77
+ # job_name: "JobName",
78
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
79
+ # submit_time_before: Time.now,
80
+ # submit_time_after: Time.now,
81
+ # }
82
+ #
83
+ # @!attribute [rw] job_name
84
+ # Filters on the name of the job.
85
+ # @return [String]
86
+ #
87
+ # @!attribute [rw] job_status
88
+ # Filters the list of jobs based on job status. Returns only jobs with
89
+ # the specified status.
90
+ # @return [String]
91
+ #
92
+ # @!attribute [rw] submit_time_before
93
+ # Filters the list of jobs based on the time that the job was
94
+ # submitted for processing. Returns only jobs submitted before the
95
+ # specified time. Jobs are returned in ascending order, oldest to
96
+ # newest.
97
+ # @return [Time]
98
+ #
99
+ # @!attribute [rw] submit_time_after
100
+ # Filters the list of jobs based on the time that the job was
101
+ # submitted for processing. Returns only jobs submitted after the
102
+ # specified time. Jobs are returned in descending order, newest to
103
+ # oldest.
104
+ # @return [Time]
105
+ #
106
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ComprehendMedicalAsyncJobFilter AWS API Documentation
107
+ #
108
+ class ComprehendMedicalAsyncJobFilter < Struct.new(
109
+ :job_name,
110
+ :job_status,
111
+ :submit_time_before,
112
+ :submit_time_after)
113
+ include Aws::Structure
114
+ end
115
+
116
+ # Provides information about a detection job.
117
+ #
118
+ # @!attribute [rw] job_id
119
+ # The identifier assigned to the detection job.
120
+ # @return [String]
121
+ #
122
+ # @!attribute [rw] job_name
123
+ # The name that you assigned to the detection job.
124
+ # @return [String]
125
+ #
126
+ # @!attribute [rw] job_status
127
+ # The current status of the detection job. If the status is `FAILED`,
128
+ # the `Message` field shows the reason for the failure.
129
+ # @return [String]
130
+ #
131
+ # @!attribute [rw] message
132
+ # A description of the status of a job.
133
+ # @return [String]
134
+ #
135
+ # @!attribute [rw] submit_time
136
+ # The time that the detection job was submitted for processing.
137
+ # @return [Time]
138
+ #
139
+ # @!attribute [rw] end_time
140
+ # The time that the detection job completed.
141
+ # @return [Time]
142
+ #
143
+ # @!attribute [rw] expiration_time
144
+ # The date and time that job metadata is deleted from the server.
145
+ # Output files in your S3 bucket will not be deleted. After the
146
+ # metadata is deleted, the job will no longer appear in the results of
147
+ # the `ListEntitiesDetectionV2Job` or the `ListPHIDetectionJobs`
148
+ # operation.
149
+ # @return [Time]
150
+ #
151
+ # @!attribute [rw] input_data_config
152
+ # The input data configuration that you supplied when you created the
153
+ # detection job.
154
+ # @return [Types::InputDataConfig]
155
+ #
156
+ # @!attribute [rw] output_data_config
157
+ # The output data configuration that you supplied when you created the
158
+ # detection job.
159
+ # @return [Types::OutputDataConfig]
160
+ #
161
+ # @!attribute [rw] language_code
162
+ # The language code of the input documents.
163
+ # @return [String]
164
+ #
165
+ # @!attribute [rw] data_access_role_arn
166
+ # The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical
167
+ # read access to your input data.
168
+ # @return [String]
169
+ #
170
+ # @!attribute [rw] manifest_file_path
171
+ # The path to the file that describes the results of a batch job.
172
+ # @return [String]
173
+ #
174
+ # @!attribute [rw] kms_key
175
+ # The AWS Key Management Service key, if any, used to encrypt the
176
+ # output files.
177
+ # @return [String]
178
+ #
179
+ # @!attribute [rw] model_version
180
+ # The version of the model used to analyze the documents. The version
181
+ # number looks like X.X.X. You can use this information to track the
182
+ # model used for a particular batch of documents.
183
+ # @return [String]
184
+ #
185
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ComprehendMedicalAsyncJobProperties AWS API Documentation
186
+ #
187
+ class ComprehendMedicalAsyncJobProperties < Struct.new(
188
+ :job_id,
189
+ :job_name,
190
+ :job_status,
191
+ :message,
192
+ :submit_time,
193
+ :end_time,
194
+ :expiration_time,
195
+ :input_data_config,
196
+ :output_data_config,
197
+ :language_code,
198
+ :data_access_role_arn,
199
+ :manifest_file_path,
200
+ :kms_key,
201
+ :model_version)
202
+ include Aws::Structure
203
+ end
204
+
205
+ # @note When making an API call, you may pass DescribeEntitiesDetectionV2JobRequest
206
+ # data as a hash:
207
+ #
208
+ # {
209
+ # job_id: "JobId", # required
210
+ # }
211
+ #
212
+ # @!attribute [rw] job_id
213
+ # The identifier that Amazon Comprehend Medical generated for the job.
214
+ # The `StartEntitiesDetectionV2Job` operation returns this identifier
215
+ # in its response.
216
+ # @return [String]
217
+ #
218
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeEntitiesDetectionV2JobRequest AWS API Documentation
219
+ #
220
+ class DescribeEntitiesDetectionV2JobRequest < Struct.new(
221
+ :job_id)
222
+ include Aws::Structure
223
+ end
224
+
225
+ # @!attribute [rw] comprehend_medical_async_job_properties
226
+ # An object that contains the properties associated with a detection
227
+ # job.
228
+ # @return [Types::ComprehendMedicalAsyncJobProperties]
229
+ #
230
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeEntitiesDetectionV2JobResponse AWS API Documentation
231
+ #
232
+ class DescribeEntitiesDetectionV2JobResponse < Struct.new(
233
+ :comprehend_medical_async_job_properties)
234
+ include Aws::Structure
235
+ end
236
+
237
+ # @note When making an API call, you may pass DescribePHIDetectionJobRequest
238
+ # data as a hash:
239
+ #
240
+ # {
241
+ # job_id: "JobId", # required
242
+ # }
243
+ #
244
+ # @!attribute [rw] job_id
245
+ # The identifier that Amazon Comprehend Medical generated for the job.
246
+ # The `StartPHIDetectionJob` operation returns this identifier in its
247
+ # response.
248
+ # @return [String]
249
+ #
250
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribePHIDetectionJobRequest AWS API Documentation
251
+ #
252
+ class DescribePHIDetectionJobRequest < Struct.new(
253
+ :job_id)
254
+ include Aws::Structure
255
+ end
256
+
257
+ # @!attribute [rw] comprehend_medical_async_job_properties
258
+ # An object that contains the properties associated with a detection
259
+ # job.
260
+ # @return [Types::ComprehendMedicalAsyncJobProperties]
261
+ #
262
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribePHIDetectionJobResponse AWS API Documentation
263
+ #
264
+ class DescribePHIDetectionJobResponse < Struct.new(
265
+ :comprehend_medical_async_job_properties)
266
+ include Aws::Structure
267
+ end
268
+
71
269
  # @note When making an API call, you may pass DetectEntitiesRequest
72
270
  # data as a hash:
73
271
  #
@@ -92,9 +290,9 @@ module Aws::ComprehendMedical
92
290
  # The collection of medical entities extracted from the input text and
93
291
  # their associated information. For each entity, the response provides
94
292
  # the entity text, the entity category, where the entity text begins
95
- # and ends, and the level of confidence that Comprehend Medical has in
96
- # the detection and analysis. Attributes and traits of the entity are
97
- # also returned.
293
+ # and ends, and the level of confidence that Amazon Comprehend Medical
294
+ # has in the detection and analysis. Attributes and traits of the
295
+ # entity are also returned.
98
296
  # @return [Array<Types::Entity>]
99
297
  #
100
298
  # @!attribute [rw] unmapped_attributes
@@ -103,17 +301,78 @@ module Aws::ComprehendMedical
103
301
  # @return [Array<Types::UnmappedAttribute>]
104
302
  #
105
303
  # @!attribute [rw] pagination_token
106
- # If the result of the previous request to DetectEntities was
107
- # truncated, include the Paginationtoken to fetch the next page of
304
+ # If the result of the previous request to `DetectEntities` was
305
+ # truncated, include the `PaginationToken` to fetch the next page of
108
306
  # entities.
109
307
  # @return [String]
110
308
  #
309
+ # @!attribute [rw] model_version
310
+ # The version of the model used to analyze the documents. The version
311
+ # number looks like X.X.X. You can use this information to track the
312
+ # model used for a particular batch of documents.
313
+ # @return [String]
314
+ #
111
315
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectEntitiesResponse AWS API Documentation
112
316
  #
113
317
  class DetectEntitiesResponse < Struct.new(
114
318
  :entities,
115
319
  :unmapped_attributes,
116
- :pagination_token)
320
+ :pagination_token,
321
+ :model_version)
322
+ include Aws::Structure
323
+ end
324
+
325
+ # @note When making an API call, you may pass DetectEntitiesV2Request
326
+ # data as a hash:
327
+ #
328
+ # {
329
+ # text: "BoundedLengthString", # required
330
+ # }
331
+ #
332
+ # @!attribute [rw] text
333
+ # A UTF-8 string containing the clinical content being examined for
334
+ # entities. Each string must contain fewer than 20,000 bytes of
335
+ # characters.
336
+ # @return [String]
337
+ #
338
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectEntitiesV2Request AWS API Documentation
339
+ #
340
+ class DetectEntitiesV2Request < Struct.new(
341
+ :text)
342
+ include Aws::Structure
343
+ end
344
+
345
+ # @!attribute [rw] entities
346
+ # The collection of medical entities extracted from the input text and
347
+ # their associated information. For each entity, the response provides
348
+ # the entity text, the entity category, where the entity text begins
349
+ # and ends, and the level of confidence in the detection and analysis.
350
+ # Attributes and traits of the entity are also returned.
351
+ # @return [Array<Types::Entity>]
352
+ #
353
+ # @!attribute [rw] unmapped_attributes
354
+ # Attributes extracted from the input text that couldn't be related
355
+ # to an entity.
356
+ # @return [Array<Types::UnmappedAttribute>]
357
+ #
358
+ # @!attribute [rw] pagination_token
359
+ # If the result to the `DetectEntitiesV2` operation was truncated,
360
+ # include the `PaginationToken` to fetch the next page of entities.
361
+ # @return [String]
362
+ #
363
+ # @!attribute [rw] model_version
364
+ # The version of the model used to analyze the documents. The version
365
+ # number looks like X.X.X. You can use this information to track the
366
+ # model used for a particular batch of documents.
367
+ # @return [String]
368
+ #
369
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectEntitiesV2Response AWS API Documentation
370
+ #
371
+ class DetectEntitiesV2Response < Struct.new(
372
+ :entities,
373
+ :unmapped_attributes,
374
+ :pagination_token,
375
+ :model_version)
117
376
  include Aws::Structure
118
377
  end
119
378
 
@@ -141,20 +400,28 @@ module Aws::ComprehendMedical
141
400
  # The collection of PHI entities extracted from the input text and
142
401
  # their associated information. For each entity, the response provides
143
402
  # the entity text, the entity category, where the entity text begins
144
- # and ends, and the level of confidence that Comprehend Medical has in
145
- # its detection.
403
+ # and ends, and the level of confidence that Amazon Comprehend Medical
404
+ # has in its detection.
146
405
  # @return [Array<Types::Entity>]
147
406
  #
148
407
  # @!attribute [rw] pagination_token
149
- # If the result of the previous request to DetectPHI was truncated,
150
- # include the Paginationtoken to fetch the next page of PHI entities.
408
+ # If the result of the previous request to `DetectPHI` was truncated,
409
+ # include the `PaginationToken` to fetch the next page of PHI
410
+ # entities.
411
+ # @return [String]
412
+ #
413
+ # @!attribute [rw] model_version
414
+ # The version of the model used to analyze the documents. The version
415
+ # number looks like X.X.X. You can use this information to track the
416
+ # model used for a particular batch of documents.
151
417
  # @return [String]
152
418
  #
153
419
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectPHIResponse AWS API Documentation
154
420
  #
155
421
  class DetectPHIResponse < Struct.new(
156
422
  :entities,
157
- :pagination_token)
423
+ :pagination_token,
424
+ :model_version)
158
425
  include Aws::Structure
159
426
  end
160
427
 
@@ -178,8 +445,8 @@ module Aws::ComprehendMedical
178
445
  # @return [Integer]
179
446
  #
180
447
  # @!attribute [rw] score
181
- # The level of confidence that Comprehend Medical has in the accuracy
182
- # of the detection.
448
+ # The level of confidence that Amazon Comprehend Medical has in the
449
+ # accuracy of the detection.
183
450
  # @return [Float]
184
451
  #
185
452
  # @!attribute [rw] text
@@ -195,7 +462,7 @@ module Aws::ComprehendMedical
195
462
  # @return [String]
196
463
  #
197
464
  # @!attribute [rw] traits
198
- # Contextual information for the entity
465
+ # Contextual information for the entity.
199
466
  # @return [Array<Types::Trait>]
200
467
  #
201
468
  # @!attribute [rw] attributes
@@ -217,115 +484,987 @@ module Aws::ComprehendMedical
217
484
  include Aws::Structure
218
485
  end
219
486
 
220
- # An internal server error occurred. Retry your request.
487
+ # The detected attributes that relate to an entity. This includes an
488
+ # extracted segment of the text that is an attribute of an entity, or
489
+ # otherwise related to an entity. InferICD10CM detects the following
490
+ # attributes: `Direction`, `System, Organ or Site`, and `Acuity`.
221
491
  #
222
- # @!attribute [rw] message
492
+ # @!attribute [rw] type
493
+ # The type of attribute. InferICD10CM detects entities of the type
494
+ # `DX_NAME`.
223
495
  # @return [String]
224
496
  #
225
- # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InternalServerException AWS API Documentation
497
+ # @!attribute [rw] score
498
+ # The level of confidence that Amazon Comprehend Medical has that the
499
+ # segment of text is correctly recognized as an attribute.
500
+ # @return [Float]
226
501
  #
227
- class InternalServerException < Struct.new(
228
- :message)
229
- include Aws::Structure
230
- end
231
-
232
- # The input text was not in valid UTF-8 character encoding. Check your
233
- # text then retry your request.
502
+ # @!attribute [rw] relationship_score
503
+ # The level of confidence that Amazon Comprehend Medical has that this
504
+ # attribute is correctly related to this entity.
505
+ # @return [Float]
234
506
  #
235
- # @!attribute [rw] message
236
- # @return [String]
507
+ # @!attribute [rw] id
508
+ # The numeric identifier for this attribute. This is a monotonically
509
+ # increasing id unique within this response rather than a global
510
+ # unique identifier.
511
+ # @return [Integer]
237
512
  #
238
- # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InvalidEncodingException AWS API Documentation
513
+ # @!attribute [rw] begin_offset
514
+ # The 0-based character offset in the input text that shows where the
515
+ # attribute begins. The offset returns the UTF-8 code point in the
516
+ # string.
517
+ # @return [Integer]
239
518
  #
240
- class InvalidEncodingException < Struct.new(
241
- :message)
242
- include Aws::Structure
243
- end
244
-
245
- # The request that you made is invalid. Check your request to determine
246
- # why it's invalid and then retry the request.
519
+ # @!attribute [rw] end_offset
520
+ # The 0-based character offset in the input text that shows where the
521
+ # attribute ends. The offset returns the UTF-8 code point in the
522
+ # string.
523
+ # @return [Integer]
247
524
  #
248
- # @!attribute [rw] message
525
+ # @!attribute [rw] text
526
+ # The segment of input text which contains the detected attribute.
249
527
  # @return [String]
250
528
  #
251
- # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InvalidRequestException AWS API Documentation
529
+ # @!attribute [rw] traits
530
+ # The contextual information for the attribute. The traits recognized
531
+ # by InferICD10CM are `DIAGNOSIS`, `SIGN`, `SYMPTOM`, and `NEGATION`.
532
+ # @return [Array<Types::ICD10CMTrait>]
252
533
  #
253
- class InvalidRequestException < Struct.new(
254
- :message)
534
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ICD10CMAttribute AWS API Documentation
535
+ #
536
+ class ICD10CMAttribute < Struct.new(
537
+ :type,
538
+ :score,
539
+ :relationship_score,
540
+ :id,
541
+ :begin_offset,
542
+ :end_offset,
543
+ :text,
544
+ :traits)
255
545
  include Aws::Structure
256
546
  end
257
547
 
258
- # The Comprehend Medical service is temporarily unavailable. Please wait
259
- # and then retry your request.
548
+ # The ICD-10-CM concepts that the entity could refer to, along with a
549
+ # score indicating the likelihood of the match.
260
550
  #
261
- # @!attribute [rw] message
551
+ # @!attribute [rw] description
552
+ # The long description of the ICD-10-CM code in the ontology.
262
553
  # @return [String]
263
554
  #
264
- # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ServiceUnavailableException AWS API Documentation
555
+ # @!attribute [rw] code
556
+ # The ICD-10-CM code that identifies the concept found in the
557
+ # knowledge base from the Centers for Disease Control.
558
+ # @return [String]
265
559
  #
266
- class ServiceUnavailableException < Struct.new(
267
- :message)
560
+ # @!attribute [rw] score
561
+ # The level of confidence that Amazon Comprehend Medical has that the
562
+ # entity is accurately linked to an ICD-10-CM concept.
563
+ # @return [Float]
564
+ #
565
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ICD10CMConcept AWS API Documentation
566
+ #
567
+ class ICD10CMConcept < Struct.new(
568
+ :description,
569
+ :code,
570
+ :score)
268
571
  include Aws::Structure
269
572
  end
270
573
 
271
- # The size of the text you submitted exceeds the size limit. Reduce the
272
- # size of the text or use a smaller document and then retry your
273
- # request.
574
+ # The collection of medical entities extracted from the input text and
575
+ # their associated information. For each entity, the response provides
576
+ # the entity text, the entity category, where the entity text begins and
577
+ # ends, and the level of confidence that Amazon Comprehend Medical has
578
+ # in the detection and analysis. Attributes and traits of the entity are
579
+ # also returned.
274
580
  #
275
- # @!attribute [rw] message
276
- # @return [String]
581
+ # @!attribute [rw] id
582
+ # The numeric identifier for the entity. This is a monotonically
583
+ # increasing id unique within this response rather than a global
584
+ # unique identifier.
585
+ # @return [Integer]
277
586
  #
278
- # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/TextSizeLimitExceededException AWS API Documentation
587
+ # @!attribute [rw] text
588
+ # The segment of input text that is matched to the detected entity.
589
+ # @return [String]
279
590
  #
280
- class TextSizeLimitExceededException < Struct.new(
281
- :message)
282
- include Aws::Structure
283
- end
284
-
285
- # You have made too many requests within a short period of time. Wait
286
- # for a short time and then try your request again. Contact customer
287
- # support for more information about a service limit increase.
591
+ # @!attribute [rw] category
592
+ # The category of the entity. InferICD10CM detects entities in the
593
+ # `MEDICAL_CONDITION` category.
594
+ # @return [String]
288
595
  #
289
- # @!attribute [rw] message
596
+ # @!attribute [rw] type
597
+ # Describes the specific type of entity with category of entities.
598
+ # InferICD10CM detects entities of the type `DX_NAME`.
290
599
  # @return [String]
291
600
  #
292
- # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/TooManyRequestsException AWS API Documentation
601
+ # @!attribute [rw] score
602
+ # The level of confidence that Amazon Comprehend Medical has in the
603
+ # accuracy of the detection.
604
+ # @return [Float]
293
605
  #
294
- class TooManyRequestsException < Struct.new(
295
- :message)
606
+ # @!attribute [rw] begin_offset
607
+ # The 0-based character offset in the input text that shows where the
608
+ # entity begins. The offset returns the UTF-8 code point in the
609
+ # string.
610
+ # @return [Integer]
611
+ #
612
+ # @!attribute [rw] end_offset
613
+ # The 0-based character offset in the input text that shows where the
614
+ # entity ends. The offset returns the UTF-8 code point in the string.
615
+ # @return [Integer]
616
+ #
617
+ # @!attribute [rw] attributes
618
+ # The detected attributes that relate to the entity. An extracted
619
+ # segment of the text that is an attribute of an entity, or otherwise
620
+ # related to an entity, such as the nature of a medical condition.
621
+ # @return [Array<Types::ICD10CMAttribute>]
622
+ #
623
+ # @!attribute [rw] traits
624
+ # Provides Contextual information for the entity. The traits
625
+ # recognized by InferICD10CM are `DIAGNOSIS`, `SIGN`, `SYMPTOM`, and
626
+ # `NEGATION.`
627
+ # @return [Array<Types::ICD10CMTrait>]
628
+ #
629
+ # @!attribute [rw] icd10cm_concepts
630
+ # The ICD-10-CM concepts that the entity could refer to, along with a
631
+ # score indicating the likelihood of the match.
632
+ # @return [Array<Types::ICD10CMConcept>]
633
+ #
634
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ICD10CMEntity AWS API Documentation
635
+ #
636
+ class ICD10CMEntity < Struct.new(
637
+ :id,
638
+ :text,
639
+ :category,
640
+ :type,
641
+ :score,
642
+ :begin_offset,
643
+ :end_offset,
644
+ :attributes,
645
+ :traits,
646
+ :icd10cm_concepts)
296
647
  include Aws::Structure
297
648
  end
298
649
 
299
- # Provides contextual information about the extracted entity.
650
+ # Contextual information for the entity. The traits recognized by
651
+ # InferICD10CM are `DIAGNOSIS`, `SIGN`, `SYMPTOM`, and `NEGATION`.
300
652
  #
301
653
  # @!attribute [rw] name
302
654
  # Provides a name or contextual description about the trait.
303
655
  # @return [String]
304
656
  #
305
657
  # @!attribute [rw] score
306
- # The level of confidence that Comprehend Medical has in the accuracy
307
- # of this trait.
658
+ # The level of confidence that Amazon Comprehend Medical has that the
659
+ # segment of text is correctly recognized as a trait.
308
660
  # @return [Float]
309
661
  #
310
- # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/Trait AWS API Documentation
662
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ICD10CMTrait AWS API Documentation
311
663
  #
312
- class Trait < Struct.new(
664
+ class ICD10CMTrait < Struct.new(
313
665
  :name,
314
666
  :score)
315
667
  include Aws::Structure
316
668
  end
317
669
 
318
- # An attribute that we extracted, but were unable to relate to an
319
- # entity.
670
+ # @note When making an API call, you may pass InferICD10CMRequest
671
+ # data as a hash:
320
672
  #
321
- # @!attribute [rw] type
322
- # The type of the attribute, could be one of the following values:
323
- # "MEDICATION", "MEDICAL\_CONDITION", "ANATOMY",
324
- # "TEST\_AND\_TREATMENT\_PROCEDURE" or
325
- # "PERSONAL\_HEALTH\_INFORMATION".
673
+ # {
674
+ # text: "OntologyLinkingBoundedLengthString", # required
675
+ # }
676
+ #
677
+ # @!attribute [rw] text
678
+ # The input text used for analysis. The input for InferICD10CM is a
679
+ # string from 1 to 10000 characters.
326
680
  # @return [String]
327
681
  #
328
- # @!attribute [rw] attribute
682
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferICD10CMRequest AWS API Documentation
683
+ #
684
+ class InferICD10CMRequest < Struct.new(
685
+ :text)
686
+ include Aws::Structure
687
+ end
688
+
689
+ # @!attribute [rw] entities
690
+ # The medical conditions detected in the text linked to ICD-10-CM
691
+ # concepts. If the action is successful, the service sends back an
692
+ # HTTP 200 response, as well as the entities detected.
693
+ # @return [Array<Types::ICD10CMEntity>]
694
+ #
695
+ # @!attribute [rw] pagination_token
696
+ # If the result of the previous request to `InferICD10CM` was
697
+ # truncated, include the `PaginationToken` to fetch the next page of
698
+ # medical condition entities.
699
+ # @return [String]
700
+ #
701
+ # @!attribute [rw] model_version
702
+ # The version of the model used to analyze the documents, in the
703
+ # format *n*.*n*.*n* You can use this information to track the model
704
+ # used for a particular batch of documents.
705
+ # @return [String]
706
+ #
707
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferICD10CMResponse AWS API Documentation
708
+ #
709
+ class InferICD10CMResponse < Struct.new(
710
+ :entities,
711
+ :pagination_token,
712
+ :model_version)
713
+ include Aws::Structure
714
+ end
715
+
716
+ # @note When making an API call, you may pass InferRxNormRequest
717
+ # data as a hash:
718
+ #
719
+ # {
720
+ # text: "OntologyLinkingBoundedLengthString", # required
721
+ # }
722
+ #
723
+ # @!attribute [rw] text
724
+ # The input text used for analysis. The input for InferRxNorm is a
725
+ # string from 1 to 10000 characters.
726
+ # @return [String]
727
+ #
728
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferRxNormRequest AWS API Documentation
729
+ #
730
+ class InferRxNormRequest < Struct.new(
731
+ :text)
732
+ include Aws::Structure
733
+ end
734
+
735
+ # @!attribute [rw] entities
736
+ # The medication entities detected in the text linked to RxNorm
737
+ # concepts. If the action is successful, the service sends back an
738
+ # HTTP 200 response, as well as the entities detected.
739
+ # @return [Array<Types::RxNormEntity>]
740
+ #
741
+ # @!attribute [rw] pagination_token
742
+ # If the result of the previous request to `InferRxNorm` was
743
+ # truncated, include the `PaginationToken` to fetch the next page of
744
+ # medication entities.
745
+ # @return [String]
746
+ #
747
+ # @!attribute [rw] model_version
748
+ # The version of the model used to analyze the documents, in the
749
+ # format *n*.*n*.*n* You can use this information to track the model
750
+ # used for a particular batch of documents.
751
+ # @return [String]
752
+ #
753
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferRxNormResponse AWS API Documentation
754
+ #
755
+ class InferRxNormResponse < Struct.new(
756
+ :entities,
757
+ :pagination_token,
758
+ :model_version)
759
+ include Aws::Structure
760
+ end
761
+
762
+ # The input properties for an entities detection job
763
+ #
764
+ # @note When making an API call, you may pass InputDataConfig
765
+ # data as a hash:
766
+ #
767
+ # {
768
+ # s3_bucket: "S3Bucket", # required
769
+ # s3_key: "S3Key",
770
+ # }
771
+ #
772
+ # @!attribute [rw] s3_bucket
773
+ # The URI of the S3 bucket that contains the input data. The bucket
774
+ # must be in the same region as the API endpoint that you are calling.
775
+ #
776
+ # Each file in the document collection must be less than 40 KB. You
777
+ # can store a maximum of 30 GB in the bucket.
778
+ # @return [String]
779
+ #
780
+ # @!attribute [rw] s3_key
781
+ # The path to the input data files in the S3 bucket.
782
+ # @return [String]
783
+ #
784
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InputDataConfig AWS API Documentation
785
+ #
786
+ class InputDataConfig < Struct.new(
787
+ :s3_bucket,
788
+ :s3_key)
789
+ include Aws::Structure
790
+ end
791
+
792
+ # An internal server error occurred. Retry your request.
793
+ #
794
+ # @!attribute [rw] message
795
+ # @return [String]
796
+ #
797
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InternalServerException AWS API Documentation
798
+ #
799
+ class InternalServerException < Struct.new(
800
+ :message)
801
+ include Aws::Structure
802
+ end
803
+
804
+ # The input text was not in valid UTF-8 character encoding. Check your
805
+ # text then retry your request.
806
+ #
807
+ # @!attribute [rw] message
808
+ # @return [String]
809
+ #
810
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InvalidEncodingException AWS API Documentation
811
+ #
812
+ class InvalidEncodingException < Struct.new(
813
+ :message)
814
+ include Aws::Structure
815
+ end
816
+
817
+ # The request that you made is invalid. Check your request to determine
818
+ # why it's invalid and then retry the request.
819
+ #
820
+ # @!attribute [rw] message
821
+ # @return [String]
822
+ #
823
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InvalidRequestException AWS API Documentation
824
+ #
825
+ class InvalidRequestException < Struct.new(
826
+ :message)
827
+ include Aws::Structure
828
+ end
829
+
830
+ # @note When making an API call, you may pass ListEntitiesDetectionV2JobsRequest
831
+ # data as a hash:
832
+ #
833
+ # {
834
+ # filter: {
835
+ # job_name: "JobName",
836
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
837
+ # submit_time_before: Time.now,
838
+ # submit_time_after: Time.now,
839
+ # },
840
+ # next_token: "String",
841
+ # max_results: 1,
842
+ # }
843
+ #
844
+ # @!attribute [rw] filter
845
+ # Filters the jobs that are returned. You can filter jobs based on
846
+ # their names, status, or the date and time that they were submitted.
847
+ # You can only set one filter at a time.
848
+ # @return [Types::ComprehendMedicalAsyncJobFilter]
849
+ #
850
+ # @!attribute [rw] next_token
851
+ # Identifies the next page of results to return.
852
+ # @return [String]
853
+ #
854
+ # @!attribute [rw] max_results
855
+ # The maximum number of results to return in each page. The default is
856
+ # 100.
857
+ # @return [Integer]
858
+ #
859
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListEntitiesDetectionV2JobsRequest AWS API Documentation
860
+ #
861
+ class ListEntitiesDetectionV2JobsRequest < Struct.new(
862
+ :filter,
863
+ :next_token,
864
+ :max_results)
865
+ include Aws::Structure
866
+ end
867
+
868
+ # @!attribute [rw] comprehend_medical_async_job_properties_list
869
+ # A list containing the properties of each job returned.
870
+ # @return [Array<Types::ComprehendMedicalAsyncJobProperties>]
871
+ #
872
+ # @!attribute [rw] next_token
873
+ # Identifies the next page of results to return.
874
+ # @return [String]
875
+ #
876
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListEntitiesDetectionV2JobsResponse AWS API Documentation
877
+ #
878
+ class ListEntitiesDetectionV2JobsResponse < Struct.new(
879
+ :comprehend_medical_async_job_properties_list,
880
+ :next_token)
881
+ include Aws::Structure
882
+ end
883
+
884
+ # @note When making an API call, you may pass ListPHIDetectionJobsRequest
885
+ # data as a hash:
886
+ #
887
+ # {
888
+ # filter: {
889
+ # job_name: "JobName",
890
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
891
+ # submit_time_before: Time.now,
892
+ # submit_time_after: Time.now,
893
+ # },
894
+ # next_token: "String",
895
+ # max_results: 1,
896
+ # }
897
+ #
898
+ # @!attribute [rw] filter
899
+ # Filters the jobs that are returned. You can filter jobs based on
900
+ # their names, status, or the date and time that they were submitted.
901
+ # You can only set one filter at a time.
902
+ # @return [Types::ComprehendMedicalAsyncJobFilter]
903
+ #
904
+ # @!attribute [rw] next_token
905
+ # Identifies the next page of results to return.
906
+ # @return [String]
907
+ #
908
+ # @!attribute [rw] max_results
909
+ # The maximum number of results to return in each page. The default is
910
+ # 100.
911
+ # @return [Integer]
912
+ #
913
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListPHIDetectionJobsRequest AWS API Documentation
914
+ #
915
+ class ListPHIDetectionJobsRequest < Struct.new(
916
+ :filter,
917
+ :next_token,
918
+ :max_results)
919
+ include Aws::Structure
920
+ end
921
+
922
+ # @!attribute [rw] comprehend_medical_async_job_properties_list
923
+ # A list containing the properties of each job returned.
924
+ # @return [Array<Types::ComprehendMedicalAsyncJobProperties>]
925
+ #
926
+ # @!attribute [rw] next_token
927
+ # Identifies the next page of results to return.
928
+ # @return [String]
929
+ #
930
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListPHIDetectionJobsResponse AWS API Documentation
931
+ #
932
+ class ListPHIDetectionJobsResponse < Struct.new(
933
+ :comprehend_medical_async_job_properties_list,
934
+ :next_token)
935
+ include Aws::Structure
936
+ end
937
+
938
+ # The output properties for a detection job.
939
+ #
940
+ # @note When making an API call, you may pass OutputDataConfig
941
+ # data as a hash:
942
+ #
943
+ # {
944
+ # s3_bucket: "S3Bucket", # required
945
+ # s3_key: "S3Key",
946
+ # }
947
+ #
948
+ # @!attribute [rw] s3_bucket
949
+ # When you use the `OutputDataConfig` object with asynchronous
950
+ # operations, you specify the Amazon S3 location where you want to
951
+ # write the output data. The URI must be in the same region as the API
952
+ # endpoint that you are calling. The location is used as the prefix
953
+ # for the actual location of the output.
954
+ # @return [String]
955
+ #
956
+ # @!attribute [rw] s3_key
957
+ # The path to the output data files in the S3 bucket. Amazon
958
+ # Comprehend Medical creates an output directory using the job ID so
959
+ # that the output from one job does not overwrite the output of
960
+ # another.
961
+ # @return [String]
962
+ #
963
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/OutputDataConfig AWS API Documentation
964
+ #
965
+ class OutputDataConfig < Struct.new(
966
+ :s3_bucket,
967
+ :s3_key)
968
+ include Aws::Structure
969
+ end
970
+
971
+ # The resource identified by the specified Amazon Resource Name (ARN)
972
+ # was not found. Check the ARN and try your request again.
973
+ #
974
+ # @!attribute [rw] message
975
+ # @return [String]
976
+ #
977
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ResourceNotFoundException AWS API Documentation
978
+ #
979
+ class ResourceNotFoundException < Struct.new(
980
+ :message)
981
+ include Aws::Structure
982
+ end
983
+
984
+ # The extracted attributes that relate to this entity. The attributes
985
+ # recognized by InferRxNorm are `DOSAGE`, `DURATION`, `FORM`,
986
+ # `FREQUENCY`, `RATE`, `ROUTE_OR_MODE`.
987
+ #
988
+ # @!attribute [rw] type
989
+ # The type of attribute. The types of attributes recognized by
990
+ # InferRxNorm are `BRAND_NAME` and `GENERIC_NAME`.
991
+ # @return [String]
992
+ #
993
+ # @!attribute [rw] score
994
+ # The level of confidence that Comprehend Medical has that the segment
995
+ # of text is correctly recognized as an attribute.
996
+ # @return [Float]
997
+ #
998
+ # @!attribute [rw] relationship_score
999
+ # The level of confidence that Amazon Comprehend Medical has that the
1000
+ # attribute is accurately linked to an entity.
1001
+ # @return [Float]
1002
+ #
1003
+ # @!attribute [rw] id
1004
+ # The numeric identifier for this attribute. This is a monotonically
1005
+ # increasing id unique within this response rather than a global
1006
+ # unique identifier.
1007
+ # @return [Integer]
1008
+ #
1009
+ # @!attribute [rw] begin_offset
1010
+ # The 0-based character offset in the input text that shows where the
1011
+ # attribute begins. The offset returns the UTF-8 code point in the
1012
+ # string.
1013
+ # @return [Integer]
1014
+ #
1015
+ # @!attribute [rw] end_offset
1016
+ # The 0-based character offset in the input text that shows where the
1017
+ # attribute ends. The offset returns the UTF-8 code point in the
1018
+ # string.
1019
+ # @return [Integer]
1020
+ #
1021
+ # @!attribute [rw] text
1022
+ # The segment of input text which corresponds to the detected
1023
+ # attribute.
1024
+ # @return [String]
1025
+ #
1026
+ # @!attribute [rw] traits
1027
+ # Contextual information for the attribute. InferRxNorm recognizes the
1028
+ # trait `NEGATION` for attributes, i.e. that the patient is not taking
1029
+ # a specific dose or form of a medication.
1030
+ # @return [Array<Types::RxNormTrait>]
1031
+ #
1032
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/RxNormAttribute AWS API Documentation
1033
+ #
1034
+ class RxNormAttribute < Struct.new(
1035
+ :type,
1036
+ :score,
1037
+ :relationship_score,
1038
+ :id,
1039
+ :begin_offset,
1040
+ :end_offset,
1041
+ :text,
1042
+ :traits)
1043
+ include Aws::Structure
1044
+ end
1045
+
1046
+ # The RxNorm concept that the entity could refer to, along with a score
1047
+ # indicating the likelihood of the match.
1048
+ #
1049
+ # @!attribute [rw] description
1050
+ # The description of the RxNorm concept.
1051
+ # @return [String]
1052
+ #
1053
+ # @!attribute [rw] code
1054
+ # RxNorm concept ID, also known as the RxCUI.
1055
+ # @return [String]
1056
+ #
1057
+ # @!attribute [rw] score
1058
+ # The level of confidence that Amazon Comprehend Medical has that the
1059
+ # entity is accurately linked to the reported RxNorm concept.
1060
+ # @return [Float]
1061
+ #
1062
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/RxNormConcept AWS API Documentation
1063
+ #
1064
+ class RxNormConcept < Struct.new(
1065
+ :description,
1066
+ :code,
1067
+ :score)
1068
+ include Aws::Structure
1069
+ end
1070
+
1071
+ # The collection of medical entities extracted from the input text and
1072
+ # their associated information. For each entity, the response provides
1073
+ # the entity text, the entity category, where the entity text begins and
1074
+ # ends, and the level of confidence that Amazon Comprehend Medical has
1075
+ # in the detection and analysis. Attributes and traits of the entity are
1076
+ # also returned.
1077
+ #
1078
+ # @!attribute [rw] id
1079
+ # The numeric identifier for the entity. This is a monotonically
1080
+ # increasing id unique within this response rather than a global
1081
+ # unique identifier.
1082
+ # @return [Integer]
1083
+ #
1084
+ # @!attribute [rw] text
1085
+ # The segment of input text extracted from which the entity was
1086
+ # detected.
1087
+ # @return [String]
1088
+ #
1089
+ # @!attribute [rw] category
1090
+ # The category of the entity. The recognized categories are `GENERIC`
1091
+ # or `BRAND_NAME`.
1092
+ # @return [String]
1093
+ #
1094
+ # @!attribute [rw] type
1095
+ # Describes the specific type of entity. For InferRxNorm, the
1096
+ # recognized entity type is `MEDICATION`.
1097
+ # @return [String]
1098
+ #
1099
+ # @!attribute [rw] score
1100
+ # The level of confidence that Amazon Comprehend Medical has in the
1101
+ # accuracy of the detected entity.
1102
+ # @return [Float]
1103
+ #
1104
+ # @!attribute [rw] begin_offset
1105
+ # The 0-based character offset in the input text that shows where the
1106
+ # entity begins. The offset returns the UTF-8 code point in the
1107
+ # string.
1108
+ # @return [Integer]
1109
+ #
1110
+ # @!attribute [rw] end_offset
1111
+ # The 0-based character offset in the input text that shows where the
1112
+ # entity ends. The offset returns the UTF-8 code point in the string.
1113
+ # @return [Integer]
1114
+ #
1115
+ # @!attribute [rw] attributes
1116
+ # The extracted attributes that relate to the entity. The attributes
1117
+ # recognized by InferRxNorm are `DOSAGE`, `DURATION`, `FORM`,
1118
+ # `FREQUENCY`, `RATE`, `ROUTE_OR_MODE`, and `STRENGTH`.
1119
+ # @return [Array<Types::RxNormAttribute>]
1120
+ #
1121
+ # @!attribute [rw] traits
1122
+ # Contextual information for the entity.
1123
+ # @return [Array<Types::RxNormTrait>]
1124
+ #
1125
+ # @!attribute [rw] rx_norm_concepts
1126
+ # The RxNorm concepts that the entity could refer to, along with a
1127
+ # score indicating the likelihood of the match.
1128
+ # @return [Array<Types::RxNormConcept>]
1129
+ #
1130
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/RxNormEntity AWS API Documentation
1131
+ #
1132
+ class RxNormEntity < Struct.new(
1133
+ :id,
1134
+ :text,
1135
+ :category,
1136
+ :type,
1137
+ :score,
1138
+ :begin_offset,
1139
+ :end_offset,
1140
+ :attributes,
1141
+ :traits,
1142
+ :rx_norm_concepts)
1143
+ include Aws::Structure
1144
+ end
1145
+
1146
+ # The contextual information for the entity. InferRxNorm recognizes the
1147
+ # trait `NEGATION`, which is any indication that the patient is not
1148
+ # taking a medication.
1149
+ #
1150
+ # @!attribute [rw] name
1151
+ # Provides a name or contextual description about the trait.
1152
+ # @return [String]
1153
+ #
1154
+ # @!attribute [rw] score
1155
+ # The level of confidence that Amazon Comprehend Medical has in the
1156
+ # accuracy of the detected trait.
1157
+ # @return [Float]
1158
+ #
1159
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/RxNormTrait AWS API Documentation
1160
+ #
1161
+ class RxNormTrait < Struct.new(
1162
+ :name,
1163
+ :score)
1164
+ include Aws::Structure
1165
+ end
1166
+
1167
+ # The Amazon Comprehend Medical service is temporarily unavailable.
1168
+ # Please wait and then retry your request.
1169
+ #
1170
+ # @!attribute [rw] message
1171
+ # @return [String]
1172
+ #
1173
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ServiceUnavailableException AWS API Documentation
1174
+ #
1175
+ class ServiceUnavailableException < Struct.new(
1176
+ :message)
1177
+ include Aws::Structure
1178
+ end
1179
+
1180
+ # @note When making an API call, you may pass StartEntitiesDetectionV2JobRequest
1181
+ # data as a hash:
1182
+ #
1183
+ # {
1184
+ # input_data_config: { # required
1185
+ # s3_bucket: "S3Bucket", # required
1186
+ # s3_key: "S3Key",
1187
+ # },
1188
+ # output_data_config: { # required
1189
+ # s3_bucket: "S3Bucket", # required
1190
+ # s3_key: "S3Key",
1191
+ # },
1192
+ # data_access_role_arn: "IamRoleArn", # required
1193
+ # job_name: "JobName",
1194
+ # client_request_token: "ClientRequestTokenString",
1195
+ # kms_key: "KMSKey",
1196
+ # language_code: "en", # required, accepts en
1197
+ # }
1198
+ #
1199
+ # @!attribute [rw] input_data_config
1200
+ # Specifies the format and location of the input data for the job.
1201
+ # @return [Types::InputDataConfig]
1202
+ #
1203
+ # @!attribute [rw] output_data_config
1204
+ # Specifies where to send the output files.
1205
+ # @return [Types::OutputDataConfig]
1206
+ #
1207
+ # @!attribute [rw] data_access_role_arn
1208
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
1209
+ # Management (IAM) role that grants Amazon Comprehend Medical read
1210
+ # access to your input data. For more information, see [ Role-Based
1211
+ # Permissions Required for Asynchronous Operations][1].
1212
+ #
1213
+ #
1214
+ #
1215
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med
1216
+ # @return [String]
1217
+ #
1218
+ # @!attribute [rw] job_name
1219
+ # The identifier of the job.
1220
+ # @return [String]
1221
+ #
1222
+ # @!attribute [rw] client_request_token
1223
+ # A unique identifier for the request. If you don't set the client
1224
+ # request token, Amazon Comprehend Medical generates one.
1225
+ #
1226
+ # **A suitable default value is auto-generated.** You should normally
1227
+ # not need to pass this option.
1228
+ # @return [String]
1229
+ #
1230
+ # @!attribute [rw] kms_key
1231
+ # An AWS Key Management Service key to encrypt your output files. If
1232
+ # you do not specify a key, the files are written in plain text.
1233
+ # @return [String]
1234
+ #
1235
+ # @!attribute [rw] language_code
1236
+ # The language of the input documents. All documents must be in the
1237
+ # same language.
1238
+ # @return [String]
1239
+ #
1240
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartEntitiesDetectionV2JobRequest AWS API Documentation
1241
+ #
1242
+ class StartEntitiesDetectionV2JobRequest < Struct.new(
1243
+ :input_data_config,
1244
+ :output_data_config,
1245
+ :data_access_role_arn,
1246
+ :job_name,
1247
+ :client_request_token,
1248
+ :kms_key,
1249
+ :language_code)
1250
+ include Aws::Structure
1251
+ end
1252
+
1253
+ # @!attribute [rw] job_id
1254
+ # The identifier generated for the job. To get the status of a job,
1255
+ # use this identifier with the `DescribeEntitiesDetectionV2Job`
1256
+ # operation.
1257
+ # @return [String]
1258
+ #
1259
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartEntitiesDetectionV2JobResponse AWS API Documentation
1260
+ #
1261
+ class StartEntitiesDetectionV2JobResponse < Struct.new(
1262
+ :job_id)
1263
+ include Aws::Structure
1264
+ end
1265
+
1266
+ # @note When making an API call, you may pass StartPHIDetectionJobRequest
1267
+ # data as a hash:
1268
+ #
1269
+ # {
1270
+ # input_data_config: { # required
1271
+ # s3_bucket: "S3Bucket", # required
1272
+ # s3_key: "S3Key",
1273
+ # },
1274
+ # output_data_config: { # required
1275
+ # s3_bucket: "S3Bucket", # required
1276
+ # s3_key: "S3Key",
1277
+ # },
1278
+ # data_access_role_arn: "IamRoleArn", # required
1279
+ # job_name: "JobName",
1280
+ # client_request_token: "ClientRequestTokenString",
1281
+ # kms_key: "KMSKey",
1282
+ # language_code: "en", # required, accepts en
1283
+ # }
1284
+ #
1285
+ # @!attribute [rw] input_data_config
1286
+ # Specifies the format and location of the input data for the job.
1287
+ # @return [Types::InputDataConfig]
1288
+ #
1289
+ # @!attribute [rw] output_data_config
1290
+ # Specifies where to send the output files.
1291
+ # @return [Types::OutputDataConfig]
1292
+ #
1293
+ # @!attribute [rw] data_access_role_arn
1294
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
1295
+ # Management (IAM) role that grants Amazon Comprehend Medical read
1296
+ # access to your input data. For more information, see [ Role-Based
1297
+ # Permissions Required for Asynchronous Operations][1].
1298
+ #
1299
+ #
1300
+ #
1301
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med
1302
+ # @return [String]
1303
+ #
1304
+ # @!attribute [rw] job_name
1305
+ # The identifier of the job.
1306
+ # @return [String]
1307
+ #
1308
+ # @!attribute [rw] client_request_token
1309
+ # A unique identifier for the request. If you don't set the client
1310
+ # request token, Amazon Comprehend Medical generates one.
1311
+ #
1312
+ # **A suitable default value is auto-generated.** You should normally
1313
+ # not need to pass this option.
1314
+ # @return [String]
1315
+ #
1316
+ # @!attribute [rw] kms_key
1317
+ # An AWS Key Management Service key to encrypt your output files. If
1318
+ # you do not specify a key, the files are written in plain text.
1319
+ # @return [String]
1320
+ #
1321
+ # @!attribute [rw] language_code
1322
+ # The language of the input documents. All documents must be in the
1323
+ # same language.
1324
+ # @return [String]
1325
+ #
1326
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartPHIDetectionJobRequest AWS API Documentation
1327
+ #
1328
+ class StartPHIDetectionJobRequest < Struct.new(
1329
+ :input_data_config,
1330
+ :output_data_config,
1331
+ :data_access_role_arn,
1332
+ :job_name,
1333
+ :client_request_token,
1334
+ :kms_key,
1335
+ :language_code)
1336
+ include Aws::Structure
1337
+ end
1338
+
1339
+ # @!attribute [rw] job_id
1340
+ # The identifier generated for the job. To get the status of a job,
1341
+ # use this identifier with the `DescribePHIDetectionJob` operation.
1342
+ # @return [String]
1343
+ #
1344
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartPHIDetectionJobResponse AWS API Documentation
1345
+ #
1346
+ class StartPHIDetectionJobResponse < Struct.new(
1347
+ :job_id)
1348
+ include Aws::Structure
1349
+ end
1350
+
1351
+ # @note When making an API call, you may pass StopEntitiesDetectionV2JobRequest
1352
+ # data as a hash:
1353
+ #
1354
+ # {
1355
+ # job_id: "JobId", # required
1356
+ # }
1357
+ #
1358
+ # @!attribute [rw] job_id
1359
+ # The identifier of the medical entities job to stop.
1360
+ # @return [String]
1361
+ #
1362
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopEntitiesDetectionV2JobRequest AWS API Documentation
1363
+ #
1364
+ class StopEntitiesDetectionV2JobRequest < Struct.new(
1365
+ :job_id)
1366
+ include Aws::Structure
1367
+ end
1368
+
1369
+ # @!attribute [rw] job_id
1370
+ # The identifier of the medical entities detection job that was
1371
+ # stopped.
1372
+ # @return [String]
1373
+ #
1374
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopEntitiesDetectionV2JobResponse AWS API Documentation
1375
+ #
1376
+ class StopEntitiesDetectionV2JobResponse < Struct.new(
1377
+ :job_id)
1378
+ include Aws::Structure
1379
+ end
1380
+
1381
+ # @note When making an API call, you may pass StopPHIDetectionJobRequest
1382
+ # data as a hash:
1383
+ #
1384
+ # {
1385
+ # job_id: "JobId", # required
1386
+ # }
1387
+ #
1388
+ # @!attribute [rw] job_id
1389
+ # The identifier of the PHI detection job to stop.
1390
+ # @return [String]
1391
+ #
1392
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopPHIDetectionJobRequest AWS API Documentation
1393
+ #
1394
+ class StopPHIDetectionJobRequest < Struct.new(
1395
+ :job_id)
1396
+ include Aws::Structure
1397
+ end
1398
+
1399
+ # @!attribute [rw] job_id
1400
+ # The identifier of the PHI detection job that was stopped.
1401
+ # @return [String]
1402
+ #
1403
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopPHIDetectionJobResponse AWS API Documentation
1404
+ #
1405
+ class StopPHIDetectionJobResponse < Struct.new(
1406
+ :job_id)
1407
+ include Aws::Structure
1408
+ end
1409
+
1410
+ # The size of the text you submitted exceeds the size limit. Reduce the
1411
+ # size of the text or use a smaller document and then retry your
1412
+ # request.
1413
+ #
1414
+ # @!attribute [rw] message
1415
+ # @return [String]
1416
+ #
1417
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/TextSizeLimitExceededException AWS API Documentation
1418
+ #
1419
+ class TextSizeLimitExceededException < Struct.new(
1420
+ :message)
1421
+ include Aws::Structure
1422
+ end
1423
+
1424
+ # You have made too many requests within a short period of time. Wait
1425
+ # for a short time and then try your request again. Contact customer
1426
+ # support for more information about a service limit increase.
1427
+ #
1428
+ # @!attribute [rw] message
1429
+ # @return [String]
1430
+ #
1431
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/TooManyRequestsException AWS API Documentation
1432
+ #
1433
+ class TooManyRequestsException < Struct.new(
1434
+ :message)
1435
+ include Aws::Structure
1436
+ end
1437
+
1438
+ # Provides contextual information about the extracted entity.
1439
+ #
1440
+ # @!attribute [rw] name
1441
+ # Provides a name or contextual description about the trait.
1442
+ # @return [String]
1443
+ #
1444
+ # @!attribute [rw] score
1445
+ # The level of confidence that Amazon Comprehend Medical has in the
1446
+ # accuracy of this trait.
1447
+ # @return [Float]
1448
+ #
1449
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/Trait AWS API Documentation
1450
+ #
1451
+ class Trait < Struct.new(
1452
+ :name,
1453
+ :score)
1454
+ include Aws::Structure
1455
+ end
1456
+
1457
+ # An attribute that we extracted, but were unable to relate to an
1458
+ # entity.
1459
+ #
1460
+ # @!attribute [rw] type
1461
+ # The type of the attribute, could be one of the following values:
1462
+ # "MEDICATION", "MEDICAL\_CONDITION", "ANATOMY",
1463
+ # "TEST\_AND\_TREATMENT\_PROCEDURE" or
1464
+ # "PROTECTED\_HEALTH\_INFORMATION".
1465
+ # @return [String]
1466
+ #
1467
+ # @!attribute [rw] attribute
329
1468
  # The specific attribute that has been extracted but not mapped to an
330
1469
  # entity.
331
1470
  # @return [Types::Attribute]
@@ -338,5 +1477,18 @@ module Aws::ComprehendMedical
338
1477
  include Aws::Structure
339
1478
  end
340
1479
 
1480
+ # The filter that you specified for the operation is invalid. Check the
1481
+ # filter values that you entered and try your request again.
1482
+ #
1483
+ # @!attribute [rw] message
1484
+ # @return [String]
1485
+ #
1486
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ValidationException AWS API Documentation
1487
+ #
1488
+ class ValidationException < Struct.new(
1489
+ :message)
1490
+ include Aws::Structure
1491
+ end
1492
+
341
1493
  end
342
1494
  end