@aws-sdk/client-healthlake 3.876.0 → 3.879.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 (40) hide show
  1. package/README.md +3 -2
  2. package/dist-cjs/index.js +225 -4
  3. package/dist-es/index.js +1 -0
  4. package/dist-es/models/models_0.js +5 -0
  5. package/dist-es/protocols/Aws_json1_0.js +2 -0
  6. package/dist-es/waiters/index.js +4 -0
  7. package/dist-es/waiters/waitForFHIRDatastoreActive.js +49 -0
  8. package/dist-es/waiters/waitForFHIRDatastoreDeleted.js +31 -0
  9. package/dist-es/waiters/waitForFHIRExportJobCompleted.js +67 -0
  10. package/dist-es/waiters/waitForFHIRImportJobCompleted.js +49 -0
  11. package/dist-types/HealthLake.d.ts +3 -2
  12. package/dist-types/HealthLakeClient.d.ts +3 -2
  13. package/dist-types/commands/CreateFHIRDatastoreCommand.d.ts +2 -2
  14. package/dist-types/commands/DeleteFHIRDatastoreCommand.d.ts +5 -4
  15. package/dist-types/commands/DescribeFHIRDatastoreCommand.d.ts +3 -4
  16. package/dist-types/commands/DescribeFHIRExportJobCommand.d.ts +3 -3
  17. package/dist-types/commands/DescribeFHIRImportJobCommand.d.ts +4 -3
  18. package/dist-types/commands/ListFHIRDatastoresCommand.d.ts +3 -2
  19. package/dist-types/commands/ListFHIRExportJobsCommand.d.ts +3 -5
  20. package/dist-types/commands/ListFHIRImportJobsCommand.d.ts +4 -5
  21. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -4
  22. package/dist-types/commands/StartFHIRExportJobCommand.d.ts +3 -3
  23. package/dist-types/commands/StartFHIRImportJobCommand.d.ts +6 -3
  24. package/dist-types/commands/TagResourceCommand.d.ts +2 -4
  25. package/dist-types/commands/UntagResourceCommand.d.ts +2 -4
  26. package/dist-types/index.d.ts +4 -2
  27. package/dist-types/models/models_0.d.ts +224 -230
  28. package/dist-types/ts3.4/index.d.ts +1 -0
  29. package/dist-types/ts3.4/models/models_0.d.ts +9 -0
  30. package/dist-types/ts3.4/waiters/index.d.ts +4 -0
  31. package/dist-types/ts3.4/waiters/waitForFHIRDatastoreActive.d.ts +11 -0
  32. package/dist-types/ts3.4/waiters/waitForFHIRDatastoreDeleted.d.ts +11 -0
  33. package/dist-types/ts3.4/waiters/waitForFHIRExportJobCompleted.d.ts +11 -0
  34. package/dist-types/ts3.4/waiters/waitForFHIRImportJobCompleted.d.ts +11 -0
  35. package/dist-types/waiters/index.d.ts +4 -0
  36. package/dist-types/waiters/waitForFHIRDatastoreActive.d.ts +14 -0
  37. package/dist-types/waiters/waitForFHIRDatastoreDeleted.d.ts +14 -0
  38. package/dist-types/waiters/waitForFHIRExportJobCompleted.d.ts +14 -0
  39. package/dist-types/waiters/waitForFHIRImportJobCompleted.d.ts +14 -0
  40. package/package.json +13 -12
