@aws-sdk/client-comprehendmedical 3.35.0 → 3.38.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 (200) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/dist-cjs/ComprehendMedical.js +0 -5
  3. package/dist-cjs/ComprehendMedicalClient.js +0 -10
  4. package/dist-cjs/commands/DescribeEntitiesDetectionV2JobCommand.js +0 -26
  5. package/dist-cjs/commands/DescribeICD10CMInferenceJobCommand.js +0 -26
  6. package/dist-cjs/commands/DescribePHIDetectionJobCommand.js +0 -26
  7. package/dist-cjs/commands/DescribeRxNormInferenceJobCommand.js +0 -26
  8. package/dist-cjs/commands/DetectEntitiesCommand.js +0 -30
  9. package/dist-cjs/commands/DetectEntitiesV2Command.js +0 -34
  10. package/dist-cjs/commands/DetectPHICommand.js +0 -27
  11. package/dist-cjs/commands/InferICD10CMCommand.js +0 -28
  12. package/dist-cjs/commands/InferRxNormCommand.js +0 -27
  13. package/dist-cjs/commands/ListEntitiesDetectionV2JobsCommand.js +0 -25
  14. package/dist-cjs/commands/ListICD10CMInferenceJobsCommand.js +0 -25
  15. package/dist-cjs/commands/ListPHIDetectionJobsCommand.js +0 -26
  16. package/dist-cjs/commands/ListRxNormInferenceJobsCommand.js +0 -25
  17. package/dist-cjs/commands/StartEntitiesDetectionV2JobCommand.js +0 -26
  18. package/dist-cjs/commands/StartICD10CMInferenceJobCommand.js +0 -27
  19. package/dist-cjs/commands/StartPHIDetectionJobCommand.js +0 -26
  20. package/dist-cjs/commands/StartRxNormInferenceJobCommand.js +0 -27
  21. package/dist-cjs/commands/StopEntitiesDetectionV2JobCommand.js +0 -25
  22. package/dist-cjs/commands/StopICD10CMInferenceJobCommand.js +0 -25
  23. package/dist-cjs/commands/StopPHIDetectionJobCommand.js +0 -25
  24. package/dist-cjs/commands/StopRxNormInferenceJobCommand.js +0 -25
  25. package/dist-cjs/commands/index.js +24 -0
  26. package/dist-cjs/endpoints.js +1 -2
  27. package/dist-cjs/index.js +3 -24
  28. package/dist-cjs/models/index.js +0 -1
  29. package/dist-cjs/models/models_0.js +0 -199
  30. package/dist-cjs/protocols/Aws_json1_1.js +0 -6
  31. package/dist-cjs/runtimeConfig.browser.js +1 -6
  32. package/dist-cjs/runtimeConfig.js +2 -7
  33. package/dist-cjs/runtimeConfig.native.js +0 -4
  34. package/dist-cjs/runtimeConfig.shared.js +0 -4
  35. package/dist-es/ComprehendMedical.js +0 -1
  36. package/dist-es/ComprehendMedicalClient.js +0 -1
  37. package/dist-es/commands/DescribeEntitiesDetectionV2JobCommand.js +0 -1
  38. package/dist-es/commands/DescribeICD10CMInferenceJobCommand.js +0 -1
  39. package/dist-es/commands/DescribePHIDetectionJobCommand.js +0 -1
  40. package/dist-es/commands/DescribeRxNormInferenceJobCommand.js +0 -1
  41. package/dist-es/commands/DetectEntitiesCommand.js +0 -1
  42. package/dist-es/commands/DetectEntitiesV2Command.js +0 -1
  43. package/dist-es/commands/DetectPHICommand.js +0 -1
  44. package/dist-es/commands/InferICD10CMCommand.js +0 -1
  45. package/dist-es/commands/InferRxNormCommand.js +0 -1
  46. package/dist-es/commands/ListEntitiesDetectionV2JobsCommand.js +0 -1
  47. package/dist-es/commands/ListICD10CMInferenceJobsCommand.js +0 -1
  48. package/dist-es/commands/ListPHIDetectionJobsCommand.js +0 -1
  49. package/dist-es/commands/ListRxNormInferenceJobsCommand.js +0 -1
  50. package/dist-es/commands/StartEntitiesDetectionV2JobCommand.js +0 -1
  51. package/dist-es/commands/StartICD10CMInferenceJobCommand.js +0 -1
  52. package/dist-es/commands/StartPHIDetectionJobCommand.js +0 -1
  53. package/dist-es/commands/StartRxNormInferenceJobCommand.js +0 -1
  54. package/dist-es/commands/StopEntitiesDetectionV2JobCommand.js +0 -1
  55. package/dist-es/commands/StopICD10CMInferenceJobCommand.js +0 -1
  56. package/dist-es/commands/StopPHIDetectionJobCommand.js +0 -1
  57. package/dist-es/commands/StopRxNormInferenceJobCommand.js +0 -1
  58. package/dist-es/commands/index.js +21 -0
  59. package/dist-es/endpoints.js +1 -2
  60. package/dist-es/index.js +3 -24
  61. package/dist-es/models/index.js +0 -1
  62. package/dist-es/models/models_0.js +0 -1
  63. package/dist-es/protocols/Aws_json1_1.js +0 -1
  64. package/dist-es/runtimeConfig.browser.js +1 -2
  65. package/dist-es/runtimeConfig.js +2 -3
  66. package/dist-es/runtimeConfig.native.js +0 -1
  67. package/dist-es/runtimeConfig.shared.js +0 -1
  68. package/dist-types/commands/index.d.ts +21 -0
  69. package/dist-types/index.d.ts +3 -23
  70. package/dist-types/ts3.4/ComprehendMedical.d.ts +22 -99
  71. package/dist-types/ts3.4/ComprehendMedicalClient.d.ts +24 -90
  72. package/dist-types/ts3.4/commands/DescribeEntitiesDetectionV2JobCommand.d.ts +2 -21
  73. package/dist-types/ts3.4/commands/DescribeICD10CMInferenceJobCommand.d.ts +2 -21
  74. package/dist-types/ts3.4/commands/DescribePHIDetectionJobCommand.d.ts +2 -21
  75. package/dist-types/ts3.4/commands/DescribeRxNormInferenceJobCommand.d.ts +2 -21
  76. package/dist-types/ts3.4/commands/DetectEntitiesCommand.d.ts +2 -25
  77. package/dist-types/ts3.4/commands/DetectEntitiesV2Command.d.ts +2 -29
  78. package/dist-types/ts3.4/commands/DetectPHICommand.d.ts +2 -22
  79. package/dist-types/ts3.4/commands/InferICD10CMCommand.d.ts +2 -23
  80. package/dist-types/ts3.4/commands/InferRxNormCommand.d.ts +2 -22
  81. package/dist-types/ts3.4/commands/ListEntitiesDetectionV2JobsCommand.d.ts +2 -20
  82. package/dist-types/ts3.4/commands/ListICD10CMInferenceJobsCommand.d.ts +2 -20
  83. package/dist-types/ts3.4/commands/ListPHIDetectionJobsCommand.d.ts +2 -21
  84. package/dist-types/ts3.4/commands/ListRxNormInferenceJobsCommand.d.ts +2 -20
  85. package/dist-types/ts3.4/commands/StartEntitiesDetectionV2JobCommand.d.ts +2 -21
  86. package/dist-types/ts3.4/commands/StartICD10CMInferenceJobCommand.d.ts +2 -22
  87. package/dist-types/ts3.4/commands/StartPHIDetectionJobCommand.d.ts +2 -21
  88. package/dist-types/ts3.4/commands/StartRxNormInferenceJobCommand.d.ts +2 -22
  89. package/dist-types/ts3.4/commands/StopEntitiesDetectionV2JobCommand.d.ts +2 -20
  90. package/dist-types/ts3.4/commands/StopICD10CMInferenceJobCommand.d.ts +2 -20
  91. package/dist-types/ts3.4/commands/StopPHIDetectionJobCommand.d.ts +2 -20
  92. package/dist-types/ts3.4/commands/StopRxNormInferenceJobCommand.d.ts +2 -20
  93. package/dist-types/ts3.4/commands/index.d.ts +21 -0
  94. package/dist-types/ts3.4/index.d.ts +3 -23
  95. package/dist-types/ts3.4/models/models_0.d.ts +273 -985
  96. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  97. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  98. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  99. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  100. package/package.json +33 -30
  101. package/dist-cjs/ComprehendMedical.js.map +0 -1
  102. package/dist-cjs/ComprehendMedicalClient.js.map +0 -1
  103. package/dist-cjs/commands/DescribeEntitiesDetectionV2JobCommand.js.map +0 -1
  104. package/dist-cjs/commands/DescribeICD10CMInferenceJobCommand.js.map +0 -1
  105. package/dist-cjs/commands/DescribePHIDetectionJobCommand.js.map +0 -1
  106. package/dist-cjs/commands/DescribeRxNormInferenceJobCommand.js.map +0 -1
  107. package/dist-cjs/commands/DetectEntitiesCommand.js.map +0 -1
  108. package/dist-cjs/commands/DetectEntitiesV2Command.js.map +0 -1
  109. package/dist-cjs/commands/DetectPHICommand.js.map +0 -1
  110. package/dist-cjs/commands/InferICD10CMCommand.js.map +0 -1
  111. package/dist-cjs/commands/InferRxNormCommand.js.map +0 -1
  112. package/dist-cjs/commands/ListEntitiesDetectionV2JobsCommand.js.map +0 -1
  113. package/dist-cjs/commands/ListICD10CMInferenceJobsCommand.js.map +0 -1
  114. package/dist-cjs/commands/ListPHIDetectionJobsCommand.js.map +0 -1
  115. package/dist-cjs/commands/ListRxNormInferenceJobsCommand.js.map +0 -1
  116. package/dist-cjs/commands/StartEntitiesDetectionV2JobCommand.js.map +0 -1
  117. package/dist-cjs/commands/StartICD10CMInferenceJobCommand.js.map +0 -1
  118. package/dist-cjs/commands/StartPHIDetectionJobCommand.js.map +0 -1
  119. package/dist-cjs/commands/StartRxNormInferenceJobCommand.js.map +0 -1
  120. package/dist-cjs/commands/StopEntitiesDetectionV2JobCommand.js.map +0 -1
  121. package/dist-cjs/commands/StopICD10CMInferenceJobCommand.js.map +0 -1
  122. package/dist-cjs/commands/StopPHIDetectionJobCommand.js.map +0 -1
  123. package/dist-cjs/commands/StopRxNormInferenceJobCommand.js.map +0 -1
  124. package/dist-cjs/endpoints.js.map +0 -1
  125. package/dist-cjs/index.js.map +0 -1
  126. package/dist-cjs/models/index.js.map +0 -1
  127. package/dist-cjs/models/models_0.js.map +0 -1
  128. package/dist-cjs/protocols/Aws_json1_1.js.map +0 -1
  129. package/dist-cjs/runtimeConfig.browser.js.map +0 -1
  130. package/dist-cjs/runtimeConfig.js.map +0 -1
  131. package/dist-cjs/runtimeConfig.native.js.map +0 -1
  132. package/dist-cjs/runtimeConfig.shared.js.map +0 -1
  133. package/dist-es/ComprehendMedical.js.map +0 -1
  134. package/dist-es/ComprehendMedicalClient.js.map +0 -1
  135. package/dist-es/commands/DescribeEntitiesDetectionV2JobCommand.js.map +0 -1
  136. package/dist-es/commands/DescribeICD10CMInferenceJobCommand.js.map +0 -1
  137. package/dist-es/commands/DescribePHIDetectionJobCommand.js.map +0 -1
  138. package/dist-es/commands/DescribeRxNormInferenceJobCommand.js.map +0 -1
  139. package/dist-es/commands/DetectEntitiesCommand.js.map +0 -1
  140. package/dist-es/commands/DetectEntitiesV2Command.js.map +0 -1
  141. package/dist-es/commands/DetectPHICommand.js.map +0 -1
  142. package/dist-es/commands/InferICD10CMCommand.js.map +0 -1
  143. package/dist-es/commands/InferRxNormCommand.js.map +0 -1
  144. package/dist-es/commands/ListEntitiesDetectionV2JobsCommand.js.map +0 -1
  145. package/dist-es/commands/ListICD10CMInferenceJobsCommand.js.map +0 -1
  146. package/dist-es/commands/ListPHIDetectionJobsCommand.js.map +0 -1
  147. package/dist-es/commands/ListRxNormInferenceJobsCommand.js.map +0 -1
  148. package/dist-es/commands/StartEntitiesDetectionV2JobCommand.js.map +0 -1
  149. package/dist-es/commands/StartICD10CMInferenceJobCommand.js.map +0 -1
  150. package/dist-es/commands/StartPHIDetectionJobCommand.js.map +0 -1
  151. package/dist-es/commands/StartRxNormInferenceJobCommand.js.map +0 -1
  152. package/dist-es/commands/StopEntitiesDetectionV2JobCommand.js.map +0 -1
  153. package/dist-es/commands/StopICD10CMInferenceJobCommand.js.map +0 -1
  154. package/dist-es/commands/StopPHIDetectionJobCommand.js.map +0 -1
  155. package/dist-es/commands/StopRxNormInferenceJobCommand.js.map +0 -1
  156. package/dist-es/endpoints.js.map +0 -1
  157. package/dist-es/index.js.map +0 -1
  158. package/dist-es/models/index.js.map +0 -1
  159. package/dist-es/models/models_0.js.map +0 -1
  160. package/dist-es/protocols/Aws_json1_1.js.map +0 -1
  161. package/dist-es/runtimeConfig.browser.js.map +0 -1
  162. package/dist-es/runtimeConfig.js.map +0 -1
  163. package/dist-es/runtimeConfig.native.js.map +0 -1
  164. package/dist-es/runtimeConfig.shared.js.map +0 -1
  165. package/jest.config.js +0 -4
  166. package/src/ComprehendMedical.ts +0 -795
  167. package/src/ComprehendMedicalClient.ts +0 -348
  168. package/src/commands/DescribeEntitiesDetectionV2JobCommand.ts +0 -108
  169. package/src/commands/DescribeICD10CMInferenceJobCommand.ts +0 -105
  170. package/src/commands/DescribePHIDetectionJobCommand.ts +0 -100
  171. package/src/commands/DescribeRxNormInferenceJobCommand.ts +0 -103
  172. package/src/commands/DetectEntitiesCommand.ts +0 -104
  173. package/src/commands/DetectEntitiesV2Command.ts +0 -108
  174. package/src/commands/DetectPHICommand.ts +0 -98
  175. package/src/commands/InferICD10CMCommand.ts +0 -102
  176. package/src/commands/InferRxNormCommand.ts +0 -101
  177. package/src/commands/ListEntitiesDetectionV2JobsCommand.ts +0 -104
  178. package/src/commands/ListICD10CMInferenceJobsCommand.ts +0 -99
  179. package/src/commands/ListPHIDetectionJobsCommand.ts +0 -100
  180. package/src/commands/ListRxNormInferenceJobsCommand.ts +0 -99
  181. package/src/commands/StartEntitiesDetectionV2JobCommand.ts +0 -105
  182. package/src/commands/StartICD10CMInferenceJobCommand.ts +0 -101
  183. package/src/commands/StartPHIDetectionJobCommand.ts +0 -100
  184. package/src/commands/StartRxNormInferenceJobCommand.ts +0 -101
  185. package/src/commands/StopEntitiesDetectionV2JobCommand.ts +0 -102
  186. package/src/commands/StopICD10CMInferenceJobCommand.ts +0 -99
  187. package/src/commands/StopPHIDetectionJobCommand.ts +0 -99
  188. package/src/commands/StopRxNormInferenceJobCommand.ts +0 -99
  189. package/src/endpoints.ts +0 -77
  190. package/src/index.ts +0 -24
  191. package/src/models/index.ts +0 -1
  192. package/src/models/models_0.ts +0 -2054
  193. package/src/protocols/Aws_json1_1.ts +0 -3273
  194. package/src/runtimeConfig.browser.ts +0 -41
  195. package/src/runtimeConfig.native.ts +0 -17
  196. package/src/runtimeConfig.shared.ts +0 -17
  197. package/src/runtimeConfig.ts +0 -46
  198. package/tsconfig.es.json +0 -10
  199. package/tsconfig.json +0 -33
  200. package/tsconfig.types.json +0 -9
