aws-sdk-comprehendmedical 1.5.0 → 1.11.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
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: bd9ba05ca4156b7142f3ff7fe9c6356f2695069a
|
4
|
+
data.tar.gz: 260257468d5de9e2d768751b05ff73fa9d7ee378
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7805c7f3ad09f22a7a151744a4fcaef569b0252c301bd59cfee032a606d6a75cd44e9004120e3b17c11c330370b8e880d906c2050cef7a0a8592395f35b1100a
|
7
|
+
data.tar.gz: b48901739048585ccca00da4cf311f9b4ea2c5765c4086114ef1f26e6c2cd6bbd64750675cc701dea41ab95e9fae154957c3705743e7c317c274dfe89f4ae86d
|
@@ -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,87 @@ module Aws::ComprehendMedical
|
|
328
430
|
req.send_request(options)
|
329
431
|
end
|
330
432
|
|
331
|
-
# Inspects the clinical text for
|
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. It does not return the
|
445
|
+
# `Quality` or `Quantity` entities.
|
446
|
+
#
|
447
|
+
# @option params [required, String] :text
|
448
|
+
# A UTF-8 string containing the clinical content being examined for
|
449
|
+
# entities. Each string must contain fewer than 20,000 bytes of
|
450
|
+
# characters.
|
451
|
+
#
|
452
|
+
# @return [Types::DetectEntitiesV2Response] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
453
|
+
#
|
454
|
+
# * {Types::DetectEntitiesV2Response#entities #entities} => Array<Types::Entity>
|
455
|
+
# * {Types::DetectEntitiesV2Response#unmapped_attributes #unmapped_attributes} => Array<Types::UnmappedAttribute>
|
456
|
+
# * {Types::DetectEntitiesV2Response#pagination_token #pagination_token} => String
|
457
|
+
# * {Types::DetectEntitiesV2Response#model_version #model_version} => String
|
458
|
+
#
|
459
|
+
# @example Request syntax with placeholder values
|
460
|
+
#
|
461
|
+
# resp = client.detect_entities_v2({
|
462
|
+
# text: "BoundedLengthString", # required
|
463
|
+
# })
|
464
|
+
#
|
465
|
+
# @example Response structure
|
466
|
+
#
|
467
|
+
# resp.entities #=> Array
|
468
|
+
# resp.entities[0].id #=> Integer
|
469
|
+
# resp.entities[0].begin_offset #=> Integer
|
470
|
+
# resp.entities[0].end_offset #=> Integer
|
471
|
+
# resp.entities[0].score #=> Float
|
472
|
+
# resp.entities[0].text #=> String
|
473
|
+
# resp.entities[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY"
|
474
|
+
# 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"
|
475
|
+
# resp.entities[0].traits #=> Array
|
476
|
+
# resp.entities[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
|
477
|
+
# resp.entities[0].traits[0].score #=> Float
|
478
|
+
# resp.entities[0].attributes #=> Array
|
479
|
+
# 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"
|
480
|
+
# resp.entities[0].attributes[0].score #=> Float
|
481
|
+
# resp.entities[0].attributes[0].relationship_score #=> Float
|
482
|
+
# resp.entities[0].attributes[0].id #=> Integer
|
483
|
+
# resp.entities[0].attributes[0].begin_offset #=> Integer
|
484
|
+
# resp.entities[0].attributes[0].end_offset #=> Integer
|
485
|
+
# resp.entities[0].attributes[0].text #=> String
|
486
|
+
# resp.entities[0].attributes[0].traits #=> Array
|
487
|
+
# resp.entities[0].attributes[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
|
488
|
+
# resp.entities[0].attributes[0].traits[0].score #=> Float
|
489
|
+
# resp.unmapped_attributes #=> Array
|
490
|
+
# resp.unmapped_attributes[0].type #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY"
|
491
|
+
# 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"
|
492
|
+
# resp.unmapped_attributes[0].attribute.score #=> Float
|
493
|
+
# resp.unmapped_attributes[0].attribute.relationship_score #=> Float
|
494
|
+
# resp.unmapped_attributes[0].attribute.id #=> Integer
|
495
|
+
# resp.unmapped_attributes[0].attribute.begin_offset #=> Integer
|
496
|
+
# resp.unmapped_attributes[0].attribute.end_offset #=> Integer
|
497
|
+
# resp.unmapped_attributes[0].attribute.text #=> String
|
498
|
+
# resp.unmapped_attributes[0].attribute.traits #=> Array
|
499
|
+
# resp.unmapped_attributes[0].attribute.traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
|
500
|
+
# resp.unmapped_attributes[0].attribute.traits[0].score #=> Float
|
501
|
+
# resp.pagination_token #=> String
|
502
|
+
# resp.model_version #=> String
|
503
|
+
#
|
504
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectEntitiesV2 AWS API Documentation
|
505
|
+
#
|
506
|
+
# @overload detect_entities_v2(params = {})
|
507
|
+
# @param [Hash] params ({})
|
508
|
+
def detect_entities_v2(params = {}, options = {})
|
509
|
+
req = build_request(:detect_entities_v2, params)
|
510
|
+
req.send_request(options)
|
511
|
+
end
|
512
|
+
|
513
|
+
# Inspects the clinical text for protected health information (PHI)
|
332
514
|
# entities and entity category, location, and confidence score on that
|
333
515
|
# information.
|
334
516
|
#
|
@@ -341,6 +523,7 @@ module Aws::ComprehendMedical
|
|
341
523
|
#
|
342
524
|
# * {Types::DetectPHIResponse#entities #entities} => Array<Types::Entity>
|
343
525
|
# * {Types::DetectPHIResponse#pagination_token #pagination_token} => String
|
526
|
+
# * {Types::DetectPHIResponse#model_version #model_version} => String
|
344
527
|
#
|
345
528
|
# @example Request syntax with placeholder values
|
346
529
|
#
|
@@ -373,6 +556,7 @@ module Aws::ComprehendMedical
|
|
373
556
|
# resp.entities[0].attributes[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
|
374
557
|
# resp.entities[0].attributes[0].traits[0].score #=> Float
|
375
558
|
# resp.pagination_token #=> String
|
559
|
+
# resp.model_version #=> String
|
376
560
|
#
|
377
561
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectPHI AWS API Documentation
|
378
562
|
#
|
@@ -383,6 +567,333 @@ module Aws::ComprehendMedical
|
|
383
567
|
req.send_request(options)
|
384
568
|
end
|
385
569
|
|
570
|
+
# Gets a list of medical entity detection jobs that you have submitted.
|
571
|
+
#
|
572
|
+
# @option params [Types::ComprehendMedicalAsyncJobFilter] :filter
|
573
|
+
# Filters the jobs that are returned. You can filter jobs based on their
|
574
|
+
# names, status, or the date and time that they were submitted. You can
|
575
|
+
# only set one filter at a time.
|
576
|
+
#
|
577
|
+
# @option params [String] :next_token
|
578
|
+
# Identifies the next page of results to return.
|
579
|
+
#
|
580
|
+
# @option params [Integer] :max_results
|
581
|
+
# The maximum number of results to return in each page. The default is
|
582
|
+
# 100.
|
583
|
+
#
|
584
|
+
# @return [Types::ListEntitiesDetectionV2JobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
585
|
+
#
|
586
|
+
# * {Types::ListEntitiesDetectionV2JobsResponse#comprehend_medical_async_job_properties_list #comprehend_medical_async_job_properties_list} => Array<Types::ComprehendMedicalAsyncJobProperties>
|
587
|
+
# * {Types::ListEntitiesDetectionV2JobsResponse#next_token #next_token} => String
|
588
|
+
#
|
589
|
+
# @example Request syntax with placeholder values
|
590
|
+
#
|
591
|
+
# resp = client.list_entities_detection_v2_jobs({
|
592
|
+
# filter: {
|
593
|
+
# job_name: "JobName",
|
594
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
|
595
|
+
# submit_time_before: Time.now,
|
596
|
+
# submit_time_after: Time.now,
|
597
|
+
# },
|
598
|
+
# next_token: "String",
|
599
|
+
# max_results: 1,
|
600
|
+
# })
|
601
|
+
#
|
602
|
+
# @example Response structure
|
603
|
+
#
|
604
|
+
# resp.comprehend_medical_async_job_properties_list #=> Array
|
605
|
+
# resp.comprehend_medical_async_job_properties_list[0].job_id #=> String
|
606
|
+
# resp.comprehend_medical_async_job_properties_list[0].job_name #=> String
|
607
|
+
# resp.comprehend_medical_async_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
|
608
|
+
# resp.comprehend_medical_async_job_properties_list[0].message #=> String
|
609
|
+
# resp.comprehend_medical_async_job_properties_list[0].submit_time #=> Time
|
610
|
+
# resp.comprehend_medical_async_job_properties_list[0].end_time #=> Time
|
611
|
+
# resp.comprehend_medical_async_job_properties_list[0].expiration_time #=> Time
|
612
|
+
# resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_bucket #=> String
|
613
|
+
# resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_key #=> String
|
614
|
+
# resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_bucket #=> String
|
615
|
+
# resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_key #=> String
|
616
|
+
# resp.comprehend_medical_async_job_properties_list[0].language_code #=> String, one of "en"
|
617
|
+
# resp.comprehend_medical_async_job_properties_list[0].data_access_role_arn #=> String
|
618
|
+
# resp.comprehend_medical_async_job_properties_list[0].manifest_file_path #=> String
|
619
|
+
# resp.comprehend_medical_async_job_properties_list[0].kms_key #=> String
|
620
|
+
# resp.comprehend_medical_async_job_properties_list[0].model_version #=> String
|
621
|
+
# resp.next_token #=> String
|
622
|
+
#
|
623
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListEntitiesDetectionV2Jobs AWS API Documentation
|
624
|
+
#
|
625
|
+
# @overload list_entities_detection_v2_jobs(params = {})
|
626
|
+
# @param [Hash] params ({})
|
627
|
+
def list_entities_detection_v2_jobs(params = {}, options = {})
|
628
|
+
req = build_request(:list_entities_detection_v2_jobs, params)
|
629
|
+
req.send_request(options)
|
630
|
+
end
|
631
|
+
|
632
|
+
# Gets a list of protected health information (PHI) detection jobs that
|
633
|
+
# you have submitted.
|
634
|
+
#
|
635
|
+
# @option params [Types::ComprehendMedicalAsyncJobFilter] :filter
|
636
|
+
# Filters the jobs that are returned. You can filter jobs based on their
|
637
|
+
# names, status, or the date and time that they were submitted. You can
|
638
|
+
# only set one filter at a time.
|
639
|
+
#
|
640
|
+
# @option params [String] :next_token
|
641
|
+
# Identifies the next page of results to return.
|
642
|
+
#
|
643
|
+
# @option params [Integer] :max_results
|
644
|
+
# The maximum number of results to return in each page. The default is
|
645
|
+
# 100.
|
646
|
+
#
|
647
|
+
# @return [Types::ListPHIDetectionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
648
|
+
#
|
649
|
+
# * {Types::ListPHIDetectionJobsResponse#comprehend_medical_async_job_properties_list #comprehend_medical_async_job_properties_list} => Array<Types::ComprehendMedicalAsyncJobProperties>
|
650
|
+
# * {Types::ListPHIDetectionJobsResponse#next_token #next_token} => String
|
651
|
+
#
|
652
|
+
# @example Request syntax with placeholder values
|
653
|
+
#
|
654
|
+
# resp = client.list_phi_detection_jobs({
|
655
|
+
# filter: {
|
656
|
+
# job_name: "JobName",
|
657
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
|
658
|
+
# submit_time_before: Time.now,
|
659
|
+
# submit_time_after: Time.now,
|
660
|
+
# },
|
661
|
+
# next_token: "String",
|
662
|
+
# max_results: 1,
|
663
|
+
# })
|
664
|
+
#
|
665
|
+
# @example Response structure
|
666
|
+
#
|
667
|
+
# resp.comprehend_medical_async_job_properties_list #=> Array
|
668
|
+
# resp.comprehend_medical_async_job_properties_list[0].job_id #=> String
|
669
|
+
# resp.comprehend_medical_async_job_properties_list[0].job_name #=> String
|
670
|
+
# resp.comprehend_medical_async_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
|
671
|
+
# resp.comprehend_medical_async_job_properties_list[0].message #=> String
|
672
|
+
# resp.comprehend_medical_async_job_properties_list[0].submit_time #=> Time
|
673
|
+
# resp.comprehend_medical_async_job_properties_list[0].end_time #=> Time
|
674
|
+
# resp.comprehend_medical_async_job_properties_list[0].expiration_time #=> Time
|
675
|
+
# resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_bucket #=> String
|
676
|
+
# resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_key #=> String
|
677
|
+
# resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_bucket #=> String
|
678
|
+
# resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_key #=> String
|
679
|
+
# resp.comprehend_medical_async_job_properties_list[0].language_code #=> String, one of "en"
|
680
|
+
# resp.comprehend_medical_async_job_properties_list[0].data_access_role_arn #=> String
|
681
|
+
# resp.comprehend_medical_async_job_properties_list[0].manifest_file_path #=> String
|
682
|
+
# resp.comprehend_medical_async_job_properties_list[0].kms_key #=> String
|
683
|
+
# resp.comprehend_medical_async_job_properties_list[0].model_version #=> String
|
684
|
+
# resp.next_token #=> String
|
685
|
+
#
|
686
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListPHIDetectionJobs AWS API Documentation
|
687
|
+
#
|
688
|
+
# @overload list_phi_detection_jobs(params = {})
|
689
|
+
# @param [Hash] params ({})
|
690
|
+
def list_phi_detection_jobs(params = {}, options = {})
|
691
|
+
req = build_request(:list_phi_detection_jobs, params)
|
692
|
+
req.send_request(options)
|
693
|
+
end
|
694
|
+
|
695
|
+
# Starts an asynchronous medical entity detection job for a collection
|
696
|
+
# of documents. Use the `DescribeEntitiesDetectionV2Job` operation to
|
697
|
+
# track the status of a job.
|
698
|
+
#
|
699
|
+
# @option params [required, Types::InputDataConfig] :input_data_config
|
700
|
+
# Specifies the format and location of the input data for the job.
|
701
|
+
#
|
702
|
+
# @option params [required, Types::OutputDataConfig] :output_data_config
|
703
|
+
# Specifies where to send the output files.
|
704
|
+
#
|
705
|
+
# @option params [required, String] :data_access_role_arn
|
706
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
707
|
+
# Management (IAM) role that grants Amazon Comprehend Medical read
|
708
|
+
# access to your input data. For more information, see [ Role-Based
|
709
|
+
# Permissions Required for Asynchronous Operations][1].
|
710
|
+
#
|
711
|
+
#
|
712
|
+
#
|
713
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med
|
714
|
+
#
|
715
|
+
# @option params [String] :job_name
|
716
|
+
# The identifier of the job.
|
717
|
+
#
|
718
|
+
# @option params [String] :client_request_token
|
719
|
+
# A unique identifier for the request. If you don't set the client
|
720
|
+
# request token, Amazon Comprehend Medical generates one.
|
721
|
+
#
|
722
|
+
# **A suitable default value is auto-generated.** You should normally
|
723
|
+
# not need to pass this option.**
|
724
|
+
#
|
725
|
+
# @option params [String] :kms_key
|
726
|
+
# An AWS Key Management Service key to encrypt your output files. If you
|
727
|
+
# do not specify a key, the files are written in plain text.
|
728
|
+
#
|
729
|
+
# @option params [required, String] :language_code
|
730
|
+
# The language of the input documents. All documents must be in the same
|
731
|
+
# language.
|
732
|
+
#
|
733
|
+
# @return [Types::StartEntitiesDetectionV2JobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
734
|
+
#
|
735
|
+
# * {Types::StartEntitiesDetectionV2JobResponse#job_id #job_id} => String
|
736
|
+
#
|
737
|
+
# @example Request syntax with placeholder values
|
738
|
+
#
|
739
|
+
# resp = client.start_entities_detection_v2_job({
|
740
|
+
# input_data_config: { # required
|
741
|
+
# s3_bucket: "S3Bucket", # required
|
742
|
+
# s3_key: "S3Key",
|
743
|
+
# },
|
744
|
+
# output_data_config: { # required
|
745
|
+
# s3_bucket: "S3Bucket", # required
|
746
|
+
# s3_key: "S3Key",
|
747
|
+
# },
|
748
|
+
# data_access_role_arn: "IamRoleArn", # required
|
749
|
+
# job_name: "JobName",
|
750
|
+
# client_request_token: "ClientRequestTokenString",
|
751
|
+
# kms_key: "KMSKey",
|
752
|
+
# language_code: "en", # required, accepts en
|
753
|
+
# })
|
754
|
+
#
|
755
|
+
# @example Response structure
|
756
|
+
#
|
757
|
+
# resp.job_id #=> String
|
758
|
+
#
|
759
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartEntitiesDetectionV2Job AWS API Documentation
|
760
|
+
#
|
761
|
+
# @overload start_entities_detection_v2_job(params = {})
|
762
|
+
# @param [Hash] params ({})
|
763
|
+
def start_entities_detection_v2_job(params = {}, options = {})
|
764
|
+
req = build_request(:start_entities_detection_v2_job, params)
|
765
|
+
req.send_request(options)
|
766
|
+
end
|
767
|
+
|
768
|
+
# Starts an asynchronous job to detect protected health information
|
769
|
+
# (PHI). Use the `DescribePHIDetectionJob` operation to track the status
|
770
|
+
# of a job.
|
771
|
+
#
|
772
|
+
# @option params [required, Types::InputDataConfig] :input_data_config
|
773
|
+
# Specifies the format and location of the input data for the job.
|
774
|
+
#
|
775
|
+
# @option params [required, Types::OutputDataConfig] :output_data_config
|
776
|
+
# Specifies where to send the output files.
|
777
|
+
#
|
778
|
+
# @option params [required, String] :data_access_role_arn
|
779
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
780
|
+
# Management (IAM) role that grants Amazon Comprehend Medical read
|
781
|
+
# access to your input data. For more information, see [ Role-Based
|
782
|
+
# Permissions Required for Asynchronous Operations][1].
|
783
|
+
#
|
784
|
+
#
|
785
|
+
#
|
786
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med
|
787
|
+
#
|
788
|
+
# @option params [String] :job_name
|
789
|
+
# The identifier of the job.
|
790
|
+
#
|
791
|
+
# @option params [String] :client_request_token
|
792
|
+
# A unique identifier for the request. If you don't set the client
|
793
|
+
# request token, Amazon Comprehend Medical generates one.
|
794
|
+
#
|
795
|
+
# **A suitable default value is auto-generated.** You should normally
|
796
|
+
# not need to pass this option.**
|
797
|
+
#
|
798
|
+
# @option params [String] :kms_key
|
799
|
+
# An AWS Key Management Service key to encrypt your output files. If you
|
800
|
+
# do not specify a key, the files are written in plain text.
|
801
|
+
#
|
802
|
+
# @option params [required, String] :language_code
|
803
|
+
# The language of the input documents. All documents must be in the same
|
804
|
+
# language.
|
805
|
+
#
|
806
|
+
# @return [Types::StartPHIDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
807
|
+
#
|
808
|
+
# * {Types::StartPHIDetectionJobResponse#job_id #job_id} => String
|
809
|
+
#
|
810
|
+
# @example Request syntax with placeholder values
|
811
|
+
#
|
812
|
+
# resp = client.start_phi_detection_job({
|
813
|
+
# input_data_config: { # required
|
814
|
+
# s3_bucket: "S3Bucket", # required
|
815
|
+
# s3_key: "S3Key",
|
816
|
+
# },
|
817
|
+
# output_data_config: { # required
|
818
|
+
# s3_bucket: "S3Bucket", # required
|
819
|
+
# s3_key: "S3Key",
|
820
|
+
# },
|
821
|
+
# data_access_role_arn: "IamRoleArn", # required
|
822
|
+
# job_name: "JobName",
|
823
|
+
# client_request_token: "ClientRequestTokenString",
|
824
|
+
# kms_key: "KMSKey",
|
825
|
+
# language_code: "en", # required, accepts en
|
826
|
+
# })
|
827
|
+
#
|
828
|
+
# @example Response structure
|
829
|
+
#
|
830
|
+
# resp.job_id #=> String
|
831
|
+
#
|
832
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartPHIDetectionJob AWS API Documentation
|
833
|
+
#
|
834
|
+
# @overload start_phi_detection_job(params = {})
|
835
|
+
# @param [Hash] params ({})
|
836
|
+
def start_phi_detection_job(params = {}, options = {})
|
837
|
+
req = build_request(:start_phi_detection_job, params)
|
838
|
+
req.send_request(options)
|
839
|
+
end
|
840
|
+
|
841
|
+
# Stops a medical entities detection job in progress.
|
842
|
+
#
|
843
|
+
# @option params [required, String] :job_id
|
844
|
+
# The identifier of the medical entities job to stop.
|
845
|
+
#
|
846
|
+
# @return [Types::StopEntitiesDetectionV2JobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
847
|
+
#
|
848
|
+
# * {Types::StopEntitiesDetectionV2JobResponse#job_id #job_id} => String
|
849
|
+
#
|
850
|
+
# @example Request syntax with placeholder values
|
851
|
+
#
|
852
|
+
# resp = client.stop_entities_detection_v2_job({
|
853
|
+
# job_id: "JobId", # required
|
854
|
+
# })
|
855
|
+
#
|
856
|
+
# @example Response structure
|
857
|
+
#
|
858
|
+
# resp.job_id #=> String
|
859
|
+
#
|
860
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopEntitiesDetectionV2Job AWS API Documentation
|
861
|
+
#
|
862
|
+
# @overload stop_entities_detection_v2_job(params = {})
|
863
|
+
# @param [Hash] params ({})
|
864
|
+
def stop_entities_detection_v2_job(params = {}, options = {})
|
865
|
+
req = build_request(:stop_entities_detection_v2_job, params)
|
866
|
+
req.send_request(options)
|
867
|
+
end
|
868
|
+
|
869
|
+
# Stops a protected health information (PHI) detection job in progress.
|
870
|
+
#
|
871
|
+
# @option params [required, String] :job_id
|
872
|
+
# The identifier of the PHI detection job to stop.
|
873
|
+
#
|
874
|
+
# @return [Types::StopPHIDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
875
|
+
#
|
876
|
+
# * {Types::StopPHIDetectionJobResponse#job_id #job_id} => String
|
877
|
+
#
|
878
|
+
# @example Request syntax with placeholder values
|
879
|
+
#
|
880
|
+
# resp = client.stop_phi_detection_job({
|
881
|
+
# job_id: "JobId", # required
|
882
|
+
# })
|
883
|
+
#
|
884
|
+
# @example Response structure
|
885
|
+
#
|
886
|
+
# resp.job_id #=> String
|
887
|
+
#
|
888
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopPHIDetectionJob AWS API Documentation
|
889
|
+
#
|
890
|
+
# @overload stop_phi_detection_job(params = {})
|
891
|
+
# @param [Hash] params ({})
|
892
|
+
def stop_phi_detection_job(params = {}, options = {})
|
893
|
+
req = build_request(:stop_phi_detection_job, params)
|
894
|
+
req.send_request(options)
|
895
|
+
end
|
896
|
+
|
386
897
|
# @!endgroup
|
387
898
|
|
388
899
|
# @param params ({})
|
@@ -396,7 +907,7 @@ module Aws::ComprehendMedical
|
|
396
907
|
params: params,
|
397
908
|
config: config)
|
398
909
|
context[:gem_name] = 'aws-sdk-comprehendmedical'
|
399
|
-
context[:gem_version] = '1.
|
910
|
+
context[:gem_version] = '1.11.0'
|
400
911
|
Seahorse::Client::Request.new(handlers, context)
|
401
912
|
end
|
402
913
|
|