aws-sdk-comprehendmedical 1.14.0 → 1.15.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.
@@ -246,6 +246,38 @@ module Aws::ComprehendMedical
246
246
  include Aws::Structure
247
247
  end
248
248
 
249
+ # @note When making an API call, you may pass DescribeICD10CMInferenceJobRequest
250
+ # data as a hash:
251
+ #
252
+ # {
253
+ # job_id: "JobId", # required
254
+ # }
255
+ #
256
+ # @!attribute [rw] job_id
257
+ # The identifier that Amazon Comprehend Medical generated for the job.
258
+ # `The StartICD10CMInferenceJob` operation returns this identifier in
259
+ # its response.
260
+ # @return [String]
261
+ #
262
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeICD10CMInferenceJobRequest AWS API Documentation
263
+ #
264
+ class DescribeICD10CMInferenceJobRequest < Struct.new(
265
+ :job_id)
266
+ include Aws::Structure
267
+ end
268
+
269
+ # @!attribute [rw] comprehend_medical_async_job_properties
270
+ # An object that contains the properties associated with a detection
271
+ # job.
272
+ # @return [Types::ComprehendMedicalAsyncJobProperties]
273
+ #
274
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeICD10CMInferenceJobResponse AWS API Documentation
275
+ #
276
+ class DescribeICD10CMInferenceJobResponse < Struct.new(
277
+ :comprehend_medical_async_job_properties)
278
+ include Aws::Structure
279
+ end
280
+
249
281
  # @note When making an API call, you may pass DescribePHIDetectionJobRequest
250
282
  # data as a hash:
251
283
  #
@@ -278,6 +310,38 @@ module Aws::ComprehendMedical
278
310
  include Aws::Structure
279
311
  end
280
312
 
313
+ # @note When making an API call, you may pass DescribeRxNormInferenceJobRequest
314
+ # data as a hash:
315
+ #
316
+ # {
317
+ # job_id: "JobId", # required
318
+ # }
319
+ #
320
+ # @!attribute [rw] job_id
321
+ # The identifier that Amazon Comprehend Medical generated for the job.
322
+ # The StartRxNormInferenceJob operation returns this identifier in its
323
+ # response.
324
+ # @return [String]
325
+ #
326
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeRxNormInferenceJobRequest AWS API Documentation
327
+ #
328
+ class DescribeRxNormInferenceJobRequest < Struct.new(
329
+ :job_id)
330
+ include Aws::Structure
331
+ end
332
+
333
+ # @!attribute [rw] comprehend_medical_async_job_properties
334
+ # An object that contains the properties associated with a detection
335
+ # job.
336
+ # @return [Types::ComprehendMedicalAsyncJobProperties]
337
+ #
338
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeRxNormInferenceJobResponse AWS API Documentation
339
+ #
340
+ class DescribeRxNormInferenceJobResponse < Struct.new(
341
+ :comprehend_medical_async_job_properties)
342
+ include Aws::Structure
343
+ end
344
+
281
345
  # @note When making an API call, you may pass DetectEntitiesRequest
282
346
  # data as a hash:
283
347
  #
@@ -771,7 +835,9 @@ module Aws::ComprehendMedical
771
835
  include Aws::Structure
772
836
  end
773
837
 
774
- # The input properties for an entities detection job.
838
+ # The input properties for an entities detection job. This includes the
839
+ # name of the S3 bucket and the path to the files to be analyzed. See
840
+ # batch-manifest for more information.
775
841
  #
776
842
  # @note When making an API call, you may pass InputDataConfig
777
843
  # data as a hash:
@@ -893,6 +959,60 @@ module Aws::ComprehendMedical
893
959
  include Aws::Structure
894
960
  end
895
961
 
962
+ # @note When making an API call, you may pass ListICD10CMInferenceJobsRequest
963
+ # data as a hash:
964
+ #
965
+ # {
966
+ # filter: {
967
+ # job_name: "JobName",
968
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
969
+ # submit_time_before: Time.now,
970
+ # submit_time_after: Time.now,
971
+ # },
972
+ # next_token: "String",
973
+ # max_results: 1,
974
+ # }
975
+ #
976
+ # @!attribute [rw] filter
977
+ # Filters the jobs that are returned. You can filter jobs based on
978
+ # their names, status, or the date and time that they were submitted.
979
+ # You can only set one filter at a time.
980
+ # @return [Types::ComprehendMedicalAsyncJobFilter]
981
+ #
982
+ # @!attribute [rw] next_token
983
+ # Identifies the next page of results to return.
984
+ # @return [String]
985
+ #
986
+ # @!attribute [rw] max_results
987
+ # The maximum number of results to return in each page. The default is
988
+ # 100.
989
+ # @return [Integer]
990
+ #
991
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListICD10CMInferenceJobsRequest AWS API Documentation
992
+ #
993
+ class ListICD10CMInferenceJobsRequest < Struct.new(
994
+ :filter,
995
+ :next_token,
996
+ :max_results)
997
+ include Aws::Structure
998
+ end
999
+
1000
+ # @!attribute [rw] comprehend_medical_async_job_properties_list
1001
+ # A list containing the properties of each job that is returned.
1002
+ # @return [Array<Types::ComprehendMedicalAsyncJobProperties>]
1003
+ #
1004
+ # @!attribute [rw] next_token
1005
+ # Identifies the next page of results to return.
1006
+ # @return [String]
1007
+ #
1008
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListICD10CMInferenceJobsResponse AWS API Documentation
1009
+ #
1010
+ class ListICD10CMInferenceJobsResponse < Struct.new(
1011
+ :comprehend_medical_async_job_properties_list,
1012
+ :next_token)
1013
+ include Aws::Structure
1014
+ end
1015
+
896
1016
  # @note When making an API call, you may pass ListPHIDetectionJobsRequest
