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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 2dac997d0912300f8c8ba5c0ef36ceff50919d1b
4
- data.tar.gz: 781137e815c9ea2d9dfd285a4972f210bcf3472a
3
+ metadata.gz: 5ad32a736f99f23f9b735935e01bdaf6077f22e7
4
+ data.tar.gz: 9aa31e920c9a4b3006897085cf6fefbda27e2a27
5
5
  SHA512:
6
- metadata.gz: ec71090f0db58b019671175c5dea03d40aa13fc84ae23baf9fad1cfeb7301c661a93b81a98e0d122e2dc4d904b71bc9c7f34712997d838d408a04ebdeb64e19c
7
- data.tar.gz: 4533a08b7dcf6bf2136758076741cfbc555ae68ac839c01264f7548429714d4e5a537ddf32619eb42225ad6809d3d1478aa283c91e0e6d69b9b840ee277ec94f
6
+ metadata.gz: 9e93dcc536cdc6e56a4dfbbf943693e8186e61544964aec5192a4a859a57ae0d0cc98f048d72a78f7ad0f5a06cdf075d6bbb0791d0167743cef9a3c6fbe7d4ed
7
+ data.tar.gz: c2e1fd7ab8f1670a8aa5a7e520f88faa00c35da7ea704d1667d16cc14c8b21bedefbb68d555f1261e81d3b65d635e07fa4a6d0de4ad22b7366c75f770f529175
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-comprehendmedical/customizations'
42
42
  # @service
43
43
  module Aws::ComprehendMedical
44
44
 
45
- GEM_VERSION = '1.6.0'
45
+ GEM_VERSION = '1.12.0'
46
46
 
47
47
  end
@@ -116,6 +116,10 @@ module Aws::ComprehendMedical
116
116
  # Allows you to provide an identifier for this client which will be attached to
117
117
  # all generated client side metrics. Defaults to an empty string.
118
118
  #
119
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
120
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
121
+ # side monitoring agent is running on, where client metrics will be published via UDP.
122
+ #
119
123
  # @option options [Integer] :client_side_monitoring_port (31000)
120
124
  # Required for publishing client metrics. The port that the client side monitoring
121
125
  # agent is running on, where client metrics will be published via UDP.
@@ -260,6 +264,102 @@ module Aws::ComprehendMedical
260
264
 
261
265
  # @!group API Operations
262
266
 
