/ cloudformation-templates / node_modules / aws-cdk / node_modules / aws-sdk / clients / healthlake.d.ts
healthlake.d.ts
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config-base'; 7 interface Blob {} 8 declare class HealthLake extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: HealthLake.Types.ClientConfiguration) 13 config: Config & HealthLake.Types.ClientConfiguration; 14 /** 15 * Creates a Data Store that can ingest and export FHIR formatted data. 16 */ 17 createFHIRDatastore(params: HealthLake.Types.CreateFHIRDatastoreRequest, callback?: (err: AWSError, data: HealthLake.Types.CreateFHIRDatastoreResponse) => void): Request<HealthLake.Types.CreateFHIRDatastoreResponse, AWSError>; 18 /** 19 * Creates a Data Store that can ingest and export FHIR formatted data. 20 */ 21 createFHIRDatastore(callback?: (err: AWSError, data: HealthLake.Types.CreateFHIRDatastoreResponse) => void): Request<HealthLake.Types.CreateFHIRDatastoreResponse, AWSError>; 22 /** 23 * Deletes a Data Store. 24 */ 25 deleteFHIRDatastore(params: HealthLake.Types.DeleteFHIRDatastoreRequest, callback?: (err: AWSError, data: HealthLake.Types.DeleteFHIRDatastoreResponse) => void): Request<HealthLake.Types.DeleteFHIRDatastoreResponse, AWSError>; 26 /** 27 * Deletes a Data Store. 28 */ 29 deleteFHIRDatastore(callback?: (err: AWSError, data: HealthLake.Types.DeleteFHIRDatastoreResponse) => void): Request<HealthLake.Types.DeleteFHIRDatastoreResponse, AWSError>; 30 /** 31 * Gets the properties associated with the FHIR Data Store, including the Data Store ID, Data Store ARN, Data Store name, Data Store status, created at, Data Store type version, and Data Store endpoint. 32 */ 33 describeFHIRDatastore(params: HealthLake.Types.DescribeFHIRDatastoreRequest, callback?: (err: AWSError, data: HealthLake.Types.DescribeFHIRDatastoreResponse) => void): Request<HealthLake.Types.DescribeFHIRDatastoreResponse, AWSError>; 34 /** 35 * Gets the properties associated with the FHIR Data Store, including the Data Store ID, Data Store ARN, Data Store name, Data Store status, created at, Data Store type version, and Data Store endpoint. 36 */ 37 describeFHIRDatastore(callback?: (err: AWSError, data: HealthLake.Types.DescribeFHIRDatastoreResponse) => void): Request<HealthLake.Types.DescribeFHIRDatastoreResponse, AWSError>; 38 /** 39 * Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job. 40 */ 41 describeFHIRExportJob(params: HealthLake.Types.DescribeFHIRExportJobRequest, callback?: (err: AWSError, data: HealthLake.Types.DescribeFHIRExportJobResponse) => void): Request<HealthLake.Types.DescribeFHIRExportJobResponse, AWSError>; 42 /** 43 * Displays the properties of a FHIR export job, including the ID, ARN, name, and the status of the job. 44 */ 45 describeFHIRExportJob(callback?: (err: AWSError, data: HealthLake.Types.DescribeFHIRExportJobResponse) => void): Request<HealthLake.Types.DescribeFHIRExportJobResponse, AWSError>; 46 /** 47 * Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job. 48 */ 49 describeFHIRImportJob(params: HealthLake.Types.DescribeFHIRImportJobRequest, callback?: (err: AWSError, data: HealthLake.Types.DescribeFHIRImportJobResponse) => void): Request<HealthLake.Types.DescribeFHIRImportJobResponse, AWSError>; 50 /** 51 * Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job. 52 */ 53 describeFHIRImportJob(callback?: (err: AWSError, data: HealthLake.Types.DescribeFHIRImportJobResponse) => void): Request<HealthLake.Types.DescribeFHIRImportJobResponse, AWSError>; 54 /** 55 * Lists all FHIR Data Stores that are in the user’s account, regardless of Data Store status. 56 */ 57 listFHIRDatastores(params: HealthLake.Types.ListFHIRDatastoresRequest, callback?: (err: AWSError, data: HealthLake.Types.ListFHIRDatastoresResponse) => void): Request<HealthLake.Types.ListFHIRDatastoresResponse, AWSError>; 58 /** 59 * Lists all FHIR Data Stores that are in the user’s account, regardless of Data Store status. 60 */ 61 listFHIRDatastores(callback?: (err: AWSError, data: HealthLake.Types.ListFHIRDatastoresResponse) => void): Request<HealthLake.Types.ListFHIRDatastoresResponse, AWSError>; 62 /** 63 * Lists all FHIR export jobs associated with an account and their statuses. 64 */ 65 listFHIRExportJobs(params: HealthLake.Types.ListFHIRExportJobsRequest, callback?: (err: AWSError, data: HealthLake.Types.ListFHIRExportJobsResponse) => void): Request<HealthLake.Types.ListFHIRExportJobsResponse, AWSError>; 66 /** 67 * Lists all FHIR export jobs associated with an account and their statuses. 68 */ 69 listFHIRExportJobs(callback?: (err: AWSError, data: HealthLake.Types.ListFHIRExportJobsResponse) => void): Request<HealthLake.Types.ListFHIRExportJobsResponse, AWSError>; 70 /** 71 * Lists all FHIR import jobs associated with an account and their statuses. 72 */ 73 listFHIRImportJobs(params: HealthLake.Types.ListFHIRImportJobsRequest, callback?: (err: AWSError, data: HealthLake.Types.ListFHIRImportJobsResponse) => void): Request<HealthLake.Types.ListFHIRImportJobsResponse, AWSError>; 74 /** 75 * Lists all FHIR import jobs associated with an account and their statuses. 76 */ 77 listFHIRImportJobs(callback?: (err: AWSError, data: HealthLake.Types.ListFHIRImportJobsResponse) => void): Request<HealthLake.Types.ListFHIRImportJobsResponse, AWSError>; 78 /** 79 * Returns a list of all existing tags associated with a Data Store. 80 */ 81 listTagsForResource(params: HealthLake.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: HealthLake.Types.ListTagsForResourceResponse) => void): Request<HealthLake.Types.ListTagsForResourceResponse, AWSError>; 82 /** 83 * Returns a list of all existing tags associated with a Data Store. 84 */ 85 listTagsForResource(callback?: (err: AWSError, data: HealthLake.Types.ListTagsForResourceResponse) => void): Request<HealthLake.Types.ListTagsForResourceResponse, AWSError>; 86 /** 87 * Begins a FHIR export job. 88 */ 89 startFHIRExportJob(params: HealthLake.Types.StartFHIRExportJobRequest, callback?: (err: AWSError, data: HealthLake.Types.StartFHIRExportJobResponse) => void): Request<HealthLake.Types.StartFHIRExportJobResponse, AWSError>; 90 /** 91 * Begins a FHIR export job. 92 */ 93 startFHIRExportJob(callback?: (err: AWSError, data: HealthLake.Types.StartFHIRExportJobResponse) => void): Request<HealthLake.Types.StartFHIRExportJobResponse, AWSError>; 94 /** 95 * Begins a FHIR Import job. 96 */ 97 startFHIRImportJob(params: HealthLake.Types.StartFHIRImportJobRequest, callback?: (err: AWSError, data: HealthLake.Types.StartFHIRImportJobResponse) => void): Request<HealthLake.Types.StartFHIRImportJobResponse, AWSError>; 98 /** 99 * Begins a FHIR Import job. 100 */ 101 startFHIRImportJob(callback?: (err: AWSError, data: HealthLake.Types.StartFHIRImportJobResponse) => void): Request<HealthLake.Types.StartFHIRImportJobResponse, AWSError>; 102 /** 103 * Adds a user specifed key and value tag to a Data Store. 104 */ 105 tagResource(params: HealthLake.Types.TagResourceRequest, callback?: (err: AWSError, data: HealthLake.Types.TagResourceResponse) => void): Request<HealthLake.Types.TagResourceResponse, AWSError>; 106 /** 107 * Adds a user specifed key and value tag to a Data Store. 108 */ 109 tagResource(callback?: (err: AWSError, data: HealthLake.Types.TagResourceResponse) => void): Request<HealthLake.Types.TagResourceResponse, AWSError>; 110 /** 111 * Removes tags from a Data Store. 112 */ 113 untagResource(params: HealthLake.Types.UntagResourceRequest, callback?: (err: AWSError, data: HealthLake.Types.UntagResourceResponse) => void): Request<HealthLake.Types.UntagResourceResponse, AWSError>; 114 /** 115 * Removes tags from a Data Store. 116 */ 117 untagResource(callback?: (err: AWSError, data: HealthLake.Types.UntagResourceResponse) => void): Request<HealthLake.Types.UntagResourceResponse, AWSError>; 118 } 119 declare namespace HealthLake { 120 export type AmazonResourceName = string; 121 export type BoundedLengthString = string; 122 export type ClientTokenString = string; 123 export type CmkType = "CUSTOMER_MANAGED_KMS_KEY"|"AWS_OWNED_KMS_KEY"|string; 124 export interface CreateFHIRDatastoreRequest { 125 /** 126 * The user generated name for the Data Store. 127 */ 128 DatastoreName?: DatastoreName; 129 /** 130 * The FHIR version of the Data Store. The only supported version is R4. 131 */ 132 DatastoreTypeVersion: FHIRVersion; 133 /** 134 * The server-side encryption key configuration for a customer provided encryption key specified for creating a Data Store. 135 */ 136 SseConfiguration?: SseConfiguration; 137 /** 138 * Optional parameter to preload data upon creation of the Data Store. Currently, the only supported preloaded data is synthetic data generated from Synthea. 139 */ 140 PreloadDataConfig?: PreloadDataConfig; 141 /** 142 * Optional user provided token used for ensuring idempotency. 143 */ 144 ClientToken?: ClientTokenString; 145 /** 146 * Resource tags that are applied to a Data Store when it is created. 147 */ 148 Tags?: TagList; 149 } 150 export interface CreateFHIRDatastoreResponse { 151 /** 152 * The AWS-generated Data Store id. This id is in the output from the initial Data Store creation call. 153 */ 154 DatastoreId: DatastoreId; 155 /** 156 * The datastore ARN is generated during the creation of the Data Store and can be found in the output from the initial Data Store creation call. 157 */ 158 DatastoreArn: DatastoreArn; 159 /** 160 * The status of the FHIR Data Store. Possible statuses are ‘CREATING’, ‘ACTIVE’, ‘DELETING’, ‘DELETED’. 161 */ 162 DatastoreStatus: DatastoreStatus; 163 /** 164 * The AWS endpoint for the created Data Store. For preview, only US-east-1 endpoints are supported. 165 */ 166 DatastoreEndpoint: BoundedLengthString; 167 } 168 export type DatastoreArn = string; 169 export interface DatastoreFilter { 170 /** 171 * Allows the user to filter Data Store results by name. 172 */ 173 DatastoreName?: DatastoreName; 174 /** 175 * Allows the user to filter Data Store results by status. 176 */ 177 DatastoreStatus?: DatastoreStatus; 178 /** 179 * A filter that allows the user to set cutoff dates for records. All Data Stores created before the specified date will be included in the results. 180 */ 181 CreatedBefore?: Timestamp; 182 /** 183 * A filter that allows the user to set cutoff dates for records. All Data Stores created after the specified date will be included in the results. 184 */ 185 CreatedAfter?: Timestamp; 186 } 187 export type DatastoreId = string; 188 export type DatastoreName = string; 189 export interface DatastoreProperties { 190 /** 191 * The AWS-generated ID number for the Data Store. 192 */ 193 DatastoreId: DatastoreId; 194 /** 195 * The Amazon Resource Name used in the creation of the Data Store. 196 */ 197 DatastoreArn: DatastoreArn; 198 /** 199 * The user-generated name for the Data Store. 200 */ 201 DatastoreName?: DatastoreName; 202 /** 203 * The status of the Data Store. Possible statuses are 'CREATING', 'ACTIVE', 'DELETING', or 'DELETED'. 204 */ 205 DatastoreStatus: DatastoreStatus; 206 /** 207 * The time that a Data Store was created. 208 */ 209 CreatedAt?: Timestamp; 210 /** 211 * The FHIR version. Only R4 version data is supported. 212 */ 213 DatastoreTypeVersion: FHIRVersion; 214 /** 215 * The AWS endpoint for the Data Store. Each Data Store will have it's own endpoint with Data Store ID in the endpoint URL. 216 */ 217 DatastoreEndpoint: String; 218 /** 219 * The server-side encryption key configuration for a customer provided encryption key (CMK). 220 */ 221 SseConfiguration?: SseConfiguration; 222 /** 223 * The preloaded data configuration for the Data Store. Only data preloaded from Synthea is supported. 224 */ 225 PreloadDataConfig?: PreloadDataConfig; 226 } 227 export type DatastorePropertiesList = DatastoreProperties[]; 228 export type DatastoreStatus = "CREATING"|"ACTIVE"|"DELETING"|"DELETED"|string; 229 export interface DeleteFHIRDatastoreRequest { 230 /** 231 * The AWS-generated ID for the Data Store to be deleted. 232 */ 233 DatastoreId?: DatastoreId; 234 } 235 export interface DeleteFHIRDatastoreResponse { 236 /** 237 * The AWS-generated ID for the Data Store to be deleted. 238 */ 239 DatastoreId: DatastoreId; 240 /** 241 * The Amazon Resource Name (ARN) that gives Amazon HealthLake access permission. 242 */ 243 DatastoreArn: DatastoreArn; 244 /** 245 * The status of the Data Store that the user has requested to be deleted. 246 */ 247 DatastoreStatus: DatastoreStatus; 248 /** 249 * The AWS endpoint for the Data Store the user has requested to be deleted. 250 */ 251 DatastoreEndpoint: BoundedLengthString; 252 } 253 export interface DescribeFHIRDatastoreRequest { 254 /** 255 * The AWS-generated Data Store id. This is part of the ‘CreateFHIRDatastore’ output. 256 */ 257 DatastoreId?: DatastoreId; 258 } 259 export interface DescribeFHIRDatastoreResponse { 260 /** 261 * All properties associated with a Data Store, including the Data Store ID, Data Store ARN, Data Store name, Data Store status, created at, Data Store type version, and Data Store endpoint. 262 */ 263 DatastoreProperties: DatastoreProperties; 264 } 265 export interface DescribeFHIRExportJobRequest { 266 /** 267 * The AWS generated ID for the Data Store from which files are being exported from for an export job. 268 */ 269 DatastoreId: DatastoreId; 270 /** 271 * The AWS generated ID for an export job. 272 */ 273 JobId: JobId; 274 } 275 export interface DescribeFHIRExportJobResponse { 276 /** 277 * Displays the properties of the export job, including the ID, Arn, Name, and the status of the job. 278 */ 279 ExportJobProperties: ExportJobProperties; 280 } 281 export interface DescribeFHIRImportJobRequest { 282 /** 283 * The AWS-generated ID of the Data Store. 284 */ 285 DatastoreId: DatastoreId; 286 /** 287 * The AWS-generated job ID. 288 */ 289 JobId: JobId; 290 } 291 export interface DescribeFHIRImportJobResponse { 292 /** 293 * The properties of the Import job request, including the ID, ARN, name, and the status of the job. 294 */ 295 ImportJobProperties: ImportJobProperties; 296 } 297 export type EncryptionKeyID = string; 298 export interface ExportJobProperties { 299 /** 300 * The AWS generated ID for an export job. 301 */ 302 JobId: JobId; 303 /** 304 * The user generated name for an export job. 305 */ 306 JobName?: JobName; 307 /** 308 * The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED. 309 */ 310 JobStatus: JobStatus; 311 /** 312 * The time an export job was initiated. 313 */ 314 SubmitTime: Timestamp; 315 /** 316 * The time an export job completed. 317 */ 318 EndTime?: Timestamp; 319 /** 320 * The AWS generated ID for the Data Store from which files are being exported for an export job. 321 */ 322 DatastoreId: DatastoreId; 323 /** 324 * The output data configuration that was supplied when the export job was created. 325 */ 326 OutputDataConfig: OutputDataConfig; 327 /** 328 * The Amazon Resource Name used during the initiation of the job. 329 */ 330 DataAccessRoleArn?: IamRoleArn; 331 /** 332 * An explanation of any errors that may have occurred during the export job. 333 */ 334 Message?: Message; 335 } 336 export type ExportJobPropertiesList = ExportJobProperties[]; 337 export type FHIRVersion = "R4"|string; 338 export type IamRoleArn = string; 339 export interface ImportJobProperties { 340 /** 341 * The AWS-generated id number for the Import job. 342 */ 343 JobId: JobId; 344 /** 345 * The user-generated name for an Import job. 346 */ 347 JobName?: JobName; 348 /** 349 * The job status for an Import job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, FAILED. 350 */ 351 JobStatus: JobStatus; 352 /** 353 * The time that the Import job was submitted for processing. 354 */ 355 SubmitTime: Timestamp; 356 /** 357 * The time that the Import job was completed. 358 */ 359 EndTime?: Timestamp; 360 /** 361 * The datastore id used when the Import job was created. 362 */ 363 DatastoreId: DatastoreId; 364 /** 365 * The input data configuration that was supplied when the Import job was created. 366 */ 367 InputDataConfig: InputDataConfig; 368 JobOutputDataConfig?: OutputDataConfig; 369 /** 370 * The Amazon Resource Name (ARN) that gives Amazon HealthLake access to your input data. 371 */ 372 DataAccessRoleArn?: IamRoleArn; 373 /** 374 * An explanation of any errors that may have occurred during the FHIR import job. 375 */ 376 Message?: Message; 377 } 378 export type ImportJobPropertiesList = ImportJobProperties[]; 379 export interface InputDataConfig { 380 /** 381 * The S3Uri is the user specified S3 location of the FHIR data to be imported into Amazon HealthLake. 382 */ 383 S3Uri?: S3Uri; 384 } 385 export type JobId = string; 386 export type JobName = string; 387 export type JobStatus = "SUBMITTED"|"IN_PROGRESS"|"COMPLETED_WITH_ERRORS"|"COMPLETED"|"FAILED"|string; 388 export interface KmsEncryptionConfig { 389 /** 390 * The type of customer-managed-key(CMK) used for encyrption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs. 391 */ 392 CmkType: CmkType; 393 /** 394 * The KMS encryption key id/alias used to encrypt the Data Store contents at rest. 395 */ 396 KmsKeyId?: EncryptionKeyID; 397 } 398 export interface ListFHIRDatastoresRequest { 399 /** 400 * Lists all filters associated with a FHIR Data Store request. 401 */ 402 Filter?: DatastoreFilter; 403 /** 404 * Fetches the next page of Data Stores when results are paginated. 405 */ 406 NextToken?: NextToken; 407 /** 408 * The maximum number of Data Stores returned in a single page of a ListFHIRDatastoresRequest call. 409 */ 410 MaxResults?: MaxResultsInteger; 411 } 412 export interface ListFHIRDatastoresResponse { 413 /** 414 * All properties associated with the listed Data Stores. 415 */ 416 DatastorePropertiesList: DatastorePropertiesList; 417 /** 418 * Pagination token that can be used to retrieve the next page of results. 419 */ 420 NextToken?: NextToken; 421 } 422 export interface ListFHIRExportJobsRequest { 423 /** 424 * This parameter limits the response to the export job with the specified Data Store ID. 425 */ 426 DatastoreId: DatastoreId; 427 /** 428 * A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query. 429 */ 430 NextToken?: NextToken; 431 /** 432 * This parameter limits the number of results returned for a ListFHIRExportJobs to a maximum quantity specified by the user. 433 */ 434 MaxResults?: MaxResultsInteger; 435 /** 436 * This parameter limits the response to the export job with the specified job name. 437 */ 438 JobName?: JobName; 439 /** 440 * This parameter limits the response to the export jobs with the specified job status. 441 */ 442 JobStatus?: JobStatus; 443 /** 444 * This parameter limits the response to FHIR export jobs submitted before a user specified date. 445 */ 446 SubmittedBefore?: Timestamp; 447 /** 448 * This parameter limits the response to FHIR export jobs submitted after a user specified date. 449 */ 450 SubmittedAfter?: Timestamp; 451 } 452 export interface ListFHIRExportJobsResponse { 453 /** 454 * The properties of listed FHIR export jobs, including the ID, ARN, name, and the status of the job. 455 */ 456 ExportJobPropertiesList: ExportJobPropertiesList; 457 /** 458 * A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query. 459 */ 460 NextToken?: NextToken; 461 } 462 export interface ListFHIRImportJobsRequest { 463 /** 464 * This parameter limits the response to the import job with the specified Data Store ID. 465 */ 466 DatastoreId: DatastoreId; 467 /** 468 * A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query. 469 */ 470 NextToken?: NextToken; 471 /** 472 * This parameter limits the number of results returned for a ListFHIRImportJobs to a maximum quantity specified by the user. 473 */ 474 MaxResults?: MaxResultsInteger; 475 /** 476 * This parameter limits the response to the import job with the specified job name. 477 */ 478 JobName?: JobName; 479 /** 480 * This parameter limits the response to the import job with the specified job status. 481 */ 482 JobStatus?: JobStatus; 483 /** 484 * This parameter limits the response to FHIR import jobs submitted before a user specified date. 485 */ 486 SubmittedBefore?: Timestamp; 487 /** 488 * This parameter limits the response to FHIR import jobs submitted after a user specified date. 489 */ 490 SubmittedAfter?: Timestamp; 491 } 492 export interface ListFHIRImportJobsResponse { 493 /** 494 * The properties of a listed FHIR import jobs, including the ID, ARN, name, and the status of the job. 495 */ 496 ImportJobPropertiesList: ImportJobPropertiesList; 497 /** 498 * A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query. 499 */ 500 NextToken?: NextToken; 501 } 502 export interface ListTagsForResourceRequest { 503 /** 504 * The Amazon Resource Name(ARN) of the Data Store for which tags are being added. 505 */ 506 ResourceARN: AmazonResourceName; 507 } 508 export interface ListTagsForResourceResponse { 509 /** 510 * Returns a list of tags associated with a Data Store. 511 */ 512 Tags?: TagList; 513 } 514 export type MaxResultsInteger = number; 515 export type Message = string; 516 export type NextToken = string; 517 export interface OutputDataConfig { 518 /** 519 * The output data configuration that was supplied when the export job was created. 520 */ 521 S3Configuration?: S3Configuration; 522 } 523 export interface PreloadDataConfig { 524 /** 525 * The type of preloaded data. Only Synthea preloaded data is supported. 526 */ 527 PreloadDataType: PreloadDataType; 528 } 529 export type PreloadDataType = "SYNTHEA"|string; 530 export interface S3Configuration { 531 /** 532 * The S3Uri is the user specified S3 location of the FHIR data to be imported into Amazon HealthLake. 533 */ 534 S3Uri: S3Uri; 535 /** 536 * The KMS key ID used to access the S3 bucket. 537 */ 538 KmsKeyId: EncryptionKeyID; 539 } 540 export type S3Uri = string; 541 export interface SseConfiguration { 542 /** 543 * The KMS encryption configuration used to provide details for data encryption. 544 */ 545 KmsEncryptionConfig: KmsEncryptionConfig; 546 } 547 export interface StartFHIRExportJobRequest { 548 /** 549 * The user generated name for an export job. 550 */ 551 JobName?: JobName; 552 /** 553 * The output data configuration that was supplied when the export job was created. 554 */ 555 OutputDataConfig: OutputDataConfig; 556 /** 557 * The AWS generated ID for the Data Store from which files are being exported for an export job. 558 */ 559 DatastoreId: DatastoreId; 560 /** 561 * The Amazon Resource Name used during the initiation of the job. 562 */ 563 DataAccessRoleArn: IamRoleArn; 564 /** 565 * An optional user provided token used for ensuring idempotency. 566 */ 567 ClientToken: ClientTokenString; 568 } 569 export interface StartFHIRExportJobResponse { 570 /** 571 * The AWS generated ID for an export job. 572 */ 573 JobId: JobId; 574 /** 575 * The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED. 576 */ 577 JobStatus: JobStatus; 578 /** 579 * The AWS generated ID for the Data Store from which files are being exported for an export job. 580 */ 581 DatastoreId?: DatastoreId; 582 } 583 export interface StartFHIRImportJobRequest { 584 /** 585 * The name of the FHIR Import job in the StartFHIRImport job request. 586 */ 587 JobName?: JobName; 588 /** 589 * The input properties of the FHIR Import job in the StartFHIRImport job request. 590 */ 591 InputDataConfig: InputDataConfig; 592 JobOutputDataConfig: OutputDataConfig; 593 /** 594 * The AWS-generated Data Store ID. 595 */ 596 DatastoreId: DatastoreId; 597 /** 598 * The Amazon Resource Name (ARN) that gives Amazon HealthLake access permission. 599 */ 600 DataAccessRoleArn: IamRoleArn; 601 /** 602 * Optional user provided token used for ensuring idempotency. 603 */ 604 ClientToken: ClientTokenString; 605 } 606 export interface StartFHIRImportJobResponse { 607 /** 608 * The AWS-generated job ID. 609 */ 610 JobId: JobId; 611 /** 612 * The status of an import job. 613 */ 614 JobStatus: JobStatus; 615 /** 616 * The AWS-generated Data Store ID. 617 */ 618 DatastoreId?: DatastoreId; 619 } 620 export type String = string; 621 export interface Tag { 622 /** 623 * The key portion of a tag. Tag keys are case sensitive. 624 */ 625 Key: TagKey; 626 /** 627 * The value portion of tag. Tag values are case sensitive. 628 */ 629 Value: TagValue; 630 } 631 export type TagKey = string; 632 export type TagKeyList = TagKey[]; 633 export type TagList = Tag[]; 634 export interface TagResourceRequest { 635 /** 636 * The Amazon Resource Name(ARN)that gives Amazon HealthLake access to the Data Store which tags are being added to. 637 */ 638 ResourceARN: AmazonResourceName; 639 /** 640 * The user specified key and value pair tags being added to a Data Store. 641 */ 642 Tags: TagList; 643 } 644 export interface TagResourceResponse { 645 } 646 export type TagValue = string; 647 export type Timestamp = Date; 648 export interface UntagResourceRequest { 649 /** 650 * "The Amazon Resource Name(ARN) of the Data Store for which tags are being removed 651 */ 652 ResourceARN: AmazonResourceName; 653 /** 654 * The keys for the tags to be removed from the Healthlake Data Store. 655 */ 656 TagKeys: TagKeyList; 657 } 658 export interface UntagResourceResponse { 659 } 660 /** 661 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 662 */ 663 export type apiVersion = "2017-07-01"|"latest"|string; 664 export interface ClientApiVersions { 665 /** 666 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 667 */ 668 apiVersion?: apiVersion; 669 } 670 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 671 /** 672 * Contains interfaces for use with the HealthLake client. 673 */ 674 export import Types = HealthLake; 675 } 676 export = HealthLake;