@aws-sdk/client-healthlake 3.876.0 → 3.879.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.
- package/README.md +3 -2
- package/dist-cjs/index.js +225 -4
- package/dist-es/index.js +1 -0
- package/dist-es/models/models_0.js +5 -0
- package/dist-es/protocols/Aws_json1_0.js +2 -0
- package/dist-es/waiters/index.js +4 -0
- package/dist-es/waiters/waitForFHIRDatastoreActive.js +49 -0
- package/dist-es/waiters/waitForFHIRDatastoreDeleted.js +31 -0
- package/dist-es/waiters/waitForFHIRExportJobCompleted.js +67 -0
- package/dist-es/waiters/waitForFHIRImportJobCompleted.js +49 -0
- package/dist-types/HealthLake.d.ts +3 -2
- package/dist-types/HealthLakeClient.d.ts +3 -2
- package/dist-types/commands/CreateFHIRDatastoreCommand.d.ts +2 -2
- package/dist-types/commands/DeleteFHIRDatastoreCommand.d.ts +5 -4
- package/dist-types/commands/DescribeFHIRDatastoreCommand.d.ts +3 -4
- package/dist-types/commands/DescribeFHIRExportJobCommand.d.ts +3 -3
- package/dist-types/commands/DescribeFHIRImportJobCommand.d.ts +4 -3
- package/dist-types/commands/ListFHIRDatastoresCommand.d.ts +3 -2
- package/dist-types/commands/ListFHIRExportJobsCommand.d.ts +3 -5
- package/dist-types/commands/ListFHIRImportJobsCommand.d.ts +4 -5
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -4
- package/dist-types/commands/StartFHIRExportJobCommand.d.ts +3 -3
- package/dist-types/commands/StartFHIRImportJobCommand.d.ts +6 -3
- package/dist-types/commands/TagResourceCommand.d.ts +2 -4
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -4
- package/dist-types/index.d.ts +4 -2
- package/dist-types/models/models_0.d.ts +224 -230
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +9 -0
- package/dist-types/ts3.4/waiters/index.d.ts +4 -0
- package/dist-types/ts3.4/waiters/waitForFHIRDatastoreActive.d.ts +11 -0
- package/dist-types/ts3.4/waiters/waitForFHIRDatastoreDeleted.d.ts +11 -0
- package/dist-types/ts3.4/waiters/waitForFHIRExportJobCompleted.d.ts +11 -0
- package/dist-types/ts3.4/waiters/waitForFHIRImportJobCompleted.d.ts +11 -0
- package/dist-types/waiters/index.d.ts +4 -0
- package/dist-types/waiters/waitForFHIRDatastoreActive.d.ts +14 -0
- package/dist-types/waiters/waitForFHIRDatastoreDeleted.d.ts +14 -0
- package/dist-types/waiters/waitForFHIRExportJobCompleted.d.ts +14 -0
- package/dist-types/waiters/waitForFHIRImportJobCompleted.d.ts +14 -0
- package/package.json +13 -12
|
@@ -39,7 +39,8 @@ export declare const CmkType: {
|
|
|
39
39
|
*/
|
|
40
40
|
export type CmkType = (typeof CmkType)[keyof typeof CmkType];
|
|
41
41
|
/**
|
|
42
|
-
* <p>The data store is in a transition state and the user requested action
|
|
42
|
+
* <p>The data store is in a transition state and the user requested action cannot be
|
|
43
|
+
* performed.</p>
|
|
43
44
|
* @public
|
|
44
45
|
*/
|
|
45
46
|
export declare class ConflictException extends __BaseException {
|
|
@@ -63,37 +64,69 @@ export declare const FHIRVersion: {
|
|
|
63
64
|
*/
|
|
64
65
|
export type FHIRVersion = (typeof FHIRVersion)[keyof typeof FHIRVersion];
|
|
65
66
|
/**
|
|
66
|
-
* <p>The identity provider configuration
|
|
67
|
+
* <p>The identity provider configuration selected when the data store was created.</p>
|
|
67
68
|
* @public
|
|
68
69
|
*/
|
|
69
70
|
export interface IdentityProviderConfiguration {
|
|
70
71
|
/**
|
|
71
|
-
* <p>The authorization strategy
|
|
72
|
+
* <p>The authorization strategy selected when the HealthLake data store is created.</p>
|
|
73
|
+
* <note>
|
|
74
|
+
* <p>HealthLake provides support for both SMART on FHIR V1 and V2 as described below.</p>
|
|
75
|
+
* <ul>
|
|
76
|
+
* <li>
|
|
77
|
+
* <p>
|
|
78
|
+
* <code>SMART_ON_FHIR_V1</code> – Support for only SMART on FHIR V1, which
|
|
79
|
+
* includes <code>read</code> (read/search) and <code>write</code>
|
|
80
|
+
* (create/update/delete) permissions.</p>
|
|
81
|
+
* </li>
|
|
82
|
+
* <li>
|
|
83
|
+
* <p>
|
|
84
|
+
* <code>SMART_ON_FHIR</code> – Support for both SMART on FHIR V1 and V2,
|
|
85
|
+
* which includes <code>create</code>, <code>read</code>, <code>update</code>,
|
|
86
|
+
* <code>delete</code>, and <code>search</code> permissions.</p>
|
|
87
|
+
* </li>
|
|
88
|
+
* <li>
|
|
89
|
+
* <p>
|
|
90
|
+
* <code>AWS_AUTH</code> – The default HealthLake authorization
|
|
91
|
+
* strategy; not affiliated with SMART on FHIR.</p>
|
|
92
|
+
* </li>
|
|
93
|
+
* </ul>
|
|
94
|
+
* </note>
|
|
72
95
|
* @public
|
|
73
96
|
*/
|
|
74
97
|
AuthorizationStrategy: AuthorizationStrategy | undefined;
|
|
75
98
|
/**
|
|
76
|
-
* <p>
|
|
99
|
+
* <p>The parameter to enable SMART on FHIR fine-grained authorization for the data
|
|
100
|
+
* store.</p>
|
|
77
101
|
* @public
|
|
78
102
|
*/
|
|
79
103
|
FineGrainedAuthorizationEnabled?: boolean | undefined;
|
|
80
104
|
/**
|
|
81
|
-
* <p>The JSON metadata elements
|
|
105
|
+
* <p>The JSON metadata elements to use in your identity provider configuration. Required
|
|
106
|
+
* elements are listed based on the launch specification of the SMART application. For more
|
|
107
|
+
* information on all possible elements, see <a href="https://build.fhir.org/ig/HL7/smart-app-launch/conformance.html#metadata">Metadata</a> in SMART's App Launch specification.</p>
|
|
82
108
|
* <p>
|
|
83
|
-
* <code>authorization_endpoint</code>: The URL to the OAuth2 authorization
|
|
109
|
+
* <code>authorization_endpoint</code>: The URL to the OAuth2 authorization
|
|
110
|
+
* endpoint.</p>
|
|
84
111
|
* <p>
|
|
85
|
-
* <code>grant_types_supported</code>:
|
|
112
|
+
* <code>grant_types_supported</code>: An array of grant types that are supported at the
|
|
113
|
+
* token endpoint. You must provide at least one grant type option. Valid options are
|
|
114
|
+
* <code>authorization_code</code> and <code>client_credentials</code>.</p>
|
|
86
115
|
* <p>
|
|
87
116
|
* <code>token_endpoint</code>: The URL to the OAuth2 token endpoint.</p>
|
|
88
117
|
* <p>
|
|
89
|
-
* <code>capabilities</code>: An array of strings of the SMART capabilities that the
|
|
118
|
+
* <code>capabilities</code>: An array of strings of the SMART capabilities that the
|
|
119
|
+
* authorization server supports.</p>
|
|
90
120
|
* <p>
|
|
91
|
-
* <code>code_challenge_methods_supported</code>: An array of strings of supported PKCE
|
|
121
|
+
* <code>code_challenge_methods_supported</code>: An array of strings of supported PKCE
|
|
122
|
+
* code challenge methods. You must include the <code>S256</code> method in the array of PKCE
|
|
123
|
+
* code challenge methods.</p>
|
|
92
124
|
* @public
|
|
93
125
|
*/
|
|
94
126
|
Metadata?: string | undefined;
|
|
95
127
|
/**
|
|
96
|
-
* <p>The Amazon Resource Name (ARN) of the Lambda function
|
|
128
|
+
* <p>The Amazon Resource Name (ARN) of the Lambda function to use to decode the access token created by the
|
|
129
|
+
* authorization server.</p>
|
|
97
130
|
* @public
|
|
98
131
|
*/
|
|
99
132
|
IdpLambdaArn?: string | undefined;
|
|
@@ -110,7 +143,7 @@ export declare const PreloadDataType: {
|
|
|
110
143
|
*/
|
|
111
144
|
export type PreloadDataType = (typeof PreloadDataType)[keyof typeof PreloadDataType];
|
|
112
145
|
/**
|
|
113
|
-
* <p>
|
|
146
|
+
* <p>The input properties for the preloaded (Synthea) data store.</p>
|
|
114
147
|
* @public
|
|
115
148
|
*/
|
|
116
149
|
export interface PreloadDataConfig {
|
|
@@ -121,60 +154,49 @@ export interface PreloadDataConfig {
|
|
|
121
154
|
PreloadDataType: PreloadDataType | undefined;
|
|
122
155
|
}
|
|
123
156
|
/**
|
|
124
|
-
* <p>
|
|
125
|
-
*
|
|
126
|
-
* </p>
|
|
157
|
+
* <p>The customer-managed-key (CMK) used when creating a data store. If a customer-owned key
|
|
158
|
+
* is not specified, an AWS-owned key is used for encryption. </p>
|
|
127
159
|
* @public
|
|
128
160
|
*/
|
|
129
161
|
export interface KmsEncryptionConfig {
|
|
130
162
|
/**
|
|
131
|
-
* <p>
|
|
132
|
-
* The type of customer-managed-key(CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.
|
|
133
|
-
* </p>
|
|
163
|
+
* <p>The type of customer-managed-key (CMK) used for encryption.</p>
|
|
134
164
|
* @public
|
|
135
165
|
*/
|
|
136
166
|
CmkType: CmkType | undefined;
|
|
137
167
|
/**
|
|
138
|
-
* <p>
|
|
139
|
-
*
|
|
140
|
-
* </p>
|
|
168
|
+
* <p>The Key Management Service (KMS) encryption key id/alias used to encrypt the data store contents at
|
|
169
|
+
* rest.</p>
|
|
141
170
|
* @public
|
|
142
171
|
*/
|
|
143
172
|
KmsKeyId?: string | undefined;
|
|
144
173
|
}
|
|
145
174
|
/**
|
|
146
|
-
* <p>
|
|
147
|
-
*
|
|
148
|
-
* </p>
|
|
175
|
+
* <p>The server-side encryption key configuration for a customer-provided encryption
|
|
176
|
+
* key.</p>
|
|
149
177
|
* @public
|
|
150
178
|
*/
|
|
151
179
|
export interface SseConfiguration {
|
|
152
180
|
/**
|
|
153
|
-
* <p>
|
|
154
|
-
*
|
|
155
|
-
* </p>
|
|
181
|
+
* <p>The Key Management Service (KMS) encryption configuration used to provide details for data
|
|
182
|
+
* encryption.</p>
|
|
156
183
|
* @public
|
|
157
184
|
*/
|
|
158
185
|
KmsEncryptionConfig: KmsEncryptionConfig | undefined;
|
|
159
186
|
}
|
|
160
187
|
/**
|
|
161
|
-
* <p>
|
|
162
|
-
*
|
|
163
|
-
* </p>
|
|
188
|
+
* <p>A label consisting of a user-defined key and value. The form for tags is \{"Key",
|
|
189
|
+
* "Value"\}</p>
|
|
164
190
|
* @public
|
|
165
191
|
*/
|
|
166
192
|
export interface Tag {
|
|
167
193
|
/**
|
|
168
|
-
* <p>
|
|
169
|
-
* The key portion of a tag. Tag keys are case sensitive.
|
|
170
|
-
* </p>
|
|
194
|
+
* <p>The key portion of a tag. Tag keys are case sensitive. </p>
|
|
171
195
|
* @public
|
|
172
196
|
*/
|
|
173
197
|
Key: string | undefined;
|
|
174
198
|
/**
|
|
175
|
-
* <p>
|
|
176
|
-
* The value portion of a tag. Tag values are case sensitive.
|
|
177
|
-
* </p>
|
|
199
|
+
* <p> The value portion of a tag. Tag values are case-sensitive.</p>
|
|
178
200
|
* @public
|
|
179
201
|
*/
|
|
180
202
|
Value: string | undefined;
|
|
@@ -184,42 +206,40 @@ export interface Tag {
|
|
|
184
206
|
*/
|
|
185
207
|
export interface CreateFHIRDatastoreRequest {
|
|
186
208
|
/**
|
|
187
|
-
* <p>The
|
|
209
|
+
* <p>The data store name (user-generated).</p>
|
|
188
210
|
* @public
|
|
189
211
|
*/
|
|
190
212
|
DatastoreName?: string | undefined;
|
|
191
213
|
/**
|
|
192
|
-
* <p>The FHIR version
|
|
214
|
+
* <p>The FHIR release version supported by the data store. Current support is for version
|
|
215
|
+
* <code>R4</code>.</p>
|
|
193
216
|
* @public
|
|
194
217
|
*/
|
|
195
218
|
DatastoreTypeVersion: FHIRVersion | undefined;
|
|
196
219
|
/**
|
|
197
|
-
* <p>
|
|
198
|
-
*
|
|
199
|
-
* </p>
|
|
220
|
+
* <p>The server-side encryption key configuration for a customer-provided encryption key
|
|
221
|
+
* specified for creating a data store. </p>
|
|
200
222
|
* @public
|
|
201
223
|
*/
|
|
202
224
|
SseConfiguration?: SseConfiguration | undefined;
|
|
203
225
|
/**
|
|
204
|
-
* <p>
|
|
205
|
-
*
|
|
226
|
+
* <p>An optional parameter to preload (import) open source Synthea FHIR data upon creation of
|
|
227
|
+
* the data store.</p>
|
|
206
228
|
* @public
|
|
207
229
|
*/
|
|
208
230
|
PreloadDataConfig?: PreloadDataConfig | undefined;
|
|
209
231
|
/**
|
|
210
|
-
* <p>
|
|
232
|
+
* <p>An optional user-provided token to ensure API idempotency.</p>
|
|
211
233
|
* @public
|
|
212
234
|
*/
|
|
213
235
|
ClientToken?: string | undefined;
|
|
214
236
|
/**
|
|
215
|
-
* <p>
|
|
216
|
-
* Resource tags that are applied to a data store when it is created.
|
|
217
|
-
* </p>
|
|
237
|
+
* <p>The resource tags applied to a data store when it is created.</p>
|
|
218
238
|
* @public
|
|
219
239
|
*/
|
|
220
240
|
Tags?: Tag[] | undefined;
|
|
221
241
|
/**
|
|
222
|
-
* <p>The
|
|
242
|
+
* <p>The identity provider configuration to use for the data store.</p>
|
|
223
243
|
* @public
|
|
224
244
|
*/
|
|
225
245
|
IdentityProviderConfiguration?: IdentityProviderConfiguration | undefined;
|
|
@@ -244,30 +264,28 @@ export type DatastoreStatus = (typeof DatastoreStatus)[keyof typeof DatastoreSta
|
|
|
244
264
|
*/
|
|
245
265
|
export interface CreateFHIRDatastoreResponse {
|
|
246
266
|
/**
|
|
247
|
-
* <p>The
|
|
248
|
-
* creation call.</p>
|
|
267
|
+
* <p>The data store identifier.</p>
|
|
249
268
|
* @public
|
|
250
269
|
*/
|
|
251
270
|
DatastoreId: string | undefined;
|
|
252
271
|
/**
|
|
253
|
-
* <p>The
|
|
254
|
-
* the output from the initial data store creation call.</p>
|
|
272
|
+
* <p>The Amazon Resource Name (ARN) for the data store.</p>
|
|
255
273
|
* @public
|
|
256
274
|
*/
|
|
257
275
|
DatastoreArn: string | undefined;
|
|
258
276
|
/**
|
|
259
|
-
* <p>The
|
|
277
|
+
* <p>The data store status.</p>
|
|
260
278
|
* @public
|
|
261
279
|
*/
|
|
262
280
|
DatastoreStatus: DatastoreStatus | undefined;
|
|
263
281
|
/**
|
|
264
|
-
* <p>The AWS endpoint for the
|
|
282
|
+
* <p>The AWS endpoint created for the data store.</p>
|
|
265
283
|
* @public
|
|
266
284
|
*/
|
|
267
285
|
DatastoreEndpoint: string | undefined;
|
|
268
286
|
}
|
|
269
287
|
/**
|
|
270
|
-
* <p>
|
|
288
|
+
* <p>An unknown internal error occurred in the service.</p>
|
|
271
289
|
* @public
|
|
272
290
|
*/
|
|
273
291
|
export declare class InternalServerException extends __BaseException {
|
|
@@ -306,29 +324,29 @@ export declare class ValidationException extends __BaseException {
|
|
|
306
324
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
307
325
|
}
|
|
308
326
|
/**
|
|
309
|
-
* <p>The filters applied to data store query.</p>
|
|
327
|
+
* <p>The filters applied to a data store query.</p>
|
|
310
328
|
* @public
|
|
311
329
|
*/
|
|
312
330
|
export interface DatastoreFilter {
|
|
313
331
|
/**
|
|
314
|
-
* <p>
|
|
332
|
+
* <p>Filter data store results by name.</p>
|
|
315
333
|
* @public
|
|
316
334
|
*/
|
|
317
335
|
DatastoreName?: string | undefined;
|
|
318
336
|
/**
|
|
319
|
-
* <p>
|
|
337
|
+
* <p>Filter data store results by status.</p>
|
|
320
338
|
* @public
|
|
321
339
|
*/
|
|
322
340
|
DatastoreStatus?: DatastoreStatus | undefined;
|
|
323
341
|
/**
|
|
324
|
-
* <p>
|
|
325
|
-
*
|
|
342
|
+
* <p>Filter to set cutoff dates for records. All data stores created before the specified
|
|
343
|
+
* date are included in the results. </p>
|
|
326
344
|
* @public
|
|
327
345
|
*/
|
|
328
346
|
CreatedBefore?: Date | undefined;
|
|
329
347
|
/**
|
|
330
|
-
* <p>
|
|
331
|
-
*
|
|
348
|
+
* <p>Filter to set cutoff dates for records. All data stores created after the specified date
|
|
349
|
+
* are included in the results.</p>
|
|
332
350
|
* @public
|
|
333
351
|
*/
|
|
334
352
|
CreatedAfter?: Date | undefined;
|
|
@@ -346,75 +364,76 @@ export declare const ErrorCategory: {
|
|
|
346
364
|
*/
|
|
347
365
|
export type ErrorCategory = (typeof ErrorCategory)[keyof typeof ErrorCategory];
|
|
348
366
|
/**
|
|
349
|
-
* <p>The error
|
|
367
|
+
* <p>The error information for <code>CreateFHIRDatastore</code> and
|
|
368
|
+
* <code>DeleteFHIRDatastore</code> actions.</p>
|
|
350
369
|
* @public
|
|
351
370
|
*/
|
|
352
371
|
export interface ErrorCause {
|
|
353
372
|
/**
|
|
354
|
-
* <p>The
|
|
373
|
+
* <p>The error message text for <code>ErrorCause</code>.</p>
|
|
355
374
|
* @public
|
|
356
375
|
*/
|
|
357
376
|
ErrorMessage?: string | undefined;
|
|
358
377
|
/**
|
|
359
|
-
* <p>The error category
|
|
378
|
+
* <p>The error category for <code>ErrorCause</code>.</p>
|
|
360
379
|
* @public
|
|
361
380
|
*/
|
|
362
381
|
ErrorCategory?: ErrorCategory | undefined;
|
|
363
382
|
}
|
|
364
383
|
/**
|
|
365
|
-
* <p>
|
|
384
|
+
* <p>The data store properties.</p>
|
|
366
385
|
* @public
|
|
367
386
|
*/
|
|
368
387
|
export interface DatastoreProperties {
|
|
369
388
|
/**
|
|
370
|
-
* <p>The
|
|
389
|
+
* <p>The data store identifier.</p>
|
|
371
390
|
* @public
|
|
372
391
|
*/
|
|
373
392
|
DatastoreId: string | undefined;
|
|
374
393
|
/**
|
|
375
|
-
* <p>The Amazon Resource Name used in the creation of the data store.</p>
|
|
394
|
+
* <p>The Amazon Resource Name (ARN) used in the creation of the data store.</p>
|
|
376
395
|
* @public
|
|
377
396
|
*/
|
|
378
397
|
DatastoreArn: string | undefined;
|
|
379
398
|
/**
|
|
380
|
-
* <p>The
|
|
399
|
+
* <p>The data store name.</p>
|
|
381
400
|
* @public
|
|
382
401
|
*/
|
|
383
402
|
DatastoreName?: string | undefined;
|
|
384
403
|
/**
|
|
385
|
-
* <p>The
|
|
404
|
+
* <p>The data store status.</p>
|
|
386
405
|
* @public
|
|
387
406
|
*/
|
|
388
407
|
DatastoreStatus: DatastoreStatus | undefined;
|
|
389
408
|
/**
|
|
390
|
-
* <p>The time
|
|
409
|
+
* <p>The time the data store was created. </p>
|
|
391
410
|
* @public
|
|
392
411
|
*/
|
|
393
412
|
CreatedAt?: Date | undefined;
|
|
394
413
|
/**
|
|
395
|
-
* <p>The FHIR version
|
|
414
|
+
* <p>The FHIR release version supported by the data store. Current support is for version
|
|
415
|
+
* <code>R4</code>.</p>
|
|
396
416
|
* @public
|
|
397
417
|
*/
|
|
398
418
|
DatastoreTypeVersion: FHIRVersion | undefined;
|
|
399
419
|
/**
|
|
400
|
-
* <p>The AWS endpoint for the data store
|
|
420
|
+
* <p>The AWS endpoint for the data store.</p>
|
|
401
421
|
* @public
|
|
402
422
|
*/
|
|
403
423
|
DatastoreEndpoint: string | undefined;
|
|
404
424
|
/**
|
|
405
|
-
* <p>
|
|
406
|
-
*
|
|
407
|
-
* </p>
|
|
425
|
+
* <p> The server-side encryption key configuration for a customer provided encryption
|
|
426
|
+
* key.</p>
|
|
408
427
|
* @public
|
|
409
428
|
*/
|
|
410
429
|
SseConfiguration?: SseConfiguration | undefined;
|
|
411
430
|
/**
|
|
412
|
-
* <p>The preloaded data configuration for the data store
|
|
431
|
+
* <p>The preloaded Synthea data configuration for the data store.</p>
|
|
413
432
|
* @public
|
|
414
433
|
*/
|
|
415
434
|
PreloadDataConfig?: PreloadDataConfig | undefined;
|
|
416
435
|
/**
|
|
417
|
-
* <p>The identity provider
|
|
436
|
+
* <p>The identity provider selected during data store creation.</p>
|
|
418
437
|
* @public
|
|
419
438
|
*/
|
|
420
439
|
IdentityProviderConfiguration?: IdentityProviderConfiguration | undefined;
|
|
@@ -429,7 +448,7 @@ export interface DatastoreProperties {
|
|
|
429
448
|
*/
|
|
430
449
|
export interface DeleteFHIRDatastoreRequest {
|
|
431
450
|
/**
|
|
432
|
-
* <p> The AWS-generated
|
|
451
|
+
* <p> The AWS-generated identifier for the data store to be deleted.</p>
|
|
433
452
|
* @public
|
|
434
453
|
*/
|
|
435
454
|
DatastoreId: string | undefined;
|
|
@@ -439,29 +458,28 @@ export interface DeleteFHIRDatastoreRequest {
|
|
|
439
458
|
*/
|
|
440
459
|
export interface DeleteFHIRDatastoreResponse {
|
|
441
460
|
/**
|
|
442
|
-
* <p>The AWS-generated ID for the data store
|
|
461
|
+
* <p>The AWS-generated ID for the deleted data store.</p>
|
|
443
462
|
* @public
|
|
444
463
|
*/
|
|
445
464
|
DatastoreId: string | undefined;
|
|
446
465
|
/**
|
|
447
|
-
* <p>The Amazon Resource Name (ARN) that
|
|
466
|
+
* <p>The Amazon Resource Name (ARN) that grants access permission to AWS HealthLake.</p>
|
|
448
467
|
* @public
|
|
449
468
|
*/
|
|
450
469
|
DatastoreArn: string | undefined;
|
|
451
470
|
/**
|
|
452
|
-
* <p>The
|
|
453
|
-
* </p>
|
|
471
|
+
* <p>The data store status.</p>
|
|
454
472
|
* @public
|
|
455
473
|
*/
|
|
456
474
|
DatastoreStatus: DatastoreStatus | undefined;
|
|
457
475
|
/**
|
|
458
|
-
* <p>The AWS endpoint
|
|
476
|
+
* <p>The AWS endpoint of the data store to be deleted.</p>
|
|
459
477
|
* @public
|
|
460
478
|
*/
|
|
461
479
|
DatastoreEndpoint: string | undefined;
|
|
462
480
|
}
|
|
463
481
|
/**
|
|
464
|
-
* <p>
|
|
482
|
+
* <p>The requested data store was not found.</p>
|
|
465
483
|
* @public
|
|
466
484
|
*/
|
|
467
485
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
@@ -478,7 +496,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
478
496
|
*/
|
|
479
497
|
export interface DescribeFHIRDatastoreRequest {
|
|
480
498
|
/**
|
|
481
|
-
* <p>The
|
|
499
|
+
* <p>The data store identifier.</p>
|
|
482
500
|
* @public
|
|
483
501
|
*/
|
|
484
502
|
DatastoreId: string | undefined;
|
|
@@ -488,8 +506,7 @@ export interface DescribeFHIRDatastoreRequest {
|
|
|
488
506
|
*/
|
|
489
507
|
export interface DescribeFHIRDatastoreResponse {
|
|
490
508
|
/**
|
|
491
|
-
* <p>
|
|
492
|
-
* data store name, data store status, when the data store was created, data store type version, and the data store's endpoint.</p>
|
|
509
|
+
* <p>The data store properties.</p>
|
|
493
510
|
* @public
|
|
494
511
|
*/
|
|
495
512
|
DatastoreProperties: DatastoreProperties | undefined;
|
|
@@ -499,12 +516,12 @@ export interface DescribeFHIRDatastoreResponse {
|
|
|
499
516
|
*/
|
|
500
517
|
export interface DescribeFHIRExportJobRequest {
|
|
501
518
|
/**
|
|
502
|
-
* <p>The
|
|
519
|
+
* <p>The data store identifier from which FHIR data is being exported from.</p>
|
|
503
520
|
* @public
|
|
504
521
|
*/
|
|
505
522
|
DatastoreId: string | undefined;
|
|
506
523
|
/**
|
|
507
|
-
* <p>The
|
|
524
|
+
* <p>The export job identifier.</p>
|
|
508
525
|
* @public
|
|
509
526
|
*/
|
|
510
527
|
JobId: string | undefined;
|
|
@@ -530,29 +547,25 @@ export declare const JobStatus: {
|
|
|
530
547
|
*/
|
|
531
548
|
export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
|
|
532
549
|
/**
|
|
533
|
-
* <p>
|
|
534
|
-
*
|
|
535
|
-
* </p>
|
|
550
|
+
* <p>The configuration of the S3 bucket for either an import or export job. This includes
|
|
551
|
+
* assigning access permissions.</p>
|
|
536
552
|
* @public
|
|
537
553
|
*/
|
|
538
554
|
export interface S3Configuration {
|
|
539
555
|
/**
|
|
540
|
-
* <p>
|
|
541
|
-
*
|
|
542
|
-
* </p>
|
|
556
|
+
* <p>The <code>S3Uri</code> is the user-specified S3 location of the FHIR data to be
|
|
557
|
+
* imported into AWS HealthLake.</p>
|
|
543
558
|
* @public
|
|
544
559
|
*/
|
|
545
560
|
S3Uri: string | undefined;
|
|
546
561
|
/**
|
|
547
|
-
* <p>
|
|
548
|
-
* The KMS key ID used to access the S3 bucket.
|
|
549
|
-
* </p>
|
|
562
|
+
* <p>The Key Management Service (KMS) key ID used to access the S3 bucket. </p>
|
|
550
563
|
* @public
|
|
551
564
|
*/
|
|
552
565
|
KmsKeyId: string | undefined;
|
|
553
566
|
}
|
|
554
567
|
/**
|
|
555
|
-
* <p>The output data configuration
|
|
568
|
+
* <p>The output data configuration supplied when the export job was created.</p>
|
|
556
569
|
* @public
|
|
557
570
|
*/
|
|
558
571
|
export type OutputDataConfig = OutputDataConfig.S3ConfigurationMember | OutputDataConfig.$UnknownMember;
|
|
@@ -561,9 +574,7 @@ export type OutputDataConfig = OutputDataConfig.S3ConfigurationMember | OutputDa
|
|
|
561
574
|
*/
|
|
562
575
|
export declare namespace OutputDataConfig {
|
|
563
576
|
/**
|
|
564
|
-
* <p>
|
|
565
|
-
* The output data configuration that was supplied when the export job was created.
|
|
566
|
-
* </p>
|
|
577
|
+
* <p>The output data configuration supplied when the export job was created. </p>
|
|
567
578
|
* @public
|
|
568
579
|
*/
|
|
569
580
|
interface S3ConfigurationMember {
|
|
@@ -584,52 +595,52 @@ export declare namespace OutputDataConfig {
|
|
|
584
595
|
const visit: <T>(value: OutputDataConfig, visitor: Visitor<T>) => T;
|
|
585
596
|
}
|
|
586
597
|
/**
|
|
587
|
-
* <p>The properties of a FHIR export job
|
|
598
|
+
* <p>The properties of a FHIR export job.</p>
|
|
588
599
|
* @public
|
|
589
600
|
*/
|
|
590
601
|
export interface ExportJobProperties {
|
|
591
602
|
/**
|
|
592
|
-
* <p>The
|
|
603
|
+
* <p>The export job identifier.</p>
|
|
593
604
|
* @public
|
|
594
605
|
*/
|
|
595
606
|
JobId: string | undefined;
|
|
596
607
|
/**
|
|
597
|
-
* <p>The
|
|
608
|
+
* <p>The export job name.</p>
|
|
598
609
|
* @public
|
|
599
610
|
*/
|
|
600
611
|
JobName?: string | undefined;
|
|
601
612
|
/**
|
|
602
|
-
* <p>The
|
|
613
|
+
* <p>The export job status.</p>
|
|
603
614
|
* @public
|
|
604
615
|
*/
|
|
605
616
|
JobStatus: JobStatus | undefined;
|
|
606
617
|
/**
|
|
607
|
-
* <p>The time
|
|
618
|
+
* <p>The time the export job was initiated.</p>
|
|
608
619
|
* @public
|
|
609
620
|
*/
|
|
610
621
|
SubmitTime: Date | undefined;
|
|
611
622
|
/**
|
|
612
|
-
* <p>The time
|
|
623
|
+
* <p>The time the export job completed.</p>
|
|
613
624
|
* @public
|
|
614
625
|
*/
|
|
615
626
|
EndTime?: Date | undefined;
|
|
616
627
|
/**
|
|
617
|
-
* <p>The
|
|
628
|
+
* <p>The data store identifier from which files are being exported.</p>
|
|
618
629
|
* @public
|
|
619
630
|
*/
|
|
620
631
|
DatastoreId: string | undefined;
|
|
621
632
|
/**
|
|
622
|
-
* <p>The output data configuration
|
|
633
|
+
* <p>The output data configuration supplied when the export job was created.</p>
|
|
623
634
|
* @public
|
|
624
635
|
*/
|
|
625
636
|
OutputDataConfig: OutputDataConfig | undefined;
|
|
626
637
|
/**
|
|
627
|
-
* <p>The Amazon Resource Name used during the initiation of the job.</p>
|
|
638
|
+
* <p>The Amazon Resource Name (ARN) used during the initiation of the export job.</p>
|
|
628
639
|
* @public
|
|
629
640
|
*/
|
|
630
641
|
DataAccessRoleArn?: string | undefined;
|
|
631
642
|
/**
|
|
632
|
-
* <p>An explanation of any errors that
|
|
643
|
+
* <p>An explanation of any errors that might have occurred during the export job.</p>
|
|
633
644
|
* @public
|
|
634
645
|
*/
|
|
635
646
|
Message?: string | undefined;
|
|
@@ -639,7 +650,7 @@ export interface ExportJobProperties {
|
|
|
639
650
|
*/
|
|
640
651
|
export interface DescribeFHIRExportJobResponse {
|
|
641
652
|
/**
|
|
642
|
-
* <p>
|
|
653
|
+
* <p>The export job properties.</p>
|
|
643
654
|
* @public
|
|
644
655
|
*/
|
|
645
656
|
ExportJobProperties: ExportJobProperties | undefined;
|
|
@@ -649,18 +660,18 @@ export interface DescribeFHIRExportJobResponse {
|
|
|
649
660
|
*/
|
|
650
661
|
export interface DescribeFHIRImportJobRequest {
|
|
651
662
|
/**
|
|
652
|
-
* <p>The
|
|
663
|
+
* <p>The data store identifier.</p>
|
|
653
664
|
* @public
|
|
654
665
|
*/
|
|
655
666
|
DatastoreId: string | undefined;
|
|
656
667
|
/**
|
|
657
|
-
* <p>The
|
|
668
|
+
* <p>The import job identifier.</p>
|
|
658
669
|
* @public
|
|
659
670
|
*/
|
|
660
671
|
JobId: string | undefined;
|
|
661
672
|
}
|
|
662
673
|
/**
|
|
663
|
-
* <p> The input properties
|
|
674
|
+
* <p> The import job input properties.</p>
|
|
664
675
|
* @public
|
|
665
676
|
*/
|
|
666
677
|
export type InputDataConfig = InputDataConfig.S3UriMember | InputDataConfig.$UnknownMember;
|
|
@@ -669,7 +680,8 @@ export type InputDataConfig = InputDataConfig.S3UriMember | InputDataConfig.$Unk
|
|
|
669
680
|
*/
|
|
670
681
|
export declare namespace InputDataConfig {
|
|
671
682
|
/**
|
|
672
|
-
* <p>The S3Uri is the user
|
|
683
|
+
* <p>The <code>S3Uri</code> is the user-specified S3 location of the FHIR data to be
|
|
684
|
+
* imported into AWS HealthLake.</p>
|
|
673
685
|
* @public
|
|
674
686
|
*/
|
|
675
687
|
interface S3UriMember {
|
|
@@ -690,32 +702,32 @@ export declare namespace InputDataConfig {
|
|
|
690
702
|
const visit: <T>(value: InputDataConfig, visitor: Visitor<T>) => T;
|
|
691
703
|
}
|
|
692
704
|
/**
|
|
693
|
-
* <p>The progress report
|
|
705
|
+
* <p>The progress report for the import job.</p>
|
|
694
706
|
* @public
|
|
695
707
|
*/
|
|
696
708
|
export interface JobProgressReport {
|
|
697
709
|
/**
|
|
698
|
-
* <p>The number of files scanned from
|
|
710
|
+
* <p>The number of files scanned from the S3 input bucket.</p>
|
|
699
711
|
* @public
|
|
700
712
|
*/
|
|
701
713
|
TotalNumberOfScannedFiles?: number | undefined;
|
|
702
714
|
/**
|
|
703
|
-
* <p>The size (in MB) of
|
|
715
|
+
* <p>The size (in MB) of files scanned from the S3 input bucket.</p>
|
|
704
716
|
* @public
|
|
705
717
|
*/
|
|
706
718
|
TotalSizeOfScannedFilesInMB?: number | undefined;
|
|
707
719
|
/**
|
|
708
|
-
* <p>The number of files imported
|
|
720
|
+
* <p>The number of files imported.</p>
|
|
709
721
|
* @public
|
|
710
722
|
*/
|
|
711
723
|
TotalNumberOfImportedFiles?: number | undefined;
|
|
712
724
|
/**
|
|
713
|
-
* <p>The number of resources scanned from the input
|
|
725
|
+
* <p>The number of resources scanned from the S3 input bucket.</p>
|
|
714
726
|
* @public
|
|
715
727
|
*/
|
|
716
728
|
TotalNumberOfResourcesScanned?: number | undefined;
|
|
717
729
|
/**
|
|
718
|
-
* <p>The number of resources imported
|
|
730
|
+
* <p>The number of resources imported.</p>
|
|
719
731
|
* @public
|
|
720
732
|
*/
|
|
721
733
|
TotalNumberOfResourcesImported?: number | undefined;
|
|
@@ -725,83 +737,103 @@ export interface JobProgressReport {
|
|
|
725
737
|
*/
|
|
726
738
|
TotalNumberOfResourcesWithCustomerError?: number | undefined;
|
|
727
739
|
/**
|
|
728
|
-
* <p>The number of files that failed to be read from the input
|
|
740
|
+
* <p>The number of files that failed to be read from the S3 input bucket due to customer
|
|
741
|
+
* error.</p>
|
|
729
742
|
* @public
|
|
730
743
|
*/
|
|
731
744
|
TotalNumberOfFilesReadWithCustomerError?: number | undefined;
|
|
732
745
|
/**
|
|
733
|
-
* <p>The
|
|
746
|
+
* <p>The transaction rate the import job is processed at.</p>
|
|
734
747
|
* @public
|
|
735
748
|
*/
|
|
736
749
|
Throughput?: number | undefined;
|
|
737
750
|
}
|
|
738
751
|
/**
|
|
739
|
-
*
|
|
752
|
+
* @public
|
|
753
|
+
* @enum
|
|
754
|
+
*/
|
|
755
|
+
export declare const ValidationLevel: {
|
|
756
|
+
readonly MINIMAL: "minimal";
|
|
757
|
+
readonly STRICT: "strict";
|
|
758
|
+
readonly STRUCTURE_ONLY: "structure-only";
|
|
759
|
+
};
|
|
760
|
+
/**
|
|
761
|
+
* @public
|
|
762
|
+
*/
|
|
763
|
+
export type ValidationLevel = (typeof ValidationLevel)[keyof typeof ValidationLevel];
|
|
764
|
+
/**
|
|
765
|
+
* <p>The import job properties.</p>
|
|
740
766
|
* @public
|
|
741
767
|
*/
|
|
742
768
|
export interface ImportJobProperties {
|
|
743
769
|
/**
|
|
744
|
-
* <p>The
|
|
770
|
+
* <p>The import job identifier.</p>
|
|
745
771
|
* @public
|
|
746
772
|
*/
|
|
747
773
|
JobId: string | undefined;
|
|
748
774
|
/**
|
|
749
|
-
* <p>The
|
|
775
|
+
* <p>The import job name.</p>
|
|
750
776
|
* @public
|
|
751
777
|
*/
|
|
752
778
|
JobName?: string | undefined;
|
|
753
779
|
/**
|
|
754
|
-
* <p>The job status
|
|
780
|
+
* <p>The import job status.</p>
|
|
755
781
|
* @public
|
|
756
782
|
*/
|
|
757
783
|
JobStatus: JobStatus | undefined;
|
|
758
784
|
/**
|
|
759
|
-
* <p>The time
|
|
785
|
+
* <p>The time the import job was submitted for processing.</p>
|
|
760
786
|
* @public
|
|
761
787
|
*/
|
|
762
788
|
SubmitTime: Date | undefined;
|
|
763
789
|
/**
|
|
764
|
-
* <p>The time
|
|
790
|
+
* <p>The time the import job was completed.</p>
|
|
765
791
|
* @public
|
|
766
792
|
*/
|
|
767
793
|
EndTime?: Date | undefined;
|
|
768
794
|
/**
|
|
769
|
-
* <p>The
|
|
795
|
+
* <p>The data store identifier. </p>
|
|
770
796
|
* @public
|
|
771
797
|
*/
|
|
772
798
|
DatastoreId: string | undefined;
|
|
773
799
|
/**
|
|
774
|
-
* <p>The input data configuration
|
|
800
|
+
* <p>The input data configuration supplied when the import job was created.</p>
|
|
775
801
|
* @public
|
|
776
802
|
*/
|
|
777
803
|
InputDataConfig: InputDataConfig | undefined;
|
|
778
804
|
/**
|
|
779
|
-
* <p>The output data configuration
|
|
805
|
+
* <p>The output data configuration supplied when the export job was created.</p>
|
|
780
806
|
* @public
|
|
781
807
|
*/
|
|
782
808
|
JobOutputDataConfig?: OutputDataConfig | undefined;
|
|
783
809
|
/**
|
|
784
|
-
* <p>Displays the progress of the import job, including total resources scanned, total
|
|
810
|
+
* <p>Displays the progress of the import job, including total resources scanned, total
|
|
811
|
+
* resources imported, and total size of data imported.</p>
|
|
785
812
|
* @public
|
|
786
813
|
*/
|
|
787
814
|
JobProgressReport?: JobProgressReport | undefined;
|
|
788
815
|
/**
|
|
789
|
-
* <p>The Amazon Resource Name (ARN) that
|
|
816
|
+
* <p>The Amazon Resource Name (ARN) that grants AWS HealthLake access to the input data.</p>
|
|
790
817
|
* @public
|
|
791
818
|
*/
|
|
792
819
|
DataAccessRoleArn?: string | undefined;
|
|
793
820
|
/**
|
|
794
|
-
* <p>An explanation of any errors that
|
|
821
|
+
* <p>An explanation of any errors that might have occurred during the FHIR import job.</p>
|
|
795
822
|
* @public
|
|
796
823
|
*/
|
|
797
824
|
Message?: string | undefined;
|
|
825
|
+
/**
|
|
826
|
+
* <p>The validation level of the import job.</p>
|
|
827
|
+
* @public
|
|
828
|
+
*/
|
|
829
|
+
ValidationLevel?: ValidationLevel | undefined;
|
|
798
830
|
}
|
|
799
831
|
/**
|
|
800
832
|
* @public
|
|
801
833
|
*/
|
|
802
834
|
export interface DescribeFHIRImportJobResponse {
|
|
803
835
|
/**
|
|
804
|
-
* <p>The
|
|
836
|
+
* <p>The import job properties.</p>
|
|
805
837
|
* @public
|
|
806
838
|
*/
|
|
807
839
|
ImportJobProperties: ImportJobProperties | undefined;
|
|
@@ -811,17 +843,18 @@ export interface DescribeFHIRImportJobResponse {
|
|
|
811
843
|
*/
|
|
812
844
|
export interface ListFHIRDatastoresRequest {
|
|
813
845
|
/**
|
|
814
|
-
* <p>
|
|
846
|
+
* <p>List all filters associated with a FHIR data store request.</p>
|
|
815
847
|
* @public
|
|
816
848
|
*/
|
|
817
849
|
Filter?: DatastoreFilter | undefined;
|
|
818
850
|
/**
|
|
819
|
-
* <p>
|
|
851
|
+
* <p>The token used to retrieve the next page of data stores when results are
|
|
852
|
+
* paginated.</p>
|
|
820
853
|
* @public
|
|
821
854
|
*/
|
|
822
855
|
NextToken?: string | undefined;
|
|
823
856
|
/**
|
|
824
|
-
* <p>The maximum number of data stores returned
|
|
857
|
+
* <p>The maximum number of data stores returned on a page.</p>
|
|
825
858
|
* @public
|
|
826
859
|
*/
|
|
827
860
|
MaxResults?: number | undefined;
|
|
@@ -831,12 +864,12 @@ export interface ListFHIRDatastoresRequest {
|
|
|
831
864
|
*/
|
|
832
865
|
export interface ListFHIRDatastoresResponse {
|
|
833
866
|
/**
|
|
834
|
-
* <p>
|
|
867
|
+
* <p>The properties associated with all listed data stores.</p>
|
|
835
868
|
* @public
|
|
836
869
|
*/
|
|
837
870
|
DatastorePropertiesList: DatastoreProperties[] | undefined;
|
|
838
871
|
/**
|
|
839
|
-
* <p>
|
|
872
|
+
* <p>The pagination token used to retrieve the next page of results.</p>
|
|
840
873
|
* @public
|
|
841
874
|
*/
|
|
842
875
|
NextToken?: string | undefined;
|
|
@@ -846,51 +879,38 @@ export interface ListFHIRDatastoresResponse {
|
|
|
846
879
|
*/
|
|
847
880
|
export interface ListFHIRExportJobsRequest {
|
|
848
881
|
/**
|
|
849
|
-
* <p>
|
|
850
|
-
* This parameter limits the response to the export job with the specified data store ID.
|
|
851
|
-
* </p>
|
|
882
|
+
* <p>Limits the response to the export job with the specified data store ID. </p>
|
|
852
883
|
* @public
|
|
853
884
|
*/
|
|
854
885
|
DatastoreId: string | undefined;
|
|
855
886
|
/**
|
|
856
|
-
* <p>
|
|
857
|
-
* A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query.
|
|
858
|
-
* </p>
|
|
887
|
+
* <p>A pagination token used to identify the next page of results to return.</p>
|
|
859
888
|
* @public
|
|
860
889
|
*/
|
|
861
890
|
NextToken?: string | undefined;
|
|
862
891
|
/**
|
|
863
|
-
* <p>
|
|
864
|
-
*
|
|
865
|
-
* </p>
|
|
892
|
+
* <p>Limits the number of results returned for a ListFHIRExportJobs to a maximum quantity
|
|
893
|
+
* specified by the user.</p>
|
|
866
894
|
* @public
|
|
867
895
|
*/
|
|
868
896
|
MaxResults?: number | undefined;
|
|
869
897
|
/**
|
|
870
|
-
* <p>
|
|
871
|
-
* This parameter limits the response to the export job with the specified job name.
|
|
872
|
-
* </p>
|
|
898
|
+
* <p>Limits the response to the export job with the specified job name. </p>
|
|
873
899
|
* @public
|
|
874
900
|
*/
|
|
875
901
|
JobName?: string | undefined;
|
|
876
902
|
/**
|
|
877
|
-
* <p>
|
|
878
|
-
* This parameter limits the response to the export jobs with the specified job status.
|
|
879
|
-
* </p>
|
|
903
|
+
* <p>Limits the response to export jobs with the specified job status. </p>
|
|
880
904
|
* @public
|
|
881
905
|
*/
|
|
882
906
|
JobStatus?: JobStatus | undefined;
|
|
883
907
|
/**
|
|
884
|
-
* <p>
|
|
885
|
-
* This parameter limits the response to FHIR export jobs submitted before a user specified date.
|
|
886
|
-
* </p>
|
|
908
|
+
* <p>Limits the response to FHIR export jobs submitted before a user- specified date.</p>
|
|
887
909
|
* @public
|
|
888
910
|
*/
|
|
889
911
|
SubmittedBefore?: Date | undefined;
|
|
890
912
|
/**
|
|
891
|
-
* <p>
|
|
892
|
-
* This parameter limits the response to FHIR export jobs submitted after a user specified date.
|
|
893
|
-
* </p>
|
|
913
|
+
* <p>Limits the response to FHIR export jobs submitted after a user-specified date.</p>
|
|
894
914
|
* @public
|
|
895
915
|
*/
|
|
896
916
|
SubmittedAfter?: Date | undefined;
|
|
@@ -900,16 +920,12 @@ export interface ListFHIRExportJobsRequest {
|
|
|
900
920
|
*/
|
|
901
921
|
export interface ListFHIRExportJobsResponse {
|
|
902
922
|
/**
|
|
903
|
-
* <p>
|
|
904
|
-
* The properties of listed FHIR export jobs, including the ID, ARN, name, and the status of the job.
|
|
905
|
-
* </p>
|
|
923
|
+
* <p>The properties of listed FHIR export jobs.</p>
|
|
906
924
|
* @public
|
|
907
925
|
*/
|
|
908
926
|
ExportJobPropertiesList: ExportJobProperties[] | undefined;
|
|
909
927
|
/**
|
|
910
|
-
* <p>
|
|
911
|
-
* A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query.
|
|
912
|
-
* </p>
|
|
928
|
+
* <p>The pagination token used to identify the next page of results to return.</p>
|
|
913
929
|
* @public
|
|
914
930
|
*/
|
|
915
931
|
NextToken?: string | undefined;
|
|
@@ -919,51 +935,38 @@ export interface ListFHIRExportJobsResponse {
|
|
|
919
935
|
*/
|
|
920
936
|
export interface ListFHIRImportJobsRequest {
|
|
921
937
|
/**
|
|
922
|
-
* <p>
|
|
923
|
-
* This parameter limits the response to the import job with the specified data store ID.
|
|
924
|
-
* </p>
|
|
938
|
+
* <p>Limits the response to the import job with the specified data store ID. </p>
|
|
925
939
|
* @public
|
|
926
940
|
*/
|
|
927
941
|
DatastoreId: string | undefined;
|
|
928
942
|
/**
|
|
929
|
-
* <p>
|
|
930
|
-
* A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query.
|
|
931
|
-
* </p>
|
|
943
|
+
* <p>The pagination token used to identify the next page of results to return.</p>
|
|
932
944
|
* @public
|
|
933
945
|
*/
|
|
934
946
|
NextToken?: string | undefined;
|
|
935
947
|
/**
|
|
936
|
-
* <p>
|
|
937
|
-
*
|
|
938
|
-
* </p>
|
|
948
|
+
* <p>Limits the number of results returned for <code>ListFHIRImportJobs</code> to a maximum
|
|
949
|
+
* quantity specified by the user.</p>
|
|
939
950
|
* @public
|
|
940
951
|
*/
|
|
941
952
|
MaxResults?: number | undefined;
|
|
942
953
|
/**
|
|
943
|
-
* <p>
|
|
944
|
-
* This parameter limits the response to the import job with the specified job name.
|
|
945
|
-
* </p>
|
|
954
|
+
* <p>Limits the response to the import job with the specified job name. </p>
|
|
946
955
|
* @public
|
|
947
956
|
*/
|
|
948
957
|
JobName?: string | undefined;
|
|
949
958
|
/**
|
|
950
|
-
* <p>
|
|
951
|
-
* This parameter limits the response to the import job with the specified job status.
|
|
952
|
-
* </p>
|
|
959
|
+
* <p>Limits the response to the import job with the specified job status. </p>
|
|
953
960
|
* @public
|
|
954
961
|
*/
|
|
955
962
|
JobStatus?: JobStatus | undefined;
|
|
956
963
|
/**
|
|
957
|
-
* <p>
|
|
958
|
-
* This parameter limits the response to FHIR import jobs submitted before a user specified date.
|
|
959
|
-
* </p>
|
|
964
|
+
* <p>Limits the response to FHIR import jobs submitted before a user- specified date. </p>
|
|
960
965
|
* @public
|
|
961
966
|
*/
|
|
962
967
|
SubmittedBefore?: Date | undefined;
|
|
963
968
|
/**
|
|
964
|
-
* <p>
|
|
965
|
-
* This parameter limits the response to FHIR import jobs submitted after a user specified date.
|
|
966
|
-
* </p>
|
|
969
|
+
* <p>Limits the response to FHIR import jobs submitted after a user-specified date.</p>
|
|
967
970
|
* @public
|
|
968
971
|
*/
|
|
969
972
|
SubmittedAfter?: Date | undefined;
|
|
@@ -973,16 +976,12 @@ export interface ListFHIRImportJobsRequest {
|
|
|
973
976
|
*/
|
|
974
977
|
export interface ListFHIRImportJobsResponse {
|
|
975
978
|
/**
|
|
976
|
-
* <p>
|
|
977
|
-
* The properties of a listed FHIR import jobs, including the ID, ARN, name, the status of the job, and the progress report of the job.
|
|
978
|
-
* </p>
|
|
979
|
+
* <p>The properties for listed import jobs.</p>
|
|
979
980
|
* @public
|
|
980
981
|
*/
|
|
981
982
|
ImportJobPropertiesList: ImportJobProperties[] | undefined;
|
|
982
983
|
/**
|
|
983
|
-
* <p>
|
|
984
|
-
* A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query.
|
|
985
|
-
* </p>
|
|
984
|
+
* <p>The pagination token used to identify the next page of results to return.</p>
|
|
986
985
|
* @public
|
|
987
986
|
*/
|
|
988
987
|
NextToken?: string | undefined;
|
|
@@ -992,9 +991,7 @@ export interface ListFHIRImportJobsResponse {
|
|
|
992
991
|
*/
|
|
993
992
|
export interface ListTagsForResourceRequest {
|
|
994
993
|
/**
|
|
995
|
-
* <p>
|
|
996
|
-
* The Amazon Resource Name(ARN) of the data store for which tags are being added.
|
|
997
|
-
* </p>
|
|
994
|
+
* <p>The Amazon Resource Name (ARN) of the data store to which tags are being added.</p>
|
|
998
995
|
* @public
|
|
999
996
|
*/
|
|
1000
997
|
ResourceARN: string | undefined;
|
|
@@ -1004,9 +1001,7 @@ export interface ListTagsForResourceRequest {
|
|
|
1004
1001
|
*/
|
|
1005
1002
|
export interface ListTagsForResourceResponse {
|
|
1006
1003
|
/**
|
|
1007
|
-
* <p>
|
|
1008
|
-
* Returns a list of tags associated with a data store.
|
|
1009
|
-
* </p>
|
|
1004
|
+
* <p>Returns a list of tags associated with a data store. </p>
|
|
1010
1005
|
* @public
|
|
1011
1006
|
*/
|
|
1012
1007
|
Tags?: Tag[] | undefined;
|
|
@@ -1016,27 +1011,27 @@ export interface ListTagsForResourceResponse {
|
|
|
1016
1011
|
*/
|
|
1017
1012
|
export interface StartFHIRExportJobRequest {
|
|
1018
1013
|
/**
|
|
1019
|
-
* <p>The
|
|
1014
|
+
* <p>The export job name.</p>
|
|
1020
1015
|
* @public
|
|
1021
1016
|
*/
|
|
1022
1017
|
JobName?: string | undefined;
|
|
1023
1018
|
/**
|
|
1024
|
-
* <p>The output data configuration
|
|
1019
|
+
* <p>The output data configuration supplied when the export job was started.</p>
|
|
1025
1020
|
* @public
|
|
1026
1021
|
*/
|
|
1027
1022
|
OutputDataConfig: OutputDataConfig | undefined;
|
|
1028
1023
|
/**
|
|
1029
|
-
* <p>The
|
|
1024
|
+
* <p>The data store identifier from which files are being exported.</p>
|
|
1030
1025
|
* @public
|
|
1031
1026
|
*/
|
|
1032
1027
|
DatastoreId: string | undefined;
|
|
1033
1028
|
/**
|
|
1034
|
-
* <p>The Amazon Resource Name used during
|
|
1029
|
+
* <p>The Amazon Resource Name (ARN) used during initiation of the export job.</p>
|
|
1035
1030
|
* @public
|
|
1036
1031
|
*/
|
|
1037
1032
|
DataAccessRoleArn: string | undefined;
|
|
1038
1033
|
/**
|
|
1039
|
-
* <p>An optional user provided token used for ensuring idempotency.</p>
|
|
1034
|
+
* <p>An optional user provided token used for ensuring API idempotency.</p>
|
|
1040
1035
|
* @public
|
|
1041
1036
|
*/
|
|
1042
1037
|
ClientToken?: string | undefined;
|
|
@@ -1046,17 +1041,17 @@ export interface StartFHIRExportJobRequest {
|
|
|
1046
1041
|
*/
|
|
1047
1042
|
export interface StartFHIRExportJobResponse {
|
|
1048
1043
|
/**
|
|
1049
|
-
* <p>The
|
|
1044
|
+
* <p>The export job identifier.</p>
|
|
1050
1045
|
* @public
|
|
1051
1046
|
*/
|
|
1052
1047
|
JobId: string | undefined;
|
|
1053
1048
|
/**
|
|
1054
|
-
* <p>The
|
|
1049
|
+
* <p>The export job status.</p>
|
|
1055
1050
|
* @public
|
|
1056
1051
|
*/
|
|
1057
1052
|
JobStatus: JobStatus | undefined;
|
|
1058
1053
|
/**
|
|
1059
|
-
* <p>The
|
|
1054
|
+
* <p>The data store identifier from which files are being exported.</p>
|
|
1060
1055
|
* @public
|
|
1061
1056
|
*/
|
|
1062
1057
|
DatastoreId?: string | undefined;
|
|
@@ -1066,52 +1061,57 @@ export interface StartFHIRExportJobResponse {
|
|
|
1066
1061
|
*/
|
|
1067
1062
|
export interface StartFHIRImportJobRequest {
|
|
1068
1063
|
/**
|
|
1069
|
-
* <p>The
|
|
1064
|
+
* <p>The import job name.</p>
|
|
1070
1065
|
* @public
|
|
1071
1066
|
*/
|
|
1072
1067
|
JobName?: string | undefined;
|
|
1073
1068
|
/**
|
|
1074
|
-
* <p>The input properties
|
|
1069
|
+
* <p>The input properties for the import job request.</p>
|
|
1075
1070
|
* @public
|
|
1076
1071
|
*/
|
|
1077
1072
|
InputDataConfig: InputDataConfig | undefined;
|
|
1078
1073
|
/**
|
|
1079
|
-
* <p>The output data configuration
|
|
1074
|
+
* <p>The output data configuration supplied when the export job was created.</p>
|
|
1080
1075
|
* @public
|
|
1081
1076
|
*/
|
|
1082
1077
|
JobOutputDataConfig: OutputDataConfig | undefined;
|
|
1083
1078
|
/**
|
|
1084
|
-
* <p>The
|
|
1079
|
+
* <p>The data store identifier.</p>
|
|
1085
1080
|
* @public
|
|
1086
1081
|
*/
|
|
1087
1082
|
DatastoreId: string | undefined;
|
|
1088
1083
|
/**
|
|
1089
|
-
* <p>The Amazon Resource Name (ARN) that
|
|
1084
|
+
* <p>The Amazon Resource Name (ARN) that grants access permission to AWS HealthLake.</p>
|
|
1090
1085
|
* @public
|
|
1091
1086
|
*/
|
|
1092
1087
|
DataAccessRoleArn: string | undefined;
|
|
1093
1088
|
/**
|
|
1094
|
-
* <p>
|
|
1089
|
+
* <p>The optional user-provided token used for ensuring API idempotency.</p>
|
|
1095
1090
|
* @public
|
|
1096
1091
|
*/
|
|
1097
1092
|
ClientToken?: string | undefined;
|
|
1093
|
+
/**
|
|
1094
|
+
* <p>The validation level of the import job.</p>
|
|
1095
|
+
* @public
|
|
1096
|
+
*/
|
|
1097
|
+
ValidationLevel?: ValidationLevel | undefined;
|
|
1098
1098
|
}
|
|
1099
1099
|
/**
|
|
1100
1100
|
* @public
|
|
1101
1101
|
*/
|
|
1102
1102
|
export interface StartFHIRImportJobResponse {
|
|
1103
1103
|
/**
|
|
1104
|
-
* <p>The
|
|
1104
|
+
* <p>The import job identifier.</p>
|
|
1105
1105
|
* @public
|
|
1106
1106
|
*/
|
|
1107
1107
|
JobId: string | undefined;
|
|
1108
1108
|
/**
|
|
1109
|
-
* <p>The
|
|
1109
|
+
* <p>The import job status.</p>
|
|
1110
1110
|
* @public
|
|
1111
1111
|
*/
|
|
1112
1112
|
JobStatus: JobStatus | undefined;
|
|
1113
1113
|
/**
|
|
1114
|
-
* <p>The
|
|
1114
|
+
* <p>The data store identifier.</p>
|
|
1115
1115
|
* @public
|
|
1116
1116
|
*/
|
|
1117
1117
|
DatastoreId?: string | undefined;
|
|
@@ -1121,16 +1121,12 @@ export interface StartFHIRImportJobResponse {
|
|
|
1121
1121
|
*/
|
|
1122
1122
|
export interface TagResourceRequest {
|
|
1123
1123
|
/**
|
|
1124
|
-
* <p>
|
|
1125
|
-
* The Amazon Resource Name(ARN)that gives AWS HealthLake access to the data store which tags are being added to.
|
|
1126
|
-
* </p>
|
|
1124
|
+
* <p>The Amazon Resource Name (ARN) that grants access to the data store tags are being added to.</p>
|
|
1127
1125
|
* @public
|
|
1128
1126
|
*/
|
|
1129
1127
|
ResourceARN: string | undefined;
|
|
1130
1128
|
/**
|
|
1131
|
-
* <p>
|
|
1132
|
-
* The user specified key and value pair tags being added to a data store.
|
|
1133
|
-
* </p>
|
|
1129
|
+
* <p>The user-specified key and value pair tags being added to a data store.</p>
|
|
1134
1130
|
* @public
|
|
1135
1131
|
*/
|
|
1136
1132
|
Tags: Tag[] | undefined;
|
|
@@ -1145,14 +1141,12 @@ export interface TagResourceResponse {
|
|
|
1145
1141
|
*/
|
|
1146
1142
|
export interface UntagResourceRequest {
|
|
1147
1143
|
/**
|
|
1148
|
-
* <p>The Amazon Resource Name(ARN) of the data store
|
|
1144
|
+
* <p>The Amazon Resource Name (ARN) of the data store from which tags are being removed.</p>
|
|
1149
1145
|
* @public
|
|
1150
1146
|
*/
|
|
1151
1147
|
ResourceARN: string | undefined;
|
|
1152
1148
|
/**
|
|
1153
|
-
* <p>
|
|
1154
|
-
* The keys for the tags to be removed from the HealthLake data store.
|
|
1155
|
-
* </p>
|
|
1149
|
+
* <p>The keys for the tags to be removed from the data store.</p>
|
|
1156
1150
|
* @public
|
|
1157
1151
|
*/
|
|
1158
1152
|
TagKeys: string[] | undefined;
|