@aws-sdk/client-healthlake 3.1087.0 → 3.1089.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 (113) hide show
  1. package/README.md +113 -3
  2. package/dist-cjs/index.js +733 -31
  3. package/dist-es/HealthLake.js +30 -0
  4. package/dist-es/commands/CreateDataTransformationProfileCommand.js +4 -0
  5. package/dist-es/commands/DeleteDataTransformationProfileCommand.js +4 -0
  6. package/dist-es/commands/DescribeDataTransformationJobCommand.js +4 -0
  7. package/dist-es/commands/GetDataTransformationProfileCommand.js +4 -0
  8. package/dist-es/commands/ListDataTransformationJobsCommand.js +4 -0
  9. package/dist-es/commands/ListDataTransformationProfileVersionsCommand.js +4 -0
  10. package/dist-es/commands/ListDataTransformationProfilesCommand.js +4 -0
  11. package/dist-es/commands/PublishDataTransformationProfileCommand.js +4 -0
  12. package/dist-es/commands/StartDataTransformationJobCommand.js +4 -0
  13. package/dist-es/commands/UpdateDataTransformationProfileCommand.js +4 -0
  14. package/dist-es/commands/UpdateProfileWithAgentCommand.js +4 -0
  15. package/dist-es/commands/index.js +11 -0
  16. package/dist-es/models/enums.js +28 -0
  17. package/dist-es/models/errors.js +114 -16
  18. package/dist-es/pagination/ListDataTransformationJobsPaginator.js +4 -0
  19. package/dist-es/pagination/ListDataTransformationProfileVersionsPaginator.js +4 -0
  20. package/dist-es/pagination/ListDataTransformationProfilesPaginator.js +4 -0
  21. package/dist-es/pagination/index.js +3 -0
  22. package/dist-es/schemas/schemas_0.js +405 -15
  23. package/dist-es/waiters/index.js +1 -0
  24. package/dist-es/waiters/waitForDataTransformationJobCompleted.js +52 -0
  25. package/dist-types/HealthLake.d.ts +106 -3
  26. package/dist-types/HealthLakeClient.d.ts +14 -5
  27. package/dist-types/commands/CreateDataTransformationProfileCommand.d.ts +121 -0
  28. package/dist-types/commands/CreateFHIRDatastoreCommand.d.ts +1 -1
  29. package/dist-types/commands/DeleteDataTransformationProfileCommand.d.ts +88 -0
  30. package/dist-types/commands/DeleteFHIRDatastoreCommand.d.ts +1 -2
  31. package/dist-types/commands/DescribeDataTransformationJobCommand.d.ts +115 -0
  32. package/dist-types/commands/DescribeFHIRDatastoreCommand.d.ts +1 -1
  33. package/dist-types/commands/DescribeFHIRImportJobCommand.d.ts +9 -0
  34. package/dist-types/commands/GetDataTransformationProfileCommand.d.ts +97 -0
  35. package/dist-types/commands/ListDataTransformationJobsCommand.d.ts +98 -0
  36. package/dist-types/commands/ListDataTransformationProfileVersionsCommand.d.ts +99 -0
  37. package/dist-types/commands/ListDataTransformationProfilesCommand.d.ts +96 -0
  38. package/dist-types/commands/ListFHIRDatastoresCommand.d.ts +2 -3
  39. package/dist-types/commands/ListFHIRImportJobsCommand.d.ts +9 -0
  40. package/dist-types/commands/PublishDataTransformationProfileCommand.d.ts +97 -0
  41. package/dist-types/commands/StartDataTransformationJobCommand.d.ts +102 -0
  42. package/dist-types/commands/StartFHIRExportJobCommand.d.ts +3 -0
  43. package/dist-types/commands/StartFHIRImportJobCommand.d.ts +7 -3
  44. package/dist-types/commands/UpdateDataTransformationProfileCommand.d.ts +94 -0
  45. package/dist-types/commands/UpdateFHIRDatastoreCommand.d.ts +5 -6
  46. package/dist-types/commands/UpdateProfileWithAgentCommand.d.ts +114 -0
  47. package/dist-types/commands/index.d.ts +11 -0
  48. package/dist-types/index.d.ts +1 -3
  49. package/dist-types/models/enums.d.ts +68 -0
  50. package/dist-types/models/errors.d.ts +137 -15
  51. package/dist-types/models/models_0.d.ts +1066 -93
  52. package/dist-types/pagination/ListDataTransformationJobsPaginator.d.ts +7 -0
  53. package/dist-types/pagination/ListDataTransformationProfileVersionsPaginator.d.ts +7 -0
  54. package/dist-types/pagination/ListDataTransformationProfilesPaginator.d.ts +7 -0
  55. package/dist-types/pagination/index.d.ts +3 -0
  56. package/dist-types/schemas/schemas_0.d.ts +55 -0
  57. package/dist-types/ts3.4/HealthLake.d.ts +269 -56
  58. package/dist-types/ts3.4/HealthLakeClient.d.ts +74 -20
  59. package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +5 -12
  60. package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +11 -15
  61. package/dist-types/ts3.4/commandBuilder.d.ts +7 -13
  62. package/dist-types/ts3.4/commands/CreateDataTransformationProfileCommand.d.ts +42 -0
  63. package/dist-types/ts3.4/commands/CreateFHIRDatastoreCommand.d.ts +5 -10
  64. package/dist-types/ts3.4/commands/DeleteDataTransformationProfileCommand.d.ts +42 -0
  65. package/dist-types/ts3.4/commands/DeleteFHIRDatastoreCommand.d.ts +5 -10
  66. package/dist-types/ts3.4/commands/DescribeDataTransformationJobCommand.d.ts +42 -0
  67. package/dist-types/ts3.4/commands/DescribeFHIRDatastoreCommand.d.ts +5 -10
  68. package/dist-types/ts3.4/commands/DescribeFHIRExportJobCommand.d.ts +5 -10
  69. package/dist-types/ts3.4/commands/DescribeFHIRImportJobCommand.d.ts +5 -10
  70. package/dist-types/ts3.4/commands/GetDataTransformationProfileCommand.d.ts +42 -0
  71. package/dist-types/ts3.4/commands/ListDataTransformationJobsCommand.d.ts +42 -0
  72. package/dist-types/ts3.4/commands/ListDataTransformationProfileVersionsCommand.d.ts +42 -0
  73. package/dist-types/ts3.4/commands/ListDataTransformationProfilesCommand.d.ts +42 -0
  74. package/dist-types/ts3.4/commands/ListFHIRDatastoresCommand.d.ts +4 -9
  75. package/dist-types/ts3.4/commands/ListFHIRExportJobsCommand.d.ts +5 -10
  76. package/dist-types/ts3.4/commands/ListFHIRImportJobsCommand.d.ts +5 -10
  77. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +5 -10
  78. package/dist-types/ts3.4/commands/PublishDataTransformationProfileCommand.d.ts +42 -0
  79. package/dist-types/ts3.4/commands/StartDataTransformationJobCommand.d.ts +42 -0
  80. package/dist-types/ts3.4/commands/StartFHIRExportJobCommand.d.ts +5 -10
  81. package/dist-types/ts3.4/commands/StartFHIRImportJobCommand.d.ts +5 -10
  82. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +3 -5
  83. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +4 -9
  84. package/dist-types/ts3.4/commands/UpdateDataTransformationProfileCommand.d.ts +42 -0
  85. package/dist-types/ts3.4/commands/UpdateFHIRDatastoreCommand.d.ts +5 -10
  86. package/dist-types/ts3.4/commands/UpdateProfileWithAgentCommand.d.ts +39 -0
  87. package/dist-types/ts3.4/commands/index.d.ts +11 -0
  88. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  89. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +1 -1
  90. package/dist-types/ts3.4/extensionConfiguration.d.ts +2 -1
  91. package/dist-types/ts3.4/models/enums.d.ts +40 -8
  92. package/dist-types/ts3.4/models/errors.d.ts +55 -23
  93. package/dist-types/ts3.4/models/models_0.d.ts +277 -4
  94. package/dist-types/ts3.4/pagination/Interfaces.d.ts +1 -2
  95. package/dist-types/ts3.4/pagination/ListDataTransformationJobsPaginator.d.ts +11 -0
  96. package/dist-types/ts3.4/pagination/ListDataTransformationProfileVersionsPaginator.d.ts +11 -0
  97. package/dist-types/ts3.4/pagination/ListDataTransformationProfilesPaginator.d.ts +11 -0
  98. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  99. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +9 -22
  100. package/dist-types/ts3.4/runtimeConfig.d.ts +8 -16
  101. package/dist-types/ts3.4/runtimeConfig.native.d.ts +9 -22
  102. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -1
  103. package/dist-types/ts3.4/runtimeExtensions.d.ts +1 -1
  104. package/dist-types/ts3.4/schemas/schemas_0.d.ts +55 -0
  105. package/dist-types/ts3.4/waiters/index.d.ts +1 -0
  106. package/dist-types/ts3.4/waiters/waitForDataTransformationJobCompleted.d.ts +15 -0
  107. package/dist-types/ts3.4/waiters/waitForFHIRDatastoreActive.d.ts +3 -5
  108. package/dist-types/ts3.4/waiters/waitForFHIRDatastoreDeleted.d.ts +3 -5
  109. package/dist-types/ts3.4/waiters/waitForFHIRExportJobCompleted.d.ts +3 -5
  110. package/dist-types/ts3.4/waiters/waitForFHIRImportJobCompleted.d.ts +3 -5
  111. package/dist-types/waiters/index.d.ts +1 -0
  112. package/dist-types/waiters/waitForDataTransformationJobCompleted.d.ts +15 -0
  113. package/package.json +38 -38