267
+ # Gets the properties associated with a medical entities detection job.
268
+ # Use this operation to get the status of a detection job.
269
+ #
270
+ # @option params [required, String] :job_id
271
+ # The identifier that Amazon Comprehend Medical generated for the job.
272
+ # The `StartEntitiesDetectionV2Job` operation returns this identifier in
273
+ # its response.
274
+ #
275
+ # @return [Types::DescribeEntitiesDetectionV2JobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
276
+ #
277
+ # * {Types::DescribeEntitiesDetectionV2JobResponse#comprehend_medical_async_job_properties #comprehend_medical_async_job_properties} => Types::ComprehendMedicalAsyncJobProperties
278
+ #
279
+ # @example Request syntax with placeholder values
280
+ #
281
+ # resp = client.describe_entities_detection_v2_job({
282
+ # job_id: "JobId", # required
283
+ # })
284
+ #
285
+ # @example Response structure
286
+ #
287
+ # resp.comprehend_medical_async_job_properties.job_id #=> String
288
+ # resp.comprehend_medical_async_job_properties.job_name #=> String
289
+ # resp.comprehend_medical_async_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
290
+ # resp.comprehend_medical_async_job_properties.message #=> String
291
+ # resp.comprehend_medical_async_job_properties.submit_time #=> Time
292
+ # resp.comprehend_medical_async_job_properties.end_time #=> Time
293
+ # resp.comprehend_medical_async_job_properties.expiration_time #=> Time
294
+ # resp.comprehend_medical_async_job_properties.input_data_config.s3_bucket #=> String
295
+ # resp.comprehend_medical_async_job_properties.input_data_config.s3_key #=> String
296
+ # resp.comprehend_medical_async_job_properties.output_data_config.s3_bucket #=> String
297
+ # resp.comprehend_medical_async_job_properties.output_data_config.s3_key #=> String
298
+ # resp.comprehend_medical_async_job_properties.language_code #=> String, one of "en"
299
+ # resp.comprehend_medical_async_job_properties.data_access_role_arn #=> String
300
+ # resp.comprehend_medical_async_job_properties.manifest_file_path #=> String
301
+ # resp.comprehend_medical_async_job_properties.kms_key #=> String
302
+ # resp.comprehend_medical_async_job_properties.model_version #=> String
303
+ #
304
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeEntitiesDetectionV2Job AWS API Documentation
305
+ #
306
+ # @overload describe_entities_detection_v2_job(params = {})
307
+ # @param [Hash] params ({})
308
+ def describe_entities_detection_v2_job(params = {}, options = {})
309
+ req = build_request(:describe_entities_detection_v2_job, params)
310
+ req.send_request(options)
311
+ end
312
+
313
+ # Gets the properties associated with a protected health information
314
+ # (PHI) detection job. Use this operation to get the status of a
315
+ # detection job.
316
+ #
317
+ # @option params [required, String] :job_id
318
+ # The identifier that Amazon Comprehend Medical generated for the job.
319
+ # The `StartPHIDetectionJob` operation returns this identifier in its
320
+ # response.
321
+ #
322
+ # @return [Types::DescribePHIDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
323
+ #
324
+ # * {Types::DescribePHIDetectionJobResponse#comprehend_medical_async_job_properties #comprehend_medical_async_job_properties} => Types::ComprehendMedicalAsyncJobProperties
325
+ #
326
+ # @example Request syntax with placeholder values
327
+ #
328
+ # resp = client.describe_phi_detection_job({
329
+ # job_id: "JobId", # required
330
+ # })
331
+ #
332
+ # @example Response structure
333
+ #
334
+ # resp.comprehend_medical_async_job_properties.job_id #=> String
335
+ # resp.comprehend_medical_async_job_properties.job_name #=> String
336
+ # resp.comprehend_medical_async_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
337
+ # resp.comprehend_medical_async_job_properties.message #=> String
338
+ # resp.comprehend_medical_async_job_properties.submit_time #=> Time
339
+ # resp.comprehend_medical_async_job_properties.end_time #=> Time
340
+ # resp.comprehend_medical_async_job_properties.expiration_time #=> Time
341
+ # resp.comprehend_medical_async_job_properties.input_data_config.s3_bucket #=> String
342
+ # resp.comprehend_medical_async_job_properties.input_data_config.s3_key #=> String
343
+ # resp.comprehend_medical_async_job_properties.output_data_config.s3_bucket #=> String
344
+ # resp.comprehend_medical_async_job_properties.output_data_config.s3_key #=> String
345
+ # resp.comprehend_medical_async_job_properties.language_code #=> String, one of "en"
346
+ # resp.comprehend_medical_async_job_properties.data_access_role_arn #=> String
347
+ # resp.comprehend_medical_async_job_properties.manifest_file_path #=> String
348
+ # resp.comprehend_medical_async_job_properties.kms_key #=> String
349
+ # resp.comprehend_medical_async_job_properties.model_version #=> String
350
+ #
351
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribePHIDetectionJob AWS API Documentation
352
+ #
353
+ # @overload describe_phi_detection_job(params = {})
354
+ # @param [Hash] params ({})
355
+ def describe_phi_detection_job(params = {}, options = {})
356
+ req = build_request(:describe_phi_detection_job, params)
357
+ req.send_request(options)
358
+ end
359
+
360
+ # The `DetectEntities` operation is deprecated. You should use the
361
+ # DetectEntitiesV2 operation instead.
362
+ #
263
363
  # Inspects the clinical text for a variety of medical entities and
264
364
  # returns specific information about them such as entity category,
265
365
  # location, and confidence score on that information .
@@ -274,6 +374,7 @@ module Aws::ComprehendMedical
274
374
  # * {Types::DetectEntitiesResponse#entities #entities} => Array<Types::Entity>
275
375
  # * {Types::DetectEntitiesResponse#unmapped_attributes #unmapped_attributes} => Array<Types::UnmappedAttribute>
276
376
  # * {Types::DetectEntitiesResponse#pagination_token #pagination_token} => String
377
+ # * {Types::DetectEntitiesResponse#model_version #model_version} => String
277
378
  #
278
379
  # @example Request syntax with placeholder values
279
380
  #
@@ -318,6 +419,7 @@ module Aws::ComprehendMedical
318
419
  # resp.unmapped_attributes[0].attribute.traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
319
420
  # resp.unmapped_attributes[0].attribute.traits[0].score #=> Float
320
421
  # resp.pagination_token #=> String
422
+ # resp.model_version #=> String
321
423
  #
322
424
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectEntities AWS API Documentation
323
425
  #
@@ -328,7 +430,86 @@ module Aws::ComprehendMedical
328
430
  req.send_request(options)