897
1017
  # data as a hash:
898
1018
  #
@@ -947,6 +1067,60 @@ module Aws::ComprehendMedical
947
1067
  include Aws::Structure
948
1068
  end
949
1069
 
1070
+ # @note When making an API call, you may pass ListRxNormInferenceJobsRequest
1071
+ # data as a hash:
1072
+ #
1073
+ # {
1074
+ # filter: {
1075
+ # job_name: "JobName",
1076
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
1077
+ # submit_time_before: Time.now,
1078
+ # submit_time_after: Time.now,
1079
+ # },
1080
+ # next_token: "String",
1081
+ # max_results: 1,
1082
+ # }
1083
+ #
1084
+ # @!attribute [rw] filter
1085
+ # Filters the jobs that are returned. You can filter jobs based on
1086
+ # their names, status, or the date and time that they were submitted.
1087
+ # You can only set one filter at a time.
1088
+ # @return [Types::ComprehendMedicalAsyncJobFilter]
1089
+ #
1090
+ # @!attribute [rw] next_token
1091
+ # Identifies the next page of results to return.
1092
+ # @return [String]
1093
+ #
1094
+ # @!attribute [rw] max_results
1095
+ # Identifies the next page of results to return.
1096
+ # @return [Integer]
1097
+ #
1098
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListRxNormInferenceJobsRequest AWS API Documentation
1099
+ #
1100
+ class ListRxNormInferenceJobsRequest < Struct.new(
1101
+ :filter,
1102
+ :next_token,
1103
+ :max_results)
1104
+ include Aws::Structure
1105
+ end
1106
+
1107
+ # @!attribute [rw] comprehend_medical_async_job_properties_list
1108
+ # The maximum number of results to return in each page. The default is
1109
+ # 100.
1110
+ # @return [Array<Types::ComprehendMedicalAsyncJobProperties>]
1111
+ #
1112
+ # @!attribute [rw] next_token
1113
+ # Identifies the next page of results to return.
1114
+ # @return [String]
1115
+ #
1116
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListRxNormInferenceJobsResponse AWS API Documentation
1117
+ #
1118
+ class ListRxNormInferenceJobsResponse < Struct.new(
1119
+ :comprehend_medical_async_job_properties_list,
1120
+ :next_token)
1121
+ include Aws::Structure
1122
+ end
1123
+
950
1124
  # The output properties for a detection job.
951
1125
  #
952
1126
  # @note When making an API call, you may pass OutputDataConfig
@@ -1275,6 +1449,91 @@ module Aws::ComprehendMedical
1275
1449
  include Aws::Structure
1276
1450
  end
1277
1451
 
