@aws-sdk/client-healthlake 3.378.0 → 3.382.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.
@@ -1,4 +1,7 @@
1
1
  import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
2
+ /**
3
+ * @public
4
+ */
2
5
  export interface ClientInputEndpointParameters {
3
6
  region?: string | Provider<string>;
4
7
  useDualstackEndpoint?: boolean | Provider<boolean>;
@@ -6,6 +6,7 @@
6
6
  */
7
7
  export * from "./HealthLakeClient";
8
8
  export * from "./HealthLake";
9
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
9
10
  export * from "./commands";
10
11
  export * from "./pagination";
11
12
  export * from "./models";
@@ -67,14 +67,17 @@ export type FHIRVersion = (typeof FHIRVersion)[keyof typeof FHIRVersion];
67
67
  */
68
68
  export interface IdentityProviderConfiguration {
69
69
  /**
70
+ * @public
70
71
  * <p>The authorization strategy that you selected when you created the data store.</p>
71
72
  */
72
73
  AuthorizationStrategy: AuthorizationStrategy | string | undefined;
73
74
  /**
75
+ * @public
74
76
  * <p>If you enabled fine-grained authorization when you created the data store.</p>
75
77
  */
76
78
  FineGrainedAuthorizationEnabled?: boolean;
77
79
  /**
80
+ * @public
78
81
  * <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>
79
82
  * <p>
80
83
  * <code>authorization_endpoint</code>: The URL to the OAuth2 authorization endpoint.</p>
@@ -89,6 +92,7 @@ export interface IdentityProviderConfiguration {
89
92
  */
90
93
  Metadata?: string;
91
94
  /**
95
+ * @public
92
96
  * <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>
93
97
  */
94
98
  IdpLambdaArn?: string;
@@ -110,6 +114,7 @@ export type PreloadDataType = (typeof PreloadDataType)[keyof typeof PreloadDataT
110
114
  */
111
115
  export interface PreloadDataConfig {
112
116
  /**
117
+ * @public
113
118
  * <p>The type of preloaded data. Only Synthea preloaded data is supported.</p>
114
119
  */
115
120
  PreloadDataType: PreloadDataType | string | undefined;
@@ -122,12 +127,14 @@ export interface PreloadDataConfig {
122
127
  */
123
128
  export interface KmsEncryptionConfig {
124
129
  /**
130
+ * @public
125
131
  * <p>
126
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.
127
133
  * </p>
128
134
  */
129
135
  CmkType: CmkType | string | undefined;
130
136
  /**
137
+ * @public
131
138
  * <p>
132
139
  * The KMS encryption key id/alias used to encrypt the data store contents at rest.
133
140
  * </p>
@@ -142,6 +149,7 @@ export interface KmsEncryptionConfig {
142
149
  */
143
150
  export interface SseConfiguration {
144
151
  /**
152
+ * @public
145
153
  * <p>
146
154
  * The KMS encryption configuration used to provide details for data encryption.
147
155
  * </p>
@@ -156,12 +164,14 @@ export interface SseConfiguration {
156
164
  */
157
165
  export interface Tag {
158
166
  /**
167
+ * @public
159
168
  * <p>
160
169
  * The key portion of a tag. Tag keys are case sensitive.
161
170
  * </p>
162
171
  */
163
172
  Key: string | undefined;
164
173
  /**
174
+ * @public
165
175
  * <p>
166
176
  * The value portion of a tag. Tag values are case sensitive.
167
177
  * </p>
@@ -173,35 +183,42 @@ export interface Tag {
173
183
  */
174
184
  export interface CreateFHIRDatastoreRequest {
175
185
  /**
186
+ * @public
176
187
  * <p>The user generated name for the data store.</p>
177
188
  */
178
189
  DatastoreName?: string;
179
190
  /**
191
+ * @public
180
192
  * <p>The FHIR version of the data store. The only supported version is R4.</p>
181
193
  */
182
194
  DatastoreTypeVersion: FHIRVersion | string | undefined;
183
195
  /**
196
+ * @public
184
197
  * <p>
185
198
  * The server-side encryption key configuration for a customer provided encryption key specified for creating a data store.
186
199
  * </p>
187
200
  */
188
201
  SseConfiguration?: SseConfiguration;
189
202
  /**
203
+ * @public
190
204
  * <p>Optional parameter to preload data upon creation of the data store. Currently, the only
191
205
  * supported preloaded data is synthetic data generated from Synthea.</p>
192
206
  */
193
207
  PreloadDataConfig?: PreloadDataConfig;
194
208
  /**
209
+ * @public
195
210
  * <p>Optional user provided token used for ensuring idempotency.</p>
196
211
  */
197
212
  ClientToken?: string;
198
213
  /**
214
+ * @public
199
215
  * <p>
200
216
  * Resource tags that are applied to a data store when it is created.
201
217
  * </p>
202
218
  */
203
219
  Tags?: Tag[];
204
220
  /**
221
+ * @public
205
222
  * <p>The configuration of the identity provider that you want to use for your data store.</p>
206
223
  */
207
224
  IdentityProviderConfiguration?: IdentityProviderConfiguration;
@@ -225,20 +242,24 @@ export type DatastoreStatus = (typeof DatastoreStatus)[keyof typeof DatastoreSta
225
242
  */
226
243
  export interface CreateFHIRDatastoreResponse {
227
244
  /**
245
+ * @public
228
246
  * <p>The AWS-generated data store id. This id is in the output from the initial data store
229
247
  * creation call.</p>
230
248
  */
231
249
  DatastoreId: string | undefined;
232
250
  /**
251
+ * @public
233
252
  * <p>The data store ARN is generated during the creation of the data store and can be found in
234
253
  * the output from the initial data store creation call.</p>
235
254
  */
236
255
  DatastoreArn: string | undefined;
237
256
  /**
257
+ * @public
238
258
  * <p>The status of the FHIR data store.</p>
239
259
  */
240
260
  DatastoreStatus: DatastoreStatus | string | undefined;
241
261
  /**
262
+ * @public
242
263
  * <p>The AWS endpoint for the created data store.</p>
243
264
  */
244
265
  DatastoreEndpoint: string | undefined;
@@ -288,19 +309,23 @@ export declare class ValidationException extends __BaseException {
288
309
  */
289
310
  export interface DatastoreFilter {
290
311
  /**
312
+ * @public
291
313
  * <p>Allows the user to filter data store results by name.</p>
292
314
  */
293
315
  DatastoreName?: string;
294
316
  /**
317
+ * @public
295
318
  * <p>Allows the user to filter data store results by status.</p>
296
319
  */
297
320
  DatastoreStatus?: DatastoreStatus | string;
298
321
  /**
322
+ * @public
299
323
  * <p>A filter that allows the user to set cutoff dates for records. All data stores created
300
324
  * before the specified date will be included in the results. </p>
301
325
  */
302
326
  CreatedBefore?: Date;
303
327
  /**
328
+ * @public
304
329
  * <p>A filter that allows the user to set cutoff dates for records. All data stores created
305
330
  * after the specified date will be included in the results.</p>
306
331
  */
@@ -312,44 +337,54 @@ export interface DatastoreFilter {
312
337
  */
313
338
  export interface DatastoreProperties {
314
339
  /**
340
+ * @public
315
341
  * <p>The AWS-generated ID number for the data store.</p>
316
342
  */
317
343
  DatastoreId: string | undefined;
318
344
  /**
345
+ * @public
319
346
  * <p>The Amazon Resource Name used in the creation of the data store.</p>
320
347
  */
321
348
  DatastoreArn: string | undefined;
322
349
  /**
350
+ * @public
323
351
  * <p>The user-generated name for the data store.</p>
324
352
  */
325
353
  DatastoreName?: string;
326
354
  /**
355
+ * @public
327
356
  * <p>The status of the data store.</p>
328
357
  */
329
358
  DatastoreStatus: DatastoreStatus | string | undefined;
330
359
  /**
360
+ * @public
331
361
  * <p>The time that a data store was created. </p>
332
362
  */
333
363
  CreatedAt?: Date;
334
364
  /**
365
+ * @public
335
366
  * <p>The FHIR version. Only R4 version data is supported.</p>
336
367
  */
337
368
  DatastoreTypeVersion: FHIRVersion | string | undefined;
338
369
  /**
370
+ * @public
339
371
  * <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>
340
372
  */
341
373
  DatastoreEndpoint: string | undefined;
342
374
  /**
375
+ * @public
343
376
  * <p>
344
377
  * The server-side encryption key configuration for a customer provided encryption key (CMK).
345
378
  * </p>
346
379
  */
347
380
  SseConfiguration?: SseConfiguration;
348
381
  /**
382
+ * @public
349
383
  * <p>The preloaded data configuration for the data store. Only data preloaded from Synthea is supported.</p>
350
384
  */
351
385
  PreloadDataConfig?: PreloadDataConfig;
352
386
  /**
387
+ * @public
353
388
  * <p>The identity provider that you selected when you created the data store.</p>
354
389
  */
355
390
  IdentityProviderConfiguration?: IdentityProviderConfiguration;
@@ -359,6 +394,7 @@ export interface DatastoreProperties {
359
394
  */
360
395
  export interface DeleteFHIRDatastoreRequest {
361
396
  /**
397
+ * @public
362
398
  * <p> The AWS-generated ID for the data store to be deleted.</p>
363
399
  */
364
400
  DatastoreId: string | undefined;
@@ -368,19 +404,23 @@ export interface DeleteFHIRDatastoreRequest {
368
404
  */
369
405
  export interface DeleteFHIRDatastoreResponse {
370
406
  /**
407
+ * @public
371
408
  * <p>The AWS-generated ID for the data store to be deleted.</p>
372
409
  */
373
410
  DatastoreId: string | undefined;
374
411
  /**
412
+ * @public
375
413
  * <p>The Amazon Resource Name (ARN) that gives AWS HealthLake access permission.</p>
376
414
  */
377
415
  DatastoreArn: string | undefined;
378
416
  /**
417
+ * @public
379
418
  * <p>The status of the data store that the user has requested to be deleted.
380
419
  * </p>
381
420
  */
382
421
  DatastoreStatus: DatastoreStatus | string | undefined;
383
422
  /**
423
+ * @public
384
424
  * <p>The AWS endpoint for the data store the user has requested to be deleted.</p>
385
425
  */
386
426
  DatastoreEndpoint: string | undefined;
@@ -403,6 +443,7 @@ export declare class ResourceNotFoundException extends __BaseException {
403
443
  */
404
444
  export interface DescribeFHIRDatastoreRequest {
405
445
  /**
446
+ * @public
406
447
  * <p>The AWS-generated data store ID.</p>
407
448
  */
408
449
  DatastoreId: string | undefined;
@@ -412,6 +453,7 @@ export interface DescribeFHIRDatastoreRequest {
412
453
  */
413
454
  export interface DescribeFHIRDatastoreResponse {
414
455
  /**
456
+ * @public
415
457
  * <p>All properties associated with a data store, including the data store ID, data store ARN,
416
458
  * data store name, data store status, when the data store was created, data store type version, and the data store's endpoint.</p>
417
459
  */
@@ -422,10 +464,12 @@ export interface DescribeFHIRDatastoreResponse {
422
464
  */
423
465
  export interface DescribeFHIRExportJobRequest {
424
466
  /**
467
+ * @public
425
468
  * <p>The AWS generated ID for the data store from which files are being exported from for an export job.</p>
426
469
  */
427
470
  DatastoreId: string | undefined;
428
471
  /**
472
+ * @public
429
473
  * <p>The AWS generated ID for an export job.</p>
430
474
  */
431
475
  JobId: string | undefined;
@@ -457,12 +501,14 @@ export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
457
501
  */
458
502
  export interface S3Configuration {
459
503
  /**
504
+ * @public
460
505
  * <p>
461
506
  * The S3Uri is the user specified S3 location of the FHIR data to be imported into AWS HealthLake.
462
507
  * </p>
463
508
  */
464
509
  S3Uri: string | undefined;
465
510
  /**
511
+ * @public
466
512
  * <p>
467
513
  * The KMS key ID used to access the S3 bucket.
468
514
  * </p>
@@ -479,6 +525,7 @@ export type OutputDataConfig = OutputDataConfig.S3ConfigurationMember | OutputDa
479
525
  */
480
526
  export declare namespace OutputDataConfig {
481
527
  /**
528
+ * @public
482
529
  * <p>
483
530
  * The output data configuration that was supplied when the export job was created.
484
531
  * </p>
@@ -487,6 +534,9 @@ export declare namespace OutputDataConfig {
487
534
  S3Configuration: S3Configuration;
488
535
  $unknown?: never;
489
536
  }
537
+ /**
538
+ * @public
539
+ */
490
540
  interface $UnknownMember {
491
541
  S3Configuration?: never;
492
542
  $unknown: [string, any];
@@ -503,38 +553,47 @@ export declare namespace OutputDataConfig {
503
553
  */
504
554
  export interface ExportJobProperties {
505
555
  /**
556
+ * @public
506
557
  * <p>The AWS generated ID for an export job.</p>
507
558
  */
508
559
  JobId: string | undefined;
509
560
  /**
561
+ * @public
510
562
  * <p>The user generated name for an export job.</p>
511
563
  */
512
564
  JobName?: string;
513
565
  /**
566
+ * @public
514
567
  * <p>The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.</p>
515
568
  */
516
569
  JobStatus: JobStatus | string | undefined;
517
570
  /**
571
+ * @public
518
572
  * <p>The time an export job was initiated.</p>
519
573
  */
520
574
  SubmitTime: Date | undefined;
521
575
  /**
576
+ * @public
522
577
  * <p>The time an export job completed.</p>
523
578
  */
524
579
  EndTime?: Date;
525
580
  /**
581
+ * @public
526
582
  * <p>The AWS generated ID for the data store from which files are being exported for an export job.</p>
527
583
  */
528
584
  DatastoreId: string | undefined;
529
585
  /**
586
+ * @public
530
587
  * <p>The output data configuration that was supplied when the export job was created.</p>
531
588
  */
532
589
  OutputDataConfig: OutputDataConfig | undefined;
533
590
  /**
591
+ * @public
534
592
  * <p>The Amazon Resource Name used during the initiation of the job.</p>
535
593
  */
536
594
  DataAccessRoleArn?: string;
537
595
  /**
596
+ * @public
538
597
  * <p>An explanation of any errors that may have occurred during the export job.</p>
539
598
  */
540
599
  Message?: string;
@@ -544,6 +603,7 @@ export interface ExportJobProperties {
544
603
  */
545
604
  export interface DescribeFHIRExportJobResponse {
546
605
  /**
606
+ * @public
547
607
  * <p>Displays the properties of the export job, including the ID, Arn, Name, and the status of the job. </p>
548
608
  */
549
609
  ExportJobProperties: ExportJobProperties | undefined;
@@ -553,10 +613,12 @@ export interface DescribeFHIRExportJobResponse {
553
613
  */
554
614
  export interface DescribeFHIRImportJobRequest {
555
615
  /**
616
+ * @public
556
617
  * <p>The AWS-generated ID of the data store.</p>
557
618
  */
558
619
  DatastoreId: string | undefined;
559
620
  /**
621
+ * @public
560
622
  * <p>The AWS-generated job ID.</p>
561
623
  */
562
624
  JobId: string | undefined;
@@ -571,12 +633,16 @@ export type InputDataConfig = InputDataConfig.S3UriMember | InputDataConfig.$Unk
571
633
  */
572
634
  export declare namespace InputDataConfig {
573
635
  /**
636
+ * @public
574
637
  * <p>The S3Uri is the user specified S3 location of the FHIR data to be imported into AWS HealthLake. </p>
575
638
  */
576
639
  interface S3UriMember {
577
640
  S3Uri: string;
578
641
  $unknown?: never;
579
642
  }
643
+ /**
644
+ * @public
645
+ */
580
646
  interface $UnknownMember {
581
647
  S3Uri?: never;
582
648
  $unknown: [string, any];
@@ -593,42 +659,52 @@ export declare namespace InputDataConfig {
593
659
  */
594
660
  export interface ImportJobProperties {
595
661
  /**
662
+ * @public
596
663
  * <p>The AWS-generated id number for the Import job.</p>
597
664
  */
598
665
  JobId: string | undefined;
599
666
  /**
667
+ * @public
600
668
  * <p>The user-generated name for an Import job.</p>
601
669
  */
602
670
  JobName?: string;
603
671
  /**
672
+ * @public
604
673
  * <p>The job status for an Import job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED_WITH_ERRORS, COMPLETED, FAILED.</p>
605
674
  */
606
675
  JobStatus: JobStatus | string | undefined;
607
676
  /**
677
+ * @public
608
678
  * <p>The time that the Import job was submitted for processing.</p>
609
679
  */
610
680
  SubmitTime: Date | undefined;
611
681
  /**
682
+ * @public
612
683
  * <p>The time that the Import job was completed.</p>
613
684
  */
614
685
  EndTime?: Date;
615
686
  /**
687
+ * @public
616
688
  * <p>The datastore id used when the Import job was created. </p>
617
689
  */
618
690
  DatastoreId: string | undefined;
619
691
  /**
692
+ * @public
620
693
  * <p>The input data configuration that was supplied when the Import job was created.</p>
621
694
  */
622
695
  InputDataConfig: InputDataConfig | undefined;
623
696
  /**
697
+ * @public
624
698
  * <p>The output data configuration that was supplied when the export job was created.</p>
625
699
  */
626
700
  JobOutputDataConfig?: OutputDataConfig;
627
701
  /**
702
+ * @public
628
703
  * <p>The Amazon Resource Name (ARN) that gives AWS HealthLake access to your input data.</p>
629
704
  */
630
705
  DataAccessRoleArn?: string;
631
706
  /**
707
+ * @public
632
708
  * <p>An explanation of any errors that may have occurred during the FHIR import job. </p>
633
709
  */
634
710
  Message?: string;
@@ -638,6 +714,7 @@ export interface ImportJobProperties {
638
714
  */
639
715
  export interface DescribeFHIRImportJobResponse {
640
716
  /**
717
+ * @public
641
718
  * <p>The properties of the Import job request, including the ID, ARN, name, and the status of the job.</p>
642
719
  */
643
720
  ImportJobProperties: ImportJobProperties | undefined;
@@ -647,14 +724,17 @@ export interface DescribeFHIRImportJobResponse {
647
724
  */
648
725
  export interface ListFHIRDatastoresRequest {
649
726
  /**
727
+ * @public
650
728
  * <p>Lists all filters associated with a FHIR data store request.</p>
651
729
  */
652
730
  Filter?: DatastoreFilter;
653
731
  /**
732
+ * @public
654
733
  * <p>Fetches the next page of data stores when results are paginated.</p>
655
734
  */
656
735
  NextToken?: string;
657
736
  /**
737
+ * @public
658
738
  * <p>The maximum number of data stores returned in a single page of a ListFHIRDatastoresRequest call.</p>
659
739
  */
660
740
  MaxResults?: number;
@@ -664,10 +744,12 @@ export interface ListFHIRDatastoresRequest {
664
744
  */
665
745
  export interface ListFHIRDatastoresResponse {
666
746
  /**
747
+ * @public
667
748
  * <p>All properties associated with the listed data stores.</p>
668
749
  */
669
750
  DatastorePropertiesList: DatastoreProperties[] | undefined;
670
751
  /**
752
+ * @public
671
753
  * <p>Pagination token that can be used to retrieve the next page of results.</p>
672
754
  */
673
755
  NextToken?: string;
@@ -677,42 +759,49 @@ export interface ListFHIRDatastoresResponse {
677
759
  */
678
760
  export interface ListFHIRExportJobsRequest {
679
761
  /**
762
+ * @public
680
763
  * <p>
681
764
  * This parameter limits the response to the export job with the specified data store ID.
682
765
  * </p>
683
766
  */
684
767
  DatastoreId: string | undefined;
685
768
  /**
769
+ * @public
686
770
  * <p>
687
771
  * A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query.
688
772
  * </p>
689
773
  */
690
774
  NextToken?: string;
691
775
  /**
776
+ * @public
692
777
  * <p>
693
778
  * This parameter limits the number of results returned for a ListFHIRExportJobs to a maximum quantity specified by the user.
694
779
  * </p>
695
780
  */
696
781
  MaxResults?: number;
697
782
  /**
783
+ * @public
698
784
  * <p>
699
785
  * This parameter limits the response to the export job with the specified job name.
700
786
  * </p>
701
787
  */
702
788
  JobName?: string;
703
789
  /**
790
+ * @public
704
791
  * <p>
705
792
  * This parameter limits the response to the export jobs with the specified job status.
706
793
  * </p>
707
794
  */
708
795
  JobStatus?: JobStatus | string;
709
796
  /**
797
+ * @public
710
798
  * <p>
711
799
  * This parameter limits the response to FHIR export jobs submitted before a user specified date.
712
800
  * </p>
713
801
  */
714
802
  SubmittedBefore?: Date;
715
803
  /**
804
+ * @public
716
805
  * <p>
717
806
  * This parameter limits the response to FHIR export jobs submitted after a user specified date.
718
807
  * </p>
@@ -724,12 +813,14 @@ export interface ListFHIRExportJobsRequest {
724
813
  */
725
814
  export interface ListFHIRExportJobsResponse {
726
815
  /**
816
+ * @public
727
817
  * <p>
728
818
  * The properties of listed FHIR export jobs, including the ID, ARN, name, and the status of the job.
729
819
  * </p>
730
820
  */
731
821
  ExportJobPropertiesList: ExportJobProperties[] | undefined;
732
822
  /**
823
+ * @public
733
824
  * <p>
734
825
  * A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query.
735
826
  * </p>
@@ -741,42 +832,49 @@ export interface ListFHIRExportJobsResponse {
741
832
  */
742
833
  export interface ListFHIRImportJobsRequest {
743
834
  /**
835
+ * @public
744
836
  * <p>
745
837
  * This parameter limits the response to the import job with the specified data store ID.
746
838
  * </p>
747
839
  */
748
840
  DatastoreId: string | undefined;
749
841
  /**
842
+ * @public
750
843
  * <p>
751
844
  * A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query.
752
845
  * </p>
753
846
  */
754
847
  NextToken?: string;
755
848
  /**
849
+ * @public
756
850
  * <p>
757
851
  * This parameter limits the number of results returned for a ListFHIRImportJobs to a maximum quantity specified by the user.
758
852
  * </p>
759
853
  */
760
854
  MaxResults?: number;
761
855
  /**
856
+ * @public
762
857
  * <p>
763
858
  * This parameter limits the response to the import job with the specified job name.
764
859
  * </p>
765
860
  */
766
861
  JobName?: string;
767
862
  /**
863
+ * @public
768
864
  * <p>
769
865
  * This parameter limits the response to the import job with the specified job status.
770
866
  * </p>
771
867
  */
772
868
  JobStatus?: JobStatus | string;
773
869
  /**
870
+ * @public
774
871
  * <p>
775
872
  * This parameter limits the response to FHIR import jobs submitted before a user specified date.
776
873
  * </p>
777
874
  */
778
875
  SubmittedBefore?: Date;
779
876
  /**
877
+ * @public
780
878
  * <p>
781
879
  * This parameter limits the response to FHIR import jobs submitted after a user specified date.
782
880
  * </p>
@@ -788,12 +886,14 @@ export interface ListFHIRImportJobsRequest {
788
886
  */
789
887
  export interface ListFHIRImportJobsResponse {
790
888
  /**
889
+ * @public
791
890
  * <p>
792
891
  * The properties of a listed FHIR import jobs, including the ID, ARN, name, and the status of the job.
793
892
  * </p>
794
893
  */
795
894
  ImportJobPropertiesList: ImportJobProperties[] | undefined;
796
895
  /**
896
+ * @public
797
897
  * <p>
798
898
  * A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query.
799
899
  * </p>
@@ -805,6 +905,7 @@ export interface ListFHIRImportJobsResponse {
805
905
  */
806
906
  export interface ListTagsForResourceRequest {
807
907
  /**
908
+ * @public
808
909
  * <p>
809
910
  * The Amazon Resource Name(ARN) of the data store for which tags are being added.
810
911
  * </p>
@@ -816,6 +917,7 @@ export interface ListTagsForResourceRequest {
816
917
  */
817
918
  export interface ListTagsForResourceResponse {
818
919
  /**
920
+ * @public
819
921
  * <p>
820
922
  * Returns a list of tags associated with a data store.
821
923
  * </p>
@@ -827,22 +929,27 @@ export interface ListTagsForResourceResponse {
827
929
  */
828
930
  export interface StartFHIRExportJobRequest {
829
931
  /**
932
+ * @public
830
933
  * <p>The user generated name for an export job.</p>
831
934
  */
832
935
  JobName?: string;
833
936
  /**
937
+ * @public
834
938
  * <p>The output data configuration that was supplied when the export job was created.</p>
835
939
  */
836
940
  OutputDataConfig: OutputDataConfig | undefined;
837
941
  /**
942
+ * @public
838
943
  * <p>The AWS generated ID for the data store from which files are being exported for an export job.</p>
839
944
  */
840
945
  DatastoreId: string | undefined;
841
946
  /**
947
+ * @public
842
948
  * <p>The Amazon Resource Name used during the initiation of the job.</p>
843
949
  */
844
950
  DataAccessRoleArn: string | undefined;
845
951
  /**
952
+ * @public
846
953
  * <p>An optional user provided token used for ensuring idempotency.</p>
847
954
  */
848
955
  ClientToken?: string;
@@ -852,14 +959,17 @@ export interface StartFHIRExportJobRequest {
852
959
  */
853
960
  export interface StartFHIRExportJobResponse {
854
961
  /**
962
+ * @public
855
963
  * <p>The AWS generated ID for an export job.</p>
856
964
  */
857
965
  JobId: string | undefined;
858
966
  /**
967
+ * @public
859
968
  * <p>The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.</p>
860
969
  */
861
970
  JobStatus: JobStatus | string | undefined;
862
971
  /**
972
+ * @public
863
973
  * <p>The AWS generated ID for the data store from which files are being exported for an export job.</p>
864
974
  */
865
975
  DatastoreId?: string;
@@ -869,26 +979,32 @@ export interface StartFHIRExportJobResponse {
869
979
  */
870
980
  export interface StartFHIRImportJobRequest {
871
981
  /**
982
+ * @public
872
983
  * <p>The name of the FHIR Import job in the StartFHIRImport job request.</p>
873
984
  */
874
985
  JobName?: string;
875
986
  /**
987
+ * @public
876
988
  * <p>The input properties of the FHIR Import job in the StartFHIRImport job request.</p>
877
989
  */
878
990
  InputDataConfig: InputDataConfig | undefined;
879
991
  /**
992
+ * @public
880
993
  * <p>The output data configuration that was supplied when the export job was created.</p>
881
994
  */
882
995
  JobOutputDataConfig: OutputDataConfig | undefined;
883
996
  /**
997
+ * @public
884
998
  * <p>The AWS-generated data store ID.</p>
885
999
  */
886
1000
  DatastoreId: string | undefined;
887
1001
  /**
1002
+ * @public
888
1003
  * <p>The Amazon Resource Name (ARN) that gives AWS HealthLake access permission.</p>
889
1004
  */
890
1005
  DataAccessRoleArn: string | undefined;
891
1006
  /**
1007
+ * @public
892
1008
  * <p>Optional user provided token used for ensuring idempotency.</p>
893
1009
  */
894
1010
  ClientToken?: string;
@@ -898,14 +1014,17 @@ export interface StartFHIRImportJobRequest {
898
1014
  */
899
1015
  export interface StartFHIRImportJobResponse {
900
1016
  /**
1017
+ * @public
901
1018
  * <p>The AWS-generated job ID.</p>
902
1019
  */
903
1020
  JobId: string | undefined;
904
1021
  /**
1022
+ * @public
905
1023
  * <p>The status of an import job.</p>
906
1024
  */
907
1025
  JobStatus: JobStatus | string | undefined;
908
1026
  /**
1027
+ * @public
909
1028
  * <p>The AWS-generated data store ID.</p>
910
1029
  */
911
1030
  DatastoreId?: string;
@@ -915,12 +1034,14 @@ export interface StartFHIRImportJobResponse {
915
1034
  */
916
1035
  export interface TagResourceRequest {
917
1036
  /**
1037
+ * @public
918
1038
  * <p>
919
1039
  * The Amazon Resource Name(ARN)that gives AWS HealthLake access to the data store which tags are being added to.
920
1040
  * </p>
921
1041
  */
922
1042
  ResourceARN: string | undefined;
923
1043
  /**
1044
+ * @public
924
1045
  * <p>
925
1046
  * The user specified key and value pair tags being added to a data store.
926
1047
  * </p>
@@ -937,10 +1058,12 @@ export interface TagResourceResponse {
937
1058
  */
938
1059
  export interface UntagResourceRequest {
939
1060
  /**
1061
+ * @public
940
1062
  * <p>The Amazon Resource Name(ARN) of the data store for which tags are being removed.</p>
941
1063
  */
942
1064
  ResourceARN: string | undefined;
943
1065
  /**
1066
+ * @public
944
1067
  * <p>
945
1068
  * The keys for the tags to be removed from the HealthLake data store.
946
1069
  * </p>
@@ -36,7 +36,9 @@ export declare const getRuntimeConfig: (config: HealthLakeClientConfig) => {
36
36
  signer?: import("@smithy/types").RequestSigner | ((authScheme?: import("@smithy/types").AuthScheme | undefined) => Promise<import("@smithy/types").RequestSigner>) | undefined;
37
37
  signingEscapePath?: boolean | undefined;
38
38
  systemClockOffset?: number | undefined;
39
- signingRegion?: string | undefined;
39
+ signingRegion?: string | undefined; /**
40
+ * @internal
41
+ */
40
42
  signerConstructor?: (new (options: import("@smithy/signature-v4").SignatureV4Init & import("@smithy/signature-v4").SignatureV4CryptoInit) => import("@smithy/types").RequestSigner) | undefined;
41
43
  customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
42
44
  };
@@ -1,5 +1,6 @@
1
1
  export * from "./HealthLakeClient";
2
2
  export * from "./HealthLake";
3
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
3
4
  export * from "./commands";
4
5
  export * from "./pagination";
5
6
  export * from "./models";
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-healthlake",
3
3
  "description": "AWS SDK for JavaScript Healthlake Client for Node.js, Browser and React Native",
4
- "version": "3.378.0",
4
+ "version": "3.382.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.378.0",
25
- "@aws-sdk/credential-provider-node": "3.378.0",
26
- "@aws-sdk/middleware-host-header": "3.378.0",
24
+ "@aws-sdk/client-sts": "3.382.0",
25
+ "@aws-sdk/credential-provider-node": "3.382.0",
26
+ "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
- "@aws-sdk/middleware-signing": "3.378.0",
30
- "@aws-sdk/middleware-user-agent": "3.378.0",
29
+ "@aws-sdk/middleware-signing": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",