329
431
  end
330
432
 
331
- # Inspects the clinical text for personal health information (PHI)
433
+ # Inspects the clinical text for a variety of medical entities and
434
+ # returns specific information about them such as entity category,
435
+ # location, and confidence score on that information.
436
+ #
437
+ # The `DetectEntitiesV2` operation replaces the DetectEntities
438
+ # operation. This new action uses a different model for determining the
439
+ # entities in your medical text and changes the way that some entities
440
+ # are returned in the output. You should use the `DetectEntitiesV2`
441
+ # operation in all new applications.
442
+ #
443
+ # The `DetectEntitiesV2` operation returns the `Acuity` and `Direction`
444
+ # entities as attributes instead of types.
445
+ #
446
+ # @option params [required, String] :text
447
+ # A UTF-8 string containing the clinical content being examined for
448
+ # entities. Each string must contain fewer than 20,000 bytes of
449
+ # characters.
450
+ #
451
+ # @return [Types::DetectEntitiesV2Response] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
452
+ #
453
+ # * {Types::DetectEntitiesV2Response#entities #entities} => Array<Types::Entity>
454
+ # * {Types::DetectEntitiesV2Response#unmapped_attributes #unmapped_attributes} => Array<Types::UnmappedAttribute>
455
+ # * {Types::DetectEntitiesV2Response#pagination_token #pagination_token} => String
456
+ # * {Types::DetectEntitiesV2Response#model_version #model_version} => String
457
+ #
458
+ # @example Request syntax with placeholder values
459
+ #
460
+ # resp = client.detect_entities_v2({
461
+ # text: "BoundedLengthString", # required
462
+ # })
463
+ #
464
+ # @example Response structure
465
+ #
466
+ # resp.entities #=> Array
467
+ # resp.entities[0].id #=> Integer
468
+ # resp.entities[0].begin_offset #=> Integer
469
+ # resp.entities[0].end_offset #=> Integer
470
+ # resp.entities[0].score #=> Float
471
+ # resp.entities[0].text #=> String
472
+ # resp.entities[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY"
473
+ # resp.entities[0].type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY"
474
+ # resp.entities[0].traits #=> Array
475
+ # resp.entities[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
476
+ # resp.entities[0].traits[0].score #=> Float
477
+ # resp.entities[0].attributes #=> Array
478
+ # resp.entities[0].attributes[0].type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY"
479
+ # resp.entities[0].attributes[0].score #=> Float
480
+ # resp.entities[0].attributes[0].relationship_score #=> Float
481
+ # resp.entities[0].attributes[0].id #=> Integer
482
+ # resp.entities[0].attributes[0].begin_offset #=> Integer
483
+ # resp.entities[0].attributes[0].end_offset #=> Integer
484
+ # resp.entities[0].attributes[0].text #=> String
485
+ # resp.entities[0].attributes[0].traits #=> Array
486
+ # resp.entities[0].attributes[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
487
+ # resp.entities[0].attributes[0].traits[0].score #=> Float
488
+ # resp.unmapped_attributes #=> Array
489
+ # resp.unmapped_attributes[0].type #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY"
490
+ # resp.unmapped_attributes[0].attribute.type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY"
491
+ # resp.unmapped_attributes[0].attribute.score #=> Float
492
+ # resp.unmapped_attributes[0].attribute.relationship_score #=> Float
493
+ # resp.unmapped_attributes[0].attribute.id #=> Integer
494
+ # resp.unmapped_attributes[0].attribute.begin_offset #=> Integer
495
+ # resp.unmapped_attributes[0].attribute.end_offset #=> Integer
496
+ # resp.unmapped_attributes[0].attribute.text #=> String
497
+ # resp.unmapped_attributes[0].attribute.traits #=> Array
498
+ # resp.unmapped_attributes[0].attribute.traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
499
+ # resp.unmapped_attributes[0].attribute.traits[0].score #=> Float
500
+ # resp.pagination_token #=> String
501
+ # resp.model_version #=> String
502
+ #
503
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectEntitiesV2 AWS API Documentation
504
+ #
505
+ # @overload detect_entities_v2(params = {})
506
+ # @param [Hash] params ({})
507
+ def detect_entities_v2(params = {}, options = {})
508
+ req = build_request(:detect_entities_v2, params)
509
+ req.send_request(options)
510
+ end
511
+
512
+ # Inspects the clinical text for protected health information (PHI)
332
513
  # entities and entity category, location, and confidence score on that
333
514
  # information.
334
515
  #