@@ -1,4 +1,758 @@
1
- import type { AnalyticsStatus, AuthorizationStrategy, CmkType, DatastoreStatus, ErrorCategory, FHIRVersion, JobStatus, NlpStatus, PreloadDataType, ValidationLevel } from "./enums";
1
+ import type { AgentInputMessageType, AgentOutputMessageType, AnalyticsStatus, AuthorizationStrategy, CmkType, DatastoreStatus, ErrorCategory, FHIRVersion, JobStatus, NlpStatus, PreloadDataType, SourceFormat, TargetFormat, TransformationJobStatus, ValidationLevel } from "./enums";
2
+ /**
3
+ * <p>Identifies an existing data transformation profile and version to clone when creating a new profile.</p>
4
+ * @public
5
+ */
6
+ export interface ExistingVersionedProfileSource {
7
+ /**
8
+ * <p>The unique identifier of the existing profile to clone from.</p>
9
+ * @public
10
+ */
11
+ ProfileId: string | undefined;
12
+ /**
13
+ * <p>The version number of the existing profile to clone from.</p>
14
+ * @public
15
+ */
16
+ Version: number | undefined;
17
+ }
18
+ /**
19
+ * <p>Contains raw content to use as the source when creating a data transformation profile directly from a mapping.</p>
20
+ * @public
21
+ */
22
+ export interface ProfileMappingSource {
23
+ /**
24
+ * <p>The content as a map of file paths to profile strings.</p>
25
+ * @public
26
+ */
27
+ ProfileMapping: Record<string, string> | undefined;
28
+ }
29
+ /**
30
+ * <p>Identifies a sample data file in Amazon S3 to use as the source when creating a data transformation profile. Valid only when the source format is Comma-separated values (CSV).</p>
31
+ * @public
32
+ */
33
+ export interface SampleDataSource {
34
+ /**
35
+ * <p>The Amazon S3 URI of the sample data file.</p>
36
+ * @public
37
+ */
38
+ S3Uri: string | undefined;
39
+ }
40
+ /**
41
+ * <p>Identifies a built-in starter profile to use as the source when creating a data transformation profile. Valid only when the source format is Consolidated Clinical Document Architecture (C-CDA).</p>
42
+ * @public
43
+ */
44
+ export interface StarterProfileSource {
45
+ /**
46
+ * <p>The name of the built-in starter profile.</p>
47
+ * @public
48
+ */
49
+ StarterProfileName: string | undefined;
50
+ }
51
+ /**
52
+ * <p>The source for initial content when creating a data transformation profile. Specify exactly one variant: a built-in starter profile, an existing profile version to clone, raw profile content, or a sample data file.</p>
53
+ * @public
54
+ */
55
+ export type CreateDataTransformationProfileSource = CreateDataTransformationProfileSource.ExistingVersionedProfileIdMember | CreateDataTransformationProfileSource.ProfileMappingMember | CreateDataTransformationProfileSource.SampleDataMember | CreateDataTransformationProfileSource.StarterProfileMember | CreateDataTransformationProfileSource.$UnknownMember;
56
+ /**
57
+ * @public
58
+ */
59
+ export declare namespace CreateDataTransformationProfileSource {
60
+ /**
61
+ * <p>Creates the profile from a built-in starter profile. Valid only when the source format is Consolidated Clinical Document Architecture (C-CDA).</p>
62
+ * @public
63
+ */
64
+ interface StarterProfileMember {
65
+ StarterProfile: StarterProfileSource;
66
+ ExistingVersionedProfileId?: never;
67
+ ProfileMapping?: never;
68
+ SampleData?: never;
69
+ $unknown?: never;
70
+ }
71
+ /**
72
+ * <p>Creates the profile by cloning an existing profile at a specific version.</p>
73
+ * @public
74
+ */
75
+ interface ExistingVersionedProfileIdMember {
76
+ StarterProfile?: never;
77
+ ExistingVersionedProfileId: ExistingVersionedProfileSource;
78
+ ProfileMapping?: never;
79
+ SampleData?: never;
80
+ $unknown?: never;
81
+ }
82
+ /**
83
+ * <p>Creates the profile from raw profile content that you provide directly. Use this variant for continuous integration and continuous delivery (CI/CD) workflows.</p>
84
+ * @public
85
+ */
86
+ interface ProfileMappingMember {
87
+ StarterProfile?: never;
88
+ ExistingVersionedProfileId?: never;
89
+ ProfileMapping: ProfileMappingSource;
90
+ SampleData?: never;
91
+ $unknown?: never;
92
+ }
93
+ /**
94
+ * <p>Creates the profile from a sample data file stored in Amazon S3. Valid only when the source format is Comma-separated values (CSV).</p>
95
+ * @public
96
+ */
97
+ interface SampleDataMember {
98
+ StarterProfile?: never;
99
+ ExistingVersionedProfileId?: never;
100
+ ProfileMapping?: never;
101
+ SampleData: SampleDataSource;
102
+ $unknown?: never;
103
+ }
104
+ /**
105
+ * @public
106
+ */
107
+ interface $UnknownMember {
108
+ StarterProfile?: never;
109
+ ExistingVersionedProfileId?: never;
110
+ ProfileMapping?: never;
111
+ SampleData?: never;
112
+ $unknown: [string, any];
113
+ }
114
+ /**
115
+ * @deprecated unused in schema-serde mode.
116
+ *
117
+ */
118
+ interface Visitor<T> {
119
+ StarterProfile: (value: StarterProfileSource) => T;
120
+ ExistingVersionedProfileId: (value: ExistingVersionedProfileSource) => T;
121
+ ProfileMapping: (value: ProfileMappingSource) => T;
122
+ SampleData: (value: SampleDataSource) => T;
123
+ _: (name: string, value: any) => T;
124
+ }
125
+ }
126
+ /**
127
+ * <p>The request parameters for the <code>CreateDataTransformationProfile</code> operation.</p>
128
+ * @public
129
+ */
130
+ export interface CreateDataTransformationProfileRequest {
131
+ /**
132
+ * <p>The source data format that this profile converts from (Consolidated Clinical Document Architecture (C-CDA) or Comma-separated values (CSV)).</p>
133
+ * @public
134
+ */
135
+ SourceFormat: SourceFormat | undefined;
136
+ /**
137
+ * <p>The source for the initial profile content. Specify a built-in starter profile, an existing profile version to clone, raw profile content for CI/CD workflows, or a sample data file in Amazon S3.</p>
138
+ * @public
139
+ */
140
+ Source: CreateDataTransformationProfileSource | undefined;
141
+ /**
142
+ * <p>The AWS Key Management Service (AWS KMS) key identifier used to encrypt the profile content at rest.</p>
143
+ * @public
144
+ */
145
+ KmsKeyId?: string | undefined;
146
+ /**
147
+ * <p>A human-readable description of the profile's purpose.</p>
148
+ * @public
149
+ */
150
+ ProfileDescription?: string | undefined;
151
+ /**
152
+ * <p>A name for the data transformation profile.</p>
153
+ * @public
154
+ */
155
+ ProfileName: string | undefined;
156
+ /**
157
+ * <p>The tags to associate with the profile at creation time.</p>
158
+ * @public
159
+ */
160
+ Tags?: Record<string, string> | undefined;
161
+ /**
162
+ * <p>A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.</p>
163
+ * @public
164
+ */
165
+ ClientToken?: string | undefined;
166
+ }
167
+ /**
168
+ * <p>The response from the <code>CreateDataTransformationProfile</code> operation.</p>
169
+ * @public
170
+ */
171
+ export interface CreateDataTransformationProfileResponse {
172
+ /**
173
+ * <p>The unique identifier of the created profile.</p>
174
+ * @public
175
+ */
176
+ ProfileId: string | undefined;
177
+ /**
178
+ * <p>The version number of the newly created profile. The starting version is always 0, which indicates the profile is in DRAFT state.</p>
179
+ * @public
180
+ */
181
+ Version: number | undefined;
182
+ /**
183
+ * <p>The source data format of the profile.</p>
184
+ * @public
185
+ */
186
+ SourceFormat: SourceFormat | undefined;
187
+ /**
188
+ * <p>The target output format. Always <code>FHIR_R4</code>.</p>
189
+ * @public
190
+ */
191
+ TargetFormat: TargetFormat | undefined;
192
+ /**
193
+ * <p>The name of the created profile.</p>
194
+ * @public
195
+ */
196
+ ProfileName: string | undefined;
197
+ /**
198
+ * <p>The timestamp when the profile was last updated.</p>
199
+ * @public
200
+ */
201
+ LastUpdatedAt: Date | undefined;
202
+ }
203
+ /**
204
+ * <p>The request parameters for the <code>DeleteDataTransformationProfile</code> operation.</p>
205
+ * @public
206
+ */
207
+ export interface DeleteDataTransformationProfileRequest {
208
+ /**
209
+ * <p>The unique identifier of the profile to delete.</p>
210
+ * @public
211
+ */
212
+ ProfileId: string | undefined;
213
+ }
214
+ /**
215
+ * <p>The response from the <code>DeleteDataTransformationProfile</code> operation.</p>
216
+ * @public
217
+ */
218
+ export interface DeleteDataTransformationProfileResponse {
219
+ /**
220
+ * <p>The unique identifier of the deleted profile.</p>
221
+ * @public
222
+ */
223
+ ProfileId: string | undefined;
224
+ /**
225
+ * <p>The name of the deleted profile.</p>
226
+ * @public
227
+ */
228
+ ProfileName?: string | undefined;
229
+ /**
230
+ * <p>The timestamp when the profile was deleted.</p>
231
+ * @public
232
+ */
233
+ DeletionTime: Date | undefined;
234
+ }
235
+ /**
236
+ * <p>The request parameters for the <code>GetDataTransformationProfile</code> operation.</p>
237
+ * @public
238
+ */
239
+ export interface GetDataTransformationProfileRequest {
240
+ /**
241
+ * <p>The unique identifier of the profile to retrieve.</p>
242
+ * @public
243
+ */
244
+ ProfileId: string | undefined;
245
+ /**
246
+ * <p>The version number to retrieve. Specify 0 to retrieve the DRAFT version. If you omit this parameter, the service returns the latest published version.</p>
247
+ * @public
248
+ */
249
+ ProfileVersion?: number | undefined;
250
+ }
251
+ /**
252
+ * <p>The response from the <code>GetDataTransformationProfile</code> operation.</p>
253
+ * @public
254
+ */
255
+ export interface GetDataTransformationProfileResponse {
256
+ /**
257
+ * <p>The unique identifier of the profile.</p>
258
+ * @public
259
+ */
260
+ ProfileId: string | undefined;
261
+ /**
262
+ * <p>The version number of the retrieved profile.</p>
263
+ * @public
264
+ */
265
+ Version: number | undefined;
266
+ /**
267
+ * <p>The source data format of the profile.</p>
268
+ * @public
269
+ */
270
+ SourceFormat: SourceFormat | undefined;
271
+ /**
272
+ * <p>The target output format of the profile.</p>
273
+ * @public
274
+ */
275
+ TargetFormat: TargetFormat | undefined;
276
+ /**
277
+ * <p>The profile content as a map of file paths to content strings.</p>
278
+ * @public
279
+ */
280
+ ProfileMapping: Record<string, string> | undefined;
281
+ /**
282
+ * <p>The name of the profile.</p>
283
+ * @public
284
+ */
285
+ ProfileName?: string | undefined;
286
+ /**
287
+ * <p>The description of the profile.</p>
288
+ * @public
289
+ */
290
+ ProfileDescription?: string | undefined;
291
+ /**
292
+ * <p>A description of what changed in this version.</p>
293
+ * @public
294
+ */
295
+ ChangeDescription?: string | undefined;
296
+ /**
297
+ * <p>The timestamp when this version was last updated.</p>
298
+ * @public
299
+ */
300
+ LastUpdatedAt: Date | undefined;
301
+ }
302
+ /**
303
+ * <p>The request parameters for the <code>ListDataTransformationProfiles</code> operation.</p>
304
+ * @public
305
+ */
306
+ export interface ListDataTransformationProfilesRequest {
307
+ /**
308
+ * <p>Filters the results by source data format.</p>
309
+ * @public
310
+ */
311
+ SourceFormat: SourceFormat | undefined;
312
+ /**
313
+ * <p>The maximum number of profiles to return per page. If you don't specify a value, the service returns up to 100 results.</p>
314
+ * @public
315
+ */
316
+ MaxResults?: number | undefined;
317
+ /**
318
+ * <p>The pagination token from a previous response. Pass this value to retrieve the next page of results.</p>
319
+ * @public
320
+ */
321
+ NextToken?: string | undefined;
322
+ }
323
+ /**
324
+ * <p>Contains summary information about a data transformation profile. To retrieve profile content, call <code>GetDataTransformationProfile</code>.</p>
325
+ * @public
326
+ */
327
+ export interface DataTransformationProfileSummary {
328
+ /**
329
+ * <p>The unique identifier of the profile.</p>
330
+ * @public
331
+ */
332
+ ProfileId: string | undefined;
333
+ /**
334
+ * <p>The latest version number of the profile.</p>
335
+ * @public
336
+ */
337
+ Version: number | undefined;
338
+ /**
339
+ * <p>The source data format that this profile converts from.</p>
340
+ * @public
341
+ */
342
+ SourceFormat: SourceFormat | undefined;
343
+ /**
344
+ * <p>The target output format of the profile.</p>
345
+ * @public
346
+ */
347
+ TargetFormat: TargetFormat | undefined;
348
+ /**
349
+ * <p>The name of the profile.</p>
350
+ * @public
351
+ */
352
+ ProfileName?: string | undefined;
353
+ /**
354
+ * <p>A description of the profile's purpose.</p>
355
+ * @public
356
+ */
357
+ ProfileDescription?: string | undefined;
358
+ /**
359
+ * <p>The timestamp when the profile was last updated.</p>
360
+ * @public
361
+ */
362
+ LastUpdatedAt?: Date | undefined;
363
+ }
364
+ /**
365
+ * <p>The response from the <code>ListDataTransformationProfiles</code> operation.</p>
366
+ * @public
367
+ */
368
+ export interface ListDataTransformationProfilesResponse {
369
+ /**
370
+ * <p>The list of data transformation profile summaries.</p>
371
+ * @public
372
+ */
373
+ Items: DataTransformationProfileSummary[] | undefined;
374
+ /**
375
+ * <p>The pagination token to use in the next request. If this value is <code>null</code>, there are no more results.</p>
376
+ * @public
377
+ */
378
+ NextToken?: string | undefined;
379
+ }
380
+ /**
381
+ * <p>The request parameters for the <code>ListDataTransformationProfileVersions</code> operation.</p>
382
+ * @public
383
+ */
384
+ export interface ListDataTransformationProfileVersionsRequest {
385
+ /**
386
+ * <p>The unique identifier of the profile whose versions to list.</p>
387
+ * @public
388
+ */
389
+ ProfileId: string | undefined;
390
+ /**
391
+ * <p>The maximum number of profile versions to return per page. If you don't specify a value, the service returns up to 100 results.</p>
392
+ * @public
393
+ */
394
+ MaxResults?: number | undefined;
395
+ /**
396
+ * <p>The pagination token from a previous response. Pass this value to retrieve the next page of results.</p>
397
+ * @public
398
+ */
399
+ NextToken?: string | undefined;
400
+ }
401
+ /**
402
+ * <p>Contains summary information about a specific version of a data transformation profile. To retrieve profile content, call <code>GetDataTransformationProfile</code>.</p>
403
+ * @public
404
+ */
405
+ export interface DataTransformationProfileVersionSummary {
406
+ /**
407
+ * <p>The unique identifier of the profile.</p>
408
+ * @public
409
+ */
410
+ ProfileId: string | undefined;
411
+ /**
412
+ * <p>The version number.</p>
413
+ * @public
414
+ */
415
+ Version: number | undefined;
416
+ /**
417
+ * <p>The source data format that this profile converts from.</p>
418
+ * @public
419
+ */
420
+ SourceFormat: SourceFormat | undefined;
421
+ /**
422
+ * <p>The target output format of the profile.</p>
423
+ * @public
424
+ */
425
+ TargetFormat: TargetFormat | undefined;
426
+ /**
427
+ * <p>The name of the profile.</p>
428
+ * @public
429
+ */
430
+ ProfileName?: string | undefined;
431
+ /**
432
+ * <p>A description of what changed in this version.</p>
433
+ * @public
434
+ */
435
+ ChangeDescription?: string | undefined;
436
+ /**
437
+ * <p>The timestamp when this version was last updated.</p>
438
+ * @public
439
+ */
440
+ LastUpdatedAt?: Date | undefined;
441
+ }
442
+ /**
443
+ * <p>The response from the <code>ListDataTransformationProfileVersions</code> operation.</p>
444
+ * @public
445
+ */
446
+ export interface ListDataTransformationProfileVersionsResponse {
447
+ /**
448
+ * <p>The list of data transformation profile version summaries.</p>
449
+ * @public
450
+ */
451
+ Items: DataTransformationProfileVersionSummary[] | undefined;
452
+ /**
453
+ * <p>The pagination token to use in the next request. If this value is <code>null</code>, there are no more results.</p>
454
+ * @public
455
+ */
456
+ NextToken?: string | undefined;
457
+ }
458
+ /**
459
+ * <p>The request parameters for the <code>PublishDataTransformationProfile</code> operation.</p>
460
+ * @public
461
+ */
462
+ export interface PublishDataTransformationProfileRequest {
463
+ /**
464
+ * <p>The unique identifier of the profile to publish.</p>
465
+ * @public
466
+ */
467
+ ProfileId: string | undefined;
468
+ /**
469
+ * <p>The source data format of the profile.</p>
470
+ * @public
471
+ */
472
+ SourceFormat: SourceFormat | undefined;
473
+ /**
474
+ * <p>The version number of a previously published version to republish as the new latest version. Use this parameter for rollback scenarios. If you omit this parameter, the service publishes the current DRAFT version.</p>
475
+ * @public
476
+ */
477
+ FromExistingVersion?: number | undefined;
478
+ /**
479
+ * <p>A description of what changed or why this version is being published.</p>
480
+ * @public
481
+ */
482
+ ChangeDescription?: string | undefined;
483
+ }
484
+ /**
485
+ * <p>The response from the <code>PublishDataTransformationProfile</code> operation.</p>
486
+ * @public
487
+ */
488
+ export interface PublishDataTransformationProfileResponse {
489
+ /**
490
+ * <p>The unique identifier of the published profile.</p>
491
+ * @public
492
+ */
493
+ ProfileId: string | undefined;
494
+ /**
495
+ * <p>The new version number that was created.</p>
496
+ * @public
497
+ */
498
+ Version: number | undefined;
499
+ /**
500
+ * <p>The source data format of the profile.</p>
501
+ * @public
502
+ */
503
+ SourceFormat: SourceFormat | undefined;
504
+ /**
505
+ * <p>The target output format of the profile.</p>
506
+ * @public
507
+ */
508
+ TargetFormat: TargetFormat | undefined;
509
+ /**
510
+ * <p>The name of the published profile.</p>
511
+ * @public
512
+ */
513
+ ProfileName?: string | undefined;
514
+ /**
515
+ * <p>The timestamp when the profile was last updated.</p>
516
+ * @public
517
+ */
518
+ LastUpdatedAt: Date | undefined;
519
+ }
520
+ /**
521
+ * <p>The Amazon S3 location and source format configuration for input data in a transformation job.</p>
522
+ * @public
523
+ */
524
+ export interface TransformationInputDataConfig {
525
+ /**
526
+ * <p>The Amazon S3 URI of the input data to transform.</p>
527
+ * @public
528
+ */
529
+ S3Uri: string | undefined;
530
+ /**
531
+ * <p>The format of the source data files (C-CDA or CSV).</p>
532
+ * @public
533
+ */
534
+ SourceFormat?: SourceFormat | undefined;
535
+ }
536
+ /**
537
+ * <p>The Amazon S3 output configuration for a data transformation job, including the output location and encryption settings.</p>
538
+ * @public
539
+ */
540
+ export interface DataTransformationS3Configuration {
541
+ /**
542
+ * <p>The Amazon S3 URI where AWS HealthLake writes the converted output files.</p>
543
+ * @public
544
+ */
545
+ S3Uri: string | undefined;
546
+ /**
547
+ * <p>The AWS Key Management Service (AWS KMS) key identifier used to encrypt the transformation job output written to Amazon S3.</p>
548
+ * @public
549
+ */
550
+ KmsKeyId: string | undefined;
551
+ }
552
+ /**
553
+ * <p>The Amazon S3 output location and encryption configuration for a transformation job.</p>
554
+ * @public
555
+ */
556
+ export interface TransformationOutputDataConfig {
557
+ /**
558
+ * <p>The Amazon S3 output location and AWS Key Management Service (AWS KMS) encryption configuration.</p>
559
+ * @public
560
+ */
561
+ S3Configuration: DataTransformationS3Configuration | undefined;
562
+ }
563
+ /**
564
+ * <p>The request parameters for the <code>StartDataTransformationJob</code> operation.</p>
565
+ * @public
566
+ */
567
+ export interface StartDataTransformationJobRequest {
568
+ /**
569
+ * <p>The Amazon S3 location and format of the source files to transform.</p>
570
+ * @public
571
+ */
572
+ InputDataConfig: TransformationInputDataConfig | undefined;
573
+ /**
574
+ * <p>The Amazon S3 output location and AWS Key Management Service (AWS KMS) encryption configuration.</p>
575
+ * @public
576
+ */
577
+ OutputDataConfig: TransformationOutputDataConfig | undefined;
578
+ /**
579
+ * <p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that AWS HealthLake assumes to read from and write to the specified Amazon S3 locations.</p>
580
+ * @public
581
+ */
582
+ DataAccessRoleArn: string | undefined;
583
+ /**
584
+ * <p>A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.</p>
585
+ * @public
586
+ */
587
+ ClientToken: string | undefined;
588
+ /**
589
+ * <p>A descriptive name for the data transformation job.</p>
590
+ * @public
591
+ */
592
+ JobName?: string | undefined;
593
+ /**
594
+ * <p>The unique identifier of the data transformation profile to use for conversion.</p>
595
+ * @public
596
+ */
597
+ ProfileId: string | undefined;
598
+ /**
599
+ * <p>Specifies whether drift detection is enabled for this job. When enabled, AWS HealthLake writes a drift report to the output Amazon S3 location alongside the converted files.</p>
600
+ * @public
601
+ */
602
+ DriftDetectionEnabled?: boolean | undefined;
603
+ /**
604
+ * <p>Specifies whether FHIR R4 Provenance resource generation is enabled for this transformation job. When provenance is enabled, the service also generates related DocumentReference and Device resources. If you don't specify a value, the default is <code>true</code>. To disable provenance output, set this parameter to <code>false</code>.</p>
605
+ * @public
606
+ */
607
+ ProvenanceEnabled?: boolean | undefined;
608
+ }
609
+ /**
610
+ * <p>The response from the <code>StartDataTransformationJob</code> operation.</p>
611
+ * @public
612
+ */
613
+ export interface StartDataTransformationJobResponse {
614
+ /**
615
+ * <p>The unique identifier assigned to the data transformation job.</p>
616
+ * @public
617
+ */
618
+ JobId: string | undefined;
619
+ /**
620
+ * <p>The initial status of the data transformation job.</p>
621
+ * @public
622
+ */
623
+ JobStatus: TransformationJobStatus | undefined;
624
+ }
625
+ /**
626
+ * <p>The request parameters for the <code>UpdateDataTransformationProfile</code> operation.</p>
627
+ * @public
628
+ */
629
+ export interface UpdateDataTransformationProfileRequest {
630
+ /**
631
+ * <p>The unique identifier of the profile to update.</p>
632
+ * @public
633
+ */
634
+ ProfileId: string | undefined;
635
+ /**
636
+ * <p>The new profile content for the DRAFT version. This is a full replacement of all profile files.</p>
637
+ * @public
638
+ */
639
+ ProfileMapping: Record<string, string> | undefined;
640
+ /**
641
+ * <p>A description of what changed in this update.</p>
642
+ * @public
643
+ */
644
+ ChangeDescription?: string | undefined;
645
+ }
646
+ /**
647
+ * <p>The response from the <code>UpdateDataTransformationProfile</code> operation.</p>
648
+ * @public
649
+ */
650
+ export interface UpdateDataTransformationProfileResponse {
651
+ /**
652
+ * <p>The unique identifier of the updated profile.</p>
653
+ * @public
654
+ */
655
+ ProfileId: string | undefined;
656
+ /**
657
+ * <p>The source data format of the profile.</p>
658
+ * @public
659
+ */
660
+ SourceFormat: SourceFormat | undefined;
661
+ /**
662
+ * <p>The target output format of the profile.</p>
663
+ * @public
664
+ */
665
+ TargetFormat: TargetFormat | undefined;
666
+ /**
667
+ * <p>The name of the updated profile.</p>
668
+ * @public
669
+ */
670
+ ProfileName?: string | undefined;
671
+ /**
672
+ * <p>The timestamp when the profile was last updated.</p>
673
+ * @public
674
+ */
675
+ LastUpdatedAt: Date | undefined;
676
+ }
677
+ /**
678
+ * <p>Represents a message sent to the agent during chat-based profile customization.</p>
679
+ * @public
680
+ */
681
+ export interface AgentInputMessage {
682
+ /**
683
+ * <p>The text of your message to the agent.</p>
684
+ * @public
685
+ */
686
+ Body: string | undefined;
687
+ /**
688
+ * <p>The type of input message, which determines how the agent processes your request. Valid values:</p> <ul> <li> <p> <code>normal</code>: A regular message to the agent.</p> </li> <li> <p> <code>confirmation_response</code>: A response to a confirmation request from the agent.</p> </li> </ul>
689
+ * @public
690
+ */
691
+ Type: AgentInputMessageType | undefined;
692
+ }
693
+ /**
694
+ * <p>The request parameters for the <code>UpdateProfileWithAgent</code> operation.</p>
695
+ * @public
696
+ */
697
+ export interface UpdateProfileWithAgentRequest {
698
+ /**
699
+ * <p>The unique identifier of the profile to update via the agent.</p>
700
+ * @public
701
+ */
702
+ ProfileId: string | undefined;
703
+ /**
704
+ * <p>The source data format for the transformation.</p>
705
+ * @public
706
+ */
707
+ SourceFormat: SourceFormat | undefined;
708
+ /**
709
+ * <p>The message to send to the agent.</p>
710
+ * @public
711
+ */
712
+ InputMessage: AgentInputMessage | undefined;
713
+ /**
714
+ * <p>The conversation identifier for multi-turn interactions. Omit to start a new conversation.</p>
715
+ * @public
716
+ */
717
+ ConversationId?: string | undefined;
718
+ }
719
+ /**
720
+ * <p>Represents a response message from the agent during chat-based profile customization.</p>
721
+ * @public
722
+ */
723
+ export interface AgentOutputMessage {
724
+ /**
725
+ * <p>The text of the agent's response.</p>
726
+ * @public
727
+ */
728
+ Body: string | undefined;
729
+ /**
730
+ * <p>The type of output message, which indicates how to interpret the agent's response.</p>
731
+ * @public
732
+ */
733
+ Type: AgentOutputMessageType | undefined;
734
+ /**
735
+ * <p>A list of selectable options presented when the response type is <code>options</code>.</p>
736
+ * @public
737
+ */
738
+ OptionsList?: string[] | undefined;
739
+ }
740
+ /**
741
+ * <p>The response from the <code>UpdateProfileWithAgent</code> operation.</p>
742
+ * @public
743
+ */
744
+ export interface UpdateProfileWithAgentResponse {
745
+ /**
746
+ * <p>The response message from the agent.</p>
747
+ * @public
748
+ */
749
+ AgentResponse: AgentOutputMessage | undefined;
750
+ /**
751
+ * <p>The conversation identifier to use for follow-up messages in this conversation.</p>
752
+ * @public
753
+ */
754
+ ConversationId: string | undefined;
755
+ }
2
756
  /**
3
757
  * <p>The analytics configuration for a data store.</p>
4
758
  * @public
@@ -16,64 +770,22 @@ export interface AnalyticsConfiguration {
16
770
  */