1452
+ # @note When making an API call, you may pass StartICD10CMInferenceJobRequest
1453
+ # data as a hash:
1454
+ #
1455
+ # {
1456
+ # input_data_config: { # required
1457
+ # s3_bucket: "S3Bucket", # required
1458
+ # s3_key: "S3Key",
1459
+ # },
1460
+ # output_data_config: { # required
1461
+ # s3_bucket: "S3Bucket", # required
1462
+ # s3_key: "S3Key",
1463
+ # },
1464
+ # data_access_role_arn: "IamRoleArn", # required
1465
+ # job_name: "JobName",
1466
+ # client_request_token: "ClientRequestTokenString",
1467
+ # kms_key: "KMSKey",
1468
+ # language_code: "en", # required, accepts en
1469
+ # }
1470
+ #
1471
+ # @!attribute [rw] input_data_config
1472
+ # Specifies the format and location of the input data for the job.
1473
+ # @return [Types::InputDataConfig]
1474
+ #
1475
+ # @!attribute [rw] output_data_config
1476
+ # Specifies where to send the output files.
1477
+ # @return [Types::OutputDataConfig]
1478
+ #
1479
+ # @!attribute [rw] data_access_role_arn
1480
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
1481
+ # Management (IAM) role that grants Amazon Comprehend Medical read
1482
+ # access to your input data. For more information, see [ Role-Based
1483
+ # Permissions Required for Asynchronous Operations][1].
1484
+ #
1485
+ #
1486
+ #
1487
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med
1488
+ # @return [String]
1489
+ #
1490
+ # @!attribute [rw] job_name
1491
+ # The identifier of the job.
1492
+ # @return [String]
1493
+ #
1494
+ # @!attribute [rw] client_request_token
1495
+ # A unique identifier for the request. If you don't set the client
1496
+ # request token, Amazon Comprehend Medical generates one.
1497
+ #
1498
+ # **A suitable default value is auto-generated.** You should normally
1499
+ # not need to pass this option.
1500
+ # @return [String]
1501
+ #
1502
+ # @!attribute [rw] kms_key
1503
+ # An AWS Key Management Service key to encrypt your output files. If
1504
+ # you do not specify a key, the files are written in plain text.
1505
+ # @return [String]
1506
+ #
1507
+ # @!attribute [rw] language_code
1508
+ # The language of the input documents. All documents must be in the
1509
+ # same language.
1510
+ # @return [String]
1511
+ #
1512
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartICD10CMInferenceJobRequest AWS API Documentation
1513
+ #
1514
+ class StartICD10CMInferenceJobRequest < Struct.new(
1515
+ :input_data_config,
1516
+ :output_data_config,
1517
+ :data_access_role_arn,
1518
+ :job_name,
1519
+ :client_request_token,
1520
+ :kms_key,
1521
+ :language_code)
1522
+ include Aws::Structure
1523
+ end
1524
+
1525
+ # @!attribute [rw] job_id
1526
+ # The identifier generated for the job. To get the status of a job,
1527
+ # use this identifier with the `StartICD10CMInferenceJob` operation.
1528
+ # @return [String]
1529
+ #
1530
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartICD10CMInferenceJobResponse AWS API Documentation
1531
+ #
1532
+ class StartICD10CMInferenceJobResponse < Struct.new(
1533
+ :job_id)
1534
+ include Aws::Structure
1535
+ end
1536
+
1278
1537
  # @note When making an API call, you may pass StartPHIDetectionJobRequest
1279
1538
  # data as a hash:
1280
1539
  #
@@ -1360,6 +1619,90 @@ module Aws::ComprehendMedical
1360
1619
  include Aws::Structure
1361
1620
  end
1362
1621
 
1622
+ # @note When making an API call, you may pass StartRxNormInferenceJobRequest
1623
+ # data as a hash:
1624
+ #
1625
+ # {
1626
+ # input_data_config: { # required
1627
+ # s3_bucket: "S3Bucket", # required
1628
+ # s3_key: "S3Key",
1629
+ # },
1630
+ # output_data_config: { # required
1631
+ # s3_bucket: "S3Bucket", # required
1632
+ # s3_key: "S3Key",
1633
+ # },
1634
+ # data_access_role_arn: "IamRoleArn", # required
1635
+ # job_name: "JobName",
1636
+ # client_request_token: "ClientRequestTokenString",
1637
+ # kms_key: "KMSKey",
1638
+ # language_code: "en", # required, accepts en
1639
+ # }
1640
+ #
1641
+ # @!attribute [rw] input_data_config
1642
+ # Specifies the format and location of the input data for the job.
1643
+ # @return [Types::InputDataConfig]
1644
+ #
1645
+ # @!attribute [rw] output_data_config
1646
+ # Specifies where to send the output files.
1647
+ # @return [Types::OutputDataConfig]
1648
+ #
1649
+ # @!attribute [rw] data_access_role_arn
1650
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
1651
+ # Management (IAM) role that grants Amazon Comprehend Medical read
1652
+ # access to your input data. For more information, see [ Role-Based
1653
+ # Permissions Required for Asynchronous Operations][1].
1654
+ #
1655
+ #
1656
+ #
1657
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med
1658
+ # @return [String]
1659
+ #
1660
+ # @!attribute [rw] job_name
1661
+ # The identifier of the job.
1662
+ # @return [String]
1663
+ #
1664
+ # @!attribute [rw] client_request_token
1665
+ # A unique identifier for the request. If you don't set the client
1666
+ # request token, Amazon Comprehend Medical generates one.
1667
+ #
1668
+ # **A suitable default value is auto-generated.** You should normally
1669
+ # not need to pass this option.
1670
+ # @return [String]
1671
+ #
1672
+ # @!attribute [rw] kms_key
1673
+ # An AWS Key Management Service key to encrypt your output files. If
1674
+ # you do not specify a key, the files are written in plain text.
1675
+ # @return [String]
1676
+ #
1677
+ # @!attribute [rw] language_code
1678
+ # The language of the input documents. All documents must be in the
1679
+ # same language.
1680
+ # @return [String]
1681
+ #
1682
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartRxNormInferenceJobRequest AWS API Documentation
1683
+ #
1684
+ class StartRxNormInferenceJobRequest < Struct.new(
1685
+ :input_data_config,
1686
+ :output_data_config,
1687
+ :data_access_role_arn,
1688
+ :job_name,
1689
+ :client_request_token,
1690
+ :kms_key,
1691
+ :language_code)
1692
+ include Aws::Structure
1693
+ end
1694
+
1695
+ # @!attribute [rw] job_id
1696
+ # The identifier of the job.
1697
+ # @return [String]
1698
+ #
1699
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartRxNormInferenceJobResponse AWS API Documentation
1700
+ #
1701
+ class StartRxNormInferenceJobResponse < Struct.new(
1702
+ :job_id)
1703
+ include Aws::Structure
1704
+ end
1705
+
1363
1706
  # @note When making an API call, you may pass StopEntitiesDetectionV2JobRequest