@@ -33,23 +33,15 @@ export declare enum AttributeName {
33
33
  SIGN = "SIGN",
34
34
  SYMPTOM = "SYMPTOM"
35
35
  }
36
- /**
37
- * <p> Provides contextual information about the extracted entity. </p>
38
- */
36
+
39
37
  export interface Trait {
40
- /**
41
- * <p> Provides a name or contextual description about the trait. </p>
42
- */
38
+
43
39
  Name?: AttributeName | string;
44
- /**
45
- * <p> The level of confidence that Amazon Comprehend Medical has in the accuracy of this trait.</p>
46
- */
40
+
47
41
  Score?: number;
48
42
  }
49
43
  export declare namespace Trait {
50
- /**
51
- * @internal
52
- */
44
+
53
45
  const filterSensitiveLog: (obj: Trait) => any;
54
46
  }
55
47
  export declare enum EntitySubType {
@@ -88,102 +80,50 @@ export declare enum EntitySubType {
88
80
  TREATMENT_NAME = "TREATMENT_NAME",
89
81
  URL = "URL"
90
82
  }
91
- /**
92
- * <p> An extracted segment of the text that is an attribute of an entity, or otherwise related
93
- * to an entity, such as the dosage of a medication taken. It contains information about the
94
- * attribute such as id, begin and end offset within the input text, and the segment of the input
95
- * text. </p>
96
- */
83
+
97
84
  export interface Attribute {
98
- /**
99
- * <p> The type of attribute. </p>
100
- */
85
+
101
86
  Type?: EntitySubType | string;
102
- /**
103
- * <p> The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized
104
- * as an attribute. </p>
105
- */
87
+
106
88
  Score?: number;
107
- /**
108
- * <p> The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this
109
- * entity. </p>
110
- */
89
+
111
90
  RelationshipScore?: number;
112
- /**
113
- * <p>The type of relationship between the entity and attribute. Type for the relationship is
114
- * <code>OVERLAP</code>, indicating that the entity occurred at the same time as the
115
- * <code>Date_Expression</code>. </p>
116
- */
91
+
117
92
  RelationshipType?: RelationshipType | string;
118
- /**
119
- * <p> The numeric identifier for this attribute. This is a monotonically increasing id unique
120
- * within this response rather than a global unique identifier. </p>
121
- */
93
+
122
94
  Id?: number;
123
- /**
124
- * <p> The 0-based character offset in the input text that shows where the attribute begins. The
125
- * offset returns the UTF-8 code point in the string. </p>
126
- */
95
+
127
96
  BeginOffset?: number;
128
- /**
129
- * <p> The 0-based character offset in the input text that shows where the attribute ends. The
130
- * offset returns the UTF-8 code point in the string.</p>
131
- */
97
+
132
98
  EndOffset?: number;
133
- /**
134
- * <p> The segment of input text extracted as this attribute.</p>
135
- */
99
+
136
100
  Text?: string;
137
- /**
138
- * <p> The category of attribute. </p>
139
- */
101
+
140
102
  Category?: EntityType | string;
141
- /**
142
- * <p> Contextual information for this attribute. </p>
143
- */
103
+
144
104
  Traits?: Trait[];
145
105
  }
146
106
  export declare namespace Attribute {
147
- /**
148
- * @internal
149
- */
107
+
150
108
  const filterSensitiveLog: (obj: Attribute) => any;
151
109
  }
152
110
  export interface DescribeEntitiesDetectionV2JobRequest {
153
- /**
154
- * <p>The identifier that Amazon Comprehend Medical generated for the job. The
155
- * <code>StartEntitiesDetectionV2Job</code> operation returns this identifier in its
156
- * response.</p>
157
- */
111
+
158
112
  JobId: string | undefined;
159
113
  }
160
114
  export declare namespace DescribeEntitiesDetectionV2JobRequest {
161
- /**
162
- * @internal
163
- */
115
+
164
116
  const filterSensitiveLog: (obj: DescribeEntitiesDetectionV2JobRequest) => any;
165
117
  }
166
- /**
167
- * <p>The input properties for an entities detection job. This includes the name of the S3
168
- * bucket and the path to the files to be analyzed. </p>
169
- */
118
+
170
119
  export interface InputDataConfig {
171
- /**
172
- * <p>The URI of the S3 bucket that contains the input data. The bucket must be in the same
173
- * region as the API endpoint that you are calling.</p>
174
- * <p>Each file in the document collection must be less than 40 KB. You can store a maximum of
175
- * 30 GB in the bucket.</p>
176
- */
120
+
177
121
  S3Bucket: string | undefined;
178
- /**
179
- * <p>The path to the input data files in the S3 bucket.</p>
180
- */
122
+
181
123
  S3Key?: string;
182
124
  }
183
125
  export declare namespace InputDataConfig {
184
- /**
185
- * @internal
186
- */
126
+
187
127
  const filterSensitiveLog: (obj: InputDataConfig) => any;
188
128
  }
189
129
  export declare enum JobStatus {
@@ -198,503 +138,284 @@ export declare enum JobStatus {
198
138
  export declare enum LanguageCode {
199
139
  EN = "en"
200
140
  }
201
- /**
202
- * <p>The output properties for a detection job.</p>
203
- */
141
+
204
142
  export interface OutputDataConfig {
205
- /**
206
- * <p>When you use the <code>OutputDataConfig</code> object with asynchronous operations, you
207
- * specify the Amazon S3 location where you want to write the output data. The URI must be in the
208
- * same region as the API endpoint that you are calling. The location is used as the prefix for
209
- * the actual location of the output.</p>
210
- */
143
+
211
144
  S3Bucket: string | undefined;
212
- /**
213
- * <p>The path to the output data files in the S3 bucket. Amazon Comprehend Medical creates an output directory
214
- * using the job ID so that the output from one job does not overwrite the output of
215
- * another.</p>
216
- */
145
+
217
146
  S3Key?: string;
218
147
  }
219
148
  export declare namespace OutputDataConfig {
220
- /**
221
- * @internal
222
- */
149
+
223
150
  const filterSensitiveLog: (obj: OutputDataConfig) => any;
224
151
  }
225
- /**
226
- * <p>Provides information about a detection job.</p>
227
- */
152
+
228
153
  export interface ComprehendMedicalAsyncJobProperties {
229
- /**
230
- * <p>The identifier assigned to the detection job.</p>
231
- */
154
+
232
155
  JobId?: string;
233
- /**
234
- * <p>The name that you assigned to the detection job.</p>
235
- */
156
+
236
157
  JobName?: string;
237
- /**
238
- * <p>The current status of the detection job. If the status is <code>FAILED</code>, the
239
- * <code>Message</code> field shows the reason for the failure.</p>
240
- */
158
+
241
159
  JobStatus?: JobStatus | string;
242
- /**
243
- * <p>A description of the status of a job.</p>
244
- */
160
+
245
161
  Message?: string;
246
- /**
247
- * <p>The time that the detection job was submitted for processing.</p>
248
- */
162
+
249
163
  SubmitTime?: Date;
250
- /**
251
- * <p>The time that the detection job completed.</p>
252
- */
164
+
253
165
  EndTime?: Date;
254
- /**
255
- * <p>The date and time that job metadata is deleted from the server. Output files in your S3
256
- * bucket will not be deleted. After the metadata is deleted, the job will no longer appear in
257
- * the results of the <code>ListEntitiesDetectionV2Job</code> or the
258
- * <code>ListPHIDetectionJobs</code> operation.</p>
259
- */
166
+
260
167
  ExpirationTime?: Date;
261
- /**
262
- * <p>The input data configuration that you supplied when you created the detection job.</p>
263
- */
168
+
264
169
  InputDataConfig?: InputDataConfig;
265
- /**
266
- * <p>The output data configuration that you supplied when you created the detection job.</p>
267
- */
170
+
268
171
  OutputDataConfig?: OutputDataConfig;
269
- /**
270
- * <p>The language code of the input documents.</p>
271
- */
172
+
272
173
  LanguageCode?: LanguageCode | string;
273
- /**
274
- * <p>The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read access to your input data.</p>
275
- */
174
+
276
175
  DataAccessRoleArn?: string;
277
- /**
278
- * <p>The path to the file that describes the results of a batch job.</p>
279
- */
176
+
280
177
  ManifestFilePath?: string;
281
- /**
282
- * <p>The AWS Key Management Service key, if any, used to encrypt the output files. </p>
283
- */
178
+
284
179
  KMSKey?: string;
285
- /**
286
- * <p>The version of the model used to analyze the documents. The version number looks like
287
- * X.X.X. You can use this information to track the model used for a particular batch of
288
- * documents.</p>
289
- */
180
+
290
181
  ModelVersion?: string;
291
182
  }
292
183
  export declare namespace ComprehendMedicalAsyncJobProperties {
293
- /**
294
- * @internal
295
- */
184
+
296
185
  const filterSensitiveLog: (obj: ComprehendMedicalAsyncJobProperties) => any;
297
186
  }
298
187
  export interface DescribeEntitiesDetectionV2JobResponse {
299
- /**
300
- * <p>An object that contains the properties associated with a detection job.</p>
301
- */
188
+
302
189
  ComprehendMedicalAsyncJobProperties?: ComprehendMedicalAsyncJobProperties;
303
190
  }
304
191
  export declare namespace DescribeEntitiesDetectionV2JobResponse {
305
- /**
306
- * @internal
307
- */
192
+
308
193
  const filterSensitiveLog: (obj: DescribeEntitiesDetectionV2JobResponse) => any;
309
194
  }
310
- /**
311
- * <p> An internal server error occurred. Retry your request. </p>
312
- */
195
+
313
196
  export interface InternalServerException extends __SmithyException, $MetadataBearer {
314
197
  name: "InternalServerException";
315
198
  $fault: "server";
316
199
  Message?: string;
317
200
  }
318
201
  export declare namespace InternalServerException {
319
- /**
320
- * @internal
321
- */
202
+
322
203
  const filterSensitiveLog: (obj: InternalServerException) => any;
323
204
  }
324
- /**
325
- * <p> The request that you made is invalid. Check your request to determine why it's invalid
326
- * and then retry the request.</p>
327
- */
205
+
328
206
  export interface InvalidRequestException extends __SmithyException, $MetadataBearer {
329
207
  name: "InvalidRequestException";
330
208
  $fault: "client";
331
209
  Message?: string;
332
210
  }
333
211
  export declare namespace InvalidRequestException {
334
- /**
335
- * @internal
336
- */
212
+
337
213
  const filterSensitiveLog: (obj: InvalidRequestException) => any;
338
214
  }
339
- /**
340
- * <p>The resource identified by the specified Amazon Resource Name (ARN) was not found. Check
341
- * the ARN and try your request again.</p>
342
- */
215
+
343
216
  export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
344
217
  name: "ResourceNotFoundException";
345
218
  $fault: "client";
346
219
  Message?: string;
347
220
  }
348
221
  export declare namespace ResourceNotFoundException {
349
- /**
350
- * @internal
351
- */
222
+
352
223
  const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
353
224
  }
354
- /**
355
- * <p> You have made too many requests within a short period of time. Wait for a short time and
356
- * then try your request again. Contact customer support for more information about a service
357
- * limit increase. </p>
358
- */
225
+
359
226
  export interface TooManyRequestsException extends __SmithyException, $MetadataBearer {
360
227
  name: "TooManyRequestsException";
361
228
  $fault: "client";
362
229
  Message?: string;
363
230
  }
364
231
  export declare namespace TooManyRequestsException {
365
- /**
366
- * @internal
367
- */
232
+
368
233
  const filterSensitiveLog: (obj: TooManyRequestsException) => any;
369
234
  }
370
235
  export interface DescribeICD10CMInferenceJobRequest {
371
- /**
372
- * <p>The identifier that Amazon Comprehend Medical generated for the job. <code>The
373
- * StartICD10CMInferenceJob</code> operation returns this identifier in its response.</p>
374
- */
236
+
375
237
  JobId: string | undefined;
376
238
  }
377
239
  export declare namespace DescribeICD10CMInferenceJobRequest {
378
- /**
379
- * @internal
380
- */
240
+
381
241
  const filterSensitiveLog: (obj: DescribeICD10CMInferenceJobRequest) => any;
382
242
  }
383
243
  export interface DescribeICD10CMInferenceJobResponse {
384
- /**
385
- * <p>An object that contains the properties associated with a detection job.</p>
386
- */
244
+
387
245
  ComprehendMedicalAsyncJobProperties?: ComprehendMedicalAsyncJobProperties;
388
246
  }
389
247
  export declare namespace DescribeICD10CMInferenceJobResponse {
390
- /**
391
- * @internal
392
- */
248
+
393
249
  const filterSensitiveLog: (obj: DescribeICD10CMInferenceJobResponse) => any;
394
250
  }
395
251
  export interface DescribePHIDetectionJobRequest {
396
- /**
397
- * <p>The identifier that Amazon Comprehend Medical generated for the job. The <code>StartPHIDetectionJob</code>
398
- * operation returns this identifier in its response.</p>
399
- */
252
+
400
253
  JobId: string | undefined;
401
254
  }
402
255
  export declare namespace DescribePHIDetectionJobRequest {
403
- /**
404
- * @internal
405
- */
256
+
406
257
  const filterSensitiveLog: (obj: DescribePHIDetectionJobRequest) => any;
407
258
  }
408
259
  export interface DescribePHIDetectionJobResponse {
409
- /**
410
- * <p>An object that contains the properties associated with a detection job.</p>
411
- */
260
+
412
261
  ComprehendMedicalAsyncJobProperties?: ComprehendMedicalAsyncJobProperties;
413
262
  }
414
263
  export declare namespace DescribePHIDetectionJobResponse {
415
- /**
416
- * @internal
417
- */
264
+
418
265
  const filterSensitiveLog: (obj: DescribePHIDetectionJobResponse) => any;
419
266
  }
420
267
  export interface DescribeRxNormInferenceJobRequest {
421
- /**
422
- * <p>The identifier that Amazon Comprehend Medical generated for the job. The
423
- * StartRxNormInferenceJob operation returns this identifier in its response.</p>
424
- */
268
+
425
269
  JobId: string | undefined;
426
270
  }
427
271
  export declare namespace DescribeRxNormInferenceJobRequest {
428
- /**
429
- * @internal
430
- */
272
+
431
273
  const filterSensitiveLog: (obj: DescribeRxNormInferenceJobRequest) => any;
432
274
  }
433
275
  export interface DescribeRxNormInferenceJobResponse {
434
- /**
435
- * <p>An object that contains the properties associated with a detection job.</p>
436
- */
276
+
437
277
  ComprehendMedicalAsyncJobProperties?: ComprehendMedicalAsyncJobProperties;
438
278
  }
439
279
  export declare namespace DescribeRxNormInferenceJobResponse {
440
- /**
441
- * @internal
442
- */
280
+
443
281
  const filterSensitiveLog: (obj: DescribeRxNormInferenceJobResponse) => any;
444
282
  }
445
283
  export interface DetectEntitiesRequest {
446
- /**
447
- * <p> A UTF-8 text string containing the clinical content being examined for entities. Each
448
- * string must contain fewer than 20,000 bytes of characters.</p>
449
- */
284
+
450
285
  Text: string | undefined;
451
286
  }
452
287
  export declare namespace DetectEntitiesRequest {
453
- /**
454
- * @internal
455
- */
288
+
456
289
  const filterSensitiveLog: (obj: DetectEntitiesRequest) => any;
457
290
  }
458
- /**
459
- * <p> Provides information about an extracted medical entity.</p>
460
- */
291
+
461
292
  export interface Entity {
462
- /**
463
- * <p> The numeric identifier for the entity. This is a monotonically increasing id unique
464
- * within this response rather than a global unique identifier. </p>
465
- */
293
+
466
294
  Id?: number;
467
- /**
468
- * <p> The 0-based character offset in the input text that shows where the entity begins. The
469
- * offset returns the UTF-8 code point in the string. </p>
470
- */
295
+
471
296
  BeginOffset?: number;
472
- /**
473
- * <p> The 0-based character offset in the input text that shows where the entity ends. The
474
- * offset returns the UTF-8 code point in the string. </p>
475
- */
297
+
476
298
  EndOffset?: number;
477
- /**
478
- * <p>The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.</p>
479
- */
299
+
480
300
  Score?: number;
481
- /**
482
- * <p> The segment of input text extracted as this entity.</p>
483
- */
301
+
484
302
  Text?: string;
485
- /**
486
- * <p> The category of the entity.</p>
487
- */
303
+
488
304
  Category?: EntityType | string;
489
- /**
490
- * <p> Describes the specific type of entity with category of entities.</p>
491
- */
305
+
492
306
  Type?: EntitySubType | string;
493
- /**
494
- * <p>Contextual information for the entity.</p>
495
- */
307
+
496
308
  Traits?: Trait[];
497
- /**
498
- * <p> The extracted attributes that relate to this entity.</p>
499
- */
309
+
500
310
  Attributes?: Attribute[];
501
311
  }
502
312
  export declare namespace Entity {
503
- /**
504
- * @internal
505
- */
313
+
506
314
  const filterSensitiveLog: (obj: Entity) => any;
507
315
  }
508
- /**
509
- * <p> An attribute that we extracted, but were unable to relate to an entity. </p>
510
- */
316
+
511
317
  export interface UnmappedAttribute {
512
- /**
513
- * <p> The type of the attribute, could be one of the following values: "MEDICATION",
514
- * "MEDICAL_CONDITION", "ANATOMY", "TEST_AND_TREATMENT_PROCEDURE" or
515
- * "PROTECTED_HEALTH_INFORMATION". </p>
516
- */
318
+
517
319
  Type?: EntityType | string;
518
- /**
519
- * <p> The specific attribute that has been extracted but not mapped to an entity. </p>
520
- */
320
+
521
321
  Attribute?: Attribute;
522
322
  }
523
323
  export declare namespace UnmappedAttribute {
524
- /**
525
- * @internal
526
- */
324
+
527
325
  const filterSensitiveLog: (obj: UnmappedAttribute) => any;
528
326
  }
529
327
  export interface DetectEntitiesResponse {
530
- /**
531
- * <p> The collection of medical entities extracted from the input text and their associated
532
- * information. For each entity, the response provides the entity text, the entity category,
533
- * where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in the
534
- * detection and analysis. Attributes and traits of the entity are also returned.</p>
535
- */
328
+
536
329
  Entities: Entity[] | undefined;
537
- /**
538
- * <p> Attributes extracted from the input text that we were unable to relate to an
539
- * entity.</p>
540
- */
330
+
541
331
  UnmappedAttributes?: UnmappedAttribute[];
542
- /**
543
- * <p> If the result of the previous request to <code>DetectEntities</code> was truncated,
544
- * include the <code>PaginationToken</code> to fetch the next page of entities.</p>
545
- */
332
+
546
333
  PaginationToken?: string;
547
- /**
548
- * <p>The version of the model used to analyze the documents. The version number looks like
549
- * X.X.X. You can use this information to track the model used for a particular batch of
550
- * documents.</p>
551
- */
334
+
552
335
  ModelVersion: string | undefined;
553
336
  }
554
337
  export declare namespace DetectEntitiesResponse {
555
- /**
556
- * @internal
557
- */
338
+
558
339
  const filterSensitiveLog: (obj: DetectEntitiesResponse) => any;
559
340
  }
560
- /**
561
- * <p> The input text was not in valid UTF-8 character encoding. Check your text then retry your
562
- * request.</p>
563
- */
341
+
564
342
  export interface InvalidEncodingException extends __SmithyException, $MetadataBearer {
565
343
  name: "InvalidEncodingException";
566
344
  $fault: "client";
567
345
  Message?: string;
568
346
  }
569
347
  export declare namespace InvalidEncodingException {
570
- /**
571
- * @internal
572
- */
348
+
573
349
  const filterSensitiveLog: (obj: InvalidEncodingException) => any;
574
350
  }
575
- /**
576
- * <p> The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
577
- * </p>
578
- */
351
+
579
352
  export interface ServiceUnavailableException extends __SmithyException, $MetadataBearer {
580
353
  name: "ServiceUnavailableException";
581
354
  $fault: "server";
582
355
  Message?: string;
583
356
  }
584
357
  export declare namespace ServiceUnavailableException {
585
- /**
586
- * @internal
587
- */
358
+
588
359
  const filterSensitiveLog: (obj: ServiceUnavailableException) => any;
589
360
  }
590
- /**
591
- * <p> The size of the text you submitted exceeds the size limit. Reduce the size of the text or
592
- * use a smaller document and then retry your request. </p>
593
- */
361
+
594
362
  export interface TextSizeLimitExceededException extends __SmithyException, $MetadataBearer {
595
363
  name: "TextSizeLimitExceededException";
596
364
  $fault: "client";
597
365
  Message?: string;
598
366
  }
599
367
  export declare namespace TextSizeLimitExceededException {
600
- /**
601
- * @internal
602
- */
368
+
603
369
  const filterSensitiveLog: (obj: TextSizeLimitExceededException) => any;
604
370
  }
605
371
  export interface DetectEntitiesV2Request {
606
- /**
607
- * <p>A UTF-8 string containing the clinical content being examined for entities. Each string
608
- * must contain fewer than 20,000 bytes of characters.</p>
609
- */
372
+
610
373
  Text: string | undefined;
611
374
  }
612
375
  export declare namespace DetectEntitiesV2Request {
613
- /**
614
- * @internal
615
- */
376
+
616
377
  const filterSensitiveLog: (obj: DetectEntitiesV2Request) => any;
617
378
  }
618
379
  export interface DetectEntitiesV2Response {
619
- /**
620
- * <p>The collection of medical entities extracted from the input text and their associated
621
- * information. For each entity, the response provides the entity text, the entity category,
622
- * where the entity text begins and ends, and the level of confidence in the detection and
623
- * analysis. Attributes and traits of the entity are also returned.</p>
624
- */
380
+
625
381
  Entities: Entity[] | undefined;
626
- /**
627
- * <p>Attributes extracted from the input text that couldn't be related to an entity.</p>
628
- */
382
+
629
383
  UnmappedAttributes?: UnmappedAttribute[];
630
- /**
631
- * <p>If the result to the <code>DetectEntitiesV2</code> operation was truncated, include the
632
- * <code>PaginationToken</code> to fetch the next page of entities.</p>
633
- */
384
+
634
385
  PaginationToken?: string;
635
- /**
636
- * <p>The version of the model used to analyze the documents. The version number looks like
637
- * X.X.X. You can use this information to track the model used for a particular batch of
638
- * documents.</p>
639
- */
386
+
640
387
  ModelVersion: string | undefined;
641
388
  }
642
389
  export declare namespace DetectEntitiesV2Response {
643
- /**
644
- * @internal
645
- */
390
+
646
391
  const filterSensitiveLog: (obj: DetectEntitiesV2Response) => any;
647
392
  }
648
393
  export interface DetectPHIRequest {
649
- /**
650
- * <p> A UTF-8 text string containing the clinical content being examined for PHI entities. Each
651
- * string must contain fewer than 20,000 bytes of characters.</p>
652
- */
394
+
653
395
  Text: string | undefined;
654
396
  }
655
397
  export declare namespace DetectPHIRequest {
656
- /**
657
- * @internal
658
- */
398
+
659
399
  const filterSensitiveLog: (obj: DetectPHIRequest) => any;
660
400
  }
661
401
  export interface DetectPHIResponse {
662
- /**
663
- * <p> The collection of PHI entities extracted from the input text and their associated
664
- * information. For each entity, the response provides the entity text, the entity category,
665
- * where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in its
666
- * detection. </p>
667
- */
402
+
668
403
  Entities: Entity[] | undefined;
669
- /**
670
- * <p> If the result of the previous request to <code>DetectPHI</code> was truncated, include
671
- * the <code>PaginationToken</code> to fetch the next page of PHI entities. </p>
672
- */
404
+
673
405
  PaginationToken?: string;
674
- /**
675
- * <p>The version of the model used to analyze the documents. The version number looks like
676
- * X.X.X. You can use this information to track the model used for a particular batch of
677
- * documents.</p>
678
- */
406
+
679
407
  ModelVersion: string | undefined;
680
408
  }
681
409
  export declare namespace DetectPHIResponse {
682
- /**
683
- * @internal
684
- */
410
+
685
411
  const filterSensitiveLog: (obj: DetectPHIResponse) => any;
686
412
  }
687
413
  export interface InferICD10CMRequest {
688
- /**
689
- * <p>The input text used for analysis. The input for InferICD10CM is a string from 1 to 10000
690
- * characters.</p>
691
- */
414
+
692
415
  Text: string | undefined;
693
416
  }
694
417
  export declare namespace InferICD10CMRequest {
695
- /**
696
- * @internal
697
- */
418
+
698
419
  const filterSensitiveLog: (obj: InferICD10CMRequest) => any;
699
420
  }
700
421
  export declare enum ICD10CMEntityType {
@@ -711,26 +432,15 @@ export declare enum ICD10CMTraitName {
711
432
  SIGN = "SIGN",
712
433
  SYMPTOM = "SYMPTOM"
713
434
  }
714
- /**
715
- * <p>Contextual information for the entity. The traits recognized by InferICD10CM are
716
- * <code>DIAGNOSIS</code>, <code>SIGN</code>, <code>SYMPTOM</code>, and
717
- * <code>NEGATION</code>.</p>
718
- */
435
+
719
436
  export interface ICD10CMTrait {
720
- /**
721
- * <p>Provides a name or contextual description about the trait.</p>
722
- */
437
+
723
438
  Name?: ICD10CMTraitName | string;
724
- /**
725
- * <p>The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized
726
- * as a trait.</p>
727
- */
439
+
728
440
  Score?: number;
729
441
  }
730
442
  export declare namespace ICD10CMTrait {
731
- /**
732
- * @internal
733
- */
443
+
734
444
  const filterSensitiveLog: (obj: ICD10CMTrait) => any;
735
445
  }
736
446
  export declare enum ICD10CMAttributeType {
@@ -742,226 +452,108 @@ export declare enum ICD10CMAttributeType {
742
452
  TIME_EXPRESSION = "TIME_EXPRESSION",
743
453
  TIME_TO_DX_NAME = "TIME_TO_DX_NAME"
744
454
  }
745
- /**
746
- * <p>The detected attributes that relate to an entity. This includes an extracted segment of
747
- * the text that is an attribute of an entity, or otherwise related to an entity. InferICD10CM
748
- * detects the following attributes: <code>Direction</code>, <code>System, Organ or Site</code>,
749
- * and <code>Acuity</code>.</p>
750
- */
455
+
751
456
  export interface ICD10CMAttribute {
752
- /**
753
- * <p>The type of attribute. InferICD10CM detects entities of the type <code>DX_NAME</code>.
754
- * </p>
755
- */
457
+
756
458
  Type?: ICD10CMAttributeType | string;
757
- /**
758
- * <p>The level of confidence that Amazon Comprehend Medical has that the segment of text is
759
- * correctly recognized as an attribute.</p>
760
- */
459
+
761
460
  Score?: number;
762
- /**
763
- * <p>The level of confidence that Amazon Comprehend Medical has that this attribute is
764
- * correctly related to this entity.</p>
765
- */
461
+
766
462
  RelationshipScore?: number;
767
- /**
768
- * <p>The numeric identifier for this attribute. This is a monotonically increasing id unique
769
- * within this response rather than a global unique identifier.</p>
770
- */
463
+
771
464
  Id?: number;
772
- /**
773
- * <p>The 0-based character offset in the input text that shows where the attribute begins. The
774
- * offset returns the UTF-8 code point in the string.</p>
775
- */
465
+
776
466
  BeginOffset?: number;
777
- /**
778
- * <p>The 0-based character offset in the input text that shows where the attribute ends. The
779
- * offset returns the UTF-8 code point in the string.</p>
780
- */
467
+
781
468
  EndOffset?: number;
782
- /**
783
- * <p>The segment of input text which contains the detected attribute.</p>
784
- */
469
+
785
470
  Text?: string;
786
- /**
787
- * <p>The contextual information for the attribute. The traits recognized by InferICD10CM are
788
- * <code>DIAGNOSIS</code>, <code>SIGN</code>, <code>SYMPTOM</code>, and
789
- * <code>NEGATION</code>.</p>
790
- */
471
+
791
472
  Traits?: ICD10CMTrait[];
792
- /**
793
- * <p>The category of attribute. Can be either of <code>DX_NAME</code> or <code>TIME_EXPRESSION</code>.</p>
794
- */
473
+
795
474
  Category?: ICD10CMEntityType | string;
796
- /**
797
- * <p>The type of relationship between the entity and attribute. Type for the relationship can
798
- * be either of <code>OVERLAP</code> or <code>SYSTEM_ORGAN_SITE</code>.</p>
799
- */
475
+
800
476
  RelationshipType?: ICD10CMRelationshipType | string;
801
477
  }
802
478
  export declare namespace ICD10CMAttribute {
803
- /**
804
- * @internal
805
- */
479
+
806
480
  const filterSensitiveLog: (obj: ICD10CMAttribute) => any;
807
481
  }
808
482
  export declare enum ICD10CMEntityCategory {
809
483
  MEDICAL_CONDITION = "MEDICAL_CONDITION"
810
484
  }
811
- /**
812
- * <p> The ICD-10-CM concepts that the entity could refer to, along with a score indicating the
813
- * likelihood of the match.</p>
814
- */
485
+
815
486
  export interface ICD10CMConcept {
816
- /**
817
- * <p>The long description of the ICD-10-CM code in the ontology.</p>
818
- */
487
+
819
488
  Description?: string;
820
- /**
821
- * <p>The ICD-10-CM code that identifies the concept found in the knowledge base from the
822
- * Centers for Disease Control.</p>
823
- */
489
+
824
490
  Code?: string;
825
- /**
826
- * <p>The level of confidence that Amazon Comprehend Medical has that the entity is accurately
827
- * linked to an ICD-10-CM concept.</p>
828
- */
491
+
829
492
  Score?: number;
830
493
  }
831
494
  export declare namespace ICD10CMConcept {
832
- /**
833
- * @internal
834
- */
495
+
835
496
  const filterSensitiveLog: (obj: ICD10CMConcept) => any;
836
497
  }
837
- /**
838
- * <p>The collection of medical entities extracted from the input text and their associated
839
- * information. For each entity, the response provides the entity text, the entity category,
840
- * where the entity text begins and ends, and the level of confidence that Amazon Comprehend
841
- * Medical has in the detection and analysis. Attributes and traits of the entity are also
842
- * returned. </p>
843
- */
498
+
844
499
  export interface ICD10CMEntity {
845
- /**
846
- * <p>The numeric identifier for the entity. This is a monotonically increasing id unique within
847
- * this response rather than a global unique identifier.</p>
848
- */
500
+
849
501
  Id?: number;
850
- /**
851
- * <p>The segment of input text that is matched to the detected entity.</p>
852
- */
502
+
853
503
  Text?: string;
854
- /**
855
- * <p> The category of the entity. InferICD10CM detects entities in the
856
- * <code>MEDICAL_CONDITION</code> category. </p>
857
- */
504
+
858
505
  Category?: ICD10CMEntityCategory | string;
859
- /**
860
- * <p>Describes the specific type of entity with category of entities. InferICD10CM detects
861
- * entities of the type <code>DX_NAME</code> and <code>TIME_EXPRESSION</code>.</p>
862
- */
506
+
863
507
  Type?: ICD10CMEntityType | string;
864
- /**
865
- * <p>The level of confidence that Amazon Comprehend Medical has in the accuracy of the
866
- * detection.</p>
867
- */
508
+
868
509
  Score?: number;
869
- /**
870
- * <p>The 0-based character offset in the input text that shows where the entity begins. The
871
- * offset returns the UTF-8 code point in the string.</p>
872
- */
510
+
873
511
  BeginOffset?: number;
874
- /**
875
- * <p>The 0-based character offset in the input text that shows where the entity ends. The
876
- * offset returns the UTF-8 code point in the string.</p>
877
- */
512
+
878
513
  EndOffset?: number;
879
- /**
880
- * <p>The detected attributes that relate to the entity. An extracted segment of the text that
881
- * is an attribute of an entity, or otherwise related to an entity, such as the nature of a
882
- * medical condition.</p>
883
- */
514
+
884
515
  Attributes?: ICD10CMAttribute[];
885
- /**
886
- * <p>Provides Contextual information for the entity. The traits recognized by InferICD10CM are
887
- * <code>DIAGNOSIS</code>, <code>SIGN</code>, <code>SYMPTOM</code>, and
888
- * <code>NEGATION.</code>
889
- * </p>
890
- */
516
+
891
517
  Traits?: ICD10CMTrait[];
892
- /**
893
- * <p>The ICD-10-CM concepts that the entity could refer to, along with a score indicating the
894
- * likelihood of the match.</p>
895
- */
518
+
896
519
  ICD10CMConcepts?: ICD10CMConcept[];
897
520
  }
898
521
  export declare namespace ICD10CMEntity {
899
- /**
900
- * @internal
901
- */
522
+
902
523
  const filterSensitiveLog: (obj: ICD10CMEntity) => any;
903
524
  }
904
525
  export interface InferICD10CMResponse {
905
- /**
906
- * <p>The medical conditions detected in the text linked to ICD-10-CM concepts. If the action is
907
- * successful, the service sends back an HTTP 200 response, as well as the entities
908
- * detected.</p>
909
- */
526
+
910
527
  Entities: ICD10CMEntity[] | undefined;
911
- /**
912
- * <p>If the result of the previous request to <code>InferICD10CM</code> was truncated, include
913
- * the <code>PaginationToken</code> to fetch the next page of medical condition entities. </p>
914
- */
528
+
915
529
  PaginationToken?: string;
916
- /**
917
- * <p>The version of the model used to analyze the documents, in the format
918
- * <i>n</i>.<i>n</i>.<i>n</i> You can use this
919
- * information to track the model used for a particular batch of documents.</p>
920
- */
530
+
921
531
  ModelVersion?: string;
922
532
  }
923
533
  export declare namespace InferICD10CMResponse {
924
- /**
925
- * @internal
926
- */
534
+
927
535
  const filterSensitiveLog: (obj: InferICD10CMResponse) => any;
928
536
  }
929
537
  export interface InferRxNormRequest {
930
- /**
931
- * <p>The input text used for analysis. The input for InferRxNorm is a string from 1 to 10000
932
- * characters.</p>
933
- */
538
+
934
539
  Text: string | undefined;
935
540
  }
936
541
  export declare namespace InferRxNormRequest {
937
- /**
938
- * @internal
939
- */
542
+
940
543
  const filterSensitiveLog: (obj: InferRxNormRequest) => any;
941
544
  }
942
545
  export declare enum RxNormTraitName {
943
546
  NEGATION = "NEGATION"
944
547
  }
945
- /**
946
- * <p>The contextual information for the entity. InferRxNorm recognizes the trait
947
- * <code>NEGATION</code>, which is any indication that the patient is not taking a medication.
948
- * </p>
949
- */
548
+
950
549
  export interface RxNormTrait {
951
- /**
952
- * <p>Provides a name or contextual description about the trait.</p>
953
- */
550
+
954
551
  Name?: RxNormTraitName | string;
955
- /**
956
- * <p>The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected
957
- * trait.</p>
958
- */
552
+
959
553
  Score?: number;
960
554
  }
961
555
  export declare namespace RxNormTrait {
962
- /**
963
- * @internal
964
- */
556
+
965
557
  const filterSensitiveLog: (obj: RxNormTrait) => any;
966
558
  }
967
559
  export declare enum RxNormAttributeType {
@@ -973,678 +565,374 @@ export declare enum RxNormAttributeType {
973
565
  ROUTE_OR_MODE = "ROUTE_OR_MODE",
974
566
  STRENGTH = "STRENGTH"
975
567
  }
976
- /**
977
- * <p>The extracted attributes that relate to this entity. The attributes recognized by
978
- * InferRxNorm are <code>DOSAGE</code>, <code>DURATION</code>, <code>FORM</code>,
979
- * <code>FREQUENCY</code>, <code>RATE</code>, <code>ROUTE_OR_MODE</code>.</p>
980
- */
568
+
981
569
  export interface RxNormAttribute {
982
- /**
983
- * <p>The type of attribute. The types of attributes recognized by InferRxNorm are
984
- * <code>BRAND_NAME</code> and <code>GENERIC_NAME</code>.</p>
985
- */
570
+
986
571
  Type?: RxNormAttributeType | string;
987
- /**
988
- * <p>The level of confidence that Comprehend Medical has that the segment of text is correctly
989
- * recognized as an attribute.</p>
990
- */
572
+
991
573
  Score?: number;
992
- /**
993
- * <p>The level of confidence that Amazon Comprehend Medical has that the attribute is
994
- * accurately linked to an entity.</p>
995
- */
574
+
996
575
  RelationshipScore?: number;
997
- /**
998
- * <p>The numeric identifier for this attribute. This is a monotonically increasing id unique
999
- * within this response rather than a global unique identifier.</p>
1000
- */
576
+
1001
577
  Id?: number;
1002
- /**
1003
- * <p>The 0-based character offset in the input text that shows where the attribute begins. The
1004
- * offset returns the UTF-8 code point in the string.</p>
1005
- */
578
+
1006
579
  BeginOffset?: number;
1007
- /**
1008
- * <p>The 0-based character offset in the input text that shows where the attribute ends. The
1009
- * offset returns the UTF-8 code point in the string.</p>
1010
- */
580
+
1011
581
  EndOffset?: number;
1012
- /**
1013
- * <p>The segment of input text which corresponds to the detected attribute.</p>
1014
- */
582
+
1015
583
  Text?: string;
1016
- /**
1017
- * <p>Contextual information for the attribute. InferRxNorm recognizes the trait
1018
- * <code>NEGATION</code> for attributes, i.e. that the patient is not taking a specific dose or
1019
- * form of a medication.</p>
1020
- */
584
+
1021
585
  Traits?: RxNormTrait[];
1022
586
  }
1023
587
  export declare namespace RxNormAttribute {
1024
- /**
1025
- * @internal
1026
- */
588
+
1027
589
  const filterSensitiveLog: (obj: RxNormAttribute) => any;
1028
590
  }
1029
591
  export declare enum RxNormEntityCategory {
1030
592
  MEDICATION = "MEDICATION"
1031
593
  }
1032
- /**
1033
- * <p>The RxNorm concept that the entity could refer to, along with a score indicating the
1034
- * likelihood of the match.</p>
1035
- */
594
+
1036
595
  export interface RxNormConcept {
1037
- /**
1038
- * <p>The description of the RxNorm concept.</p>
1039
- */
596
+
1040
597
  Description?: string;
1041
- /**
1042
- * <p>RxNorm concept ID, also known as the RxCUI.</p>
1043
- */
598
+
1044
599
  Code?: string;
1045
- /**
1046
- * <p>The level of confidence that Amazon Comprehend Medical has that the entity is accurately
1047
- * linked to the reported RxNorm concept.</p>
1048
- */
600
+
1049
601
  Score?: number;
1050
602
  }
1051
603
  export declare namespace RxNormConcept {
1052
- /**
1053
- * @internal
1054
- */
604
+
1055
605
  const filterSensitiveLog: (obj: RxNormConcept) => any;
1056
606
  }
1057
607
  export declare enum RxNormEntityType {
1058
608
  BRAND_NAME = "BRAND_NAME",
1059
609
  GENERIC_NAME = "GENERIC_NAME"
1060
610
  }
1061
- /**
1062
- * <p>The collection of medical entities extracted from the input text and their associated
1063
- * information. For each entity, the response provides the entity text, the entity category,
1064
- * where the entity text begins and ends, and the level of confidence that Amazon Comprehend
1065
- * Medical has in the detection and analysis. Attributes and traits of the entity are also
1066
- * returned. </p>
1067
- */
611
+
1068
612
  export interface RxNormEntity {
1069
- /**
1070
- * <p>The numeric identifier for the entity. This is a monotonically increasing id unique within
1071
- * this response rather than a global unique identifier.</p>
1072
- */
613
+
1073
614
  Id?: number;
1074
- /**
1075
- * <p>The segment of input text extracted from which the entity was detected.</p>
1076
- */
615
+
1077
616
  Text?: string;
1078
- /**
1079
- * <p>The category of the entity. The recognized categories are <code>GENERIC</code> or
1080
- * <code>BRAND_NAME</code>.</p>
1081
- */
617
+
1082
618
  Category?: RxNormEntityCategory | string;
1083
- /**
1084
- * <p> Describes the specific type of entity. For InferRxNorm, the recognized entity type is
1085
- * <code>MEDICATION</code>.</p>
1086
- */
619
+
1087
620
  Type?: RxNormEntityType | string;
1088
- /**
1089
- * <p>The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected
1090
- * entity.</p>
1091
- */
621
+
1092
622
  Score?: number;
1093
- /**
1094
- * <p>The 0-based character offset in the input text that shows where the entity begins. The
1095
- * offset returns the UTF-8 code point in the string.</p>
1096
- */
623
+
1097
624
  BeginOffset?: number;
1098
- /**
1099
- * <p>The 0-based character offset in the input text that shows where the entity ends. The
1100
- * offset returns the UTF-8 code point in the string.</p>
1101
- */
625
+
1102
626
  EndOffset?: number;
1103
- /**
1104
- * <p>The extracted attributes that relate to the entity. The attributes recognized by
1105
- * InferRxNorm are <code>DOSAGE</code>, <code>DURATION</code>, <code>FORM</code>,
1106
- * <code>FREQUENCY</code>, <code>RATE</code>, <code>ROUTE_OR_MODE</code>, and
1107
- * <code>STRENGTH</code>.</p>
1108
- */
627
+
1109
628
  Attributes?: RxNormAttribute[];
1110
- /**
1111
- * <p> Contextual information for the entity.</p>
1112
- */
629
+
1113
630
  Traits?: RxNormTrait[];
1114
- /**
1115
- * <p> The RxNorm concepts that the entity could refer to, along with a score indicating the
1116
- * likelihood of the match.</p>
1117
- */
631
+
1118
632
  RxNormConcepts?: RxNormConcept[];
1119
633
  }
1120
634
  export declare namespace RxNormEntity {
1121
- /**
1122
- * @internal
1123
- */
635
+
1124
636
  const filterSensitiveLog: (obj: RxNormEntity) => any;
1125
637
  }
1126
638
  export interface InferRxNormResponse {
1127
- /**
1128
- * <p>The medication entities detected in the text linked to RxNorm concepts. If the action is
1129
- * successful, the service sends back an HTTP 200 response, as well as the entities
1130
- * detected.</p>
1131
- */
639
+
1132
640
  Entities: RxNormEntity[] | undefined;
1133
- /**
1134
- * <p>If the result of the previous request to <code>InferRxNorm</code> was truncated, include
1135
- * the <code>PaginationToken</code> to fetch the next page of medication entities.</p>
1136
- */
641
+
1137
642
  PaginationToken?: string;
1138
- /**
1139
- * <p>The version of the model used to analyze the documents, in the format
1140
- * <i>n</i>.<i>n</i>.<i>n</i> You can use this
1141
- * information to track the model used for a particular batch of documents.</p>
1142
- */
643
+
1143
644
  ModelVersion?: string;
1144
645
  }
1145
646
  export declare namespace InferRxNormResponse {
1146
- /**
1147
- * @internal
1148
- */
647
+
1149
648
  const filterSensitiveLog: (obj: InferRxNormResponse) => any;
1150
649
  }
1151
- /**
1152
- * <p>Provides information for filtering a list of detection jobs.</p>
1153
- */
650
+
1154
651
  export interface ComprehendMedicalAsyncJobFilter {
1155
- /**
1156
- * <p>Filters on the name of the job.</p>
1157
- */
652
+
1158
653
  JobName?: string;
1159
- /**
1160
- * <p>Filters the list of jobs based on job status. Returns only jobs with the specified
1161
- * status.</p>
1162
- */
654
+
1163
655
  JobStatus?: JobStatus | string;
1164
- /**
1165
- * <p>Filters the list of jobs based on the time that the job was submitted for processing.
1166
- * Returns only jobs submitted before the specified time. Jobs are returned in ascending order,
1167
- * oldest to newest.</p>
1168
- */
656
+
1169
657
  SubmitTimeBefore?: Date;
1170
- /**
1171
- * <p>Filters the list of jobs based on the time that the job was submitted for processing.
1172
- * Returns only jobs submitted after the specified time. Jobs are returned in descending order,
1173
- * newest to oldest.</p>
1174
- */
658
+
1175
659
  SubmitTimeAfter?: Date;
1176
660
  }
1177
661
  export declare namespace ComprehendMedicalAsyncJobFilter {
1178
- /**
1179
- * @internal
1180
- */
662
+
1181
663
  const filterSensitiveLog: (obj: ComprehendMedicalAsyncJobFilter) => any;
1182
664
  }
1183
665
  export interface ListEntitiesDetectionV2JobsRequest {
1184
- /**
1185
- * <p>Filters the jobs that are returned. You can filter jobs based on their names, status, or
1186
- * the date and time that they were submitted. You can only set one filter at a time.</p>
1187
- */
666
+
1188
667
  Filter?: ComprehendMedicalAsyncJobFilter;
1189
- /**
1190
- * <p>Identifies the next page of results to return.</p>
1191
- */
668
+
1192
669
  NextToken?: string;
1193
- /**
1194
- * <p>The maximum number of results to return in each page. The default is 100.</p>
1195
- */
670
+
1196
671
  MaxResults?: number;
1197
672
  }
1198
673
  export declare namespace ListEntitiesDetectionV2JobsRequest {
1199
- /**
1200
- * @internal
1201
- */
674
+
1202
675
  const filterSensitiveLog: (obj: ListEntitiesDetectionV2JobsRequest) => any;
1203
676
  }
1204
677
  export interface ListEntitiesDetectionV2JobsResponse {
1205
- /**
1206
- * <p>A list containing the properties of each job returned.</p>
1207
- */
678
+
1208
679
  ComprehendMedicalAsyncJobPropertiesList?: ComprehendMedicalAsyncJobProperties[];
1209
- /**
1210
- * <p>Identifies the next page of results to return.</p>
1211
- */
680
+
1212
681
  NextToken?: string;
1213
682
  }
1214
683
  export declare namespace ListEntitiesDetectionV2JobsResponse {
1215
- /**
1216
- * @internal
1217
- */
684
+
1218
685
  const filterSensitiveLog: (obj: ListEntitiesDetectionV2JobsResponse) => any;
1219
686
  }
1220
- /**
1221
- * <p>The filter that you specified for the operation is invalid. Check the filter values that
1222
- * you entered and try your request again.</p>
1223
- */
687
+
1224
688
  export interface ValidationException extends __SmithyException, $MetadataBearer {
1225
689
  name: "ValidationException";
1226
690
  $fault: "client";
1227
691
  Message?: string;
1228
692
  }
1229
693
  export declare namespace ValidationException {
1230
- /**
1231
- * @internal
1232
- */
694
+
1233
695
  const filterSensitiveLog: (obj: ValidationException) => any;
1234
696
  }
1235
697
  export interface ListICD10CMInferenceJobsRequest {
1236
- /**
1237
- * <p>Filters the jobs that are returned. You can filter jobs based on their names, status, or
1238
- * the date and time that they were submitted. You can only set one filter at a time.</p>
1239
- */
698
+
1240
699
  Filter?: ComprehendMedicalAsyncJobFilter;
1241
- /**
1242
- * <p>Identifies the next page of results to return.</p>
1243
- */
700
+
1244
701
  NextToken?: string;
1245
- /**
1246
- * <p>The maximum number of results to return in each page. The default is 100.</p>
1247
- */
702
+
1248
703
  MaxResults?: number;
1249
704
  }
1250
705
  export declare namespace ListICD10CMInferenceJobsRequest {
1251
- /**
1252
- * @internal
1253
- */
706
+
1254
707
  const filterSensitiveLog: (obj: ListICD10CMInferenceJobsRequest) => any;
1255
708
  }
1256
709
  export interface ListICD10CMInferenceJobsResponse {
1257
- /**
1258
- * <p>A list containing the properties of each job that is returned.</p>
1259
- */
710
+
1260
711
  ComprehendMedicalAsyncJobPropertiesList?: ComprehendMedicalAsyncJobProperties[];
1261
- /**
1262
- * <p>Identifies the next page of results to return.</p>
1263
- */
712
+
1264
713
  NextToken?: string;
1265
714
  }
1266
715
  export declare namespace ListICD10CMInferenceJobsResponse {
1267
- /**
1268
- * @internal
1269
- */
716
+
1270
717
  const filterSensitiveLog: (obj: ListICD10CMInferenceJobsResponse) => any;
1271
718
  }
1272
719
  export interface ListPHIDetectionJobsRequest {
1273
- /**
1274
- * <p>Filters the jobs that are returned. You can filter jobs based on their names, status, or
1275
- * the date and time that they were submitted. You can only set one filter at a time.</p>
1276
- */
720
+
1277
721
  Filter?: ComprehendMedicalAsyncJobFilter;
1278
- /**
1279
- * <p>Identifies the next page of results to return.</p>
1280
- */
722
+
1281
723
  NextToken?: string;
1282
- /**
1283
- * <p>The maximum number of results to return in each page. The default is 100.</p>
1284
- */
724
+
1285
725
  MaxResults?: number;
1286
726
  }
1287
727
  export declare namespace ListPHIDetectionJobsRequest {
1288
- /**
1289
- * @internal
1290
- */
728
+
1291
729
  const filterSensitiveLog: (obj: ListPHIDetectionJobsRequest) => any;
1292
730
  }
1293
731
  export interface ListPHIDetectionJobsResponse {
1294
- /**
1295
- * <p>A list containing the properties of each job returned.</p>
1296
- */
732
+
1297
733
  ComprehendMedicalAsyncJobPropertiesList?: ComprehendMedicalAsyncJobProperties[];
1298
- /**
1299
- * <p>Identifies the next page of results to return.</p>
1300
- */
734
+
1301
735
  NextToken?: string;
1302
736
  }
1303
737
  export declare namespace ListPHIDetectionJobsResponse {
1304
- /**
1305
- * @internal
1306
- */
738
+
1307
739
  const filterSensitiveLog: (obj: ListPHIDetectionJobsResponse) => any;
1308
740
  }
1309
741
  export interface ListRxNormInferenceJobsRequest {
1310
- /**
1311
- * <p>Filters the jobs that are returned. You can filter jobs based on their names, status, or
1312
- * the date and time that they were submitted. You can only set one filter at a time.</p>
1313
- */
742
+
1314
743
  Filter?: ComprehendMedicalAsyncJobFilter;
1315
- /**
1316
- * <p>Identifies the next page of results to return.</p>
1317
- */
744
+
1318
745
  NextToken?: string;
1319
- /**
1320
- * <p>Identifies the next page of results to return.</p>
1321
- */
746
+
1322
747
  MaxResults?: number;
1323
748
  }
1324
749
  export declare namespace ListRxNormInferenceJobsRequest {
1325
- /**
1326
- * @internal
1327
- */
750
+
1328
751
  const filterSensitiveLog: (obj: ListRxNormInferenceJobsRequest) => any;
1329
752
  }
1330
753
  export interface ListRxNormInferenceJobsResponse {
1331
- /**
1332
- * <p>The maximum number of results to return in each page. The default is 100.</p>
1333
- */
754
+
1334
755
  ComprehendMedicalAsyncJobPropertiesList?: ComprehendMedicalAsyncJobProperties[];
1335
- /**
1336
- * <p>Identifies the next page of results to return.</p>
1337
- */
756
+
1338
757
  NextToken?: string;
1339
758
  }
1340
759
  export declare namespace ListRxNormInferenceJobsResponse {
1341
- /**
1342
- * @internal
1343
- */
760
+
1344
761
  const filterSensitiveLog: (obj: ListRxNormInferenceJobsResponse) => any;
1345
762
  }
1346
763
  export interface StartEntitiesDetectionV2JobRequest {
1347
- /**
1348
- * <p>Specifies the format and location of the input data for the job.</p>
1349
- */
764
+
1350
765
  InputDataConfig: InputDataConfig | undefined;
1351
- /**
1352
- * <p>Specifies where to send the output files.</p>
1353
- */
766
+
1354
767
  OutputDataConfig: OutputDataConfig | undefined;
1355
- /**
1356
- * <p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that
1357
- * grants Amazon Comprehend Medical read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med"> Role-Based Permissions Required for Asynchronous Operations</a>.</p>
1358
- */
768
+
1359
769
  DataAccessRoleArn: string | undefined;
1360
- /**
1361
- * <p>The identifier of the job.</p>
1362
- */
770
+
1363
771
  JobName?: string;
1364
- /**
1365
- * <p>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical
1366
- * generates one.</p>
1367
- */
772
+
1368
773
  ClientRequestToken?: string;
1369
- /**
1370
- * <p>An AWS Key Management Service key to encrypt your output files. If you do not specify a
1371
- * key, the files are written in plain text.</p>
1372
- */
774
+
1373
775
  KMSKey?: string;
1374
- /**
1375
- * <p>The language of the input documents. All documents must be in the same language.</p>
1376
- */
776
+
1377
777
  LanguageCode: LanguageCode | string | undefined;
1378
778
  }
1379
779
  export declare namespace StartEntitiesDetectionV2JobRequest {
1380
- /**
1381
- * @internal
1382
- */
780
+
1383
781
  const filterSensitiveLog: (obj: StartEntitiesDetectionV2JobRequest) => any;
1384
782
  }
1385
783
  export interface StartEntitiesDetectionV2JobResponse {
1386
- /**
1387
- * <p>The identifier generated for the job. To get the status of a job, use this identifier with
1388
- * the <code>DescribeEntitiesDetectionV2Job</code> operation.</p>
1389
- */
784
+
1390
785
  JobId?: string;
1391
786
  }
1392
787
  export declare namespace StartEntitiesDetectionV2JobResponse {
1393
- /**
1394
- * @internal
1395
- */
788
+
1396
789
  const filterSensitiveLog: (obj: StartEntitiesDetectionV2JobResponse) => any;
1397
790
  }
1398
791
  export interface StartICD10CMInferenceJobRequest {
1399
- /**
1400
- * <p>Specifies the format and location of the input data for the job.</p>
1401
- */
792
+
1402
793
  InputDataConfig: InputDataConfig | undefined;
1403
- /**
1404
- * <p>Specifies where to send the output files.</p>
1405
- */
794
+
1406
795
  OutputDataConfig: OutputDataConfig | undefined;
1407
- /**
1408
- * <p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that
1409
- * grants Amazon Comprehend Medical read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med"> Role-Based Permissions Required for Asynchronous Operations</a>.</p>
1410
- */
796
+
1411
797
  DataAccessRoleArn: string | undefined;
1412
- /**
1413
- * <p>The identifier of the job.</p>
1414
- */
798
+
1415
799
  JobName?: string;
1416
- /**
1417
- * <p>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical
1418
- * generates one.</p>
1419
- */
800
+
1420
801
  ClientRequestToken?: string;
1421
- /**
1422
- * <p>An AWS Key Management Service key to encrypt your output files. If you do not specify a
1423
- * key, the files are written in plain text.</p>
1424
- */
802
+
1425
803
  KMSKey?: string;
1426
- /**
1427
- * <p>The language of the input documents. All documents must be in the same language.</p>
1428
- */
804
+
1429
805
  LanguageCode: LanguageCode | string | undefined;
1430
806
  }
1431
807
  export declare namespace StartICD10CMInferenceJobRequest {
1432
- /**
1433
- * @internal
1434
- */
808
+
1435
809
  const filterSensitiveLog: (obj: StartICD10CMInferenceJobRequest) => any;
1436
810
  }
1437
811
  export interface StartICD10CMInferenceJobResponse {
1438
- /**
1439
- * <p>The identifier generated for the job. To get the status of a job, use this identifier with
1440
- * the <code>StartICD10CMInferenceJob</code> operation.</p>
1441
- */
812
+
1442
813
  JobId?: string;
1443
814
  }
1444
815
  export declare namespace StartICD10CMInferenceJobResponse {
1445
- /**
1446
- * @internal
1447
- */
816
+
1448
817
  const filterSensitiveLog: (obj: StartICD10CMInferenceJobResponse) => any;
1449
818
  }
1450
819
  export interface StartPHIDetectionJobRequest {
1451
- /**
1452
- * <p>Specifies the format and location of the input data for the job.</p>
1453
- */
820
+
1454
821
  InputDataConfig: InputDataConfig | undefined;
1455
- /**
1456
- * <p>Specifies where to send the output files.</p>
1457
- */
822
+
1458
823
  OutputDataConfig: OutputDataConfig | undefined;
1459
- /**
1460
- * <p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that
1461
- * grants Amazon Comprehend Medical read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med"> Role-Based Permissions Required for Asynchronous Operations</a>.</p>
1462
- */
824
+
1463
825
  DataAccessRoleArn: string | undefined;
1464
- /**
1465
- * <p>The identifier of the job.</p>
1466
- */
826
+
1467
827
  JobName?: string;
1468
- /**
1469
- * <p>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical
1470
- * generates one.</p>
1471
- */
828
+
1472
829
  ClientRequestToken?: string;
1473
- /**
1474
- * <p>An AWS Key Management Service key to encrypt your output files. If you do not specify a
1475
- * key, the files are written in plain text.</p>
1476
- */
830
+
1477
831
  KMSKey?: string;
1478
- /**
1479
- * <p>The language of the input documents. All documents must be in the same language.</p>
1480
- */
832
+
1481
833
  LanguageCode: LanguageCode | string | undefined;
1482
834
  }
1483
835
  export declare namespace StartPHIDetectionJobRequest {
1484
- /**
1485
- * @internal
1486
- */
836
+
1487
837
  const filterSensitiveLog: (obj: StartPHIDetectionJobRequest) => any;
1488
838
  }
1489
839
  export interface StartPHIDetectionJobResponse {
1490
- /**
1491
- * <p>The identifier generated for the job. To get the status of a job, use this identifier with
1492
- * the <code>DescribePHIDetectionJob</code> operation.</p>
1493
- */
840
+
1494
841
  JobId?: string;
1495
842
  }
1496
843
  export declare namespace StartPHIDetectionJobResponse {
1497
- /**
1498
- * @internal
1499
- */
844
+
1500
845
  const filterSensitiveLog: (obj: StartPHIDetectionJobResponse) => any;
1501
846
  }
1502
847
  export interface StartRxNormInferenceJobRequest {
1503
- /**
1504
- * <p>Specifies the format and location of the input data for the job.</p>
1505
- */
848
+
1506
849
  InputDataConfig: InputDataConfig | undefined;
1507
- /**
1508
- * <p>Specifies where to send the output files.</p>
1509
- */
850
+
1510
851
  OutputDataConfig: OutputDataConfig | undefined;
1511
- /**
1512
- * <p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that
1513
- * grants Amazon Comprehend Medical read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med"> Role-Based Permissions Required for Asynchronous Operations</a>.</p>
1514
- */
852
+
1515
853
  DataAccessRoleArn: string | undefined;
1516
- /**
1517
- * <p>The identifier of the job.</p>
1518
- */
854
+
1519
855
  JobName?: string;
1520
- /**
1521
- * <p>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical
1522
- * generates one.</p>
1523
- */
856
+
1524
857
  ClientRequestToken?: string;
1525
- /**
1526
- * <p>An AWS Key Management Service key to encrypt your output files. If you do not specify a
1527
- * key, the files are written in plain text.</p>
1528
- */
858
+
1529
859
  KMSKey?: string;
1530
- /**
1531
- * <p>The language of the input documents. All documents must be in the same language.</p>
1532
- */
860
+
1533
861
  LanguageCode: LanguageCode | string | undefined;
1534
862
  }
1535
863
  export declare namespace StartRxNormInferenceJobRequest {
1536
- /**
1537
- * @internal
1538
- */
864
+
1539
865
  const filterSensitiveLog: (obj: StartRxNormInferenceJobRequest) => any;
1540
866
  }
1541
867
  export interface StartRxNormInferenceJobResponse {
1542
- /**
1543
- * <p>The identifier of the job.</p>
1544
- */
868
+
1545
869
  JobId?: string;
1546
870
  }
1547
871
  export declare namespace StartRxNormInferenceJobResponse {
1548
- /**
1549
- * @internal
1550
- */
872
+
1551
873
  const filterSensitiveLog: (obj: StartRxNormInferenceJobResponse) => any;
1552
874
  }
1553
875
  export interface StopEntitiesDetectionV2JobRequest {
1554
- /**
1555
- * <p>The identifier of the medical entities job to stop.</p>
1556
- */
876
+
1557
877
  JobId: string | undefined;
1558
878
  }
1559
879
  export declare namespace StopEntitiesDetectionV2JobRequest {
1560
- /**
1561
- * @internal
1562
- */
880
+
1563
881
  const filterSensitiveLog: (obj: StopEntitiesDetectionV2JobRequest) => any;
1564
882
  }
1565
883
  export interface StopEntitiesDetectionV2JobResponse {
1566
- /**
1567
- * <p>The identifier of the medical entities detection job that was stopped.</p>
1568
- */
884
+
1569
885
  JobId?: string;
1570
886
  }
1571
887
  export declare namespace StopEntitiesDetectionV2JobResponse {
1572
- /**
1573
- * @internal
1574
- */
888
+
1575
889
  const filterSensitiveLog: (obj: StopEntitiesDetectionV2JobResponse) => any;
1576
890
  }
1577
891
  export interface StopICD10CMInferenceJobRequest {
1578
- /**
1579
- * <p>The identifier of the job.</p>
1580
- */
892
+
1581
893
  JobId: string | undefined;
1582
894
  }
1583
895
  export declare namespace StopICD10CMInferenceJobRequest {
1584
- /**
1585
- * @internal
1586
- */
896
+
1587
897
  const filterSensitiveLog: (obj: StopICD10CMInferenceJobRequest) => any;
1588
898
  }
1589
899
  export interface StopICD10CMInferenceJobResponse {
1590
- /**
1591
- * <p>The identifier generated for the job. To get the status of job, use this identifier with
1592
- * the <code>DescribeICD10CMInferenceJob</code> operation.</p>
1593
- */
900
+
1594
901
  JobId?: string;
1595
902
  }
1596
903
  export declare namespace StopICD10CMInferenceJobResponse {
1597
- /**
1598
- * @internal
1599
- */
904
+
1600
905
  const filterSensitiveLog: (obj: StopICD10CMInferenceJobResponse) => any;
1601
906
  }
1602
907
  export interface StopPHIDetectionJobRequest {
1603
- /**
1604
- * <p>The identifier of the PHI detection job to stop.</p>
1605
- */
908
+
1606
909
  JobId: string | undefined;
1607
910
  }
1608
911
  export declare namespace StopPHIDetectionJobRequest {
1609
- /**
1610
- * @internal
1611
- */
912
+
1612
913
  const filterSensitiveLog: (obj: StopPHIDetectionJobRequest) => any;
1613
914
  }
1614
915
  export interface StopPHIDetectionJobResponse {
1615
- /**
1616
- * <p>The identifier of the PHI detection job that was stopped.</p>
1617
- */
916
+
1618
917
  JobId?: string;
1619
918
  }
1620
919
  export declare namespace StopPHIDetectionJobResponse {
1621
- /**
1622
- * @internal
1623
- */
920
+
1624
921
  const filterSensitiveLog: (obj: StopPHIDetectionJobResponse) => any;
1625
922
  }
1626
923
  export interface StopRxNormInferenceJobRequest {
1627
- /**
1628
- * <p>The identifier of the job.</p>
1629
- */
924
+
1630
925
  JobId: string | undefined;
1631
926
  }
1632
927
  export declare namespace StopRxNormInferenceJobRequest {
1633
- /**
1634
- * @internal
1635
- */
928
+
1636
929
  const filterSensitiveLog: (obj: StopRxNormInferenceJobRequest) => any;
1637
930
  }
1638
931
  export interface StopRxNormInferenceJobResponse {
1639
- /**
1640
- * <p>The identifier generated for the job. To get the status of job, use this identifier with
1641
- * the <code>DescribeRxNormInferenceJob</code> operation.</p>
1642
- */
932
+
1643
933
  JobId?: string;
1644
934
  }
1645
935
  export declare namespace StopRxNormInferenceJobResponse {
1646
- /**
1647
- * @internal
1648
- */
936
+
1649
937
  const filterSensitiveLog: (obj: StopRxNormInferenceJobResponse) => any;
1650
938
  }