aws-sdk-comprehendmedical 1.31.0 → 1.35.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-comprehendmedical/client.rb +330 -40
- data/lib/aws-sdk-comprehendmedical/client_api.rb +180 -0
- data/lib/aws-sdk-comprehendmedical/types.rb +559 -48
- data/lib/aws-sdk-comprehendmedical.rb +1 -1
- metadata +4 -4
@@ -27,6 +27,8 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
31
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
30
32
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
33
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
32
34
|
|
@@ -73,6 +75,8 @@ module Aws::ComprehendMedical
|
|
73
75
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
76
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
77
|
add_plugin(Aws::Plugins::HttpChecksum)
|
78
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
79
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
76
80
|
add_plugin(Aws::Plugins::SignatureV4)
|
77
81
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
78
82
|
|
@@ -119,7 +123,9 @@ module Aws::ComprehendMedical
|
|
119
123
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
124
|
# are very aggressive. Construct and pass an instance of
|
121
125
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
126
|
+
# enable retries and extended timeouts. Instance profile credential
|
127
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
128
|
+
# to true.
|
123
129
|
#
|
124
130
|
# @option options [required, String] :region
|
125
131
|
# The AWS region to connect to. The configured `:region` is
|
@@ -173,6 +179,10 @@ module Aws::ComprehendMedical
|
|
173
179
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
174
180
|
# a clock skew correction and retry requests with skewed client clocks.
|
175
181
|
#
|
182
|
+
# @option options [String] :defaults_mode ("legacy")
|
183
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
184
|
+
# accepted modes and the configuration defaults that are included.
|
185
|
+
#
|
176
186
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
177
187
|
# Set to true to disable SDK automatically adding host prefix
|
178
188
|
# to default service endpoint when available.
|
@@ -305,7 +315,7 @@ module Aws::ComprehendMedical
|
|
305
315
|
# seconds to wait when opening a HTTP session before raising a
|
306
316
|
# `Timeout::Error`.
|
307
317
|
#
|
308
|
-
# @option options [
|
318
|
+
# @option options [Float] :http_read_timeout (60) The default
|
309
319
|
# number of seconds to wait for response data. This value can
|
310
320
|
# safely be set per-request on the session.
|
311
321
|
#
|
@@ -321,6 +331,9 @@ module Aws::ComprehendMedical
|
|
321
331
|
# disables this behaviour. This value can safely be set per
|
322
332
|
# request on the session.
|
323
333
|
#
|
334
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
335
|
+
# in seconds.
|
336
|
+
#
|
324
337
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
325
338
|
# HTTP debug output will be sent to the `:logger`.
|
326
339
|
#
|
@@ -350,9 +363,9 @@ module Aws::ComprehendMedical
|
|
350
363
|
# Use this operation to get the status of a detection job.
|
351
364
|
#
|
352
365
|
# @option params [required, String] :job_id
|
353
|
-
# The identifier that
|
354
|
-
#
|
355
|
-
#
|
366
|
+
# The identifier that Comprehend Medical; generated for the job. The
|
367
|
+
# `StartEntitiesDetectionV2Job` operation returns this identifier in its
|
368
|
+
# response.
|
356
369
|
#
|
357
370
|
# @return [Types::DescribeEntitiesDetectionV2JobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
358
371
|
#
|
@@ -443,8 +456,8 @@ module Aws::ComprehendMedical
|
|
443
456
|
# detection job.
|
444
457
|
#
|
445
458
|
# @option params [required, String] :job_id
|
446
|
-
# The identifier that
|
447
|
-
#
|
459
|
+
# The identifier that Comprehend Medical; generated for the job. The
|
460
|
+
# `StartPHIDetectionJob` operation returns this identifier in its
|
448
461
|
# response.
|
449
462
|
#
|
450
463
|
# @return [Types::DescribePHIDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -531,6 +544,52 @@ module Aws::ComprehendMedical
|
|
531
544
|
req.send_request(options)
|
532
545
|
end
|
533
546
|
|
547
|
+
# Gets the properties associated with an InferSNOMEDCT job. Use this
|
548
|
+
# operation to get the status of an inference job.
|
549
|
+
#
|
550
|
+
# @option params [required, String] :job_id
|
551
|
+
# The identifier that Amazon Comprehend Medical generated for the job.
|
552
|
+
# The StartSNOMEDCTInferenceJob operation returns this identifier in its
|
553
|
+
# response.
|
554
|
+
#
|
555
|
+
# @return [Types::DescribeSNOMEDCTInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
556
|
+
#
|
557
|
+
# * {Types::DescribeSNOMEDCTInferenceJobResponse#comprehend_medical_async_job_properties #comprehend_medical_async_job_properties} => Types::ComprehendMedicalAsyncJobProperties
|
558
|
+
#
|
559
|
+
# @example Request syntax with placeholder values
|
560
|
+
#
|
561
|
+
# resp = client.describe_snomedct_inference_job({
|
562
|
+
# job_id: "JobId", # required
|
563
|
+
# })
|
564
|
+
#
|
565
|
+
# @example Response structure
|
566
|
+
#
|
567
|
+
# resp.comprehend_medical_async_job_properties.job_id #=> String
|
568
|
+
# resp.comprehend_medical_async_job_properties.job_name #=> String
|
569
|
+
# resp.comprehend_medical_async_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
|
570
|
+
# resp.comprehend_medical_async_job_properties.message #=> String
|
571
|
+
# resp.comprehend_medical_async_job_properties.submit_time #=> Time
|
572
|
+
# resp.comprehend_medical_async_job_properties.end_time #=> Time
|
573
|
+
# resp.comprehend_medical_async_job_properties.expiration_time #=> Time
|
574
|
+
# resp.comprehend_medical_async_job_properties.input_data_config.s3_bucket #=> String
|
575
|
+
# resp.comprehend_medical_async_job_properties.input_data_config.s3_key #=> String
|
576
|
+
# resp.comprehend_medical_async_job_properties.output_data_config.s3_bucket #=> String
|
577
|
+
# resp.comprehend_medical_async_job_properties.output_data_config.s3_key #=> String
|
578
|
+
# resp.comprehend_medical_async_job_properties.language_code #=> String, one of "en"
|
579
|
+
# resp.comprehend_medical_async_job_properties.data_access_role_arn #=> String
|
580
|
+
# resp.comprehend_medical_async_job_properties.manifest_file_path #=> String
|
581
|
+
# resp.comprehend_medical_async_job_properties.kms_key #=> String
|
582
|
+
# resp.comprehend_medical_async_job_properties.model_version #=> String
|
583
|
+
#
|
584
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeSNOMEDCTInferenceJob AWS API Documentation
|
585
|
+
#
|
586
|
+
# @overload describe_snomedct_inference_job(params = {})
|
587
|
+
# @param [Hash] params ({})
|
588
|
+
def describe_snomedct_inference_job(params = {}, options = {})
|
589
|
+
req = build_request(:describe_snomedct_inference_job, params)
|
590
|
+
req.send_request(options)
|
591
|
+
end
|
592
|
+
|
534
593
|
# The `DetectEntities` operation is deprecated. You should use the
|
535
594
|
# DetectEntitiesV2 operation instead.
|
536
595
|
#
|
@@ -565,15 +624,15 @@ module Aws::ComprehendMedical
|
|
565
624
|
# resp.entities[0].score #=> Float
|
566
625
|
# resp.entities[0].text #=> String
|
567
626
|
# resp.entities[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
|
568
|
-
# 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", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME"
|
627
|
+
# resp.entities[0].type #=> String, one of "NAME", "DX_NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "PHONE_OR_FAX", "EMAIL", "IDENTIFIER", "ID", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME"
|
569
628
|
# resp.entities[0].traits #=> Array
|
570
629
|
# resp.entities[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
|
571
630
|
# resp.entities[0].traits[0].score #=> Float
|
572
631
|
# resp.entities[0].attributes #=> Array
|
573
|
-
# 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", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME"
|
632
|
+
# resp.entities[0].attributes[0].type #=> String, one of "NAME", "DX_NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "PHONE_OR_FAX", "EMAIL", "IDENTIFIER", "ID", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME"
|
574
633
|
# resp.entities[0].attributes[0].score #=> Float
|
575
634
|
# resp.entities[0].attributes[0].relationship_score #=> Float
|
576
|
-
# resp.entities[0].attributes[0].relationship_type #=> String, one of "EVERY", "WITH_DOSAGE", "ADMINISTERED_VIA", "FOR", "NEGATIVE", "OVERLAP", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "STRENGTH", "RATE", "ACUITY", "TEST_VALUE", "TEST_UNITS", "DIRECTION", "SYSTEM_ORGAN_SITE"
|
635
|
+
# resp.entities[0].attributes[0].relationship_type #=> String, one of "EVERY", "WITH_DOSAGE", "ADMINISTERED_VIA", "FOR", "NEGATIVE", "OVERLAP", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "STRENGTH", "RATE", "ACUITY", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "DIRECTION", "SYSTEM_ORGAN_SITE"
|
577
636
|
# resp.entities[0].attributes[0].id #=> Integer
|
578
637
|
# resp.entities[0].attributes[0].begin_offset #=> Integer
|
579
638
|
# resp.entities[0].attributes[0].end_offset #=> Integer
|
@@ -584,10 +643,10 @@ module Aws::ComprehendMedical
|
|
584
643
|
# resp.entities[0].attributes[0].traits[0].score #=> Float
|
585
644
|
# resp.unmapped_attributes #=> Array
|
586
645
|
# resp.unmapped_attributes[0].type #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
|
587
|
-
# 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", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME"
|
646
|
+
# resp.unmapped_attributes[0].attribute.type #=> String, one of "NAME", "DX_NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "PHONE_OR_FAX", "EMAIL", "IDENTIFIER", "ID", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME"
|
588
647
|
# resp.unmapped_attributes[0].attribute.score #=> Float
|
589
648
|
# resp.unmapped_attributes[0].attribute.relationship_score #=> Float
|
590
|
-
# resp.unmapped_attributes[0].attribute.relationship_type #=> String, one of "EVERY", "WITH_DOSAGE", "ADMINISTERED_VIA", "FOR", "NEGATIVE", "OVERLAP", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "STRENGTH", "RATE", "ACUITY", "TEST_VALUE", "TEST_UNITS", "DIRECTION", "SYSTEM_ORGAN_SITE"
|
649
|
+
# resp.unmapped_attributes[0].attribute.relationship_type #=> String, one of "EVERY", "WITH_DOSAGE", "ADMINISTERED_VIA", "FOR", "NEGATIVE", "OVERLAP", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "STRENGTH", "RATE", "ACUITY", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "DIRECTION", "SYSTEM_ORGAN_SITE"
|
591
650
|
# resp.unmapped_attributes[0].attribute.id #=> Integer
|
592
651
|
# resp.unmapped_attributes[0].attribute.begin_offset #=> Integer
|
593
652
|
# resp.unmapped_attributes[0].attribute.end_offset #=> Integer
|
@@ -649,15 +708,15 @@ module Aws::ComprehendMedical
|
|
649
708
|
# resp.entities[0].score #=> Float
|
650
709
|
# resp.entities[0].text #=> String
|
651
710
|
# resp.entities[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
|
652
|
-
# 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", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME"
|
711
|
+
# resp.entities[0].type #=> String, one of "NAME", "DX_NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "PHONE_OR_FAX", "EMAIL", "IDENTIFIER", "ID", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME"
|
653
712
|
# resp.entities[0].traits #=> Array
|
654
713
|
# resp.entities[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
|
655
714
|
# resp.entities[0].traits[0].score #=> Float
|
656
715
|
# resp.entities[0].attributes #=> Array
|
657
|
-
# 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", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME"
|
716
|
+
# resp.entities[0].attributes[0].type #=> String, one of "NAME", "DX_NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "PHONE_OR_FAX", "EMAIL", "IDENTIFIER", "ID", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME"
|
658
717
|
# resp.entities[0].attributes[0].score #=> Float
|
659
718
|
# resp.entities[0].attributes[0].relationship_score #=> Float
|
660
|
-
# resp.entities[0].attributes[0].relationship_type #=> String, one of "EVERY", "WITH_DOSAGE", "ADMINISTERED_VIA", "FOR", "NEGATIVE", "OVERLAP", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "STRENGTH", "RATE", "ACUITY", "TEST_VALUE", "TEST_UNITS", "DIRECTION", "SYSTEM_ORGAN_SITE"
|
719
|
+
# resp.entities[0].attributes[0].relationship_type #=> String, one of "EVERY", "WITH_DOSAGE", "ADMINISTERED_VIA", "FOR", "NEGATIVE", "OVERLAP", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "STRENGTH", "RATE", "ACUITY", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "DIRECTION", "SYSTEM_ORGAN_SITE"
|
661
720
|
# resp.entities[0].attributes[0].id #=> Integer
|
662
721
|
# resp.entities[0].attributes[0].begin_offset #=> Integer
|
663
722
|
# resp.entities[0].attributes[0].end_offset #=> Integer
|
@@ -668,10 +727,10 @@ module Aws::ComprehendMedical
|
|
668
727
|
# resp.entities[0].attributes[0].traits[0].score #=> Float
|
669
728
|
# resp.unmapped_attributes #=> Array
|
670
729
|
# resp.unmapped_attributes[0].type #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
|
671
|
-
# 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", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME"
|
730
|
+
# resp.unmapped_attributes[0].attribute.type #=> String, one of "NAME", "DX_NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "PHONE_OR_FAX", "EMAIL", "IDENTIFIER", "ID", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME"
|
672
731
|
# resp.unmapped_attributes[0].attribute.score #=> Float
|
673
732
|
# resp.unmapped_attributes[0].attribute.relationship_score #=> Float
|
674
|
-
# resp.unmapped_attributes[0].attribute.relationship_type #=> String, one of "EVERY", "WITH_DOSAGE", "ADMINISTERED_VIA", "FOR", "NEGATIVE", "OVERLAP", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "STRENGTH", "RATE", "ACUITY", "TEST_VALUE", "TEST_UNITS", "DIRECTION", "SYSTEM_ORGAN_SITE"
|
733
|
+
# resp.unmapped_attributes[0].attribute.relationship_type #=> String, one of "EVERY", "WITH_DOSAGE", "ADMINISTERED_VIA", "FOR", "NEGATIVE", "OVERLAP", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "STRENGTH", "RATE", "ACUITY", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "DIRECTION", "SYSTEM_ORGAN_SITE"
|
675
734
|
# resp.unmapped_attributes[0].attribute.id #=> Integer
|
676
735
|
# resp.unmapped_attributes[0].attribute.begin_offset #=> Integer
|
677
736
|
# resp.unmapped_attributes[0].attribute.end_offset #=> Integer
|
@@ -723,15 +782,15 @@ module Aws::ComprehendMedical
|
|
723
782
|
# resp.entities[0].score #=> Float
|
724
783
|
# resp.entities[0].text #=> String
|
725
784
|
# resp.entities[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION"
|
726
|
-
# 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", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME"
|
785
|
+
# resp.entities[0].type #=> String, one of "NAME", "DX_NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "PHONE_OR_FAX", "EMAIL", "IDENTIFIER", "ID", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME"
|
727
786
|
# resp.entities[0].traits #=> Array
|
728
787
|
# resp.entities[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
|
729
788
|
# resp.entities[0].traits[0].score #=> Float
|
730
789
|
# resp.entities[0].attributes #=> Array
|
731
|
-
# 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", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME"
|
790
|
+
# resp.entities[0].attributes[0].type #=> String, one of "NAME", "DX_NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "PHONE_OR_FAX", "EMAIL", "IDENTIFIER", "ID", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME"
|
732
791
|
# resp.entities[0].attributes[0].score #=> Float
|
733
792
|
# resp.entities[0].attributes[0].relationship_score #=> Float
|
734
|
-
# resp.entities[0].attributes[0].relationship_type #=> String, one of "EVERY", "WITH_DOSAGE", "ADMINISTERED_VIA", "FOR", "NEGATIVE", "OVERLAP", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "STRENGTH", "RATE", "ACUITY", "TEST_VALUE", "TEST_UNITS", "DIRECTION", "SYSTEM_ORGAN_SITE"
|
793
|
+
# resp.entities[0].attributes[0].relationship_type #=> String, one of "EVERY", "WITH_DOSAGE", "ADMINISTERED_VIA", "FOR", "NEGATIVE", "OVERLAP", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "STRENGTH", "RATE", "ACUITY", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "DIRECTION", "SYSTEM_ORGAN_SITE"
|
735
794
|
# resp.entities[0].attributes[0].id #=> Integer
|
736
795
|
# resp.entities[0].attributes[0].begin_offset #=> Integer
|
737
796
|
# resp.entities[0].attributes[0].end_offset #=> Integer
|
@@ -877,6 +936,78 @@ module Aws::ComprehendMedical
|
|
877
936
|
req.send_request(options)
|
878
937
|
end
|
879
938
|
|
939
|
+
# InferSNOMEDCT detects possible medical concepts as entities and links
|
940
|
+
# them to codes from the Systematized Nomenclature of Medicine, Clinical
|
941
|
+
# Terms (SNOMED-CT) ontology
|
942
|
+
#
|
943
|
+
# @option params [required, String] :text
|
944
|
+
# The input text to be analyzed using InferSNOMEDCT. The text should be
|
945
|
+
# a string with 1 to 10000 characters.
|
946
|
+
#
|
947
|
+
# @return [Types::InferSNOMEDCTResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
948
|
+
#
|
949
|
+
# * {Types::InferSNOMEDCTResponse#entities #entities} => Array<Types::SNOMEDCTEntity>
|
950
|
+
# * {Types::InferSNOMEDCTResponse#pagination_token #pagination_token} => String
|
951
|
+
# * {Types::InferSNOMEDCTResponse#model_version #model_version} => String
|
952
|
+
# * {Types::InferSNOMEDCTResponse#snomedct_details #snomedct_details} => Types::SNOMEDCTDetails
|
953
|
+
# * {Types::InferSNOMEDCTResponse#characters #characters} => Types::Characters
|
954
|
+
#
|
955
|
+
# @example Request syntax with placeholder values
|
956
|
+
#
|
957
|
+
# resp = client.infer_snomedct({
|
958
|
+
# text: "OntologyLinkingBoundedLengthString", # required
|
959
|
+
# })
|
960
|
+
#
|
961
|
+
# @example Response structure
|
962
|
+
#
|
963
|
+
# resp.entities #=> Array
|
964
|
+
# resp.entities[0].id #=> Integer
|
965
|
+
# resp.entities[0].text #=> String
|
966
|
+
# resp.entities[0].category #=> String, one of "MEDICAL_CONDITION", "ANATOMY", "TEST_TREATMENT_PROCEDURE"
|
967
|
+
# resp.entities[0].type #=> String, one of "DX_NAME", "TEST_NAME", "PROCEDURE_NAME", "TREATMENT_NAME"
|
968
|
+
# resp.entities[0].score #=> Float
|
969
|
+
# resp.entities[0].begin_offset #=> Integer
|
970
|
+
# resp.entities[0].end_offset #=> Integer
|
971
|
+
# resp.entities[0].attributes #=> Array
|
972
|
+
# resp.entities[0].attributes[0].category #=> String, one of "MEDICAL_CONDITION", "ANATOMY", "TEST_TREATMENT_PROCEDURE"
|
973
|
+
# resp.entities[0].attributes[0].type #=> String, one of "ACUITY", "QUALITY", "DIRECTION", "SYSTEM_ORGAN_SITE", "TEST_VALUE", "TEST_UNIT"
|
974
|
+
# resp.entities[0].attributes[0].score #=> Float
|
975
|
+
# resp.entities[0].attributes[0].relationship_score #=> Float
|
976
|
+
# resp.entities[0].attributes[0].relationship_type #=> String, one of "ACUITY", "QUALITY", "TEST_VALUE", "TEST_UNITS", "DIRECTION", "SYSTEM_ORGAN_SITE"
|
977
|
+
# resp.entities[0].attributes[0].id #=> Integer
|
978
|
+
# resp.entities[0].attributes[0].begin_offset #=> Integer
|
979
|
+
# resp.entities[0].attributes[0].end_offset #=> Integer
|
980
|
+
# resp.entities[0].attributes[0].text #=> String
|
981
|
+
# resp.entities[0].attributes[0].traits #=> Array
|
982
|
+
# resp.entities[0].attributes[0].traits[0].name #=> String, one of "NEGATION", "DIAGNOSIS", "SIGN", "SYMPTOM"
|
983
|
+
# resp.entities[0].attributes[0].traits[0].score #=> Float
|
984
|
+
# resp.entities[0].attributes[0].snomedct_concepts #=> Array
|
985
|
+
# resp.entities[0].attributes[0].snomedct_concepts[0].description #=> String
|
986
|
+
# resp.entities[0].attributes[0].snomedct_concepts[0].code #=> String
|
987
|
+
# resp.entities[0].attributes[0].snomedct_concepts[0].score #=> Float
|
988
|
+
# resp.entities[0].traits #=> Array
|
989
|
+
# resp.entities[0].traits[0].name #=> String, one of "NEGATION", "DIAGNOSIS", "SIGN", "SYMPTOM"
|
990
|
+
# resp.entities[0].traits[0].score #=> Float
|
991
|
+
# resp.entities[0].snomedct_concepts #=> Array
|
992
|
+
# resp.entities[0].snomedct_concepts[0].description #=> String
|
993
|
+
# resp.entities[0].snomedct_concepts[0].code #=> String
|
994
|
+
# resp.entities[0].snomedct_concepts[0].score #=> Float
|
995
|
+
# resp.pagination_token #=> String
|
996
|
+
# resp.model_version #=> String
|
997
|
+
# resp.snomedct_details.edition #=> String
|
998
|
+
# resp.snomedct_details.language #=> String
|
999
|
+
# resp.snomedct_details.version_date #=> String
|
1000
|
+
# resp.characters.original_text_characters #=> Integer
|
1001
|
+
#
|
1002
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferSNOMEDCT AWS API Documentation
|
1003
|
+
#
|
1004
|
+
# @overload infer_snomedct(params = {})
|
1005
|
+
# @param [Hash] params ({})
|
1006
|
+
def infer_snomedct(params = {}, options = {})
|
1007
|
+
req = build_request(:infer_snomedct, params)
|
1008
|
+
req.send_request(options)
|
1009
|
+
end
|
1010
|
+
|
880
1011
|
# Gets a list of medical entity detection jobs that you have submitted.
|
881
1012
|
#
|
882
1013
|
# @option params [Types::ComprehendMedicalAsyncJobFilter] :filter
|
@@ -1125,21 +1256,83 @@ module Aws::ComprehendMedical
|
|
1125
1256
|
req.send_request(options)
|
1126
1257
|
end
|
1127
1258
|
|
1259
|
+
# Gets a list of InferSNOMEDCT jobs a user has submitted.
|
1260
|
+
#
|
1261
|
+
# @option params [Types::ComprehendMedicalAsyncJobFilter] :filter
|
1262
|
+
# Provides information for filtering a list of detection jobs.
|
1263
|
+
#
|
1264
|
+
# @option params [String] :next_token
|
1265
|
+
# Identifies the next page of InferSNOMEDCT results to return.
|
1266
|
+
#
|
1267
|
+
# @option params [Integer] :max_results
|
1268
|
+
# The maximum number of results to return in each page. The default is
|
1269
|
+
# 100.
|
1270
|
+
#
|
1271
|
+
# @return [Types::ListSNOMEDCTInferenceJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1272
|
+
#
|
1273
|
+
# * {Types::ListSNOMEDCTInferenceJobsResponse#comprehend_medical_async_job_properties_list #comprehend_medical_async_job_properties_list} => Array<Types::ComprehendMedicalAsyncJobProperties>
|
1274
|
+
# * {Types::ListSNOMEDCTInferenceJobsResponse#next_token #next_token} => String
|
1275
|
+
#
|
1276
|
+
# @example Request syntax with placeholder values
|
1277
|
+
#
|
1278
|
+
# resp = client.list_snomedct_inference_jobs({
|
1279
|
+
# filter: {
|
1280
|
+
# job_name: "JobName",
|
1281
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
|
1282
|
+
# submit_time_before: Time.now,
|
1283
|
+
# submit_time_after: Time.now,
|
1284
|
+
# },
|
1285
|
+
# next_token: "String",
|
1286
|
+
# max_results: 1,
|
1287
|
+
# })
|
1288
|
+
#
|
1289
|
+
# @example Response structure
|
1290
|
+
#
|
1291
|
+
# resp.comprehend_medical_async_job_properties_list #=> Array
|
1292
|
+
# resp.comprehend_medical_async_job_properties_list[0].job_id #=> String
|
1293
|
+
# resp.comprehend_medical_async_job_properties_list[0].job_name #=> String
|
1294
|
+
# resp.comprehend_medical_async_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
|
1295
|
+
# resp.comprehend_medical_async_job_properties_list[0].message #=> String
|
1296
|
+
# resp.comprehend_medical_async_job_properties_list[0].submit_time #=> Time
|
1297
|
+
# resp.comprehend_medical_async_job_properties_list[0].end_time #=> Time
|
1298
|
+
# resp.comprehend_medical_async_job_properties_list[0].expiration_time #=> Time
|
1299
|
+
# resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_bucket #=> String
|
1300
|
+
# resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_key #=> String
|
1301
|
+
# resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_bucket #=> String
|
1302
|
+
# resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_key #=> String
|
1303
|
+
# resp.comprehend_medical_async_job_properties_list[0].language_code #=> String, one of "en"
|
1304
|
+
# resp.comprehend_medical_async_job_properties_list[0].data_access_role_arn #=> String
|
1305
|
+
# resp.comprehend_medical_async_job_properties_list[0].manifest_file_path #=> String
|
1306
|
+
# resp.comprehend_medical_async_job_properties_list[0].kms_key #=> String
|
1307
|
+
# resp.comprehend_medical_async_job_properties_list[0].model_version #=> String
|
1308
|
+
# resp.next_token #=> String
|
1309
|
+
#
|
1310
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListSNOMEDCTInferenceJobs AWS API Documentation
|
1311
|
+
#
|
1312
|
+
# @overload list_snomedct_inference_jobs(params = {})
|
1313
|
+
# @param [Hash] params ({})
|
1314
|
+
def list_snomedct_inference_jobs(params = {}, options = {})
|
1315
|
+
req = build_request(:list_snomedct_inference_jobs, params)
|
1316
|
+
req.send_request(options)
|
1317
|
+
end
|
1318
|
+
|
1128
1319
|
# Starts an asynchronous medical entity detection job for a collection
|
1129
1320
|
# of documents. Use the `DescribeEntitiesDetectionV2Job` operation to
|
1130
1321
|
# track the status of a job.
|
1131
1322
|
#
|
1132
1323
|
# @option params [required, Types::InputDataConfig] :input_data_config
|
1133
|
-
#
|
1324
|
+
# The input configuration that specifies the format and location of the
|
1325
|
+
# input data for the job.
|
1134
1326
|
#
|
1135
1327
|
# @option params [required, Types::OutputDataConfig] :output_data_config
|
1136
|
-
#
|
1328
|
+
# The output configuration that specifies where to send the output
|
1329
|
+
# files.
|
1137
1330
|
#
|
1138
1331
|
# @option params [required, String] :data_access_role_arn
|
1139
1332
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1140
|
-
# Management (IAM) role that grants
|
1141
|
-
#
|
1142
|
-
#
|
1333
|
+
# Management (IAM) role that grants Comprehend Medical; read access to
|
1334
|
+
# your input data. For more information, see [ Role-Based Permissions
|
1335
|
+
# Required for Asynchronous Operations][1].
|
1143
1336
|
#
|
1144
1337
|
#
|
1145
1338
|
#
|
@@ -1150,7 +1343,7 @@ module Aws::ComprehendMedical
|
|
1150
1343
|
#
|
1151
1344
|
# @option params [String] :client_request_token
|
1152
1345
|
# A unique identifier for the request. If you don't set the client
|
1153
|
-
# request token,
|
1346
|
+
# request token, Comprehend Medical; generates one for you.
|
1154
1347
|
#
|
1155
1348
|
# **A suitable default value is auto-generated.** You should normally
|
1156
1349
|
# not need to pass this option.**
|
@@ -1161,7 +1354,7 @@ module Aws::ComprehendMedical
|
|
1161
1354
|
#
|
1162
1355
|
# @option params [required, String] :language_code
|
1163
1356
|
# The language of the input documents. All documents must be in the same
|
1164
|
-
# language.
|
1357
|
+
# language. Comprehend Medical; processes files in US English (en).
|
1165
1358
|
#
|
1166
1359
|
# @return [Types::StartEntitiesDetectionV2JobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1167
1360
|
#
|
@@ -1210,9 +1403,9 @@ module Aws::ComprehendMedical
|
|
1210
1403
|
#
|
1211
1404
|
# @option params [required, String] :data_access_role_arn
|
1212
1405
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1213
|
-
# Management (IAM) role that grants
|
1214
|
-
#
|
1215
|
-
#
|
1406
|
+
# Management (IAM) role that grants Comprehend Medical; read access to
|
1407
|
+
# your input data. For more information, see [ Role-Based Permissions
|
1408
|
+
# Required for Asynchronous Operations][1].
|
1216
1409
|
#
|
1217
1410
|
#
|
1218
1411
|
#
|
@@ -1223,7 +1416,7 @@ module Aws::ComprehendMedical
|
|
1223
1416
|
#
|
1224
1417
|
# @option params [String] :client_request_token
|
1225
1418
|
# A unique identifier for the request. If you don't set the client
|
1226
|
-
# request token,
|
1419
|
+
# request token, Comprehend Medical; generates one.
|
1227
1420
|
#
|
1228
1421
|
# **A suitable default value is auto-generated.** You should normally
|
1229
1422
|
# not need to pass this option.**
|
@@ -1283,9 +1476,9 @@ module Aws::ComprehendMedical
|
|
1283
1476
|
#
|
1284
1477
|
# @option params [required, String] :data_access_role_arn
|
1285
1478
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1286
|
-
# Management (IAM) role that grants
|
1287
|
-
#
|
1288
|
-
#
|
1479
|
+
# Management (IAM) role that grants Comprehend Medical; read access to
|
1480
|
+
# your input data. For more information, see [ Role-Based Permissions
|
1481
|
+
# Required for Asynchronous Operations][1].
|
1289
1482
|
#
|
1290
1483
|
#
|
1291
1484
|
#
|
@@ -1296,7 +1489,7 @@ module Aws::ComprehendMedical
|
|
1296
1489
|
#
|
1297
1490
|
# @option params [String] :client_request_token
|
1298
1491
|
# A unique identifier for the request. If you don't set the client
|
1299
|
-
# request token,
|
1492
|
+
# request token, Comprehend Medical; generates one.
|
1300
1493
|
#
|
1301
1494
|
# **A suitable default value is auto-generated.** You should normally
|
1302
1495
|
# not need to pass this option.**
|
@@ -1356,9 +1549,9 @@ module Aws::ComprehendMedical
|
|
1356
1549
|
#
|
1357
1550
|
# @option params [required, String] :data_access_role_arn
|
1358
1551
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1359
|
-
# Management (IAM) role that grants
|
1360
|
-
#
|
1361
|
-
#
|
1552
|
+
# Management (IAM) role that grants Comprehend Medical; read access to
|
1553
|
+
# your input data. For more information, see [ Role-Based Permissions
|
1554
|
+
# Required for Asynchronous Operations][1].
|
1362
1555
|
#
|
1363
1556
|
#
|
1364
1557
|
#
|
@@ -1369,7 +1562,7 @@ module Aws::ComprehendMedical
|
|
1369
1562
|
#
|
1370
1563
|
# @option params [String] :client_request_token
|
1371
1564
|
# A unique identifier for the request. If you don't set the client
|
1372
|
-
# request token,
|
1565
|
+
# request token, Comprehend Medical; generates one.
|
1373
1566
|
#
|
1374
1567
|
# **A suitable default value is auto-generated.** You should normally
|
1375
1568
|
# not need to pass this option.**
|
@@ -1417,6 +1610,75 @@ module Aws::ComprehendMedical
|
|
1417
1610
|
req.send_request(options)
|
1418
1611
|
end
|
1419
1612
|
|
1613
|
+
# Starts an asynchronous job to detect medical concepts and link them to
|
1614
|
+
# the SNOMED-CT ontology. Use the DescribeSNOMEDCTInferenceJob operation
|
1615
|
+
# to track the status of a job.
|
1616
|
+
#
|
1617
|
+
# @option params [required, Types::InputDataConfig] :input_data_config
|
1618
|
+
# The input properties for an entities detection job. This includes the
|
1619
|
+
# name of the S3 bucket and the path to the files to be analyzed.
|
1620
|
+
#
|
1621
|
+
# @option params [required, Types::OutputDataConfig] :output_data_config
|
1622
|
+
# The output properties for a detection job.
|
1623
|
+
#
|
1624
|
+
# @option params [required, String] :data_access_role_arn
|
1625
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1626
|
+
# Management (IAM) role that grants Amazon Comprehend Medical read
|
1627
|
+
# access to your input data.
|
1628
|
+
#
|
1629
|
+
# @option params [String] :job_name
|
1630
|
+
# The user generated name the asynchronous InferSNOMEDCT job.
|
1631
|
+
#
|
1632
|
+
# @option params [String] :client_request_token
|
1633
|
+
# A unique identifier for the request. If you don't set the client
|
1634
|
+
# request token, Amazon Comprehend Medical generates one.
|
1635
|
+
#
|
1636
|
+
# **A suitable default value is auto-generated.** You should normally
|
1637
|
+
# not need to pass this option.**
|
1638
|
+
#
|
1639
|
+
# @option params [String] :kms_key
|
1640
|
+
# An AWS Key Management Service key used to encrypt your output files.
|
1641
|
+
# If you do not specify a key, the files are written in plain text.
|
1642
|
+
#
|
1643
|
+
# @option params [required, String] :language_code
|
1644
|
+
# The language of the input documents. All documents must be in the same
|
1645
|
+
# language.
|
1646
|
+
#
|
1647
|
+
# @return [Types::StartSNOMEDCTInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1648
|
+
#
|
1649
|
+
# * {Types::StartSNOMEDCTInferenceJobResponse#job_id #job_id} => String
|
1650
|
+
#
|
1651
|
+
# @example Request syntax with placeholder values
|
1652
|
+
#
|
1653
|
+
# resp = client.start_snomedct_inference_job({
|
1654
|
+
# input_data_config: { # required
|
1655
|
+
# s3_bucket: "S3Bucket", # required
|
1656
|
+
# s3_key: "S3Key",
|
1657
|
+
# },
|
1658
|
+
# output_data_config: { # required
|
1659
|
+
# s3_bucket: "S3Bucket", # required
|
1660
|
+
# s3_key: "S3Key",
|
1661
|
+
# },
|
1662
|
+
# data_access_role_arn: "IamRoleArn", # required
|
1663
|
+
# job_name: "JobName",
|
1664
|
+
# client_request_token: "ClientRequestTokenString",
|
1665
|
+
# kms_key: "KMSKey",
|
1666
|
+
# language_code: "en", # required, accepts en
|
1667
|
+
# })
|
1668
|
+
#
|
1669
|
+
# @example Response structure
|
1670
|
+
#
|
1671
|
+
# resp.job_id #=> String
|
1672
|
+
#
|
1673
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartSNOMEDCTInferenceJob AWS API Documentation
|
1674
|
+
#
|
1675
|
+
# @overload start_snomedct_inference_job(params = {})
|
1676
|
+
# @param [Hash] params ({})
|
1677
|
+
def start_snomedct_inference_job(params = {}, options = {})
|
1678
|
+
req = build_request(:start_snomedct_inference_job, params)
|
1679
|
+
req.send_request(options)
|
1680
|
+
end
|
1681
|
+
|
1420
1682
|
# Stops a medical entities detection job in progress.
|
1421
1683
|
#
|
1422
1684
|
# @option params [required, String] :job_id
|
@@ -1529,6 +1791,34 @@ module Aws::ComprehendMedical
|
|
1529
1791
|
req.send_request(options)
|
1530
1792
|
end
|
1531
1793
|
|
1794
|
+
# Stops an InferSNOMEDCT inference job in progress.
|
1795
|
+
#
|
1796
|
+
# @option params [required, String] :job_id
|
1797
|
+
# The job id of the asynchronous InferSNOMEDCT job to be stopped.
|
1798
|
+
#
|
1799
|
+
# @return [Types::StopSNOMEDCTInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1800
|
+
#
|
1801
|
+
# * {Types::StopSNOMEDCTInferenceJobResponse#job_id #job_id} => String
|
1802
|
+
#
|
1803
|
+
# @example Request syntax with placeholder values
|
1804
|
+
#
|
1805
|
+
# resp = client.stop_snomedct_inference_job({
|
1806
|
+
# job_id: "JobId", # required
|
1807
|
+
# })
|
1808
|
+
#
|
1809
|
+
# @example Response structure
|
1810
|
+
#
|
1811
|
+
# resp.job_id #=> String
|
1812
|
+
#
|
1813
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopSNOMEDCTInferenceJob AWS API Documentation
|
1814
|
+
#
|
1815
|
+
# @overload stop_snomedct_inference_job(params = {})
|
1816
|
+
# @param [Hash] params ({})
|
1817
|
+
def stop_snomedct_inference_job(params = {}, options = {})
|
1818
|
+
req = build_request(:stop_snomedct_inference_job, params)
|
1819
|
+
req.send_request(options)
|
1820
|
+
end
|
1821
|
+
|
1532
1822
|
# @!endgroup
|
1533
1823
|
|
1534
1824
|
# @param params ({})
|
@@ -1542,7 +1832,7 @@ module Aws::ComprehendMedical
|
|
1542
1832
|
params: params,
|
1543
1833
|
config: config)
|
1544
1834
|
context[:gem_name] = 'aws-sdk-comprehendmedical'
|
1545
|
-
context[:gem_version] = '1.
|
1835
|
+
context[:gem_version] = '1.35.0'
|
1546
1836
|
Seahorse::Client::Request.new(handlers, context)
|
1547
1837
|
end
|
1548
1838
|
|