@aws-sdk/client-healthlake 3.533.0 → 3.535.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.
Files changed (31) hide show
  1. package/dist-types/HealthLake.d.ts +2 -1
  2. package/dist-types/HealthLakeClient.d.ts +1 -1
  3. package/dist-types/commands/CreateFHIRDatastoreCommand.d.ts +2 -1
  4. package/dist-types/commands/DeleteFHIRDatastoreCommand.d.ts +2 -1
  5. package/dist-types/commands/DescribeFHIRDatastoreCommand.d.ts +2 -1
  6. package/dist-types/commands/DescribeFHIRExportJobCommand.d.ts +2 -1
  7. package/dist-types/commands/DescribeFHIRImportJobCommand.d.ts +2 -1
  8. package/dist-types/commands/ListFHIRDatastoresCommand.d.ts +2 -1
  9. package/dist-types/commands/ListFHIRExportJobsCommand.d.ts +2 -1
  10. package/dist-types/commands/ListFHIRImportJobsCommand.d.ts +2 -1
  11. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  12. package/dist-types/commands/StartFHIRExportJobCommand.d.ts +2 -1
  13. package/dist-types/commands/StartFHIRImportJobCommand.d.ts +2 -1
  14. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  15. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  16. package/dist-types/models/models_0.d.ts +145 -145
  17. package/dist-types/ts3.4/HealthLake.d.ts +1 -0
  18. package/dist-types/ts3.4/commands/CreateFHIRDatastoreCommand.d.ts +9 -0
  19. package/dist-types/ts3.4/commands/DeleteFHIRDatastoreCommand.d.ts +9 -0
  20. package/dist-types/ts3.4/commands/DescribeFHIRDatastoreCommand.d.ts +9 -0
  21. package/dist-types/ts3.4/commands/DescribeFHIRExportJobCommand.d.ts +9 -0
  22. package/dist-types/ts3.4/commands/DescribeFHIRImportJobCommand.d.ts +9 -0
  23. package/dist-types/ts3.4/commands/ListFHIRDatastoresCommand.d.ts +9 -0
  24. package/dist-types/ts3.4/commands/ListFHIRExportJobsCommand.d.ts +9 -0
  25. package/dist-types/ts3.4/commands/ListFHIRImportJobsCommand.d.ts +9 -0
  26. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  27. package/dist-types/ts3.4/commands/StartFHIRExportJobCommand.d.ts +9 -0
  28. package/dist-types/ts3.4/commands/StartFHIRImportJobCommand.d.ts +9 -0
  29. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  30. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  31. package/package.json +40 -40
@@ -1,8 +1,8 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { HealthLakeServiceException as __BaseException } from "./HealthLakeServiceException";
3
3
  /**
4
- * @public
5
4
  * <p>Access is denied. Your account is not authorized to perform this operation.</p>
5
+ * @public
6
6
  */
