healthlake.d.ts 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762
  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, when the data store was created, data store type version, and the data store's 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, when the data store was created, data store type version, and the data store's 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 specified 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 specified 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 AuthorizationStrategy = "SMART_ON_FHIR_V1"|"AWS_AUTH"|string;
  122. export type Boolean = boolean;
  123. export type BoundedLengthString = string;
  124. export type ClientTokenString = string;
  125. export type CmkType = "CUSTOMER_MANAGED_KMS_KEY"|"AWS_OWNED_KMS_KEY"|string;
  126. export type ConfigurationMetadata = string;
  127. export interface CreateFHIRDatastoreRequest {
  128. /**
  129. * The user generated name for the data store.
  130. */
  131. DatastoreName?: DatastoreName;
  132. /**
  133. * The FHIR version of the data store. The only supported version is R4.
  134. */
  135. DatastoreTypeVersion: FHIRVersion;
  136. /**
  137. * The server-side encryption key configuration for a customer provided encryption key specified for creating a data store.
  138. */
  139. SseConfiguration?: SseConfiguration;
  140. /**
  141. * Optional parameter to preload data upon creation of the data store. Currently, the only supported preloaded data is synthetic data generated from Synthea.
  142. */
  143. PreloadDataConfig?: PreloadDataConfig;
  144. /**
  145. * Optional user provided token used for ensuring idempotency.
  146. */
  147. ClientToken?: ClientTokenString;
  148. /**
  149. * Resource tags that are applied to a data store when it is created.
  150. */
  151. Tags?: TagList;
  152. /**
  153. * The configuration of the identity provider that you want to use for your data store.
  154. */
  155. IdentityProviderConfiguration?: IdentityProviderConfiguration;
  156. }
  157. export interface CreateFHIRDatastoreResponse {
  158. /**
  159. * The AWS-generated data store id. This id is in the output from the initial data store creation call.
  160. */
  161. DatastoreId: DatastoreId;
  162. /**
  163. * The data store ARN is generated during the creation of the data store and can be found in the output from the initial data store creation call.
  164. */
  165. DatastoreArn: DatastoreArn;
  166. /**
  167. * The status of the FHIR data store.
  168. */
  169. DatastoreStatus: DatastoreStatus;
  170. /**
  171. * The AWS endpoint for the created data store.
  172. */
  173. DatastoreEndpoint: BoundedLengthString;
  174. }
  175. export type DatastoreArn = string;
  176. export interface DatastoreFilter {
  177. /**
  178. * Allows the user to filter data store results by name.
  179. */
  180. DatastoreName?: DatastoreName;
  181. /**
  182. * Allows the user to filter data store results by status.
  183. */
  184. DatastoreStatus?: DatastoreStatus;
  185. /**
  186. * 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.
  187. */
  188. CreatedBefore?: Timestamp;
  189. /**
  190. * 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.
  191. */
  192. CreatedAfter?: Timestamp;
  193. }
  194. export type DatastoreId = string;
  195. export type DatastoreName = string;
  196. export interface DatastoreProperties {
  197. /**
  198. * The AWS-generated ID number for the data store.
  199. */
  200. DatastoreId: DatastoreId;
  201. /**
  202. * The Amazon Resource Name used in the creation of the data store.
  203. */
  204. DatastoreArn: DatastoreArn;
  205. /**
  206. * The user-generated name for the data store.
  207. */
  208. DatastoreName?: DatastoreName;
  209. /**
  210. * The status of the data store.
  211. */
  212. DatastoreStatus: DatastoreStatus;
  213. /**
  214. * The time that a data store was created.
  215. */
  216. CreatedAt?: Timestamp;
  217. /**
  218. * The FHIR version. Only R4 version data is supported.
  219. */
  220. DatastoreTypeVersion: FHIRVersion;
  221. /**
  222. * The AWS endpoint for the data store. Each data store will have it's own endpoint with data store ID in the endpoint URL.
  223. */
  224. DatastoreEndpoint: String;
  225. /**
  226. * The server-side encryption key configuration for a customer provided encryption key (CMK).
  227. */
  228. SseConfiguration?: SseConfiguration;
  229. /**
  230. * The preloaded data configuration for the data store. Only data preloaded from Synthea is supported.
  231. */
  232. PreloadDataConfig?: PreloadDataConfig;
  233. /**
  234. * The identity provider that you selected when you created the data store.
  235. */
  236. IdentityProviderConfiguration?: IdentityProviderConfiguration;
  237. /**
  238. * The error cause for the current data store operation.
  239. */
  240. ErrorCause?: ErrorCause;
  241. }
  242. export type DatastorePropertiesList = DatastoreProperties[];
  243. export type DatastoreStatus = "CREATING"|"ACTIVE"|"DELETING"|"DELETED"|"CREATE_FAILED"|string;
  244. export interface DeleteFHIRDatastoreRequest {
  245. /**
  246. * The AWS-generated ID for the data store to be deleted.
  247. */
  248. DatastoreId: DatastoreId;
  249. }
  250. export interface DeleteFHIRDatastoreResponse {
  251. /**
  252. * The AWS-generated ID for the data store to be deleted.
  253. */
  254. DatastoreId: DatastoreId;
  255. /**
  256. * The Amazon Resource Name (ARN) that gives AWS HealthLake access permission.
  257. */
  258. DatastoreArn: DatastoreArn;
  259. /**
  260. * The status of the data store that the user has requested to be deleted.
  261. */
  262. DatastoreStatus: DatastoreStatus;
  263. /**
  264. * The AWS endpoint for the data store the user has requested to be deleted.
  265. */
  266. DatastoreEndpoint: BoundedLengthString;
  267. }
  268. export interface DescribeFHIRDatastoreRequest {
  269. /**
  270. * The AWS-generated data store ID.
  271. */
  272. DatastoreId: DatastoreId;
  273. }
  274. export interface DescribeFHIRDatastoreResponse {
  275. /**
  276. * All properties associated with a data store, including the data store ID, data store ARN, data store name, data store status, when the data store was created, data store type version, and the data store's endpoint.
  277. */
  278. DatastoreProperties: DatastoreProperties;
  279. }
  280. export interface DescribeFHIRExportJobRequest {
  281. /**
  282. * The AWS generated ID for the data store from which files are being exported from for an export job.
  283. */
  284. DatastoreId: DatastoreId;
  285. /**
  286. * The AWS generated ID for an export job.
  287. */
  288. JobId: JobId;
  289. }
  290. export interface DescribeFHIRExportJobResponse {
  291. /**
  292. * Displays the properties of the export job, including the ID, Arn, Name, and the status of the job.
  293. */
  294. ExportJobProperties: ExportJobProperties;
  295. }
  296. export interface DescribeFHIRImportJobRequest {
  297. /**
  298. * The AWS-generated ID of the data store.
  299. */
  300. DatastoreId: DatastoreId;
  301. /**
  302. * The AWS-generated job ID.
  303. */
  304. JobId: JobId;
  305. }
  306. export interface DescribeFHIRImportJobResponse {
  307. /**
  308. * The properties of the Import job request, including the ID, ARN, name, status of the job, and the progress report of the job.
  309. */
  310. ImportJobProperties: ImportJobProperties;
  311. }
  312. export type EncryptionKeyID = string;
  313. export type ErrorCategory = "RETRYABLE_ERROR"|"NON_RETRYABLE_ERROR"|string;
  314. export interface ErrorCause {
  315. /**
  316. * The text of the error message.
  317. */
  318. ErrorMessage?: ErrorMessage;
  319. /**
  320. * The error category of the create/delete data store operation. Possible statuses are RETRYABLE_ERROR or NON_RETRYABLE_ERROR.
  321. */
  322. ErrorCategory?: ErrorCategory;
  323. }
  324. export type ErrorMessage = string;
  325. export interface ExportJobProperties {
  326. /**
  327. * The AWS generated ID for an export job.
  328. */
  329. JobId: JobId;
  330. /**
  331. * The user generated name for an export job.
  332. */
  333. JobName?: JobName;
  334. /**
  335. * The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.
  336. */
  337. JobStatus: JobStatus;
  338. /**
  339. * The time an export job was initiated.
  340. */
  341. SubmitTime: Timestamp;
  342. /**
  343. * The time an export job completed.
  344. */
  345. EndTime?: Timestamp;
  346. /**
  347. * The AWS generated ID for the data store from which files are being exported for an export job.
  348. */
  349. DatastoreId: DatastoreId;
  350. /**
  351. * The output data configuration that was supplied when the export job was created.
  352. */
  353. OutputDataConfig: OutputDataConfig;
  354. /**
  355. * The Amazon Resource Name used during the initiation of the job.
  356. */
  357. DataAccessRoleArn?: IamRoleArn;
  358. /**
  359. * An explanation of any errors that may have occurred during the export job.
  360. */
  361. Message?: Message;
  362. }
  363. export type ExportJobPropertiesList = ExportJobProperties[];
  364. export type FHIRVersion = "R4"|string;
  365. export type GenericDouble = number;
  366. export type GenericLong = number;
  367. export type IamRoleArn = string;
  368. export interface IdentityProviderConfiguration {
  369. /**
  370. * The authorization strategy that you selected when you created the data store.
  371. */
  372. AuthorizationStrategy: AuthorizationStrategy;
  373. /**
  374. * If you enabled fine-grained authorization when you created the data store.
  375. */
  376. FineGrainedAuthorizationEnabled?: Boolean;
  377. /**
  378. * 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 Metadata in SMART's App Launch specification. authorization_endpoint: The URL to the OAuth2 authorization endpoint. grant_types_supported: An array of grant types that are supported at the token endpoint. You must provide at least one grant type option. Valid options are authorization_code and client_credentials. token_endpoint: The URL to the OAuth2 token endpoint. capabilities: An array of strings of the SMART capabilities that the authorization server supports. code_challenge_methods_supported: An array of strings of supported PKCE code challenge methods. You must include the S256 method in the array of PKCE code challenge methods.
  379. */
  380. Metadata?: ConfigurationMetadata;
  381. /**
  382. * The Amazon Resource Name (ARN) of the Lambda function that you want to use to decode the access token created by the authorization server.
  383. */
  384. IdpLambdaArn?: LambdaArn;
  385. }
  386. export interface ImportJobProperties {
  387. /**
  388. * The AWS-generated id number for the Import job.
  389. */
  390. JobId: JobId;
  391. /**
  392. * The user-generated name for an Import job.
  393. */
  394. JobName?: JobName;
  395. /**
  396. * The job status for an Import job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED_WITH_ERRORS, COMPLETED, FAILED.
  397. */
  398. JobStatus: JobStatus;
  399. /**
  400. * The time that the Import job was submitted for processing.
  401. */
  402. SubmitTime: Timestamp;
  403. /**
  404. * The time that the Import job was completed.
  405. */
  406. EndTime?: Timestamp;
  407. /**
  408. * The datastore id used when the Import job was created.
  409. */
  410. DatastoreId: DatastoreId;
  411. /**
  412. * The input data configuration that was supplied when the Import job was created.
  413. */
  414. InputDataConfig: InputDataConfig;
  415. JobOutputDataConfig?: OutputDataConfig;
  416. /**
  417. * Displays the progress of the import job, including total resources scanned, total resources ingested, and total size of data ingested.
  418. */
  419. JobProgressReport?: JobProgressReport;
  420. /**
  421. * The Amazon Resource Name (ARN) that gives AWS HealthLake access to your input data.
  422. */
  423. DataAccessRoleArn?: IamRoleArn;
  424. /**
  425. * An explanation of any errors that may have occurred during the FHIR import job.
  426. */
  427. Message?: Message;
  428. }
  429. export type ImportJobPropertiesList = ImportJobProperties[];
  430. export interface InputDataConfig {
  431. /**
  432. * The S3Uri is the user specified S3 location of the FHIR data to be imported into AWS HealthLake.
  433. */
  434. S3Uri?: S3Uri;
  435. }
  436. export type JobId = string;
  437. export type JobName = string;
  438. export interface JobProgressReport {
  439. /**
  440. * The number of files scanned from input S3 bucket.
  441. */
  442. TotalNumberOfScannedFiles?: GenericLong;
  443. /**
  444. * The size (in MB) of the files scanned from the input S3 bucket.
  445. */
  446. TotalSizeOfScannedFilesInMB?: GenericDouble;
  447. /**
  448. * The number of files imported so far.
  449. */
  450. TotalNumberOfImportedFiles?: GenericLong;
  451. /**
  452. * The number of resources scanned from the input S3 bucket.
  453. */
  454. TotalNumberOfResourcesScanned?: GenericLong;
  455. /**
  456. * The number of resources imported so far.
  457. */
  458. TotalNumberOfResourcesImported?: GenericLong;
  459. /**
  460. * The number of resources that failed due to customer error.
  461. */
  462. TotalNumberOfResourcesWithCustomerError?: GenericLong;
  463. /**
  464. * The number of files that failed to be read from the input S3 bucket due to customer error.
  465. */
  466. TotalNumberOfFilesReadWithCustomerError?: GenericLong;
  467. /**
  468. * The throughput (in MB/sec) of the import job.
  469. */
  470. Throughput?: GenericDouble;
  471. }
  472. export type JobStatus = "SUBMITTED"|"IN_PROGRESS"|"COMPLETED_WITH_ERRORS"|"COMPLETED"|"FAILED"|"CANCEL_SUBMITTED"|"CANCEL_IN_PROGRESS"|"CANCEL_COMPLETED"|"CANCEL_FAILED"|string;
  473. export interface KmsEncryptionConfig {
  474. /**
  475. * The type of customer-managed-key(CMK) used for encryption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.
  476. */
  477. CmkType: CmkType;
  478. /**
  479. * The KMS encryption key id/alias used to encrypt the data store contents at rest.
  480. */
  481. KmsKeyId?: EncryptionKeyID;
  482. }
  483. export type LambdaArn = string;
  484. export interface ListFHIRDatastoresRequest {
  485. /**
  486. * Lists all filters associated with a FHIR data store request.
  487. */
  488. Filter?: DatastoreFilter;
  489. /**
  490. * Fetches the next page of data stores when results are paginated.
  491. */
  492. NextToken?: NextToken;
  493. /**
  494. * The maximum number of data stores returned in a single page of a ListFHIRDatastoresRequest call.
  495. */
  496. MaxResults?: MaxResultsInteger;
  497. }
  498. export interface ListFHIRDatastoresResponse {
  499. /**
  500. * All properties associated with the listed data stores.
  501. */
  502. DatastorePropertiesList: DatastorePropertiesList;
  503. /**
  504. * Pagination token that can be used to retrieve the next page of results.
  505. */
  506. NextToken?: NextToken;
  507. }
  508. export interface ListFHIRExportJobsRequest {
  509. /**
  510. * This parameter limits the response to the export job with the specified data store ID.
  511. */
  512. DatastoreId: DatastoreId;
  513. /**
  514. * A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query.
  515. */
  516. NextToken?: NextToken;
  517. /**
  518. * This parameter limits the number of results returned for a ListFHIRExportJobs to a maximum quantity specified by the user.
  519. */
  520. MaxResults?: MaxResultsInteger;
  521. /**
  522. * This parameter limits the response to the export job with the specified job name.
  523. */
  524. JobName?: JobName;
  525. /**
  526. * This parameter limits the response to the export jobs with the specified job status.
  527. */
  528. JobStatus?: JobStatus;
  529. /**
  530. * This parameter limits the response to FHIR export jobs submitted before a user specified date.
  531. */
  532. SubmittedBefore?: Timestamp;
  533. /**
  534. * This parameter limits the response to FHIR export jobs submitted after a user specified date.
  535. */
  536. SubmittedAfter?: Timestamp;
  537. }
  538. export interface ListFHIRExportJobsResponse {
  539. /**
  540. * The properties of listed FHIR export jobs, including the ID, ARN, name, and the status of the job.
  541. */
  542. ExportJobPropertiesList: ExportJobPropertiesList;
  543. /**
  544. * A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query.
  545. */
  546. NextToken?: NextToken;
  547. }
  548. export interface ListFHIRImportJobsRequest {
  549. /**
  550. * This parameter limits the response to the import job with the specified data store ID.
  551. */
  552. DatastoreId: DatastoreId;
  553. /**
  554. * A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query.
  555. */
  556. NextToken?: NextToken;
  557. /**
  558. * This parameter limits the number of results returned for a ListFHIRImportJobs to a maximum quantity specified by the user.
  559. */
  560. MaxResults?: MaxResultsInteger;
  561. /**
  562. * This parameter limits the response to the import job with the specified job name.
  563. */
  564. JobName?: JobName;
  565. /**
  566. * This parameter limits the response to the import job with the specified job status.
  567. */
  568. JobStatus?: JobStatus;
  569. /**
  570. * This parameter limits the response to FHIR import jobs submitted before a user specified date.
  571. */
  572. SubmittedBefore?: Timestamp;
  573. /**
  574. * This parameter limits the response to FHIR import jobs submitted after a user specified date.
  575. */
  576. SubmittedAfter?: Timestamp;
  577. }
  578. export interface ListFHIRImportJobsResponse {
  579. /**
  580. * The properties of a listed FHIR import jobs, including the ID, ARN, name, the status of the job, and the progress report of the job.
  581. */
  582. ImportJobPropertiesList: ImportJobPropertiesList;
  583. /**
  584. * A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query.
  585. */
  586. NextToken?: NextToken;
  587. }
  588. export interface ListTagsForResourceRequest {
  589. /**
  590. * The Amazon Resource Name(ARN) of the data store for which tags are being added.
  591. */
  592. ResourceARN: AmazonResourceName;
  593. }
  594. export interface ListTagsForResourceResponse {
  595. /**
  596. * Returns a list of tags associated with a data store.
  597. */
  598. Tags?: TagList;
  599. }
  600. export type MaxResultsInteger = number;
  601. export type Message = string;
  602. export type NextToken = string;
  603. export interface OutputDataConfig {
  604. /**
  605. * The output data configuration that was supplied when the export job was created.
  606. */
  607. S3Configuration?: S3Configuration;
  608. }
  609. export interface PreloadDataConfig {
  610. /**
  611. * The type of preloaded data. Only Synthea preloaded data is supported.
  612. */
  613. PreloadDataType: PreloadDataType;
  614. }
  615. export type PreloadDataType = "SYNTHEA"|string;
  616. export interface S3Configuration {
  617. /**
  618. * The S3Uri is the user specified S3 location of the FHIR data to be imported into AWS HealthLake.
  619. */
  620. S3Uri: S3Uri;
  621. /**
  622. * The KMS key ID used to access the S3 bucket.
  623. */
  624. KmsKeyId: EncryptionKeyID;
  625. }
  626. export type S3Uri = string;
  627. export interface SseConfiguration {
  628. /**
  629. * The KMS encryption configuration used to provide details for data encryption.
  630. */
  631. KmsEncryptionConfig: KmsEncryptionConfig;
  632. }
  633. export interface StartFHIRExportJobRequest {
  634. /**
  635. * The user generated name for an export job.
  636. */
  637. JobName?: JobName;
  638. /**
  639. * The output data configuration that was supplied when the export job was created.
  640. */
  641. OutputDataConfig: OutputDataConfig;
  642. /**
  643. * The AWS generated ID for the data store from which files are being exported for an export job.
  644. */
  645. DatastoreId: DatastoreId;
  646. /**
  647. * The Amazon Resource Name used during the initiation of the job.
  648. */
  649. DataAccessRoleArn: IamRoleArn;
  650. /**
  651. * An optional user provided token used for ensuring idempotency.
  652. */
  653. ClientToken: ClientTokenString;
  654. }
  655. export interface StartFHIRExportJobResponse {
  656. /**
  657. * The AWS generated ID for an export job.
  658. */
  659. JobId: JobId;
  660. /**
  661. * The status of a FHIR export job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, or FAILED.
  662. */
  663. JobStatus: JobStatus;
  664. /**
  665. * The AWS generated ID for the data store from which files are being exported for an export job.
  666. */
  667. DatastoreId?: DatastoreId;
  668. }
  669. export interface StartFHIRImportJobRequest {
  670. /**
  671. * The name of the FHIR Import job in the StartFHIRImport job request.
  672. */
  673. JobName?: JobName;
  674. /**
  675. * The input properties of the FHIR Import job in the StartFHIRImport job request.
  676. */
  677. InputDataConfig: InputDataConfig;
  678. JobOutputDataConfig: OutputDataConfig;
  679. /**
  680. * The AWS-generated data store ID.
  681. */
  682. DatastoreId: DatastoreId;
  683. /**
  684. * The Amazon Resource Name (ARN) that gives AWS HealthLake access permission.
  685. */
  686. DataAccessRoleArn: IamRoleArn;
  687. /**
  688. * Optional user provided token used for ensuring idempotency.
  689. */
  690. ClientToken: ClientTokenString;
  691. }
  692. export interface StartFHIRImportJobResponse {
  693. /**
  694. * The AWS-generated job ID.
  695. */
  696. JobId: JobId;
  697. /**
  698. * The status of an import job.
  699. */
  700. JobStatus: JobStatus;
  701. /**
  702. * The AWS-generated data store ID.
  703. */
  704. DatastoreId?: DatastoreId;
  705. }
  706. export type String = string;
  707. export interface Tag {
  708. /**
  709. * The key portion of a tag. Tag keys are case sensitive.
  710. */
  711. Key: TagKey;
  712. /**
  713. * The value portion of a tag. Tag values are case sensitive.
  714. */
  715. Value: TagValue;
  716. }
  717. export type TagKey = string;
  718. export type TagKeyList = TagKey[];
  719. export type TagList = Tag[];
  720. export interface TagResourceRequest {
  721. /**
  722. * The Amazon Resource Name(ARN)that gives AWS HealthLake access to the data store which tags are being added to.
  723. */
  724. ResourceARN: AmazonResourceName;
  725. /**
  726. * The user specified key and value pair tags being added to a data store.
  727. */
  728. Tags: TagList;
  729. }
  730. export interface TagResourceResponse {
  731. }
  732. export type TagValue = string;
  733. export type Timestamp = Date;
  734. export interface UntagResourceRequest {
  735. /**
  736. * The Amazon Resource Name(ARN) of the data store for which tags are being removed.
  737. */
  738. ResourceARN: AmazonResourceName;
  739. /**
  740. * The keys for the tags to be removed from the HealthLake data store.
  741. */
  742. TagKeys: TagKeyList;
  743. }
  744. export interface UntagResourceResponse {
  745. }
  746. /**
  747. * 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.
  748. */
  749. export type apiVersion = "2017-07-01"|"latest"|string;
  750. export interface ClientApiVersions {
  751. /**
  752. * 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.
  753. */
  754. apiVersion?: apiVersion;
  755. }
  756. export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
  757. /**
  758. * Contains interfaces for use with the HealthLake client.
  759. */
  760. export import Types = HealthLake;
  761. }
  762. export = HealthLake;