@@ -341,6 +522,7 @@ module Aws::ComprehendMedical
341
522
  #
342
523
  # * {Types::DetectPHIResponse#entities #entities} => Array<Types::Entity>
343
524
  # * {Types::DetectPHIResponse#pagination_token #pagination_token} => String
525
+ # * {Types::DetectPHIResponse#model_version #model_version} => String
344
526
  #
345
527
  # @example Request syntax with placeholder values
346
528
  #
@@ -373,6 +555,7 @@ module Aws::ComprehendMedical
373
555
  # resp.entities[0].attributes[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
374
556
  # resp.entities[0].attributes[0].traits[0].score #=> Float
375
557
  # resp.pagination_token #=> String
558
+ # resp.model_version #=> String
376
559
  #
377
560
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectPHI AWS API Documentation
378
561
  #
@@ -383,6 +566,454 @@ module Aws::ComprehendMedical
383
566
  req.send_request(options)
384
567
  end
385
568
 
569
+ # InferICD10CM detects medical conditions as entities listed in a
570
+ # patient record and links those entities to normalized concept
571
+ # identifiers in the ICD-10-CM knowledge base from the Centers for
572
+ # Disease Control.
573
+ #
574
+ # @option params [required, String] :text
575
+ # The input text used for analysis. The input for InferICD10CM is a
576
+ # string from 1 to 10000 characters.
577
+ #
578
+ # @return [Types::InferICD10CMResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
579
+ #
580
+ # * {Types::InferICD10CMResponse#entities #entities} => Array<Types::ICD10CMEntity>
581
+ # * {Types::InferICD10CMResponse#pagination_token #pagination_token} => String
582
+ # * {Types::InferICD10CMResponse#model_version #model_version} => String
583
+ #
584
+ # @example Request syntax with placeholder values
585
+ #
586
+ # resp = client.infer_icd10cm({
587
+ # text: "OntologyLinkingBoundedLengthString", # required
588
+ # })
589
+ #
590
+ # @example Response structure
591
+ #
592
+ # resp.entities #=> Array
593
+ # resp.entities[0].id #=> Integer
594
+ # resp.entities[0].text #=> String
595
+ # resp.entities[0].category #=> String, one of "MEDICAL_CONDITION"
596
+ # resp.entities[0].type #=> String, one of "DX_NAME"
597
+ # resp.entities[0].score #=> Float
598
+ # resp.entities[0].begin_offset #=> Integer
599
+ # resp.entities[0].end_offset #=> Integer
600
+ # resp.entities[0].attributes #=> Array
601
+ # resp.entities[0].attributes[0].type #=> String, one of "ACUITY", "DIRECTION", "SYSTEM_ORGAN_SITE", "QUALITY", "QUANTITY"
602
+ # resp.entities[0].attributes[0].score #=> Float
603
+ # resp.entities[0].attributes[0].relationship_score #=> Float
604
+ # resp.entities[0].attributes[0].id #=> Integer
605
+ # resp.entities[0].attributes[0].begin_offset #=> Integer
606
+ # resp.entities[0].attributes[0].end_offset #=> Integer
607
+ # resp.entities[0].attributes[0].text #=> String
608
+ # resp.entities[0].attributes[0].traits #=> Array
609
+ # resp.entities[0].attributes[0].traits[0].name #=> String, one of "NEGATION", "DIAGNOSIS", "SIGN", "SYMPTOM"
610
+ # resp.entities[0].attributes[0].traits[0].score #=> Float
611
+ # resp.entities[0].traits #=> Array
612
+ # resp.entities[0].traits[0].name #=> String, one of "NEGATION", "DIAGNOSIS", "SIGN", "SYMPTOM"
613
+ # resp.entities[0].traits[0].score #=> Float
614
+ # resp.entities[0].icd10cm_concepts #=> Array
615
+ # resp.entities[0].icd10cm_concepts[0].description #=> String
616
+ # resp.entities[0].icd10cm_concepts[0].code #=> String
617
+ # resp.entities[0].icd10cm_concepts[0].score #=> Float
618
+ # resp.pagination_token #=> String
619
+ # resp.model_version #=> String
620
+ #
621
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferICD10CM AWS API Documentation
622
+ #
623
+ # @overload infer_icd10cm(params = {})
624
+ # @param [Hash] params ({})
625
+ def infer_icd10cm(params = {}, options = {})
626
+ req = build_request(:infer_icd10cm, params)
627
+ req.send_request(options)
628
+ end
629
+
630
+ # InferRxNorm detects medications as entities listed in a patient record
631
+ # and links to the normalized concept identifiers in the RxNorm database
632
+ # from the National Library of Medicine.
633
+ #
634
+ # @option params [required, String] :text
635
+ # The input text used for analysis. The input for InferRxNorm is a
636
+ # string from 1 to 10000 characters.
637
+ #
638
+ # @return [Types::InferRxNormResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
639
+ #
640
+ # * {Types::InferRxNormResponse#entities #entities} => Array<Types::RxNormEntity>
641
+ # * {Types::InferRxNormResponse#pagination_token #pagination_token} => String
642
+ # * {Types::InferRxNormResponse#model_version #model_version} => String
643
+ #
644
+ # @example Request syntax with placeholder values
645
+ #
646
+ # resp = client.infer_rx_norm({
647
+ # text: "OntologyLinkingBoundedLengthString", # required
648
+ # })
649
+ #
650
+ # @example Response structure
651
+ #
652
+ # resp.entities #=> Array
653
+ # resp.entities[0].id #=> Integer
654
+ # resp.entities[0].text #=> String
655
+ # resp.entities[0].category #=> String, one of "MEDICATION"
656
+ # resp.entities[0].type #=> String, one of "BRAND_NAME", "GENERIC_NAME"
657
+ # resp.entities[0].score #=> Float
658
+ # resp.entities[0].begin_offset #=> Integer
659
+ # resp.entities[0].end_offset #=> Integer
660
+ # resp.entities[0].attributes #=> Array
661
+ # resp.entities[0].attributes[0].type #=> String, one of "DOSAGE", "DURATION", "FORM", "FREQUENCY", "RATE", "ROUTE_OR_MODE", "STRENGTH"
662
+ # resp.entities[0].attributes[0].score #=> Float
663
+ # resp.entities[0].attributes[0].relationship_score #=> Float
664
+ # resp.entities[0].attributes[0].id #=> Integer
665
+ # resp.entities[0].attributes[0].begin_offset #=> Integer
666
+ # resp.entities[0].attributes[0].end_offset #=> Integer
667
+ # resp.entities[0].attributes[0].text #=> String
668
+ # resp.entities[0].attributes[0].traits #=> Array
669
+ # resp.entities[0].attributes[0].traits[0].name #=> String, one of "NEGATION"
670
+ # resp.entities[0].attributes[0].traits[0].score #=> Float
671
+ # resp.entities[0].traits #=> Array
672
+ # resp.entities[0].traits[0].name #=> String, one of "NEGATION"
673
+ # resp.entities[0].traits[0].score #=> Float
674
+ # resp.entities[0].rx_norm_concepts #=> Array
675
+ # resp.entities[0].rx_norm_concepts[0].description #=> String
676
+ # resp.entities[0].rx_norm_concepts[0].code #=> String
677
+ # resp.entities[0].rx_norm_concepts[0].score #=> Float
678
+ # resp.pagination_token #=> String
679
+ # resp.model_version #=> String
680
+ #
681
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferRxNorm AWS API Documentation
682
+ #
683
+ # @overload infer_rx_norm(params = {})
684
+ # @param [Hash] params ({})
685
+ def infer_rx_norm(params = {}, options = {})
686
+ req = build_request(:infer_rx_norm, params)
687
+ req.send_request(options)
688
+ end
689
+
690
+ # Gets a list of medical entity detection jobs that you have submitted.
691
+ #
692
+ # @option params [Types::ComprehendMedicalAsyncJobFilter] :filter
693
+ # Filters the jobs that are returned. You can filter jobs based on their
694
+ # names, status, or the date and time that they were submitted. You can
695
+ # only set one filter at a time.
696
+ #
697
+ # @option params [String] :next_token
698
+ # Identifies the next page of results to return.
699
+ #
700
+ # @option params [Integer] :max_results
701
+ # The maximum number of results to return in each page. The default is
702
+ # 100.
703
+ #
704
+ # @return [Types::ListEntitiesDetectionV2JobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
705
+ #
706
+ # * {Types::ListEntitiesDetectionV2JobsResponse#comprehend_medical_async_job_properties_list #comprehend_medical_async_job_properties_list} => Array<Types::ComprehendMedicalAsyncJobProperties>
707
+ # * {Types::ListEntitiesDetectionV2JobsResponse#next_token #next_token} => String
708
+ #
709
+ # @example Request syntax with placeholder values
710
+ #
711
+ # resp = client.list_entities_detection_v2_jobs({
712
+ # filter: {
713
+ # job_name: "JobName",
714
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
715
+ # submit_time_before: Time.now,
716
+ # submit_time_after: Time.now,
717
+ # },
718
+ # next_token: "String",
719
+ # max_results: 1,
720
+ # })
721
+ #
722
+ # @example Response structure
723
+ #
724
+ # resp.comprehend_medical_async_job_properties_list #=> Array
725
+ # resp.comprehend_medical_async_job_properties_list[0].job_id #=> String
726
+ # resp.comprehend_medical_async_job_properties_list[0].job_name #=> String
727
+ # resp.comprehend_medical_async_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
728
+ # resp.comprehend_medical_async_job_properties_list[0].message #=> String
729
+ # resp.comprehend_medical_async_job_properties_list[0].submit_time #=> Time
730
+ # resp.comprehend_medical_async_job_properties_list[0].end_time #=> Time
731
+ # resp.comprehend_medical_async_job_properties_list[0].expiration_time #=> Time
732
+ # resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_bucket #=> String
733
+ # resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_key #=> String
734
+ # resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_bucket #=> String
735
+ # resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_key #=> String
736
+ # resp.comprehend_medical_async_job_properties_list[0].language_code #=> String, one of "en"
737
+ # resp.comprehend_medical_async_job_properties_list[0].data_access_role_arn #=> String
738
+ # resp.comprehend_medical_async_job_properties_list[0].manifest_file_path #=> String
739
+ # resp.comprehend_medical_async_job_properties_list[0].kms_key #=> String
740
+ # resp.comprehend_medical_async_job_properties_list[0].model_version #=> String
741
+ # resp.next_token #=> String
742
+ #
743
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListEntitiesDetectionV2Jobs AWS API Documentation
744
+ #
745
+ # @overload list_entities_detection_v2_jobs(params = {})
746
+ # @param [Hash] params ({})
747
+ def list_entities_detection_v2_jobs(params = {}, options = {})
748
+ req = build_request(:list_entities_detection_v2_jobs, params)
749
+ req.send_request(options)
750
+ end
751
+
752
+ # Gets a list of protected health information (PHI) detection jobs that
753
+ # you have submitted.
754
+ #
755
+ # @option params [Types::ComprehendMedicalAsyncJobFilter] :filter
756
+ # Filters the jobs that are returned. You can filter jobs based on their
757
+ # names, status, or the date and time that they were submitted. You can
758
+ # only set one filter at a time.
759
+ #
760
+ # @option params [String] :next_token
761
+ # Identifies the next page of results to return.
762
+ #
763
+ # @option params [Integer] :max_results
764
+ # The maximum number of results to return in each page. The default is
765
+ # 100.
766
+ #
767
+ # @return [Types::ListPHIDetectionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
768
+ #
769
+ # * {Types::ListPHIDetectionJobsResponse#comprehend_medical_async_job_properties_list #comprehend_medical_async_job_properties_list} => Array<Types::ComprehendMedicalAsyncJobProperties>
770
+ # * {Types::ListPHIDetectionJobsResponse#next_token #next_token} => String
771
+ #
772
+ # @example Request syntax with placeholder values
773
+ #
774
+ # resp = client.list_phi_detection_jobs({
775
+ # filter: {
776
+ # job_name: "JobName",
777
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
778
+ # submit_time_before: Time.now,
779
+ # submit_time_after: Time.now,
780
+ # },
781
+ # next_token: "String",
782
+ # max_results: 1,
783
+ # })
784
+ #
785
+ # @example Response structure
786
+ #
787
+ # resp.comprehend_medical_async_job_properties_list #=> Array
788
+ # resp.comprehend_medical_async_job_properties_list[0].job_id #=> String
789
+ # resp.comprehend_medical_async_job_properties_list[0].job_name #=> String
790
+ # resp.comprehend_medical_async_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
791
+ # resp.comprehend_medical_async_job_properties_list[0].message #=> String
792
+ # resp.comprehend_medical_async_job_properties_list[0].submit_time #=> Time
793
+ # resp.comprehend_medical_async_job_properties_list[0].end_time #=> Time
794
+ # resp.comprehend_medical_async_job_properties_list[0].expiration_time #=> Time
795
+ # resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_bucket #=> String
796
+ # resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_key #=> String
797
+ # resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_bucket #=> String
798
+ # resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_key #=> String
799
+ # resp.comprehend_medical_async_job_properties_list[0].language_code #=> String, one of "en"
800
+ # resp.comprehend_medical_async_job_properties_list[0].data_access_role_arn #=> String
801
+ # resp.comprehend_medical_async_job_properties_list[0].manifest_file_path #=> String
802
+ # resp.comprehend_medical_async_job_properties_list[0].kms_key #=> String
803
+ # resp.comprehend_medical_async_job_properties_list[0].model_version #=> String
804
+ # resp.next_token #=> String
805
+ #
806
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListPHIDetectionJobs AWS API Documentation
807
+ #
808
+ # @overload list_phi_detection_jobs(params = {})
809
+ # @param [Hash] params ({})
810
+ def list_phi_detection_jobs(params = {}, options = {})
811
+ req = build_request(:list_phi_detection_jobs, params)
812
+ req.send_request(options)
813
+ end
814
+
815
+ # Starts an asynchronous medical entity detection job for a collection
816
+ # of documents. Use the `DescribeEntitiesDetectionV2Job` operation to
817
+ # track the status of a job.
818
+ #
819
+ # @option params [required, Types::InputDataConfig] :input_data_config
820
+ # Specifies the format and location of the input data for the job.
821
+ #
822
+ # @option params [required, Types::OutputDataConfig] :output_data_config
823
+ # Specifies where to send the output files.
824
+ #
825
+ # @option params [required, String] :data_access_role_arn
826
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
827
+ # Management (IAM) role that grants Amazon Comprehend Medical read
828
+ # access to your input data. For more information, see [ Role-Based
829
+ # Permissions Required for Asynchronous Operations][1].
830
+ #
831
+ #
832
+ #
833
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med
834
+ #
835
+ # @option params [String] :job_name
836
+ # The identifier of the job.
837
+ #
838
+ # @option params [String] :client_request_token
839
+ # A unique identifier for the request. If you don't set the client
840
+ # request token, Amazon Comprehend Medical generates one.
841
+ #
842
+ # **A suitable default value is auto-generated.** You should normally
843
+ # not need to pass this option.**
844
+ #
845
+ # @option params [String] :kms_key
846
+ # An AWS Key Management Service key to encrypt your output files. If you
847
+ # do not specify a key, the files are written in plain text.
848
+ #
849
+ # @option params [required, String] :language_code
850
+ # The language of the input documents. All documents must be in the same
851
+ # language.
852
+ #
853
+ # @return [Types::StartEntitiesDetectionV2JobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
854
+ #
855
+ # * {Types::StartEntitiesDetectionV2JobResponse#job_id #job_id} => String
856
+ #
857
+ # @example Request syntax with placeholder values
858
+ #
859
+ # resp = client.start_entities_detection_v2_job({
860
+ # input_data_config: { # required
861
+ # s3_bucket: "S3Bucket", # required
862
+ # s3_key: "S3Key",
863
+ # },
864
+ # output_data_config: { # required
865
+ # s3_bucket: "S3Bucket", # required
866
+ # s3_key: "S3Key",
867
+ # },
868
+ # data_access_role_arn: "IamRoleArn", # required
869
+ # job_name: "JobName",
870
+ # client_request_token: "ClientRequestTokenString",
871
+ # kms_key: "KMSKey",
872
+ # language_code: "en", # required, accepts en
873
+ # })
874
+ #
875
+ # @example Response structure
876
+ #
877
+ # resp.job_id #=> String
878
+ #
879
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartEntitiesDetectionV2Job AWS API Documentation
880
+ #
881
+ # @overload start_entities_detection_v2_job(params = {})
882
+ # @param [Hash] params ({})
883
+ def start_entities_detection_v2_job(params = {}, options = {})
884
+ req = build_request(:start_entities_detection_v2_job, params)
885
+ req.send_request(options)
886
+ end
887
+
888
+ # Starts an asynchronous job to detect protected health information
889
+ # (PHI). Use the `DescribePHIDetectionJob` operation to track the status
890
+ # of a job.
891
+ #
892
+ # @option params [required, Types::InputDataConfig] :input_data_config
893
+ # Specifies the format and location of the input data for the job.
894
+ #
895
+ # @option params [required, Types::OutputDataConfig] :output_data_config
896
+ # Specifies where to send the output files.
897
+ #
898
+ # @option params [required, String] :data_access_role_arn
899
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
900
+ # Management (IAM) role that grants Amazon Comprehend Medical read
901
+ # access to your input data. For more information, see [ Role-Based
902
+ # Permissions Required for Asynchronous Operations][1].
903
+ #
904
+ #
905
+ #
906
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med
907
+ #
908
+ # @option params [String] :job_name
909
+ # The identifier of the job.
910
+ #
911
+ # @option params [String] :client_request_token
912
+ # A unique identifier for the request. If you don't set the client
913
+ # request token, Amazon Comprehend Medical generates one.
914
+ #
915
+ # **A suitable default value is auto-generated.** You should normally
916
+ # not need to pass this option.**
917
+ #
918
+ # @option params [String] :kms_key
919
+ # An AWS Key Management Service key to encrypt your output files. If you
920
+ # do not specify a key, the files are written in plain text.
921
+ #
922
+ # @option params [required, String] :language_code
923
+ # The language of the input documents. All documents must be in the same
924
+ # language.
925
+ #
926
+ # @return [Types::StartPHIDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
927
+ #
928
+ # * {Types::StartPHIDetectionJobResponse#job_id #job_id} => String
929
+ #
930
+ # @example Request syntax with placeholder values
931
+ #
932
+ # resp = client.start_phi_detection_job({
933
+ # input_data_config: { # required
934
+ # s3_bucket: "S3Bucket", # required
935
+ # s3_key: "S3Key",
936
+ # },
937
+ # output_data_config: { # required
938
+ # s3_bucket: "S3Bucket", # required
939
+ # s3_key: "S3Key",
940
+ # },
941
+ # data_access_role_arn: "IamRoleArn", # required
942
+ # job_name: "JobName",
943
+ # client_request_token: "ClientRequestTokenString",
944
+ # kms_key: "KMSKey",
945
+ # language_code: "en", # required, accepts en
946
+ # })
947
+ #
948
+ # @example Response structure
949
+ #
950
+ # resp.job_id #=> String
951
+ #
952
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartPHIDetectionJob AWS API Documentation
953
+ #
954
+ # @overload start_phi_detection_job(params = {})
955
+ # @param [Hash] params ({})
956
+ def start_phi_detection_job(params = {}, options = {})
957
+ req = build_request(:start_phi_detection_job, params)
958
+ req.send_request(options)
959
+ end
960
+
961
+ # Stops a medical entities detection job in progress.
962
+ #
963
+ # @option params [required, String] :job_id
964
+ # The identifier of the medical entities job to stop.
965
+ #
966
+ # @return [Types::StopEntitiesDetectionV2JobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
967
+ #
968
+ # * {Types::StopEntitiesDetectionV2JobResponse#job_id #job_id} => String
969
+ #
970
+ # @example Request syntax with placeholder values
971
+ #
972
+ # resp = client.stop_entities_detection_v2_job({
973
+ # job_id: "JobId", # required
974
+ # })
975
+ #
976
+ # @example Response structure
977
+ #
978
+ # resp.job_id #=> String
979
+ #
980
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopEntitiesDetectionV2Job AWS API Documentation
981
+ #
982
+ # @overload stop_entities_detection_v2_job(params = {})
983
+ # @param [Hash] params ({})
984
+ def stop_entities_detection_v2_job(params = {}, options = {})
985
+ req = build_request(:stop_entities_detection_v2_job, params)
986
+ req.send_request(options)
987
+ end
988
+
989
+ # Stops a protected health information (PHI) detection job in progress.
990
+ #
991
+ # @option params [required, String] :job_id
992
+ # The identifier of the PHI detection job to stop.
993
+ #
994
+ # @return [Types::StopPHIDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
995
+ #
996
+ # * {Types::StopPHIDetectionJobResponse#job_id #job_id} => String
997
+ #
998
+ # @example Request syntax with placeholder values
999
+ #
1000
+ # resp = client.stop_phi_detection_job({
1001
+ # job_id: "JobId", # required
1002
+ # })
1003
+ #
1004
+ # @example Response structure
1005
+ #
1006
+ # resp.job_id #=> String
1007
+ #
1008
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopPHIDetectionJob AWS API Documentation
1009
+ #
1010
+ # @overload stop_phi_detection_job(params = {})
1011
+ # @param [Hash] params ({})
1012
+ def stop_phi_detection_job(params = {}, options = {})
1013
+ req = build_request(:stop_phi_detection_job, params)
1014
+ req.send_request(options)
1015
+ end
1016
+
386
1017
  # @!endgroup
387
1018
 
388
1019
  # @param params ({})
@@ -396,7 +1027,7 @@ module Aws::ComprehendMedical
396
1027
  params: params,
397
1028
  config: config)
398
1029
  context[:gem_name] = 'aws-sdk-comprehendmedical'
399
- context[:gem_version] = '1.6.0'
1030
+ context[:gem_version] = '1.12.0'
400
1031
  Seahorse::Client::Request.new(handlers, context)
401
1032
  end
402
1033