1364
1707
  # data as a hash:
1365
1708
  #
@@ -1390,6 +1733,36 @@ module Aws::ComprehendMedical
1390
1733
  include Aws::Structure
1391
1734
  end
1392
1735
 
1736
+ # @note When making an API call, you may pass StopICD10CMInferenceJobRequest
1737
+ # data as a hash:
1738
+ #
1739
+ # {
1740
+ # job_id: "JobId", # required
1741
+ # }
1742
+ #
1743
+ # @!attribute [rw] job_id
1744
+ # The identifier of the job.
1745
+ # @return [String]
1746
+ #
1747
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopICD10CMInferenceJobRequest AWS API Documentation
1748
+ #
1749
+ class StopICD10CMInferenceJobRequest < Struct.new(
1750
+ :job_id)
1751
+ include Aws::Structure
1752
+ end
1753
+
1754
+ # @!attribute [rw] job_id
1755
+ # The identifier generated for the job. To get the status of job, use
1756
+ # this identifier with the `DescribeICD10CMInferenceJob` operation.
1757
+ # @return [String]
1758
+ #
1759
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopICD10CMInferenceJobResponse AWS API Documentation
1760
+ #
1761
+ class StopICD10CMInferenceJobResponse < Struct.new(
1762
+ :job_id)
1763
+ include Aws::Structure
1764
+ end
1765
+
1393
1766
  # @note When making an API call, you may pass StopPHIDetectionJobRequest
1394
1767
  # data as a hash:
1395
1768
  #
@@ -1419,6 +1792,36 @@ module Aws::ComprehendMedical
1419
1792
  include Aws::Structure
1420
1793
  end
1421
1794
 
1795
+ # @note When making an API call, you may pass StopRxNormInferenceJobRequest
1796
+ # data as a hash:
1797
+ #
1798
+ # {
1799
+ # job_id: "JobId", # required
1800
+ # }
1801
+ #
1802
+ # @!attribute [rw] job_id
1803
+ # The identifier of the job.
1804
+ # @return [String]
1805
+ #
1806
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopRxNormInferenceJobRequest AWS API Documentation
1807
+ #
1808
+ class StopRxNormInferenceJobRequest < Struct.new(
1809
+ :job_id)
1810
+ include Aws::Structure
1811
+ end
1812
+
1813
+ # @!attribute [rw] job_id
1814
+ # The identifier generated for the job. To get the status of job, use
1815
+ # this identifier with the `DescribeRxNormInferenceJob` operation.
1816
+ # @return [String]
1817
+ #
1818
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopRxNormInferenceJobResponse AWS API Documentation
1819
+ #
1820
+ class StopRxNormInferenceJobResponse < Struct.new(
1821
+ :job_id)
1822
+ include Aws::Structure
1823
+ end
1824
+
1422
1825
  # The size of the text you submitted exceeds the size limit. Reduce the
1423
1826
  # size of the text or use a smaller document and then retry your
1424
1827
  # request.
@@ -45,6 +45,6 @@ require_relative 'aws-sdk-comprehendmedical/customizations'
45
45
  # @service
46
46
  module Aws::ComprehendMedical
47
47
 
48
- GEM_VERSION = '1.14.0'
48
+ GEM_VERSION = '1.15.0'
49
49
 
50
50
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-comprehendmedical
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.14.0
4
+ version: 1.15.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-03-09 00:00:00.000000000 Z
11
+ date: 2020-05-06 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
81
81
  version: '0'
82
82
  requirements: []
83
83
  rubyforge_project:
84
- rubygems_version: 2.5.2.3
84
+ rubygems_version: 2.7.6.2
85
85
  signing_key:
86
86
  specification_version: 4
87
87
  summary: AWS SDK for Ruby - ComprehendMedical