aws-sdk-healthlake 1.0.0 → 1.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +28 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-healthlake.rb +2 -2
- data/lib/aws-sdk-healthlake/client.rb +398 -22
- data/lib/aws-sdk-healthlake/client_api.rb +229 -1
- data/lib/aws-sdk-healthlake/errors.rb +1 -1
- data/lib/aws-sdk-healthlake/resource.rb +1 -1
- data/lib/aws-sdk-healthlake/types.rb +670 -47
- metadata +11 -9
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 6f34135b671ab9899458965c12c804a6cb43d951e2d35ad2dda7f48aa9c5cfdb
|
4
|
+
data.tar.gz: 3bceee0b6d6846bdb81aca4740196122e1cf6264ab3d8c0ce9f8082126691c7a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: aa41716213b567ca9394ebfefbdff1cf83a5e8defc6b875f526cfb858815a55d2d3f182f8392f9f5dc3409e2c607253c66a7f8701fab550db9cb724d5ed45269
|
7
|
+
data.tar.gz: 30636167ce8ebd00ac29a5f6422d3f398b57e882e3021c7003f972535eb820b4028f0df429cba34c1f291959157ae67f7f480e2c1ae768b55513d53603478af7
|
data/CHANGELOG.md
ADDED
@@ -0,0 +1,28 @@
|
|
1
|
+
Unreleased Changes
|
2
|
+
------------------
|
3
|
+
|
4
|
+
1.4.0 (2021-07-14)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - General availability for Amazon HealthLake. StartFHIRImportJob and StartFHIRExportJob APIs now require AWS KMS parameter. For more information, see the Amazon HealthLake Documentation https://docs.aws.amazon.com/healthlake/index.html.
|
8
|
+
|
9
|
+
1.3.0 (2021-03-10)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.2.0 (2021-02-02)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.1.0 (2021-01-04)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Amazon HealthLake now supports exporting data from FHIR Data Stores in Preview.
|
23
|
+
|
24
|
+
1.0.0 (2020-12-08)
|
25
|
+
------------------
|
26
|
+
|
27
|
+
* Feature - Initial release of `aws-sdk-healthlake`.
|
28
|
+
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
1.4.0
|
data/lib/aws-sdk-healthlake.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-healthlake/customizations'
|
|
48
48
|
# @!group service
|
49
49
|
module Aws::HealthLake
|
50
50
|
|
51
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.4.0'
|
52
52
|
|
53
53
|
end
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -337,16 +337,20 @@ module Aws::HealthLake
|
|
337
337
|
|
338
338
|
# @!group API Operations
|
339
339
|
|
340
|
-
# Creates a
|
340
|
+
# Creates a Data Store that can ingest and export FHIR formatted data.
|
341
341
|
#
|
342
342
|
# @option params [String] :datastore_name
|
343
|
-
# The user generated name for the
|
343
|
+
# The user generated name for the Data Store.
|
344
344
|
#
|
345
345
|
# @option params [required, String] :datastore_type_version
|
346
|
-
# The FHIR version of the
|
346
|
+
# The FHIR version of the Data Store. The only supported version is R4.
|
347
|
+
#
|
348
|
+
# @option params [Types::SseConfiguration] :sse_configuration
|
349
|
+
# The server-side encryption key configuration for a customer provided
|
350
|
+
# encryption key specified for creating a Data Store.
|
347
351
|
#
|
348
352
|
# @option params [Types::PreloadDataConfig] :preload_data_config
|
349
|
-
# Optional parameter to preload data upon creation of the
|
353
|
+
# Optional parameter to preload data upon creation of the Data Store.
|
350
354
|
# Currently, the only supported preloaded data is synthetic data
|
351
355
|
# generated from Synthea.
|
352
356
|
#
|
@@ -356,6 +360,9 @@ module Aws::HealthLake
|
|
356
360
|
# **A suitable default value is auto-generated.** You should normally
|
357
361
|
# not need to pass this option.**
|
358
362
|
#
|
363
|
+
# @option params [Array<Types::Tag>] :tags
|
364
|
+
# Resource tags that are applied to a Data Store when it is created.
|
365
|
+
#
|
359
366
|
# @return [Types::CreateFHIRDatastoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
360
367
|
#
|
361
368
|
# * {Types::CreateFHIRDatastoreResponse#datastore_id #datastore_id} => String
|
@@ -368,10 +375,22 @@ module Aws::HealthLake
|
|
368
375
|
# resp = client.create_fhir_datastore({
|
369
376
|
# datastore_name: "DatastoreName",
|
370
377
|
# datastore_type_version: "R4", # required, accepts R4
|
378
|
+
# sse_configuration: {
|
379
|
+
# kms_encryption_config: { # required
|
380
|
+
# cmk_type: "CUSTOMER_MANAGED_KMS_KEY", # required, accepts CUSTOMER_MANAGED_KMS_KEY, AWS_OWNED_KMS_KEY
|
381
|
+
# kms_key_id: "EncryptionKeyID",
|
382
|
+
# },
|
383
|
+
# },
|
371
384
|
# preload_data_config: {
|
372
385
|
# preload_data_type: "SYNTHEA", # required, accepts SYNTHEA
|
373
386
|
# },
|
374
387
|
# client_token: "ClientTokenString",
|
388
|
+
# tags: [
|
389
|
+
# {
|
390
|
+
# key: "TagKey", # required
|
391
|
+
# value: "TagValue", # required
|
392
|
+
# },
|
393
|
+
# ],
|
375
394
|
# })
|
376
395
|
#
|
377
396
|
# @example Response structure
|
@@ -390,10 +409,10 @@ module Aws::HealthLake
|
|
390
409
|
req.send_request(options)
|
391
410
|
end
|
392
411
|
|
393
|
-
# Deletes a
|
412
|
+
# Deletes a Data Store.
|
394
413
|
#
|
395
414
|
# @option params [String] :datastore_id
|
396
|
-
# The AWS-generated ID for the
|
415
|
+
# The AWS-generated ID for the Data Store to be deleted.
|
397
416
|
#
|
398
417
|
# @return [Types::DeleteFHIRDatastoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
399
418
|
#
|
@@ -424,12 +443,12 @@ module Aws::HealthLake
|
|
424
443
|
req.send_request(options)
|
425
444
|
end
|
426
445
|
|
427
|
-
# Gets the properties associated with the FHIR
|
428
|
-
#
|
429
|
-
# at,
|
446
|
+
# Gets the properties associated with the FHIR Data Store, including the
|
447
|
+
# Data Store ID, Data Store ARN, Data Store name, Data Store status,
|
448
|
+
# created at, Data Store type version, and Data Store endpoint.
|
430
449
|
#
|
431
450
|
# @option params [String] :datastore_id
|
432
|
-
# The AWS-generated
|
451
|
+
# The AWS-generated Data Store id. This is part of the
|
433
452
|
# ‘CreateFHIRDatastore’ output.
|
434
453
|
#
|
435
454
|
# @return [Types::DescribeFHIRDatastoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -451,6 +470,8 @@ module Aws::HealthLake
|
|
451
470
|
# resp.datastore_properties.created_at #=> Time
|
452
471
|
# resp.datastore_properties.datastore_type_version #=> String, one of "R4"
|
453
472
|
# resp.datastore_properties.datastore_endpoint #=> String
|
473
|
+
# resp.datastore_properties.sse_configuration.kms_encryption_config.cmk_type #=> String, one of "CUSTOMER_MANAGED_KMS_KEY", "AWS_OWNED_KMS_KEY"
|
474
|
+
# resp.datastore_properties.sse_configuration.kms_encryption_config.kms_key_id #=> String
|
454
475
|
# resp.datastore_properties.preload_data_config.preload_data_type #=> String, one of "SYNTHEA"
|
455
476
|
#
|
456
477
|
# @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DescribeFHIRDatastore AWS API Documentation
|
@@ -462,11 +483,54 @@ module Aws::HealthLake
|
|
462
483
|
req.send_request(options)
|
463
484
|
end
|
464
485
|
|
486
|
+
# Displays the properties of a FHIR export job, including the ID, ARN,
|
487
|
+
# name, and the status of the job.
|
488
|
+
#
|
489
|
+
# @option params [required, String] :datastore_id
|
490
|
+
# The AWS generated ID for the Data Store from which files are being
|
491
|
+
# exported from for an export job.
|
492
|
+
#
|
493
|
+
# @option params [required, String] :job_id
|
494
|
+
# The AWS generated ID for an export job.
|
495
|
+
#
|
496
|
+
# @return [Types::DescribeFHIRExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
497
|
+
#
|
498
|
+
# * {Types::DescribeFHIRExportJobResponse#export_job_properties #export_job_properties} => Types::ExportJobProperties
|
499
|
+
#
|
500
|
+
# @example Request syntax with placeholder values
|
501
|
+
#
|
502
|
+
# resp = client.describe_fhir_export_job({
|
503
|
+
# datastore_id: "DatastoreId", # required
|
504
|
+
# job_id: "JobId", # required
|
505
|
+
# })
|
506
|
+
#
|
507
|
+
# @example Response structure
|
508
|
+
#
|
509
|
+
# resp.export_job_properties.job_id #=> String
|
510
|
+
# resp.export_job_properties.job_name #=> String
|
511
|
+
# resp.export_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED_WITH_ERRORS", "COMPLETED", "FAILED"
|
512
|
+
# resp.export_job_properties.submit_time #=> Time
|
513
|
+
# resp.export_job_properties.end_time #=> Time
|
514
|
+
# resp.export_job_properties.datastore_id #=> String
|
515
|
+
# resp.export_job_properties.output_data_config.s3_configuration.s3_uri #=> String
|
516
|
+
# resp.export_job_properties.output_data_config.s3_configuration.kms_key_id #=> String
|
517
|
+
# resp.export_job_properties.data_access_role_arn #=> String
|
518
|
+
# resp.export_job_properties.message #=> String
|
519
|
+
#
|
520
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/DescribeFHIRExportJob AWS API Documentation
|
521
|
+
#
|
522
|
+
# @overload describe_fhir_export_job(params = {})
|
523
|
+
# @param [Hash] params ({})
|
524
|
+
def describe_fhir_export_job(params = {}, options = {})
|
525
|
+
req = build_request(:describe_fhir_export_job, params)
|
526
|
+
req.send_request(options)
|
527
|
+
end
|
528
|
+
|
465
529
|
# Displays the properties of a FHIR import job, including the ID, ARN,
|
466
|
-
# name, and the status of the
|
530
|
+
# name, and the status of the job.
|
467
531
|
#
|
468
532
|
# @option params [required, String] :datastore_id
|
469
|
-
# The AWS-generated ID of the
|
533
|
+
# The AWS-generated ID of the Data Store.
|
470
534
|
#
|
471
535
|
# @option params [required, String] :job_id
|
472
536
|
# The AWS-generated job ID.
|
@@ -486,11 +550,13 @@ module Aws::HealthLake
|
|
486
550
|
#
|
487
551
|
# resp.import_job_properties.job_id #=> String
|
488
552
|
# resp.import_job_properties.job_name #=> String
|
489
|
-
# resp.import_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED"
|
553
|
+
# resp.import_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED_WITH_ERRORS", "COMPLETED", "FAILED"
|
490
554
|
# resp.import_job_properties.submit_time #=> Time
|
491
555
|
# resp.import_job_properties.end_time #=> Time
|
492
556
|
# resp.import_job_properties.datastore_id #=> String
|
493
557
|
# resp.import_job_properties.input_data_config.s3_uri #=> String
|
558
|
+
# resp.import_job_properties.job_output_data_config.s3_configuration.s3_uri #=> String
|
559
|
+
# resp.import_job_properties.job_output_data_config.s3_configuration.kms_key_id #=> String
|
494
560
|
# resp.import_job_properties.data_access_role_arn #=> String
|
495
561
|
# resp.import_job_properties.message #=> String
|
496
562
|
#
|
@@ -503,17 +569,17 @@ module Aws::HealthLake
|
|
503
569
|
req.send_request(options)
|
504
570
|
end
|
505
571
|
|
506
|
-
# Lists all FHIR
|
507
|
-
# of
|
572
|
+
# Lists all FHIR Data Stores that are in the user’s account, regardless
|
573
|
+
# of Data Store status.
|
508
574
|
#
|
509
575
|
# @option params [Types::DatastoreFilter] :filter
|
510
|
-
# Lists all filters associated with a FHIR
|
576
|
+
# Lists all filters associated with a FHIR Data Store request.
|
511
577
|
#
|
512
578
|
# @option params [String] :next_token
|
513
|
-
# Fetches the next page of
|
579
|
+
# Fetches the next page of Data Stores when results are paginated.
|
514
580
|
#
|
515
581
|
# @option params [Integer] :max_results
|
516
|
-
# The maximum number of
|
582
|
+
# The maximum number of Data Stores returned in a single page of a
|
517
583
|
# ListFHIRDatastoresRequest call.
|
518
584
|
#
|
519
585
|
# @return [Types::ListFHIRDatastoresResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -546,6 +612,8 @@ module Aws::HealthLake
|
|
546
612
|
# resp.datastore_properties_list[0].created_at #=> Time
|
547
613
|
# resp.datastore_properties_list[0].datastore_type_version #=> String, one of "R4"
|
548
614
|
# resp.datastore_properties_list[0].datastore_endpoint #=> String
|
615
|
+
# resp.datastore_properties_list[0].sse_configuration.kms_encryption_config.cmk_type #=> String, one of "CUSTOMER_MANAGED_KMS_KEY", "AWS_OWNED_KMS_KEY"
|
616
|
+
# resp.datastore_properties_list[0].sse_configuration.kms_encryption_config.kms_key_id #=> String
|
549
617
|
# resp.datastore_properties_list[0].preload_data_config.preload_data_type #=> String, one of "SYNTHEA"
|
550
618
|
# resp.next_token #=> String
|
551
619
|
#
|
@@ -558,6 +626,244 @@ module Aws::HealthLake
|
|
558
626
|
req.send_request(options)
|
559
627
|
end
|
560
628
|
|
629
|
+
# Lists all FHIR export jobs associated with an account and their
|
630
|
+
# statuses.
|
631
|
+
#
|
632
|
+
# @option params [required, String] :datastore_id
|
633
|
+
# This parameter limits the response to the export job with the
|
634
|
+
# specified Data Store ID.
|
635
|
+
#
|
636
|
+
# @option params [String] :next_token
|
637
|
+
# A pagination token used to identify the next page of results to return
|
638
|
+
# for a ListFHIRExportJobs query.
|
639
|
+
#
|
640
|
+
# @option params [Integer] :max_results
|
641
|
+
# This parameter limits the number of results returned for a
|
642
|
+
# ListFHIRExportJobs to a maximum quantity specified by the user.
|
643
|
+
#
|
644
|
+
# @option params [String] :job_name
|
645
|
+
# This parameter limits the response to the export job with the
|
646
|
+
# specified job name.
|
647
|
+
#
|
648
|
+
# @option params [String] :job_status
|
649
|
+
# This parameter limits the response to the export jobs with the
|
650
|
+
# specified job status.
|
651
|
+
#
|
652
|
+
# @option params [Time,DateTime,Date,Integer,String] :submitted_before
|
653
|
+
# This parameter limits the response to FHIR export jobs submitted
|
654
|
+
# before a user specified date.
|
655
|
+
#
|
656
|
+
# @option params [Time,DateTime,Date,Integer,String] :submitted_after
|
657
|
+
# This parameter limits the response to FHIR export jobs submitted after
|
658
|
+
# a user specified date.
|
659
|
+
#
|
660
|
+
# @return [Types::ListFHIRExportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
661
|
+
#
|
662
|
+
# * {Types::ListFHIRExportJobsResponse#export_job_properties_list #export_job_properties_list} => Array<Types::ExportJobProperties>
|
663
|
+
# * {Types::ListFHIRExportJobsResponse#next_token #next_token} => String
|
664
|
+
#
|
665
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
666
|
+
#
|
667
|
+
# @example Request syntax with placeholder values
|
668
|
+
#
|
669
|
+
# resp = client.list_fhir_export_jobs({
|
670
|
+
# datastore_id: "DatastoreId", # required
|
671
|
+
# next_token: "NextToken",
|
672
|
+
# max_results: 1,
|
673
|
+
# job_name: "JobName",
|
674
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED_WITH_ERRORS, COMPLETED, FAILED
|
675
|
+
# submitted_before: Time.now,
|
676
|
+
# submitted_after: Time.now,
|
677
|
+
# })
|
678
|
+
#
|
679
|
+
# @example Response structure
|
680
|
+
#
|
681
|
+
# resp.export_job_properties_list #=> Array
|
682
|
+
# resp.export_job_properties_list[0].job_id #=> String
|
683
|
+
# resp.export_job_properties_list[0].job_name #=> String
|
684
|
+
# resp.export_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED_WITH_ERRORS", "COMPLETED", "FAILED"
|
685
|
+
# resp.export_job_properties_list[0].submit_time #=> Time
|
686
|
+
# resp.export_job_properties_list[0].end_time #=> Time
|
687
|
+
# resp.export_job_properties_list[0].datastore_id #=> String
|
688
|
+
# resp.export_job_properties_list[0].output_data_config.s3_configuration.s3_uri #=> String
|
689
|
+
# resp.export_job_properties_list[0].output_data_config.s3_configuration.kms_key_id #=> String
|
690
|
+
# resp.export_job_properties_list[0].data_access_role_arn #=> String
|
691
|
+
# resp.export_job_properties_list[0].message #=> String
|
692
|
+
# resp.next_token #=> String
|
693
|
+
#
|
694
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/ListFHIRExportJobs AWS API Documentation
|
695
|
+
#
|
696
|
+
# @overload list_fhir_export_jobs(params = {})
|
697
|
+
# @param [Hash] params ({})
|
698
|
+
def list_fhir_export_jobs(params = {}, options = {})
|
699
|
+
req = build_request(:list_fhir_export_jobs, params)
|
700
|
+
req.send_request(options)
|
701
|
+
end
|
702
|
+
|
703
|
+
# Lists all FHIR import jobs associated with an account and their
|
704
|
+
# statuses.
|
705
|
+
#
|
706
|
+
# @option params [required, String] :datastore_id
|
707
|
+
# This parameter limits the response to the import job with the
|
708
|
+
# specified Data Store ID.
|
709
|
+
#
|
710
|
+
# @option params [String] :next_token
|
711
|
+
# A pagination token used to identify the next page of results to return
|
712
|
+
# for a ListFHIRImportJobs query.
|
713
|
+
#
|
714
|
+
# @option params [Integer] :max_results
|
715
|
+
# This parameter limits the number of results returned for a
|
716
|
+
# ListFHIRImportJobs to a maximum quantity specified by the user.
|
717
|
+
#
|
718
|
+
# @option params [String] :job_name
|
719
|
+
# This parameter limits the response to the import job with the
|
720
|
+
# specified job name.
|
721
|
+
#
|
722
|
+
# @option params [String] :job_status
|
723
|
+
# This parameter limits the response to the import job with the
|
724
|
+
# specified job status.
|
725
|
+
#
|
726
|
+
# @option params [Time,DateTime,Date,Integer,String] :submitted_before
|
727
|
+
# This parameter limits the response to FHIR import jobs submitted
|
728
|
+
# before a user specified date.
|
729
|
+
#
|
730
|
+
# @option params [Time,DateTime,Date,Integer,String] :submitted_after
|
731
|
+
# This parameter limits the response to FHIR import jobs submitted after
|
732
|
+
# a user specified date.
|
733
|
+
#
|
734
|
+
# @return [Types::ListFHIRImportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
735
|
+
#
|
736
|
+
# * {Types::ListFHIRImportJobsResponse#import_job_properties_list #import_job_properties_list} => Array<Types::ImportJobProperties>
|
737
|
+
# * {Types::ListFHIRImportJobsResponse#next_token #next_token} => String
|
738
|
+
#
|
739
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
740
|
+
#
|
741
|
+
# @example Request syntax with placeholder values
|
742
|
+
#
|
743
|
+
# resp = client.list_fhir_import_jobs({
|
744
|
+
# datastore_id: "DatastoreId", # required
|
745
|
+
# next_token: "NextToken",
|
746
|
+
# max_results: 1,
|
747
|
+
# job_name: "JobName",
|
748
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED_WITH_ERRORS, COMPLETED, FAILED
|
749
|
+
# submitted_before: Time.now,
|
750
|
+
# submitted_after: Time.now,
|
751
|
+
# })
|
752
|
+
#
|
753
|
+
# @example Response structure
|
754
|
+
#
|
755
|
+
# resp.import_job_properties_list #=> Array
|
756
|
+
# resp.import_job_properties_list[0].job_id #=> String
|
757
|
+
# resp.import_job_properties_list[0].job_name #=> String
|
758
|
+
# resp.import_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED_WITH_ERRORS", "COMPLETED", "FAILED"
|
759
|
+
# resp.import_job_properties_list[0].submit_time #=> Time
|
760
|
+
# resp.import_job_properties_list[0].end_time #=> Time
|
761
|
+
# resp.import_job_properties_list[0].datastore_id #=> String
|
762
|
+
# resp.import_job_properties_list[0].input_data_config.s3_uri #=> String
|
763
|
+
# resp.import_job_properties_list[0].job_output_data_config.s3_configuration.s3_uri #=> String
|
764
|
+
# resp.import_job_properties_list[0].job_output_data_config.s3_configuration.kms_key_id #=> String
|
765
|
+
# resp.import_job_properties_list[0].data_access_role_arn #=> String
|
766
|
+
# resp.import_job_properties_list[0].message #=> String
|
767
|
+
# resp.next_token #=> String
|
768
|
+
#
|
769
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/ListFHIRImportJobs AWS API Documentation
|
770
|
+
#
|
771
|
+
# @overload list_fhir_import_jobs(params = {})
|
772
|
+
# @param [Hash] params ({})
|
773
|
+
def list_fhir_import_jobs(params = {}, options = {})
|
774
|
+
req = build_request(:list_fhir_import_jobs, params)
|
775
|
+
req.send_request(options)
|
776
|
+
end
|
777
|
+
|
778
|
+
# Returns a list of all existing tags associated with a Data Store.
|
779
|
+
#
|
780
|
+
# @option params [required, String] :resource_arn
|
781
|
+
# The Amazon Resource Name(ARN) of the Data Store for which tags are
|
782
|
+
# being added.
|
783
|
+
#
|
784
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
785
|
+
#
|
786
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Array<Types::Tag>
|
787
|
+
#
|
788
|
+
# @example Request syntax with placeholder values
|
789
|
+
#
|
790
|
+
# resp = client.list_tags_for_resource({
|
791
|
+
# resource_arn: "AmazonResourceName", # required
|
792
|
+
# })
|
793
|
+
#
|
794
|
+
# @example Response structure
|
795
|
+
#
|
796
|
+
# resp.tags #=> Array
|
797
|
+
# resp.tags[0].key #=> String
|
798
|
+
# resp.tags[0].value #=> String
|
799
|
+
#
|
800
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/ListTagsForResource AWS API Documentation
|
801
|
+
#
|
802
|
+
# @overload list_tags_for_resource(params = {})
|
803
|
+
# @param [Hash] params ({})
|
804
|
+
def list_tags_for_resource(params = {}, options = {})
|
805
|
+
req = build_request(:list_tags_for_resource, params)
|
806
|
+
req.send_request(options)
|
807
|
+
end
|
808
|
+
|
809
|
+
# Begins a FHIR export job.
|
810
|
+
#
|
811
|
+
# @option params [String] :job_name
|
812
|
+
# The user generated name for an export job.
|
813
|
+
#
|
814
|
+
# @option params [required, Types::OutputDataConfig] :output_data_config
|
815
|
+
# The output data configuration that was supplied when the export job
|
816
|
+
# was created.
|
817
|
+
#
|
818
|
+
# @option params [required, String] :datastore_id
|
819
|
+
# The AWS generated ID for the Data Store from which files are being
|
820
|
+
# exported for an export job.
|
821
|
+
#
|
822
|
+
# @option params [required, String] :data_access_role_arn
|
823
|
+
# The Amazon Resource Name used during the initiation of the job.
|
824
|
+
#
|
825
|
+
# @option params [required, String] :client_token
|
826
|
+
# An optional user provided token used for ensuring idempotency.
|
827
|
+
#
|
828
|
+
# **A suitable default value is auto-generated.** You should normally
|
829
|
+
# not need to pass this option.**
|
830
|
+
#
|
831
|
+
# @return [Types::StartFHIRExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
832
|
+
#
|
833
|
+
# * {Types::StartFHIRExportJobResponse#job_id #job_id} => String
|
834
|
+
# * {Types::StartFHIRExportJobResponse#job_status #job_status} => String
|
835
|
+
# * {Types::StartFHIRExportJobResponse#datastore_id #datastore_id} => String
|
836
|
+
#
|
837
|
+
# @example Request syntax with placeholder values
|
838
|
+
#
|
839
|
+
# resp = client.start_fhir_export_job({
|
840
|
+
# job_name: "JobName",
|
841
|
+
# output_data_config: { # required
|
842
|
+
# s3_configuration: {
|
843
|
+
# s3_uri: "S3Uri", # required
|
844
|
+
# kms_key_id: "EncryptionKeyID", # required
|
845
|
+
# },
|
846
|
+
# },
|
847
|
+
# datastore_id: "DatastoreId", # required
|
848
|
+
# data_access_role_arn: "IamRoleArn", # required
|
849
|
+
# client_token: "ClientTokenString", # required
|
850
|
+
# })
|
851
|
+
#
|
852
|
+
# @example Response structure
|
853
|
+
#
|
854
|
+
# resp.job_id #=> String
|
855
|
+
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED_WITH_ERRORS", "COMPLETED", "FAILED"
|
856
|
+
# resp.datastore_id #=> String
|
857
|
+
#
|
858
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/StartFHIRExportJob AWS API Documentation
|
859
|
+
#
|
860
|
+
# @overload start_fhir_export_job(params = {})
|
861
|
+
# @param [Hash] params ({})
|
862
|
+
def start_fhir_export_job(params = {}, options = {})
|
863
|
+
req = build_request(:start_fhir_export_job, params)
|
864
|
+
req.send_request(options)
|
865
|
+
end
|
866
|
+
|
561
867
|
# Begins a FHIR Import job.
|
562
868
|
#
|
563
869
|
# @option params [String] :job_name
|
@@ -567,8 +873,12 @@ module Aws::HealthLake
|
|
567
873
|
# The input properties of the FHIR Import job in the StartFHIRImport job
|
568
874
|
# request.
|
569
875
|
#
|
876
|
+
# @option params [required, Types::OutputDataConfig] :job_output_data_config
|
877
|
+
# The output data configuration that was supplied when the export job
|
878
|
+
# was created.
|
879
|
+
#
|
570
880
|
# @option params [required, String] :datastore_id
|
571
|
-
# The AWS-generated
|
881
|
+
# The AWS-generated Data Store ID.
|
572
882
|
#
|
573
883
|
# @option params [required, String] :data_access_role_arn
|
574
884
|
# The Amazon Resource Name (ARN) that gives Amazon HealthLake access
|
@@ -593,6 +903,12 @@ module Aws::HealthLake
|
|
593
903
|
# input_data_config: { # required
|
594
904
|
# s3_uri: "S3Uri",
|
595
905
|
# },
|
906
|
+
# job_output_data_config: { # required
|
907
|
+
# s3_configuration: {
|
908
|
+
# s3_uri: "S3Uri", # required
|
909
|
+
# kms_key_id: "EncryptionKeyID", # required
|
910
|
+
# },
|
911
|
+
# },
|
596
912
|
# datastore_id: "DatastoreId", # required
|
597
913
|
# data_access_role_arn: "IamRoleArn", # required
|
598
914
|
# client_token: "ClientTokenString", # required
|
@@ -601,7 +917,7 @@ module Aws::HealthLake
|
|
601
917
|
# @example Response structure
|
602
918
|
#
|
603
919
|
# resp.job_id #=> String
|
604
|
-
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED"
|
920
|
+
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED_WITH_ERRORS", "COMPLETED", "FAILED"
|
605
921
|
# resp.datastore_id #=> String
|
606
922
|
#
|
607
923
|
# @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/StartFHIRImportJob AWS API Documentation
|
@@ -613,6 +929,66 @@ module Aws::HealthLake
|
|
613
929
|
req.send_request(options)
|
614
930
|
end
|
615
931
|
|
932
|
+
# Adds a user specifed key and value tag to a Data Store.
|
933
|
+
#
|
934
|
+
# @option params [required, String] :resource_arn
|
935
|
+
# The Amazon Resource Name(ARN)that gives Amazon HealthLake access to
|
936
|
+
# the Data Store which tags are being added to.
|
937
|
+
#
|
938
|
+
# @option params [required, Array<Types::Tag>] :tags
|
939
|
+
# The user specified key and value pair tags being added to a Data
|
940
|
+
# Store.
|
941
|
+
#
|
942
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
943
|
+
#
|
944
|
+
# @example Request syntax with placeholder values
|
945
|
+
#
|
946
|
+
# resp = client.tag_resource({
|
947
|
+
# resource_arn: "AmazonResourceName", # required
|
948
|
+
# tags: [ # required
|
949
|
+
# {
|
950
|
+
# key: "TagKey", # required
|
951
|
+
# value: "TagValue", # required
|
952
|
+
# },
|
953
|
+
# ],
|
954
|
+
# })
|
955
|
+
#
|
956
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/TagResource AWS API Documentation
|
957
|
+
#
|
958
|
+
# @overload tag_resource(params = {})
|
959
|
+
# @param [Hash] params ({})
|
960
|
+
def tag_resource(params = {}, options = {})
|
961
|
+
req = build_request(:tag_resource, params)
|
962
|
+
req.send_request(options)
|
963
|
+
end
|
964
|
+
|
965
|
+
# Removes tags from a Data Store.
|
966
|
+
#
|
967
|
+
# @option params [required, String] :resource_arn
|
968
|
+
# "The Amazon Resource Name(ARN) of the Data Store for which tags are
|
969
|
+
# being removed
|
970
|
+
#
|
971
|
+
# @option params [required, Array<String>] :tag_keys
|
972
|
+
# The keys for the tags to be removed from the Healthlake Data Store.
|
973
|
+
#
|
974
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
975
|
+
#
|
976
|
+
# @example Request syntax with placeholder values
|
977
|
+
#
|
978
|
+
# resp = client.untag_resource({
|
979
|
+
# resource_arn: "AmazonResourceName", # required
|
980
|
+
# tag_keys: ["TagKey"], # required
|
981
|
+
# })
|
982
|
+
#
|
983
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/healthlake-2017-07-01/UntagResource AWS API Documentation
|
984
|
+
#
|
985
|
+
# @overload untag_resource(params = {})
|
986
|
+
# @param [Hash] params ({})
|
987
|
+
def untag_resource(params = {}, options = {})
|
988
|
+
req = build_request(:untag_resource, params)
|
989
|
+
req.send_request(options)
|
990
|
+
end
|
991
|
+
|
616
992
|
# @!endgroup
|
617
993
|
|
618
994
|
# @param params ({})
|
@@ -626,7 +1002,7 @@ module Aws::HealthLake
|
|
626
1002
|
params: params,
|
627
1003
|
config: config)
|
628
1004
|
context[:gem_name] = 'aws-sdk-healthlake'
|
629
|
-
context[:gem_version] = '1.
|
1005
|
+
context[:gem_version] = '1.4.0'
|
630
1006
|
Seahorse::Client::Request.new(handlers, context)
|
631
1007
|
end
|
632
1008
|
|