7
7
  export declare class AccessDeniedException extends __BaseException {
8
8
  readonly name: "AccessDeniedException";
@@ -38,8 +38,8 @@ export declare const CmkType: {
38
38
  */
39
39
  export type CmkType = (typeof CmkType)[keyof typeof CmkType];
40
40
  /**
41
- * @public
42
41
  * <p>The data store is in a transition state and the user requested action can not be performed.</p>
42
+ * @public
43
43
  */
44
44
  export declare class ConflictException extends __BaseException {
45
45
  readonly name: "ConflictException";
@@ -62,22 +62,21 @@ export declare const FHIRVersion: {
62
62
  */
63
63
  export type FHIRVersion = (typeof FHIRVersion)[keyof typeof FHIRVersion];
64
64
  /**
65
- * @public
66
65
  * <p>The identity provider configuration that you gave when the data store was created.</p>
66
+ * @public
67
67
  */
68
68
  export interface IdentityProviderConfiguration {
69
69
  /**
70
- * @public
71
70
  * <p>The authorization strategy that you selected when you created the data store.</p>
71
+ * @public
72
72
  */
73
73
  AuthorizationStrategy: AuthorizationStrategy | undefined;
74
74
  /**
75
- * @public
76
75
  * <p>If you enabled fine-grained authorization when you created the data store.</p>
76
+ * @public
77
77
  */
78
78
  FineGrainedAuthorizationEnabled?: boolean;
79
79
  /**
80
- * @public
81
80
  * <p>The JSON metadata elements that you want to use in your identity provider configuration. Required elements are listed based on the launch specification of the SMART application. For more 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
81
  * <p>
83
82
  * <code>authorization_endpoint</code>: The URL to the OAuth2 authorization endpoint.</p>
@@ -89,11 +88,12 @@ export interface IdentityProviderConfiguration {
89
88
  * <code>capabilities</code>: An array of strings of the SMART capabilities that the authorization server supports.</p>
90
89
  * <p>
91
90
  * <code>code_challenge_methods_supported</code>: An array of strings of supported PKCE code challenge methods. You must include the <code>S256</code> method in the array of PKCE code challenge methods.</p>
91
+ * @public
92
92
  */
93
93
  Metadata?: string;
94
94
  /**
95
- * @public
96
95
  * <p>The Amazon Resource Name (ARN) of the Lambda function that you want to use to decode the access token created by the authorization server.</p>
96
+ * @public
97
97
  */
98
98
  IdpLambdaArn?: string;
99
99
  }
@@ -109,72 +109,72 @@ export declare const PreloadDataType: {
109
109
  */
110
110
  export type PreloadDataType = (typeof PreloadDataType)[keyof typeof PreloadDataType];
111
111
  /**
112
- * @public
113
112
  * <p> The input properties for the preloaded data store. Only data preloaded from Synthea is supported.</p>
113
+ * @public
114
114
  */
115
115
  export interface PreloadDataConfig {
116
116
  /**
117
- * @public
118
117
  * <p>The type of preloaded data. Only Synthea preloaded data is supported.</p>
118
+ * @public
119
119
  */
120
120
  PreloadDataType: PreloadDataType | undefined;
121
121
  }
122
122
  /**
123
- * @public
124
123
  * <p>
125
124
  * The customer-managed-key(CMK) used when creating a data store. If a customer owned key is not specified, an AWS owned key will be used for encryption.
126
125
  * </p>
126
+ * @public
127
127
  */
128
128
  export interface KmsEncryptionConfig {
129
129
  /**
130
- * @public
131
130
  * <p>
132
131
  * 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
132
  * </p>
133
+ * @public
134
134
  */
135
135
  CmkType: CmkType | undefined;
136
136
  /**
137
- * @public
138
137
  * <p>
139
138
  * The KMS encryption key id/alias used to encrypt the data store contents at rest.
140
139
  * </p>
140
+ * @public
141
141
  */
142
142
  KmsKeyId?: string;
143
143
  }
144
144
  /**
145
- * @public
146
145
  * <p>
147
146
  * The server-side encryption key configuration for a customer provided encryption key.
148
147
  * </p>
148
+ * @public
149
149
  */
150
150
  export interface SseConfiguration {
151
151
  /**
152
- * @public
153
152
  * <p>
154
153
  * The KMS encryption configuration used to provide details for data encryption.
155
154
  * </p>
155
+ * @public
156
156
  */
157
157
  KmsEncryptionConfig: KmsEncryptionConfig | undefined;
158
158
  }
159
159
  /**
160
- * @public
161
160
  * <p>
162
161
  * A tag is a label consisting of a user-defined key and value. The form for tags is \{"Key", "Value"\}
163
162
  * </p>
163
+ * @public
164
164
  */
165
165
  export interface Tag {
166
166
  /**
167
- * @public
168
167
  * <p>
169
168
  * The key portion of a tag. Tag keys are case sensitive.
170
169
  * </p>
170
+ * @public
171
171
  */
172
172
  Key: string | undefined;
173
173
  /**
174
- * @public
175
174
  * <p>
176
175
  * The value portion of a tag. Tag values are case sensitive.
177
176
  * </p>
177
+ * @public
178
178
  */
179
179
  Value: string | undefined;
180
180
  }
@@ -183,43 +183,43 @@ export interface Tag {
183
183
  */
184
184
  export interface CreateFHIRDatastoreRequest {
185
185
  /**
186
- * @public
187
186
  * <p>The user generated name for the data store.</p>
187
+ * @public
188
188
  */
189
189
  DatastoreName?: string;
190
190
  /**
191
- * @public
192
191
  * <p>The FHIR version of the data store. The only supported version is R4.</p>
192
+ * @public
193
193
  */
194
194
  DatastoreTypeVersion: FHIRVersion | undefined;
195
195
  /**
196
- * @public
197
196
  * <p>
198
197
  * The server-side encryption key configuration for a customer provided encryption key specified for creating a data store.
199
198
  * </p>
199
+ * @public
200
200
  */
201
201
  SseConfiguration?: SseConfiguration;
202
202
  /**
203
- * @public
204
203
  * <p>Optional parameter to preload data upon creation of the data store. Currently, the only
205
204
  * supported preloaded data is synthetic data generated from Synthea.</p>
205
+ * @public
206
206
  */
207
207
  PreloadDataConfig?: PreloadDataConfig;
208
208
  /**
209
- * @public
210
209
  * <p>Optional user provided token used for ensuring idempotency.</p>
210
+ * @public
211
211
  */
212
212
  ClientToken?: string;
213
213
  /**
214
- * @public
215
214
  * <p>
216
215
  * Resource tags that are applied to a data store when it is created.
217
216
  * </p>
217
+ * @public
218
218
  */
219
219
  Tags?: Tag[];
220
220
  /**
221
- * @public
222
221
  * <p>The configuration of the identity provider that you want to use for your data store.</p>
222
+ * @public
223
223
  */
224
224
  IdentityProviderConfiguration?: IdentityProviderConfiguration;
225
225
  }
@@ -242,31 +242,31 @@ export type DatastoreStatus = (typeof DatastoreStatus)[keyof typeof DatastoreSta
242
242
  */
243
243
  export interface CreateFHIRDatastoreResponse {
244
244
  /**
245
- * @public
246
245
  * <p>The AWS-generated data store id. This id is in the output from the initial data store
247
246
  * creation call.</p>
247
+ * @public
248
248
  */
249
249
  DatastoreId: string | undefined;
250
250
  /**
251
- * @public
252
251
  * <p>The data store ARN is generated during the creation of the data store and can be found in
253
252
  * the output from the initial data store creation call.</p>
253
+ * @public
254
254
  */
255
255
  DatastoreArn: string | undefined;
256
256
  /**
257
- * @public
258
257
  * <p>The status of the FHIR data store.</p>
258
+ * @public
259
259
  */
260
260
  DatastoreStatus: DatastoreStatus | undefined;
261
261
  /**
262
- * @public
263
262
  * <p>The AWS endpoint for the created data store.</p>
263
+ * @public
264
264
  */
265
265
  DatastoreEndpoint: string | undefined;
266
266
  }
267
267
  /**
268
- * @public
269
268
  * <p>Unknown error occurs in the service.</p>
269
+ * @public
270
270
  */
271
271
  export declare class InternalServerException extends __BaseException {
272
272
  readonly name: "InternalServerException";
@@ -278,8 +278,8 @@ export declare class InternalServerException extends __BaseException {
278
278
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
279
279
  }
280
280
  /**
281
- * @public
282
281
  * <p>The user has exceeded their maximum number of allowed calls to the given API. </p>
282
+ * @public
283
283
  */
284
284
  export declare class ThrottlingException extends __BaseException {
285
285
  readonly name: "ThrottlingException";
@@ -291,8 +291,8 @@ export declare class ThrottlingException extends __BaseException {
291
291
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
292
292
  }
293
293
  /**
294
- * @public
295
294
  * <p>The user input parameter was invalid.</p>
295
+ * @public
296
296
  */
297
297
  export declare class ValidationException extends __BaseException {
298
298
  readonly name: "ValidationException";
@@ -304,88 +304,88 @@ export declare class ValidationException extends __BaseException {
304
304
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
305
305
  }
306
306
  /**
307
- * @public
308
307
  * <p>The filters applied to data store query.</p>
308
+ * @public
309
309
  */
310
310
  export interface DatastoreFilter {
311
311
  /**
312
- * @public
313
312
  * <p>Allows the user to filter data store results by name.</p>
313
+ * @public
314
314
  */
315
315
  DatastoreName?: string;
316
316
  /**
317
- * @public
318
317
  * <p>Allows the user to filter data store results by status.</p>
318
+ * @public
319
319
  */
320
320
  DatastoreStatus?: DatastoreStatus;
321
321
  /**
322
- * @public
323
322
  * <p>A filter that allows the user to set cutoff dates for records. All data stores created
324
323
  * before the specified date will be included in the results. </p>
324
+ * @public
325
325
  */
326
326
  CreatedBefore?: Date;
327
327
  /**
328
- * @public
329
328
  * <p>A filter that allows the user to set cutoff dates for records. All data stores created
330
329
  * after the specified date will be included in the results.</p>
330
+ * @public
331
331
  */
332
332
  CreatedAfter?: Date;
333
333
  }
334
334
  /**
335
- * @public
336
335
  * <p>Displays the properties of the data store, including the ID, ARN, name, and the status of the data store.</p>
336
+ * @public
337
337
  */
338
338
  export interface DatastoreProperties {
339
339
  /**
340
- * @public
341
340
  * <p>The AWS-generated ID number for the data store.</p>
341
+ * @public
342
342
  */
343
343
  DatastoreId: string | undefined;
344
344
  /**
345
- * @public
346
345
  * <p>The Amazon Resource Name used in the creation of the data store.</p>
346
+ * @public
347
347
  */
348
348
  DatastoreArn: string | undefined;
349
349
  /**
350
- * @public
351
350
  * <p>The user-generated name for the data store.</p>
351
+ * @public
352
352
  */
353
353
  DatastoreName?: string;
354
354
  /**
355
- * @public
356
355
  * <p>The status of the data store.</p>
356
+ * @public
357
357
  */
358
358
  DatastoreStatus: DatastoreStatus | undefined;
359
359
  /**
360
- * @public
361
360
  * <p>The time that a data store was created. </p>
361
+ * @public
362
362
  */
363
363
  CreatedAt?: Date;
364
364
  /**
365
- * @public
366
365
  * <p>The FHIR version. Only R4 version data is supported.</p>
366
+ * @public
367
367
  */
368
368
  DatastoreTypeVersion: FHIRVersion | undefined;
369
369
  /**
370
- * @public
371
370
  * <p>The AWS endpoint for the data store. Each data store will have it's own endpoint with data store ID in the endpoint URL.</p>
371
+ * @public
372
372
  */
373
373
  DatastoreEndpoint: string | undefined;
374
374
  /**
375
- * @public
376
375
  * <p>
377
376
  * The server-side encryption key configuration for a customer provided encryption key (CMK).
378
377
  * </p>
378
+ * @public
379
379
  */
380
380
  SseConfiguration?: SseConfiguration;
381
381
  /**
382
- * @public
383
382
  * <p>The preloaded data configuration for the data store. Only data preloaded from Synthea is supported.</p>
383
+ * @public
384
384
  */
385
385
  PreloadDataConfig?: PreloadDataConfig;
386
386
  /**
387
- * @public
388
387
  * <p>The identity provider that you selected when you created the data store.</p>
388
+ * @public
389
389
  */
390
390
  IdentityProviderConfiguration?: IdentityProviderConfiguration;
391
391
  }
@@ -394,8 +394,8 @@ export interface DatastoreProperties {
394
394
  */
395
395
  export interface DeleteFHIRDatastoreRequest {
396
396
  /**
397
- * @public
398
397
  * <p> The AWS-generated ID for the data store to be deleted.</p>
398
+ * @public
399
399
  */
400
400
  DatastoreId: string | undefined;
401
401
  }
@@ -404,30 +404,30 @@ export interface DeleteFHIRDatastoreRequest {
404
404
  */
405
405
  export interface DeleteFHIRDatastoreResponse {
406
406
  /**
407
- * @public
408
407
  * <p>The AWS-generated ID for the data store to be deleted.</p>
408
+ * @public
409
409
  */
410
410
  DatastoreId: string | undefined;
411
411
  /**
412
- * @public
413
412
  * <p>The Amazon Resource Name (ARN) that gives AWS HealthLake access permission.</p>
413
+ * @public
414
414
  */
415
415
  DatastoreArn: string | undefined;
416
416
  /**
417
- * @public
418
417
  * <p>The status of the data store that the user has requested to be deleted.
419
418
  * </p>
419
+ * @public
420
420
  */
421
421
  DatastoreStatus: DatastoreStatus | undefined;
422
422
  /**
423
- * @public
424
423
  * <p>The AWS endpoint for the data store the user has requested to be deleted.</p>
424
+ * @public
425
425
  */
426
426
  DatastoreEndpoint: string | undefined;
427
427
  }
428
428
  /**
429
- * @public
430
429
  * <p> The requested data store was not found.</p>
430
+ * @public
431
431
  */
432
432
  export declare class ResourceNotFoundException extends __BaseException {
433
433
  readonly name: "ResourceNotFoundException";
@@ -443,8 +443,8 @@ export declare class ResourceNotFoundException extends __BaseException {
443
443
  */
444
444
  export interface DescribeFHIRDatastoreRequest {
445
445
  /**
446
- * @public
447
446
  * <p>The AWS-generated data store ID.</p>
447
+ * @public
448
448
  */
449
449
  DatastoreId: string | undefined;
450
450
  }
@@ -453,9 +453,9 @@ export interface DescribeFHIRDatastoreRequest {
453
453
  */
454
454
  export interface DescribeFHIRDatastoreResponse {
455
455
  /**
456
- * @public
457
456
  * <p>All properties associated with a data store, including the data store ID, data store ARN,
458
457
  * data store name, data store status, when the data store was created, data store type version, and the data store's endpoint.</p>
458
+ * @public
459
459
  */
460
460
  DatastoreProperties: DatastoreProperties | undefined;
461
461
  }
@@ -464,13 +464,13 @@ export interface DescribeFHIRDatastoreResponse {
464
464
  */
465
465
  export interface DescribeFHIRExportJobRequest {
466
466
  /**
467
- * @public
468
467
  * <p>The AWS generated ID for the data store from which files are being exported from for an export job.</p>
468
+ * @public
469
469
  */
470
470
  DatastoreId: string | undefined;
471
471
  /**
472
- * @public
473
472
  * <p>The AWS generated ID for an export job.</p>
473
+ * @public
474
474
  */
475
475
  JobId: string | undefined;
476
476
  }
@@ -494,30 +494,30 @@ export declare const JobStatus: {
494
494
  */
495
495
  export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
496
496
  /**
497
- * @public
498
497
  * <p>
499
498
  * The configuration of the S3 bucket for either an import or export job. This includes assigning permissions for access.
500
499
  * </p>
500
+ * @public
501
501
  */
502
502
  export interface S3Configuration {
503
503
  /**
504
- * @public
505
504
  * <p>
506
505
  * The S3Uri is the user specified S3 location of the FHIR data to be imported into AWS HealthLake.
507
506
  * </p>
507
+ * @public
508
508
  */
509
509
  S3Uri: string | undefined;
510
510
  /**
511
- * @public
512
511
  * <p>
513
512
  * The KMS key ID used to access the S3 bucket.
514
513
  * </p>
514
+ * @public
515
515
  */
516
516
  KmsKeyId: string | undefined;
517
517
  }
518
518
  /**
519
- * @public
520
519
  * <p>The output data configuration that was supplied when the export job was created.</p>
520
+ * @public
521
521
  */
522
522
  export type OutputDataConfig = OutputDataConfig.S3ConfigurationMember | OutputDataConfig.$UnknownMember;
523
523
  /**
@@ -525,10 +525,10 @@ export type OutputDataConfig = OutputDataConfig.S3ConfigurationMember | OutputDa
525
525
  */
526
526
  export declare namespace OutputDataConfig {
527
527
  /**
528
- * @public
529
528
  * <p>
530
529
  * The output data configuration that was supplied when the export job was created.
531
530
  * </p>
531
+ * @public
532
532
  */
533
533
  interface S3ConfigurationMember {
534
534
  S3Configuration: S3Configuration;
@@ -548,53 +548,53 @@ export declare namespace OutputDataConfig {
548
548
  const visit: <T>(value: OutputDataConfig, visitor: Visitor<T>) => T;
549
549
  }
550
550
  /**
551
- * @public
552
551
  * <p>The properties of a FHIR export job, including the ID, ARN, name, and the status of the job.</p>
552
+ * @public
553
553
  */
554
554
  export interface ExportJobProperties {
555
555
  /**
556
- * @public
557
556
  * <p>The AWS generated ID for an export job.</p>
557
+ * @public
558
558
  */
559
559
  JobId: string | undefined;
560
560
  /**
561
- * @public
562
561
  * <p>The user generated name for an export job.</p>
562
+ * @public
563
563
  */
564
564
  JobName?: string;
565
565
  /**
566
- * @public
567
566
  * <p>The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.</p>
567
+ * @public
568
568
  */
569
569
  JobStatus: JobStatus | undefined;
570
570
  /**
571
- * @public
572
571
  * <p>The time an export job was initiated.</p>
572
+ * @public
573
573
  */
574
574
  SubmitTime: Date | undefined;
575
575
  /**
576
- * @public
577
576
  * <p>The time an export job completed.</p>
577
+ * @public
578
578
  */
579
579
  EndTime?: Date;
580
580
  /**
581
- * @public
582
581
  * <p>The AWS generated ID for the data store from which files are being exported for an export job.</p>
582
+ * @public
583
583
  */
584
584
  DatastoreId: string | undefined;
585
585
  /**
586
- * @public
587
586
  * <p>The output data configuration that was supplied when the export job was created.</p>
587
+ * @public
588
588
  */
589
589
  OutputDataConfig: OutputDataConfig | undefined;
590
590
  /**
591
- * @public
592
591
  * <p>The Amazon Resource Name used during the initiation of the job.</p>
592
+ * @public
593
593
  */
594
594
  DataAccessRoleArn?: string;
595
595
  /**
596
- * @public
597
596
  * <p>An explanation of any errors that may have occurred during the export job.</p>
597
+ * @public
598
598
  */
599
599
  Message?: string;
600
600
  }
@@ -603,8 +603,8 @@ export interface ExportJobProperties {
603
603
  */
604
604
  export interface DescribeFHIRExportJobResponse {
605
605
  /**
606
- * @public
607
606
  * <p>Displays the properties of the export job, including the ID, Arn, Name, and the status of the job. </p>
607
+ * @public
608
608
  */
609
609
  ExportJobProperties: ExportJobProperties | undefined;
610
610
  }
@@ -613,19 +613,19 @@ export interface DescribeFHIRExportJobResponse {
613
613
  */
614
614
  export interface DescribeFHIRImportJobRequest {
615
615
  /**
616
- * @public
617
616
  * <p>The AWS-generated ID of the data store.</p>
617
+ * @public
618
618
  */
619
619
  DatastoreId: string | undefined;
620
620
  /**
621
- * @public
622
621
  * <p>The AWS-generated job ID.</p>
622
+ * @public
623
623
  */
624
624
  JobId: string | undefined;
625
625
  }
626
626
  /**
627
- * @public
628
627
  * <p> The input properties for an import job.</p>
628
+ * @public
629
629
  */
630
630
  export type InputDataConfig = InputDataConfig.S3UriMember | InputDataConfig.$UnknownMember;
631
631
  /**
@@ -633,8 +633,8 @@ export type InputDataConfig = InputDataConfig.S3UriMember | InputDataConfig.$Unk
633
633
  */
634
634
  export declare namespace InputDataConfig {
635
635
  /**
636
- * @public
637
636
  * <p>The S3Uri is the user specified S3 location of the FHIR data to be imported into AWS HealthLake. </p>
637
+ * @public
638
638
  */
639
639
  interface S3UriMember {
640
640
  S3Uri: string;
@@ -654,109 +654,109 @@ export declare namespace InputDataConfig {
654
654
  const visit: <T>(value: InputDataConfig, visitor: Visitor<T>) => T;
655
655
  }
656
656
  /**
657
- * @public
658
657
  * <p>The progress report of an import job.</p>
658
+ * @public
659
659
  */
660
660
  export interface JobProgressReport {
661
661
  /**
662
- * @public
663
662
  * <p>The number of files scanned from input S3 bucket.</p>
663
+ * @public
664
664
  */
665
665
  TotalNumberOfScannedFiles?: number;
666
666
  /**
667
- * @public
668
667
  * <p>The size (in MB) of the files scanned from the input S3 bucket.</p>
668
+ * @public
669
669
  */
670
670
  TotalSizeOfScannedFilesInMB?: number;
671
671
  /**
672
- * @public
673
672
  * <p>The number of files imported so far.</p>
673
+ * @public
674
674
  */
675
675
  TotalNumberOfImportedFiles?: number;
676
676
  /**
677
- * @public
678
677
  * <p>The number of resources scanned from the input S3 bucket.</p>
678
+ * @public
679
679
  */
680
680
  TotalNumberOfResourcesScanned?: number;
681
681
  /**
682
- * @public
683
682
  * <p>The number of resources imported so far.</p>
683
+ * @public
684
684
  */
685
685
  TotalNumberOfResourcesImported?: number;
686
686
  /**
687
- * @public
688
687
  * <p>The number of resources that failed due to customer error.</p>
688
+ * @public
689
689
  */
690
690
  TotalNumberOfResourcesWithCustomerError?: number;
691
691
  /**
692
- * @public
693
692
  * <p>The number of files that failed to be read from the input S3 bucket due to customer error.</p>
693
+ * @public
694
694
  */
695
695
  TotalNumberOfFilesReadWithCustomerError?: number;
696
696
  /**
697
- * @public
698
697
  * <p>The throughput (in MB/sec) of the import job.</p>
698
+ * @public
699
699
  */
700
700
  Throughput?: number;
701
701
  }
702
702
  /**
703
- * @public
704
703
  * <p>Displays the properties of the import job, including the ID, Arn, Name, the status of the job, and the progress report of the job.</p>
704
+ * @public
705
705
  */
706
706
  export interface ImportJobProperties {
707
707
  /**
708
- * @public
709
708
  * <p>The AWS-generated id number for the Import job.</p>
709
+ * @public
710
710
  */
711
711
  JobId: string | undefined;
712
712
  /**
713
- * @public
714
713
  * <p>The user-generated name for an Import job.</p>
714
+ * @public
715
715
  */
716
716
  JobName?: string;
717
717
  /**
718
- * @public
719
718
  * <p>The job status for an Import job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED_WITH_ERRORS, COMPLETED, FAILED.</p>
719
+ * @public
720
720
  */
721
721
  JobStatus: JobStatus | undefined;
722
722
  /**
723
- * @public
724
723
  * <p>The time that the Import job was submitted for processing.</p>
724
+ * @public
725
725
  */
726
726
  SubmitTime: Date | undefined;
727
727
  /**
728
- * @public
729
728
  * <p>The time that the Import job was completed.</p>
729
+ * @public
730
730
  */
731
731
  EndTime?: Date;
732
732
  /**
733
- * @public
734
733
  * <p>The datastore id used when the Import job was created. </p>
734
+ * @public
735
735
  */
736
736
  DatastoreId: string | undefined;
737
737
  /**
738
- * @public
739
738
  * <p>The input data configuration that was supplied when the Import job was created.</p>
739
+ * @public
740
740
  */
741
741
  InputDataConfig: InputDataConfig | undefined;
742
742
  /**
743
- * @public
744
743
  * <p>The output data configuration that was supplied when the export job was created.</p>
744
+ * @public
745
745
  */
746
746
  JobOutputDataConfig?: OutputDataConfig;
747
747
  /**
748
- * @public
749
748
  * <p>Displays the progress of the import job, including total resources scanned, total resources ingested, and total size of data ingested.</p>
749
+ * @public
750
750
  */
751
751
  JobProgressReport?: JobProgressReport;
752
752
  /**
753
- * @public
754
753
  * <p>The Amazon Resource Name (ARN) that gives AWS HealthLake access to your input data.</p>
754
+ * @public
755
755
  */
756
756
  DataAccessRoleArn?: string;
757
757
  /**
758
- * @public
759
758
  * <p>An explanation of any errors that may have occurred during the FHIR import job. </p>
759
+ * @public
760
760
  */
761
761
  Message?: string;
762
762
  }
@@ -765,8 +765,8 @@ export interface ImportJobProperties {
765
765
  */
766
766
  export interface DescribeFHIRImportJobResponse {
767
767
  /**
768
- * @public
769
768
  * <p>The properties of the Import job request, including the ID, ARN, name, status of the job, and the progress report of the job.</p>
769
+ * @public
770
770
  */
771
771
  ImportJobProperties: ImportJobProperties | undefined;
772
772
  }
@@ -775,18 +775,18 @@ export interface DescribeFHIRImportJobResponse {
775
775
  */
776
776
  export interface ListFHIRDatastoresRequest {
777
777
  /**
778
- * @public
779
778
  * <p>Lists all filters associated with a FHIR data store request.</p>
779
+ * @public
780
780
  */
781
781
  Filter?: DatastoreFilter;
782
782
  /**
783
- * @public
784
783
  * <p>Fetches the next page of data stores when results are paginated.</p>
784
+ * @public
785
785
  */
786
786
  NextToken?: string;
787
787
  /**
788
- * @public
789
788
  * <p>The maximum number of data stores returned in a single page of a ListFHIRDatastoresRequest call.</p>
789
+ * @public
790
790
  */
791
791
  MaxResults?: number;
792
792
  }
@@ -795,13 +795,13 @@ export interface ListFHIRDatastoresRequest {
795
795
  */
796
796
  export interface ListFHIRDatastoresResponse {
797
797
  /**
798
- * @public
799
798
  * <p>All properties associated with the listed data stores.</p>
799
+ * @public
800
800
  */
801
801
  DatastorePropertiesList: DatastoreProperties[] | undefined;
802
802
  /**
803
- * @public
804
803
  * <p>Pagination token that can be used to retrieve the next page of results.</p>
804
+ * @public
805
805
  */
806
806
  NextToken?: string;
807
807
  }
@@ -810,52 +810,52 @@ export interface ListFHIRDatastoresResponse {
810
810
  */
811
811
  export interface ListFHIRExportJobsRequest {
812
812
  /**
813
- * @public
814
813
  * <p>
815
814
  * This parameter limits the response to the export job with the specified data store ID.
816
815
  * </p>
816
+ * @public
817
817
  */
818
818
  DatastoreId: string | undefined;
819
819
  /**
820
- * @public
821
820
  * <p>
822
821
  * A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query.
823
822
  * </p>
823
+ * @public
824
824
  */
825
825
  NextToken?: string;
826
826
  /**
827
- * @public
828
827
  * <p>
829
828
  * This parameter limits the number of results returned for a ListFHIRExportJobs to a maximum quantity specified by the user.
830
829
  * </p>
830
+ * @public
831
831
  */
832
832
  MaxResults?: number;
833
833
  /**
834
- * @public
835
834
  * <p>
836
835
  * This parameter limits the response to the export job with the specified job name.
837
836
  * </p>
837
+ * @public
838
838
  */
839
839
  JobName?: string;
840
840
  /**
841
- * @public
842
841
  * <p>
843
842
  * This parameter limits the response to the export jobs with the specified job status.
844
843
  * </p>
844
+ * @public
845
845
  */
846
846
  JobStatus?: JobStatus;
847
847
  /**
848
- * @public
849
848
  * <p>
850
849
  * This parameter limits the response to FHIR export jobs submitted before a user specified date.
851
850
  * </p>
851
+ * @public
852
852
  */
853
853
  SubmittedBefore?: Date;
854
854
  /**
855
- * @public
856
855
  * <p>
857
856
  * This parameter limits the response to FHIR export jobs submitted after a user specified date.
858
857
  * </p>
858
+ * @public
859
859
  */
860
860
  SubmittedAfter?: Date;
861
861
  }
@@ -864,17 +864,17 @@ export interface ListFHIRExportJobsRequest {
864
864
  */
865
865
  export interface ListFHIRExportJobsResponse {
866
866
  /**
867
- * @public
868
867
  * <p>
869
868
  * The properties of listed FHIR export jobs, including the ID, ARN, name, and the status of the job.
870
869
  * </p>
870
+ * @public
871
871
  */
872
872
  ExportJobPropertiesList: ExportJobProperties[] | undefined;
873
873
  /**
874
- * @public
875
874
  * <p>
876
875
  * A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query.
877
876
  * </p>
877
+ * @public
878
878
  */
879
879
  NextToken?: string;
880
880
  }
@@ -883,52 +883,52 @@ export interface ListFHIRExportJobsResponse {
883
883
  */
884
884
  export interface ListFHIRImportJobsRequest {
885
885
  /**
886
- * @public
887
886
  * <p>
888
887
  * This parameter limits the response to the import job with the specified data store ID.
889
888
  * </p>
889
+ * @public
890
890
  */
891
891
  DatastoreId: string | undefined;
892
892
  /**
893
- * @public
894
893
  * <p>
895
894
  * A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query.
896
895
  * </p>
896
+ * @public
897
897
  */
898
898
  NextToken?: string;
899
899
  /**
900
- * @public
901
900
  * <p>
902
901
  * This parameter limits the number of results returned for a ListFHIRImportJobs to a maximum quantity specified by the user.
903
902
  * </p>
903
+ * @public
904
904
  */
905
905
  MaxResults?: number;
906
906
  /**
907
- * @public
908
907
  * <p>
909
908
  * This parameter limits the response to the import job with the specified job name.
910
909
  * </p>
910
+ * @public
911
911
  */
912
912
  JobName?: string;
913
913
  /**
914
- * @public
915
914
  * <p>
916
915
  * This parameter limits the response to the import job with the specified job status.
917
916
  * </p>
917
+ * @public
918
918
  */
919
919
  JobStatus?: JobStatus;
920
920
  /**
921
- * @public
922
921
  * <p>
923
922
  * This parameter limits the response to FHIR import jobs submitted before a user specified date.
924
923
  * </p>
924
+ * @public
925
925
  */
926
926
  SubmittedBefore?: Date;
927
927
  /**
928
- * @public
929
928
  * <p>
930
929
  * This parameter limits the response to FHIR import jobs submitted after a user specified date.
931
930
  * </p>
931
+ * @public
932
932
  */
933
933
  SubmittedAfter?: Date;
934
934
  }
@@ -937,17 +937,17 @@ export interface ListFHIRImportJobsRequest {
937
937
  */
938
938
  export interface ListFHIRImportJobsResponse {
939
939
  /**
940
- * @public
941
940
  * <p>
942
941
  * 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.
943
942
  * </p>
943
+ * @public
944
944
  */
945
945
  ImportJobPropertiesList: ImportJobProperties[] | undefined;
946
946
  /**
947
- * @public
948
947
  * <p>
949
948
  * A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query.
950
949
  * </p>
950
+ * @public
951
951
  */
952
952
  NextToken?: string;
953
953
  }
@@ -956,10 +956,10 @@ export interface ListFHIRImportJobsResponse {
956
956
  */
957
957
  export interface ListTagsForResourceRequest {
958
958
  /**
959
- * @public
960
959
  * <p>
961
960
  * The Amazon Resource Name(ARN) of the data store for which tags are being added.
962
961
  * </p>
962
+ * @public
963
963
  */
964
964
  ResourceARN: string | undefined;
965
965
  }
@@ -968,10 +968,10 @@ export interface ListTagsForResourceRequest {
968
968
  */
969
969
  export interface ListTagsForResourceResponse {
970
970
  /**
971
- * @public
972
971
  * <p>
973
972
  * Returns a list of tags associated with a data store.
974
973
  * </p>
974
+ * @public
975
975
  */
976
976
  Tags?: Tag[];
977
977
  }
@@ -980,28 +980,28 @@ export interface ListTagsForResourceResponse {
980
980
  */
981
981
  export interface StartFHIRExportJobRequest {
982
982
  /**
983
- * @public
984
983
  * <p>The user generated name for an export job.</p>
984
+ * @public
985
985
  */
986
986
  JobName?: string;
987
987
  /**
988
- * @public
989
988
  * <p>The output data configuration that was supplied when the export job was created.</p>
989
+ * @public
990
990
  */
991
991
  OutputDataConfig: OutputDataConfig | undefined;
992
992
  /**
993
- * @public
994
993
  * <p>The AWS generated ID for the data store from which files are being exported for an export job.</p>
994
+ * @public
995
995
  */
996
996
  DatastoreId: string | undefined;
997
997
  /**
998
- * @public
999
998
  * <p>The Amazon Resource Name used during the initiation of the job.</p>
999
+ * @public
1000
1000
  */
1001
1001
  DataAccessRoleArn: string | undefined;
1002
1002
  /**
1003
- * @public
1004
1003
  * <p>An optional user provided token used for ensuring idempotency.</p>
1004
+ * @public
1005
1005
  */
1006
1006
  ClientToken?: string;
1007
1007
  }
@@ -1010,18 +1010,18 @@ export interface StartFHIRExportJobRequest {
1010
1010
  */
1011
1011
  export interface StartFHIRExportJobResponse {
1012
1012
  /**
1013
- * @public
1014
1013
  * <p>The AWS generated ID for an export job.</p>
1014
+ * @public
1015
1015
  */
1016
1016
  JobId: string | undefined;
1017
1017
  /**
1018
- * @public
1019
1018
  * <p>The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.</p>
1019
+ * @public
1020
1020
  */
1021
1021
  JobStatus: JobStatus | undefined;
1022
1022
  /**
1023
- * @public
1024
1023
  * <p>The AWS generated ID for the data store from which files are being exported for an export job.</p>
1024
+ * @public
1025
1025
  */
1026
1026
  DatastoreId?: string;
1027
1027
  }
@@ -1030,33 +1030,33 @@ export interface StartFHIRExportJobResponse {
1030
1030
  */
1031
1031
  export interface StartFHIRImportJobRequest {
1032
1032
  /**
1033
- * @public
1034
1033
  * <p>The name of the FHIR Import job in the StartFHIRImport job request.</p>
1034
+ * @public
1035
1035
  */
1036
1036
  JobName?: string;
1037
1037
  /**
1038
- * @public
1039
1038
  * <p>The input properties of the FHIR Import job in the StartFHIRImport job request.</p>
1039
+ * @public
1040
1040
  */
1041
1041
  InputDataConfig: InputDataConfig | undefined;
1042
1042
  /**
1043
- * @public
1044
1043
  * <p>The output data configuration that was supplied when the export job was created.</p>
1044
+ * @public
1045
1045
  */
1046
1046
  JobOutputDataConfig: OutputDataConfig | undefined;
1047
1047
  /**
1048
- * @public
1049
1048
  * <p>The AWS-generated data store ID.</p>
1049
+ * @public
1050
1050
  */
1051
1051
  DatastoreId: string | undefined;
1052
1052
  /**
1053
- * @public
1054
1053
  * <p>The Amazon Resource Name (ARN) that gives AWS HealthLake access permission.</p>
1054
+ * @public
1055
1055
  */
1056
1056
  DataAccessRoleArn: string | undefined;
1057
1057
  /**
1058
- * @public
1059
1058
  * <p>Optional user provided token used for ensuring idempotency.</p>
1059
+ * @public
1060
1060
  */
1061
1061
  ClientToken?: string;
1062
1062
  }
@@ -1065,18 +1065,18 @@ export interface StartFHIRImportJobRequest {
1065
1065
  */
1066
1066
  export interface StartFHIRImportJobResponse {
1067
1067
  /**
1068
- * @public
1069
1068
  * <p>The AWS-generated job ID.</p>
1069
+ * @public
1070
1070
  */
1071
1071
  JobId: string | undefined;
1072
1072
  /**
1073
- * @public
1074
1073
  * <p>The status of an import job.</p>
1074
+ * @public
1075
1075
  */
1076
1076
  JobStatus: JobStatus | undefined;
1077
1077
  /**
1078
- * @public
1079
1078
  * <p>The AWS-generated data store ID.</p>
1079
+ * @public
1080
1080
  */
1081
1081
  DatastoreId?: string;
1082
1082
  }
@@ -1085,17 +1085,17 @@ export interface StartFHIRImportJobResponse {
1085
1085
  */
1086
1086
  export interface TagResourceRequest {
1087
1087
  /**
1088
- * @public
1089
1088
  * <p>
1090
1089
  * The Amazon Resource Name(ARN)that gives AWS HealthLake access to the data store which tags are being added to.
1091
1090
  * </p>
1091
+ * @public
1092
1092
  */
1093
1093
  ResourceARN: string | undefined;
1094
1094
  /**
1095
- * @public
1096
1095
  * <p>
1097
1096
  * The user specified key and value pair tags being added to a data store.
1098
1097
  * </p>
1098
+ * @public
1099
1099
  */
1100
1100
  Tags: Tag[] | undefined;
1101
1101
  }
@@ -1109,15 +1109,15 @@ export interface TagResourceResponse {
1109
1109
  */
1110
1110
  export interface UntagResourceRequest {
1111
1111
  /**
1112
- * @public
1113
1112
  * <p>The Amazon Resource Name(ARN) of the data store for which tags are being removed.</p>
1113
+ * @public
1114
1114
  */
1115
1115
  ResourceARN: string | undefined;
1116
1116
  /**
1117
- * @public
1118
1117
  * <p>
1119
1118
  * The keys for the tags to be removed from the HealthLake data store.
1120
1119
  * </p>
1120
+ * @public
1121
1121
  */
1122
1122
  TagKeys: string[] | undefined;
1123
1123
  }