17
771
  export interface IdentityProviderConfiguration {
18
772
  /**
19
- * <p>The authorization strategy selected when the HealthLake data store is created.</p>
20
- * <note>
21
- * <p>HealthLake provides support for both SMART on FHIR V1 and V2 as described below.</p>
22
- * <ul>
23
- * <li>
24
- * <p>
25
- * <code>SMART_ON_FHIR_V1</code> – Support for only SMART on FHIR V1, which
26
- * includes <code>read</code> (read/search) and <code>write</code>
27
- * (create/update/delete) permissions.</p>
28
- * </li>
29
- * <li>
30
- * <p>
31
- * <code>SMART_ON_FHIR</code> – Support for both SMART on FHIR V1 and V2,
32
- * which includes <code>create</code>, <code>read</code>, <code>update</code>,
33
- * <code>delete</code>, and <code>search</code> permissions.</p>
34
- * </li>
35
- * <li>
36
- * <p>
37
- * <code>AWS_AUTH</code> – The default HealthLake authorization
38
- * strategy; not affiliated with SMART on FHIR.</p>
39
- * </li>
40
- * </ul>
41
- * </note>
773
+ * <p>The authorization strategy selected when the HealthLake data store is created.</p> <note> <p>HealthLake provides support for both SMART on FHIR V1 and V2 as described below.</p> <ul> <li> <p> <code>SMART_ON_FHIR_V1</code> – Support for only SMART on FHIR V1, which includes <code>read</code> (read/search) and <code>write</code> (create/update/delete) permissions.</p> </li> <li> <p> <code>SMART_ON_FHIR</code> – Support for both SMART on FHIR V1 and V2, which includes <code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>, and <code>search</code> permissions.</p> </li> <li> <p> <code>AWS_AUTH</code> – The default HealthLake authorization strategy; not affiliated with SMART on FHIR.</p> </li> </ul> </note>
42
774
  * @public
43
775
  */
44
776
  AuthorizationStrategy: AuthorizationStrategy | undefined;
45
777
  /**
46
- * <p>The parameter to enable SMART on FHIR fine-grained authorization for the data
47
- * store.</p>
778
+ * <p>The parameter to enable SMART on FHIR fine-grained authorization for the data store.</p>
48
779
  * @public
49
780
  */
50
781
  FineGrainedAuthorizationEnabled?: boolean | undefined;
51
782
  /**
52
- * <p>The JSON metadata elements to use in your identity provider configuration. Required
53
- * elements are listed based on the launch specification of the SMART application. For more
54
- * 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>
55
- * <p>
56
- * <code>authorization_endpoint</code>: The URL to the OAuth2 authorization
57
- * endpoint.</p>
58
- * <p>
59
- * <code>grant_types_supported</code>: An array of grant types that are supported at the
60
- * token endpoint. You must provide at least one grant type option. Valid options are
61
- * <code>authorization_code</code> and <code>client_credentials</code>.</p>
62
- * <p>
63
- * <code>token_endpoint</code>: The URL to the OAuth2 token endpoint.</p>
64
- * <p>
65
- * <code>capabilities</code>: An array of strings of the SMART capabilities that the
66
- * authorization server supports.</p>
67
- * <p>
68
- * <code>code_challenge_methods_supported</code>: An array of strings of supported PKCE
69
- * code challenge methods. You must include the <code>S256</code> method in the array of PKCE
70
- * code challenge methods.</p>
783
+ * <p>The JSON metadata elements 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> <p> <code>authorization_endpoint</code>: The URL to the OAuth2 authorization endpoint.</p> <p> <code>grant_types_supported</code>: An array of grant types that are supported at the token endpoint. You must provide at least one grant type option. Valid options are <code>authorization_code</code> and <code>client_credentials</code>.</p> <p> <code>token_endpoint</code>: The URL to the OAuth2 token endpoint.</p> <p> <code>capabilities</code>: An array of strings of the SMART capabilities that the authorization server supports.</p> <p> <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>
71
784
  * @public
72
785
  */
73
786
  Metadata?: string | undefined;
74
787
  /**
75
- * <p>The Amazon Resource Name (ARN) of the Lambda function to use to decode the access token created by the
76
- * authorization server.</p>
788
+ * <p>The Amazon Resource Name (ARN) of the Lambda function to use to decode the access token created by the authorization server.</p>
77
789
  * @public
78
790
  */
79
791
  IdpLambdaArn?: string | undefined;
@@ -112,8 +824,7 @@ export interface ProfileConfiguration {
112
824
  DefaultProfiles?: string[] | undefined;
113
825
  }
114
826
  /**
115
- * <p>The customer-managed-key (CMK) used when creating a data store. If a customer-owned key
116
- * is not specified, an AWS-owned key is used for encryption. </p>
827
+ * <p>The customer-managed-key (CMK) used when creating a data store. If a customer-owned key is not specified, an AWS-owned key is used for encryption. </p>
117
828
  * @public
118
829
  */
119
830
  export interface KmsEncryptionConfig {
@@ -123,28 +834,24 @@ export interface KmsEncryptionConfig {
123
834
  */
124
835
  CmkType: CmkType | undefined;
125
836
  /**
126
- * <p>The Key Management Service (KMS) encryption key id/alias used to encrypt the data store contents at
127
- * rest.</p>
837
+ * <p>The Key Management Service (KMS) encryption key id/alias used to encrypt the data store contents at rest.</p>
128
838
  * @public
129
839
  */
130
840
  KmsKeyId?: string | undefined;
131
841
  }
132
842
  /**
133
- * <p>The server-side encryption key configuration for a customer-provided encryption
134
- * key.</p>
843
+ * <p>The server-side encryption key configuration for a customer-provided encryption key.</p>
135
844
  * @public
136
845
  */
137
846
  export interface SseConfiguration {
138
847
  /**
139
- * <p>The Key Management Service (KMS) encryption configuration used to provide details for data
140
- * encryption.</p>
848
+ * <p>The Key Management Service (KMS) encryption configuration used to provide details for data encryption.</p>
141
849
  * @public
142
850
  */
143
851
  KmsEncryptionConfig: KmsEncryptionConfig | undefined;
144
852
  }
145
853
  /**
146
- * <p>A label consisting of a user-defined key and value. The form for tags is \{"Key",
147
- * "Value"\}</p>
854
+ * <p>A label consisting of a user-defined key and value. The form for tags is \{"Key", "Value"\}</p>
148
855
  * @public
149
856
  */
150
857
  export interface Tag {
@@ -169,20 +876,17 @@ export interface CreateFHIRDatastoreRequest {
169
876
  */
170
877
  DatastoreName?: string | undefined;
171
878
  /**
172
- * <p>The FHIR release version supported by the data store. Current support is for version
173
- * <code>R4</code>.</p>
879
+ * <p>The FHIR release version supported by the data store. Current support is for version <code>R4</code>.</p>
174
880
  * @public
175
881
  */
176
882
  DatastoreTypeVersion: FHIRVersion | undefined;
177
883
  /**
178
- * <p>The server-side encryption key configuration for a customer-provided encryption key
179
- * specified for creating a data store. </p>
884
+ * <p>The server-side encryption key configuration for a customer-provided encryption key specified for creating a data store. </p>
180
885
  * @public
181
886
  */
182
887
  SseConfiguration?: SseConfiguration | undefined;
183
888
  /**
184
- * <p>An optional parameter to preload (import) open source Synthea FHIR data upon creation of
185
- * the data store.</p>
889
+ * <p>An optional parameter to preload (import) open source Synthea FHIR data upon creation of the data store.</p>
186
890
  * @public
187
891
  */
188
892
  PreloadDataConfig?: PreloadDataConfig | undefined;
@@ -258,21 +962,18 @@ export interface DatastoreFilter {
258
962
  */
259
963
  DatastoreStatus?: DatastoreStatus | undefined;
260
964
  /**
261
- * <p>Filter to set cutoff dates for records. All data stores created before the specified
262
- * date are included in the results. </p>
965
+ * <p>Filter to set cutoff dates for records. All data stores created before the specified date are included in the results. </p>
263
966
  * @public
264
967
  */
265
968
  CreatedBefore?: Date | undefined;
266
969
  /**
267
- * <p>Filter to set cutoff dates for records. All data stores created after the specified date
268
- * are included in the results.</p>
970
+ * <p>Filter to set cutoff dates for records. All data stores created after the specified date are included in the results.</p>
269
971
  * @public
270
972
  */
271
973
  CreatedAfter?: Date | undefined;
272
974
  }
273
975
  /**
274
- * <p>The error information for <code>CreateFHIRDatastore</code> and
275
- * <code>DeleteFHIRDatastore</code> actions.</p>
976
+ * <p>The error information for <code>CreateFHIRDatastore</code> and <code>DeleteFHIRDatastore</code> actions.</p>
276
977
  * @public
277
978
  */
278
979
  export interface ErrorCause {
@@ -318,8 +1019,7 @@ export interface DatastoreProperties {
318
1019
  */
319
1020
  CreatedAt?: Date | undefined;
320
1021
  /**
321
- * <p>The FHIR release version supported by the data store. Current support is for version
322
- * <code>R4</code>.</p>
1022
+ * <p>The FHIR release version supported by the data store. Current support is for version <code>R4</code>.</p>
323
1023
  * @public
324
1024
  */
325
1025
  DatastoreTypeVersion: FHIRVersion | undefined;
@@ -329,8 +1029,7 @@ export interface DatastoreProperties {
329
1029
  */
330
1030
  DatastoreEndpoint: string | undefined;
331
1031
  /**
332
- * <p> The server-side encryption key configuration for a customer provided encryption
333
- * key.</p>
1032
+ * <p> The server-side encryption key configuration for a customer provided encryption key.</p>
334
1033
  * @public
335
1034
  */
336
1035
  SseConfiguration?: SseConfiguration | undefined;
@@ -400,6 +1099,135 @@ export interface DeleteFHIRDatastoreResponse {
400
1099
  */
401
1100
  DatastoreEndpoint: string | undefined;
402
1101
  }
1102
+ /**
1103
+ * <p>The request parameters for the <code>DescribeDataTransformationJob</code> operation.</p>
1104
+ * @public
1105
+ */
1106
+ export interface DescribeDataTransformationJobRequest {
1107
+ /**
1108
+ * <p>The unique identifier of the data transformation job to describe.</p>
1109
+ * @public
1110
+ */
1111
+ JobId: string | undefined;
1112
+ }
1113
+ /**
1114
+ * <p>Contains progress metrics for a data transformation job, including counts of files scanned, converted, and failed.</p>
1115
+ * @public
1116
+ */
1117
+ export interface TransformationJobProgressReport {
1118
+ /**
1119
+ * <p>The total number of source files scanned by the job.</p>
1120
+ * @public
1121
+ */
1122
+ TotalFilesScanned: number | undefined;
1123
+ /**
1124
+ * <p>The total number of source files successfully converted.</p>
1125
+ * @public
1126
+ */
1127
+ TotalFilesConverted: number | undefined;
1128
+ /**
1129
+ * <p>The total number of source files that failed conversion.</p>
1130
+ * @public
1131
+ */
1132
+ TotalFilesFailed: number | undefined;
1133
+ /**
1134
+ * <p>The total number of FHIR R4 resources generated across all converted files.</p>
1135
+ * @public
1136
+ */
1137
+ TotalResourcesGenerated: number | undefined;
1138
+ }
1139
+ /**
1140
+ * <p>Contains the properties of a data transformation job, including its status, configuration, and progress information. You retrieve this structure by calling <code>DescribeDataTransformationJob</code>.</p>
1141
+ * @public
1142
+ */
1143
+ export interface TransformationJobProperties {
1144
+ /**
1145
+ * <p>The unique identifier of the data transformation job.</p>
1146
+ * @public
1147
+ */
1148
+ JobId: string | undefined;
1149
+ /**
1150
+ * <p>The current status of the data transformation job.</p>
1151
+ * @public
1152
+ */
1153
+ JobStatus: TransformationJobStatus | undefined;
1154
+ /**
1155
+ * <p>The Amazon S3 location and format of the source files for this job.</p>
1156
+ * @public
1157
+ */
1158
+ InputDataConfig: TransformationInputDataConfig | undefined;
1159
+ /**
1160
+ * <p>The Amazon S3 location and encryption configuration for the converted output.</p>
1161
+ * @public
1162
+ */
1163
+ OutputDataConfig: TransformationOutputDataConfig | undefined;
1164
+ /**
1165
+ * <p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants AWS HealthLake access to the specified Amazon S3 locations. AWS HealthLake assumes this role to read input files and write output files.</p>
1166
+ * @public
1167
+ */
1168
+ DataAccessRoleArn: string | undefined;
1169
+ /**
1170
+ * <p>The timestamp when the job was submitted.</p>
1171
+ * @public
1172
+ */
1173
+ SubmitTime: Date | undefined;
1174
+ /**
1175
+ * <p>The name of the data transformation job.</p>
1176
+ * @public
1177
+ */
1178
+ JobName?: string | undefined;
1179
+ /**
1180
+ * <p>The unique identifier of the data transformation profile used for this job.</p>
1181
+ * @public
1182
+ */
1183
+ ProfileId?: string | undefined;
1184
+ /**
1185
+ * <p>The name of the data transformation profile used for this job.</p>
1186
+ * @public
1187
+ */
1188
+ ProfileName?: string | undefined;
1189
+ /**
1190
+ * <p>The version number of the data transformation profile used for this job.</p>
1191
+ * @public
1192
+ */
1193
+ ProfileVersion?: number | undefined;
1194
+ /**
1195
+ * <p>The timestamp when the job completed or failed.</p>
1196
+ * @public
1197
+ */
1198
+ EndTime?: Date | undefined;
1199
+ /**
1200
+ * <p>Specifies whether drift detection is enabled for this job. When enabled, AWS HealthLake writes a drift report to the output Amazon S3 location alongside the converted files.</p>
1201
+ * @public
1202
+ */
1203
+ DriftDetectionEnabled?: boolean | undefined;
1204
+ /**
1205
+ * <p>Specifies whether FHIR R4 Provenance resource generation is enabled for this transformation job. When provenance is enabled, the service also generates related DocumentReference and Device resources.</p>
1206
+ * @public
1207
+ */
1208
+ ProvenanceEnabled?: boolean | undefined;
1209
+ /**
1210
+ * <p>An informational message about the job, such as an error description if the job failed.</p>
1211
+ * @public
1212
+ */
1213
+ Message?: string | undefined;
1214
+ /**
1215
+ * <p>The progress report for the data transformation job, including counts of files processed and resources generated.</p>
1216
+ * @public
1217
+ */
1218
+ JobProgressReport?: TransformationJobProgressReport | undefined;
1219
+ }
1220
+ /**
1221
+ * <p>The response from the <code>DescribeDataTransformationJob</code> operation.</p>
1222
+ * @public
1223
+ */
1224
+ export interface DescribeDataTransformationJobResponse {
1225
+ /**
1226
+ * <p>The properties of the data transformation job, including status, configuration, and progress information.</p>
1227
+ * @public
1228
+ */
1229
+ TransformationJobProperties: TransformationJobProperties | undefined;
1230
+ }
403
1231
  /**
404
1232
  * @public
405
1233
  */
@@ -436,14 +1264,12 @@ export interface DescribeFHIRExportJobRequest {
436
1264
  JobId: string | undefined;
437
1265
  }
438
1266
  /**
439
- * <p>The configuration of the S3 bucket for either an import or export job. This includes
440
- * assigning access permissions.</p>
1267
+ * <p>The configuration of the S3 bucket for either an import or export job. This includes assigning access permissions.</p>
441
1268
  * @public
442
1269
  */
443
1270
  export interface S3Configuration {
444
1271
  /**
445
- * <p>The <code>S3Uri</code> is the user-specified S3 location of the FHIR data to be
446
- * imported into AWS HealthLake.</p>
1272
+ * <p>The <code>S3Uri</code> is the user-specified S3 location of the FHIR data to be imported into AWS HealthLake.</p>
447
1273
  * @public
448
1274
  */
449
1275
  S3Uri: string | undefined;
@@ -572,8 +1398,7 @@ export type InputDataConfig = InputDataConfig.S3UriMember | InputDataConfig.$Unk
572
1398
  */
573
1399
  export declare namespace InputDataConfig {
574
1400
  /**
575
- * <p>The <code>S3Uri</code> is the user-specified S3 location of the FHIR data to be
576
- * imported into AWS HealthLake.</p>
1401
+ * <p>The <code>S3Uri</code> is the user-specified S3 location of the FHIR data to be imported into AWS HealthLake.</p>
577
1402
  * @public
578
1403
  */
579
1404
  interface S3UriMember {
@@ -632,16 +1457,65 @@ export interface JobProgressReport {
632
1457
  */
633
1458
  TotalNumberOfResourcesWithCustomerError?: number | undefined;
634
1459
  /**
635
- * <p>The number of files that failed to be read from the S3 input bucket due to customer
636
- * error.</p>
1460
+ * <p>The number of files that failed to be read from the S3 input bucket due to customer error.</p>
637
1461
  * @public
638
1462
  */
639
1463
  TotalNumberOfFilesReadWithCustomerError?: number | undefined;
1464
+ /**
1465
+ * The number of non-FHIR files scanned from the S3 input bucket.
1466
+ * @public
1467
+ */
1468
+ TotalNumberOfScannedNonFhirFiles?: number | undefined;
1469
+ /**
1470
+ * The size (in MB) of non-FHIR files scanned from the S3 input bucket.
1471
+ * @public
1472
+ */
1473
+ TotalSizeOfScannedNonFhirFilesInMB?: number | undefined;
1474
+ /**
1475
+ * The number of non-FHIR files imported.
1476
+ * @public
1477
+ */
1478
+ TotalNumberOfImportedNonFhirFiles?: number | undefined;
1479
+ /**
1480
+ * The number of non-FHIR resources scanned from the S3 input bucket.
1481
+ * @public
1482
+ */
1483
+ TotalNumberOfNonFhirResourcesScanned?: number | undefined;
1484
+ /**
1485
+ * The number of non-FHIR resources imported.
1486
+ * @public
1487
+ */
1488
+ TotalNumberOfNonFhirResourcesImported?: number | undefined;
1489
+ /**
1490
+ * The number of non-FHIR resources that failed due to customer error.
1491
+ * @public
1492
+ */
1493
+ TotalNumberOfNonFhirResourcesWithCustomerError?: number | undefined;
1494
+ /**
1495
+ * The number of non-FHIR files that failed to be read from the S3 input bucket due to customer error.
1496
+ * @public
1497
+ */
1498
+ TotalNumberOfNonFhirFilesReadWithCustomerError?: number | undefined;
640
1499
  /**
641
1500
  * <p>The transaction rate the import job is processed at.</p>
642
1501
  * @public
643
1502
  */
644
1503
  Throughput?: number | undefined;
1504
+ /**
1505
+ * Number of CCDA files successfully transformed during the import's
1506
+ * transformation phase. Populated only for import jobs that use the
1507
+ * two-Step-Function (transformation + ingestion) flow; null for legacy
1508
+ * single-SF imports and for pure FHIR imports that skip transformation.
1509
+ * @public
1510
+ */
1511
+ TotalFilesConverted?: number | undefined;
1512
+ /**
1513
+ * Number of FHIR resources produced by the transformation phase.
1514
+ * Populated only for import jobs that use the two-Step-Function flow;
1515
+ * null for legacy single-SF imports and for pure FHIR imports.
1516
+ * @public
1517
+ */
1518
+ TotalResourcesGenerated?: number | undefined;
645
1519
  }
646
1520
  /**
647
1521
  * <p>The import job properties.</p>
@@ -689,8 +1563,7 @@ export interface ImportJobProperties {
689
1563
  */
690
1564
  JobOutputDataConfig?: OutputDataConfig | undefined;
691
1565
  /**
692
- * <p>Displays the progress of the import job, including total resources scanned, total
693
- * resources imported, and total size of data imported.</p>
1566
+ * <p>Displays the progress of the import job, including total resources scanned, total resources imported, and total size of data imported.</p>
694
1567
  * @public
695
1568
  */
696
1569
  JobProgressReport?: JobProgressReport | undefined;
@@ -720,6 +1593,94 @@ export interface DescribeFHIRImportJobResponse {
720
1593
  */
721
1594
  ImportJobProperties: ImportJobProperties | undefined;
722
1595
  }
1596
+ /**
1597
+ * <p>The request parameters for the <code>ListDataTransformationJobs</code> operation.</p>
1598
+ * @public
1599
+ */
1600
+ export interface ListDataTransformationJobsRequest {
1601
+ /**
1602
+ * <p>The maximum number of jobs to return per page. If you don't specify a value, the service returns up to 100 results.</p>
1603
+ * @public
1604
+ */
1605
+ MaxResults?: number | undefined;
1606
+ /**
1607
+ * <p>The pagination token from a previous response. Pass this value to retrieve the next page of results.</p>
1608
+ * @public
1609
+ */
1610
+ NextToken?: string | undefined;
1611
+ /**
1612
+ * <p>Filters the results to include only jobs with the specified status.</p>
1613
+ * @public
1614
+ */
1615
+ JobStatus?: TransformationJobStatus | undefined;
1616
+ /**
1617
+ * <p>Filters the results to include only jobs with the specified name.</p>
1618
+ * @public
1619
+ */
1620
+ JobName?: string | undefined;
1621
+ /**
1622
+ * <p>Filters the results to include only jobs submitted at or after this timestamp.</p>
1623
+ * @public
1624
+ */
1625
+ SubmittedAfter?: Date | undefined;
1626
+ /**
1627
+ * <p>Filters the results to include only jobs submitted at or before this timestamp.</p>
1628
+ * @public
1629
+ */
1630
+ SubmittedBefore?: Date | undefined;
1631
+ }
1632
+ /**
1633
+ * <p>Contains summary information about a data transformation job. To retrieve full job details, call <code>DescribeDataTransformationJob</code>.</p>
1634
+ * @public
1635
+ */
1636
+ export interface TransformationJobSummary {
1637
+ /**
1638
+ * <p>The unique identifier of the job.</p>
1639
+ * @public
1640
+ */
1641
+ JobId: string | undefined;
1642
+ /**
1643
+ * <p>The current status of the job.</p>
1644
+ * @public
1645
+ */
1646
+ JobStatus: TransformationJobStatus | undefined;
1647
+ /**
1648
+ * <p>The timestamp when the job was submitted.</p>
1649
+ * @public
1650
+ */
1651
+ SubmitTime: Date | undefined;
1652
+ /**
1653
+ * <p>The name of the job.</p>
1654
+ * @public
1655
+ */
1656
+ JobName?: string | undefined;
1657
+ /**
1658
+ * <p>The timestamp when the job completed.</p>
1659
+ * @public
1660
+ */
1661
+ EndTime?: Date | undefined;
1662
+ /**
1663
+ * <p>The source data format for this job.</p>
1664
+ * @public
1665
+ */
1666
+ SourceFormat?: SourceFormat | undefined;
1667
+ }
1668
+ /**
1669
+ * <p>The response from the <code>ListDataTransformationJobs</code> operation.</p>
1670
+ * @public
1671
+ */
1672
+ export interface ListDataTransformationJobsResponse {
1673
+ /**
1674
+ * <p>The list of data transformation job summaries.</p>
1675
+ * @public
1676
+ */
1677
+ Items: TransformationJobSummary[] | undefined;
1678
+ /**
1679
+ * <p>The pagination token to use in the next request. If this value is <code>null</code>, there are no more results.</p>
1680
+ * @public
1681
+ */
1682
+ NextToken?: string | undefined;
1683
+ }
723
1684
  /**
724
1685
  * @public
725
1686
  */
@@ -730,8 +1691,7 @@ export interface ListFHIRDatastoresRequest {
730
1691
  */
731
1692
  Filter?: DatastoreFilter | undefined;
732
1693
  /**
733
- * <p>The token used to retrieve the next page of data stores when results are
734
- * paginated.</p>
1694
+ * <p>The token used to retrieve the next page of data stores when results are paginated.</p>
735
1695
  * @public
736
1696
  */
737
1697
  NextToken?: string | undefined;
@@ -771,8 +1731,7 @@ export interface ListFHIRExportJobsRequest {
771
1731
  */
772
1732
  NextToken?: string | undefined;
773
1733
  /**
774
- * <p>Limits the number of results returned for a ListFHIRExportJobs to a maximum quantity
775
- * specified by the user.</p>
1734
+ * <p>Limits the number of results returned for a ListFHIRExportJobs to a maximum quantity specified by the user.</p>
776
1735
  * @public
777
1736
  */
778
1737
  MaxResults?: number | undefined;
@@ -827,8 +1786,7 @@ export interface ListFHIRImportJobsRequest {
827
1786
  */
828
1787
  NextToken?: string | undefined;
829
1788
  /**
830
- * <p>Limits the number of results returned for <code>ListFHIRImportJobs</code> to a maximum
831
- * quantity specified by the user.</p>
1789
+ * <p>Limits the number of results returned for <code>ListFHIRImportJobs</code> to a maximum quantity specified by the user.</p>
832
1790
  * @public
833
1791
  */
834
1792
  MaxResults?: number | undefined;
@@ -977,6 +1935,21 @@ export interface StartFHIRImportJobRequest {
977
1935
  * @public
978
1936
  */
979
1937
  ValidationLevel?: ValidationLevel | undefined;
1938
+ /**
1939
+ * A bounded-length string value.
1940
+ * @public
1941
+ */
1942
+ ProfileId?: string | undefined;
1943
+ /**
1944
+ * A bounded-length string value.
1945
+ * @public
1946
+ */
1947
+ InputFormat?: string | undefined;
1948
+ /**
1949
+ * A boolean value.
1950
+ * @public
1951
+ */
1952
+ DriftDetectionEnabled?: boolean | undefined;
980
1953
  }
981
1954
  /**
982
1955
  * @public
@@ -1053,15 +2026,15 @@ export interface UpdateFHIRDatastoreRequest {
1053
2026
  */
1054
2027
  DatastoreName?: string | undefined;
1055
2028
  /**
1056
- * <p>The natural language processing (NLP) configuration for the data store.</p>
2029
+ * <p>The analytics configuration for the data store.</p>
1057
2030
  * @public
1058
2031
  */
1059
- NlpConfiguration?: NlpConfiguration | undefined;
2032
+ AnalyticsConfiguration?: AnalyticsConfiguration | undefined;
1060
2033
  /**
1061
- * <p>The analytics configuration for the data store.</p>
2034
+ * <p>The natural language processing (NLP) configuration for the data store.</p>
1062
2035
  * @public
1063
2036
  */
1064
- AnalyticsConfiguration?: AnalyticsConfiguration | undefined;
2037
+ NlpConfiguration?: NlpConfiguration | undefined;
1065
2038
  /**
1066
2039
  * <p>The profile configuration for the data store.</p>
1067
2040
  * @public