@@ -27,7 +27,7 @@ declare const DescribeFHIRImportJobCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job. </p>
30
+ * <p>Get the import job properties to learn more about the job or job progress.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -69,6 +69,7 @@ declare const DescribeFHIRImportJobCommand_base: {
69
69
  * // },
70
70
  * // DataAccessRoleArn: "STRING_VALUE",
71
71
  * // Message: "STRING_VALUE",
72
+ * // ValidationLevel: "strict" || "structure-only" || "minimal",
72
73
  * // },
73
74
  * // };
74
75
  *
@@ -81,10 +82,10 @@ declare const DescribeFHIRImportJobCommand_base: {
81
82
  * @see {@link HealthLakeClientResolvedConfig | config} for HealthLakeClient's `config` shape.
82
83
  *
83
84
  * @throws {@link InternalServerException} (server fault)
84
- * <p>Unknown error occurs in the service.</p>
85
+ * <p>An unknown internal error occurred in the service.</p>
85
86
  *
86
87
  * @throws {@link ResourceNotFoundException} (client fault)
87
- * <p> The requested data store was not found.</p>
88
+ * <p>The requested data store was not found.</p>
88
89
  *
89
90
  * @throws {@link ThrottlingException} (client fault)
90
91
  * <p>The user has exceeded their maximum number of allowed calls to the given API. </p>
@@ -27,7 +27,8 @@ declare const ListFHIRDatastoresCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Lists all FHIR data stores that are in the user’s account, regardless of data store status.</p>
30
+ * <p>List all FHIR-enabled data stores in a user’s account, regardless of data store
31
+ * status.</p>
31
32
  * @example
32
33
  * Use a bare-bones client and the command you need to make an API call.
33
34
  * ```javascript
@@ -89,7 +90,7 @@ declare const ListFHIRDatastoresCommand_base: {
89
90
  * @see {@link HealthLakeClientResolvedConfig | config} for HealthLakeClient's `config` shape.
90
91
  *
91
92
  * @throws {@link InternalServerException} (server fault)
92
- * <p>Unknown error occurs in the service.</p>
93
+ * <p>An unknown internal error occurred in the service.</p>
93
94
  *
94
95
  * @throws {@link ThrottlingException} (client fault)
95
96
  * <p>The user has exceeded their maximum number of allowed calls to the given API. </p>
@@ -27,9 +27,7 @@ declare const ListFHIRExportJobsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>
31
- * Lists all FHIR export jobs associated with an account and their statuses.
32
- * </p>
30
+ * <p>Lists all FHIR export jobs associated with an account and their statuses.</p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -81,10 +79,10 @@ declare const ListFHIRExportJobsCommand_base: {
81
79
  * <p>Access is denied. Your account is not authorized to perform this operation.</p>
82
80
  *
83
81
  * @throws {@link InternalServerException} (server fault)
84
- * <p>Unknown error occurs in the service.</p>
82
+ * <p>An unknown internal error occurred in the service.</p>
85
83
  *
86
84
  * @throws {@link ResourceNotFoundException} (client fault)
87
- * <p> The requested data store was not found.</p>
85
+ * <p>The requested data store was not found.</p>
88
86
  *
89
87
  * @throws {@link ThrottlingException} (client fault)
90
88
  * <p>The user has exceeded their maximum number of allowed calls to the given API. </p>
@@ -27,9 +27,7 @@ declare const ListFHIRImportJobsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>
31
- * Lists all FHIR import jobs associated with an account and their statuses.
32
- * </p>
30
+ * <p>List all FHIR import jobs associated with an account and their statuses.</p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -77,6 +75,7 @@ declare const ListFHIRImportJobsCommand_base: {
77
75
  * // },
78
76
  * // DataAccessRoleArn: "STRING_VALUE",
79
77
  * // Message: "STRING_VALUE",
78
+ * // ValidationLevel: "strict" || "structure-only" || "minimal",
80
79
  * // },
81
80
  * // ],
82
81
  * // NextToken: "STRING_VALUE",
@@ -94,10 +93,10 @@ declare const ListFHIRImportJobsCommand_base: {
94
93
  * <p>Access is denied. Your account is not authorized to perform this operation.</p>
95
94
  *
96
95
  * @throws {@link InternalServerException} (server fault)
97
- * <p>Unknown error occurs in the service.</p>
96
+ * <p>An unknown internal error occurred in the service.</p>
98
97
  *
99
98
  * @throws {@link ResourceNotFoundException} (client fault)
100
- * <p> The requested data store was not found.</p>
99
+ * <p>The requested data store was not found.</p>
101
100
  *
102
101
  * @throws {@link ThrottlingException} (client fault)
103
102
  * <p>The user has exceeded their maximum number of allowed calls to the given API. </p>
@@ -27,9 +27,7 @@ declare const ListTagsForResourceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>
31
- * Returns a list of all existing tags associated with a data store.
32
- * </p>
30
+ * <p>Returns a list of all existing tags associated with a data store.</p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -59,7 +57,7 @@ declare const ListTagsForResourceCommand_base: {
59
57
  * @see {@link HealthLakeClientResolvedConfig | config} for HealthLakeClient's `config` shape.
60
58
  *
61
59
  * @throws {@link ResourceNotFoundException} (client fault)
62
- * <p> The requested data store was not found.</p>
60
+ * <p>The requested data store was not found.</p>
63
61
  *
64
62
  * @throws {@link ValidationException} (client fault)
65
63
  * <p>The user input parameter was invalid.</p>
@@ -27,7 +27,7 @@ declare const StartFHIRExportJobCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Begins a FHIR export job.</p>
30
+ * <p>Start a FHIR export job.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -66,10 +66,10 @@ declare const StartFHIRExportJobCommand_base: {
66
66
  * <p>Access is denied. Your account is not authorized to perform this operation.</p>
67
67
  *
68
68
  * @throws {@link InternalServerException} (server fault)
69
- * <p>Unknown error occurs in the service.</p>
69
+ * <p>An unknown internal error occurred in the service.</p>
70
70
  *
71
71
  * @throws {@link ResourceNotFoundException} (client fault)
72
- * <p> The requested data store was not found.</p>
72
+ * <p>The requested data store was not found.</p>
73
73
  *
74
74
  * @throws {@link ThrottlingException} (client fault)
75
75
  * <p>The user has exceeded their maximum number of allowed calls to the given API. </p>
@@ -27,7 +27,9 @@ declare const StartFHIRImportJobCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Begins a FHIR Import job.</p>
30
+ * <p>Start importing bulk FHIR data into an ACTIVE data store. The import job imports FHIR
31
+ * data found in the <code>InputDataConfig</code> object and stores processing results in the
32
+ * <code>JobOutputDataConfig</code> object.</p>
31
33
  * @example
32
34
  * Use a bare-bones client and the command you need to make an API call.
33
35
  * ```javascript
@@ -48,6 +50,7 @@ declare const StartFHIRImportJobCommand_base: {
48
50
  * DatastoreId: "STRING_VALUE", // required
49
51
  * DataAccessRoleArn: "STRING_VALUE", // required
50
52
  * ClientToken: "STRING_VALUE",
53
+ * ValidationLevel: "strict" || "structure-only" || "minimal",
51
54
  * };
52
55
  * const command = new StartFHIRImportJobCommand(input);
53
56
  * const response = await client.send(command);
@@ -69,10 +72,10 @@ declare const StartFHIRImportJobCommand_base: {
69
72
  * <p>Access is denied. Your account is not authorized to perform this operation.</p>
70
73
  *
71
74
  * @throws {@link InternalServerException} (server fault)
72
- * <p>Unknown error occurs in the service.</p>
75
+ * <p>An unknown internal error occurred in the service.</p>
73
76
  *
74
77
  * @throws {@link ResourceNotFoundException} (client fault)
75
- * <p> The requested data store was not found.</p>
78
+ * <p>The requested data store was not found.</p>
76
79
  *
77
80
  * @throws {@link ThrottlingException} (client fault)
78
81
  * <p>The user has exceeded their maximum number of allowed calls to the given API. </p>
@@ -27,9 +27,7 @@ declare const TagResourceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>
31
- * Adds a user specified key and value tag to a data store.
32
- * </p>
30
+ * <p>Add a user-specifed key and value tag to a data store.</p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -58,7 +56,7 @@ declare const TagResourceCommand_base: {
58
56
  * @see {@link HealthLakeClientResolvedConfig | config} for HealthLakeClient's `config` shape.
59
57
  *
60
58
  * @throws {@link ResourceNotFoundException} (client fault)
61
- * <p> The requested data store was not found.</p>
59
+ * <p>The requested data store was not found.</p>
62
60
  *
63
61
  * @throws {@link ValidationException} (client fault)
64
62
  * <p>The user input parameter was invalid.</p>
@@ -27,9 +27,7 @@ declare const UntagResourceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>
31
- * Removes tags from a data store.
32
- * </p>
30
+ * <p>Remove a user-specifed key and value tag from a data store.</p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -55,7 +53,7 @@ declare const UntagResourceCommand_base: {
55
53
  * @see {@link HealthLakeClientResolvedConfig | config} for HealthLakeClient's `config` shape.
56
54
  *
57
55
  * @throws {@link ResourceNotFoundException} (client fault)
58
- * <p> The requested data store was not found.</p>
56
+ * <p>The requested data store was not found.</p>
59
57
  *
60
58
  * @throws {@link ValidationException} (client fault)
61
59
  * <p>The user input parameter was invalid.</p>
@@ -1,6 +1,7 @@
1
1
  /**
2
- * <p>AWS HealthLake is a HIPAA eligibile service that allows customers to store,
3
- * transform, query, and analyze their FHIR-formatted data in a consistent fashion in the cloud.</p>
2
+ * <p>This is the <i>AWS HealthLake API Reference</i>. For an introduction to
3
+ * the service, see <a href="https://docs.aws.amazon.com/healthlake/latest/devguide/what-is.html">What is AWS HealthLake?</a> in the <i>AWS HealthLake Developer
4
+ * Guide</i>.</p>
4
5
  *
5
6
  * @packageDocumentation
6
7
  */
@@ -11,5 +12,6 @@ export type { RuntimeExtension } from "./runtimeExtensions";
11
12
  export type { HealthLakeExtensionConfiguration } from "./extensionConfiguration";
12
13
  export * from "./commands";
13
14
  export * from "./pagination";
15
+ export * from "./waiters";
14
16
  export * from "./models";
15
17
  export { HealthLakeServiceException } from "./models/HealthLakeServiceException";