@aws-sdk/client-comprehendmedical 3.296.0 → 3.298.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 (86) hide show
  1. package/dist-cjs/commands/DescribeEntitiesDetectionV2JobCommand.js +2 -3
  2. package/dist-cjs/commands/DescribeICD10CMInferenceJobCommand.js +2 -3
  3. package/dist-cjs/commands/DescribePHIDetectionJobCommand.js +2 -3
  4. package/dist-cjs/commands/DescribeRxNormInferenceJobCommand.js +2 -3
  5. package/dist-cjs/commands/DescribeSNOMEDCTInferenceJobCommand.js +2 -3
  6. package/dist-cjs/commands/DetectEntitiesCommand.js +2 -3
  7. package/dist-cjs/commands/DetectEntitiesV2Command.js +2 -3
  8. package/dist-cjs/commands/DetectPHICommand.js +2 -3
  9. package/dist-cjs/commands/InferICD10CMCommand.js +2 -3
  10. package/dist-cjs/commands/InferRxNormCommand.js +2 -3
  11. package/dist-cjs/commands/InferSNOMEDCTCommand.js +2 -3
  12. package/dist-cjs/commands/ListEntitiesDetectionV2JobsCommand.js +2 -3
  13. package/dist-cjs/commands/ListICD10CMInferenceJobsCommand.js +2 -3
  14. package/dist-cjs/commands/ListPHIDetectionJobsCommand.js +2 -3
  15. package/dist-cjs/commands/ListRxNormInferenceJobsCommand.js +2 -3
  16. package/dist-cjs/commands/ListSNOMEDCTInferenceJobsCommand.js +2 -3
  17. package/dist-cjs/commands/StartEntitiesDetectionV2JobCommand.js +2 -3
  18. package/dist-cjs/commands/StartICD10CMInferenceJobCommand.js +2 -3
  19. package/dist-cjs/commands/StartPHIDetectionJobCommand.js +2 -3
  20. package/dist-cjs/commands/StartRxNormInferenceJobCommand.js +2 -3
  21. package/dist-cjs/commands/StartSNOMEDCTInferenceJobCommand.js +2 -3
  22. package/dist-cjs/commands/StopEntitiesDetectionV2JobCommand.js +2 -3
  23. package/dist-cjs/commands/StopICD10CMInferenceJobCommand.js +2 -3
  24. package/dist-cjs/commands/StopPHIDetectionJobCommand.js +2 -3
  25. package/dist-cjs/commands/StopRxNormInferenceJobCommand.js +2 -3
  26. package/dist-cjs/commands/StopSNOMEDCTInferenceJobCommand.js +2 -3
  27. package/dist-cjs/models/models_0.js +1 -299
  28. package/dist-es/commands/DescribeEntitiesDetectionV2JobCommand.js +2 -3
  29. package/dist-es/commands/DescribeICD10CMInferenceJobCommand.js +2 -3
  30. package/dist-es/commands/DescribePHIDetectionJobCommand.js +2 -3
  31. package/dist-es/commands/DescribeRxNormInferenceJobCommand.js +2 -3
  32. package/dist-es/commands/DescribeSNOMEDCTInferenceJobCommand.js +2 -3
  33. package/dist-es/commands/DetectEntitiesCommand.js +2 -3
  34. package/dist-es/commands/DetectEntitiesV2Command.js +2 -3
  35. package/dist-es/commands/DetectPHICommand.js +2 -3
  36. package/dist-es/commands/InferICD10CMCommand.js +2 -3
  37. package/dist-es/commands/InferRxNormCommand.js +2 -3
  38. package/dist-es/commands/InferSNOMEDCTCommand.js +2 -3
  39. package/dist-es/commands/ListEntitiesDetectionV2JobsCommand.js +2 -3
  40. package/dist-es/commands/ListICD10CMInferenceJobsCommand.js +2 -3
  41. package/dist-es/commands/ListPHIDetectionJobsCommand.js +2 -3
  42. package/dist-es/commands/ListRxNormInferenceJobsCommand.js +2 -3
  43. package/dist-es/commands/ListSNOMEDCTInferenceJobsCommand.js +2 -3
  44. package/dist-es/commands/StartEntitiesDetectionV2JobCommand.js +2 -3
  45. package/dist-es/commands/StartICD10CMInferenceJobCommand.js +2 -3
  46. package/dist-es/commands/StartPHIDetectionJobCommand.js +2 -3
  47. package/dist-es/commands/StartRxNormInferenceJobCommand.js +2 -3
  48. package/dist-es/commands/StartSNOMEDCTInferenceJobCommand.js +2 -3
  49. package/dist-es/commands/StopEntitiesDetectionV2JobCommand.js +2 -3
  50. package/dist-es/commands/StopICD10CMInferenceJobCommand.js +2 -3
  51. package/dist-es/commands/StopPHIDetectionJobCommand.js +2 -3
  52. package/dist-es/commands/StopRxNormInferenceJobCommand.js +2 -3
  53. package/dist-es/commands/StopSNOMEDCTInferenceJobCommand.js +2 -3
  54. package/dist-es/models/models_0.js +0 -222
  55. package/dist-types/ComprehendMedical.d.ts +27 -0
  56. package/dist-types/ComprehendMedicalClient.d.ts +24 -4
  57. package/dist-types/commands/DescribeEntitiesDetectionV2JobCommand.d.ts +16 -0
  58. package/dist-types/commands/DescribeICD10CMInferenceJobCommand.d.ts +16 -0
  59. package/dist-types/commands/DescribePHIDetectionJobCommand.d.ts +16 -0
  60. package/dist-types/commands/DescribeRxNormInferenceJobCommand.d.ts +16 -0
  61. package/dist-types/commands/DescribeSNOMEDCTInferenceJobCommand.d.ts +16 -0
  62. package/dist-types/commands/DetectEntitiesCommand.d.ts +16 -0
  63. package/dist-types/commands/DetectEntitiesV2Command.d.ts +16 -0
  64. package/dist-types/commands/DetectPHICommand.d.ts +16 -0
  65. package/dist-types/commands/InferICD10CMCommand.d.ts +16 -0
  66. package/dist-types/commands/InferRxNormCommand.d.ts +16 -0
  67. package/dist-types/commands/InferSNOMEDCTCommand.d.ts +16 -0
  68. package/dist-types/commands/ListEntitiesDetectionV2JobsCommand.d.ts +16 -0
  69. package/dist-types/commands/ListICD10CMInferenceJobsCommand.d.ts +16 -0
  70. package/dist-types/commands/ListPHIDetectionJobsCommand.d.ts +16 -0
  71. package/dist-types/commands/ListRxNormInferenceJobsCommand.d.ts +16 -0
  72. package/dist-types/commands/ListSNOMEDCTInferenceJobsCommand.d.ts +16 -0
  73. package/dist-types/commands/StartEntitiesDetectionV2JobCommand.d.ts +16 -0
  74. package/dist-types/commands/StartICD10CMInferenceJobCommand.d.ts +16 -0
  75. package/dist-types/commands/StartPHIDetectionJobCommand.d.ts +16 -0
  76. package/dist-types/commands/StartRxNormInferenceJobCommand.d.ts +16 -0
  77. package/dist-types/commands/StartSNOMEDCTInferenceJobCommand.d.ts +16 -0
  78. package/dist-types/commands/StopEntitiesDetectionV2JobCommand.d.ts +16 -0
  79. package/dist-types/commands/StopICD10CMInferenceJobCommand.d.ts +16 -0
  80. package/dist-types/commands/StopPHIDetectionJobCommand.d.ts +16 -0
  81. package/dist-types/commands/StopRxNormInferenceJobCommand.d.ts +16 -0
  82. package/dist-types/commands/StopSNOMEDCTInferenceJobCommand.d.ts +16 -0
  83. package/dist-types/models/ComprehendMedicalServiceException.d.ts +2 -0
  84. package/dist-types/models/models_0.d.ts +246 -296
  85. package/dist-types/ts3.4/models/models_0.d.ts +0 -208
  86. package/package.json +4 -3
@@ -34,15 +34,24 @@ import { StopPHIDetectionJobCommandInput, StopPHIDetectionJobCommandOutput } fro
34
34
  import { StopRxNormInferenceJobCommandInput, StopRxNormInferenceJobCommandOutput } from "./commands/StopRxNormInferenceJobCommand";
35
35
  import { StopSNOMEDCTInferenceJobCommandInput, StopSNOMEDCTInferenceJobCommandOutput } from "./commands/StopSNOMEDCTInferenceJobCommand";
36
36
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
37
+ /**
38
+ * @public
39
+ */
37
40
  export type ServiceInputTypes = DescribeEntitiesDetectionV2JobCommandInput | DescribeICD10CMInferenceJobCommandInput | DescribePHIDetectionJobCommandInput | DescribeRxNormInferenceJobCommandInput | DescribeSNOMEDCTInferenceJobCommandInput | DetectEntitiesCommandInput | DetectEntitiesV2CommandInput | DetectPHICommandInput | InferICD10CMCommandInput | InferRxNormCommandInput | InferSNOMEDCTCommandInput | ListEntitiesDetectionV2JobsCommandInput | ListICD10CMInferenceJobsCommandInput | ListPHIDetectionJobsCommandInput | ListRxNormInferenceJobsCommandInput | ListSNOMEDCTInferenceJobsCommandInput | StartEntitiesDetectionV2JobCommandInput | StartICD10CMInferenceJobCommandInput | StartPHIDetectionJobCommandInput | StartRxNormInferenceJobCommandInput | StartSNOMEDCTInferenceJobCommandInput | StopEntitiesDetectionV2JobCommandInput | StopICD10CMInferenceJobCommandInput | StopPHIDetectionJobCommandInput | StopRxNormInferenceJobCommandInput | StopSNOMEDCTInferenceJobCommandInput;
41
+ /**
42
+ * @public
43
+ */
38
44
  export type ServiceOutputTypes = DescribeEntitiesDetectionV2JobCommandOutput | DescribeICD10CMInferenceJobCommandOutput | DescribePHIDetectionJobCommandOutput | DescribeRxNormInferenceJobCommandOutput | DescribeSNOMEDCTInferenceJobCommandOutput | DetectEntitiesCommandOutput | DetectEntitiesV2CommandOutput | DetectPHICommandOutput | InferICD10CMCommandOutput | InferRxNormCommandOutput | InferSNOMEDCTCommandOutput | ListEntitiesDetectionV2JobsCommandOutput | ListICD10CMInferenceJobsCommandOutput | ListPHIDetectionJobsCommandOutput | ListRxNormInferenceJobsCommandOutput | ListSNOMEDCTInferenceJobsCommandOutput | StartEntitiesDetectionV2JobCommandOutput | StartICD10CMInferenceJobCommandOutput | StartPHIDetectionJobCommandOutput | StartRxNormInferenceJobCommandOutput | StartSNOMEDCTInferenceJobCommandOutput | StopEntitiesDetectionV2JobCommandOutput | StopICD10CMInferenceJobCommandOutput | StopPHIDetectionJobCommandOutput | StopRxNormInferenceJobCommandOutput | StopSNOMEDCTInferenceJobCommandOutput;
45
+ /**
46
+ * @public
47
+ */
39
48
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
40
49
  /**
41
50
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
42
51
  */
43
52
  requestHandler?: __HttpHandler;
44
53
  /**
45
- * A constructor for a class implementing the {@link __Checksum} interface
54
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
46
55
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
47
56
  * @internal
48
57
  */
@@ -132,23 +141,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
132
141
  */
133
142
  logger?: __Logger;
134
143
  /**
135
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
144
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
136
145
  */
137
146
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
138
147
  }
148
+ /**
149
+ * @public
150
+ */
139
151
  type ComprehendMedicalClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
140
152
  /**
141
- * The configuration interface of ComprehendMedicalClient class constructor that set the region, credentials and other options.
153
+ * @public
154
+ *
155
+ * The configuration interface of ComprehendMedicalClient class constructor that set the region, credentials and other options.
142
156
  */
143
157
  export interface ComprehendMedicalClientConfig extends ComprehendMedicalClientConfigType {
144
158
  }
159
+ /**
160
+ * @public
161
+ */
145
162
  type ComprehendMedicalClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
146
163
  /**
147
- * The resolved configuration interface of ComprehendMedicalClient class. This is resolved and normalized from the {@link ComprehendMedicalClientConfig | constructor configuration interface}.
164
+ * @public
165
+ *
166
+ * The resolved configuration interface of ComprehendMedicalClient class. This is resolved and normalized from the {@link ComprehendMedicalClientConfig | constructor configuration interface}.
148
167
  */
149
168
  export interface ComprehendMedicalClientResolvedConfig extends ComprehendMedicalClientResolvedConfigType {
150
169
  }
151
170
  /**
171
+ * @public
152
172
  * <p> Comprehend Medical; extracts structured information from unstructured clinical text. Use these actions
153
173
  * to gain insight in your documents. </p>
154
174
  */
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ComprehendMedicalClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendMedicalClient";
5
5
  import { DescribeEntitiesDetectionV2JobRequest, DescribeEntitiesDetectionV2JobResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeEntitiesDetectionV2JobCommand}.
8
10
  */
9
11
  export interface DescribeEntitiesDetectionV2JobCommandInput extends DescribeEntitiesDetectionV2JobRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeEntitiesDetectionV2JobCommand}.
13
17
  */
14
18
  export interface DescribeEntitiesDetectionV2JobCommandOutput extends DescribeEntitiesDetectionV2JobResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the properties associated with a medical entities detection job. Use this operation
18
23
  * to get the status of a detection job.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DescribeEntitiesDetectionV2JobCommandOutput extends DescribeEnt
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DescribeEntitiesDetectionV2JobCommandInput - {@link DescribeEntitiesDetectionV2JobCommandInput}
35
+ * @returns {@link DescribeEntitiesDetectionV2JobCommandOutput}
29
36
  * @see {@link DescribeEntitiesDetectionV2JobCommandInput} for command's `input` shape.
30
37
  * @see {@link DescribeEntitiesDetectionV2JobCommandOutput} for command's `response` shape.
31
38
  * @see {@link ComprehendMedicalClientResolvedConfig | config} for ComprehendMedicalClient's `config` shape.
@@ -51,11 +58,20 @@ export interface DescribeEntitiesDetectionV2JobCommandOutput extends DescribeEnt
51
58
  export declare class DescribeEntitiesDetectionV2JobCommand extends $Command<DescribeEntitiesDetectionV2JobCommandInput, DescribeEntitiesDetectionV2JobCommandOutput, ComprehendMedicalClientResolvedConfig> {
52
59
  readonly input: DescribeEntitiesDetectionV2JobCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: DescribeEntitiesDetectionV2JobCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendMedicalClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEntitiesDetectionV2JobCommandInput, DescribeEntitiesDetectionV2JobCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ComprehendMedicalClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendMedicalClient";
5
5
  import { DescribeICD10CMInferenceJobRequest, DescribeICD10CMInferenceJobResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeICD10CMInferenceJobCommand}.
8
10
  */
9
11
  export interface DescribeICD10CMInferenceJobCommandInput extends DescribeICD10CMInferenceJobRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeICD10CMInferenceJobCommand}.
13
17
  */
14
18
  export interface DescribeICD10CMInferenceJobCommandOutput extends DescribeICD10CMInferenceJobResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the properties associated with an InferICD10CM job. Use this operation to get the
18
23
  * status of an inference job.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DescribeICD10CMInferenceJobCommandOutput extends DescribeICD10C
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DescribeICD10CMInferenceJobCommandInput - {@link DescribeICD10CMInferenceJobCommandInput}
35
+ * @returns {@link DescribeICD10CMInferenceJobCommandOutput}
29
36
  * @see {@link DescribeICD10CMInferenceJobCommandInput} for command's `input` shape.
30
37
  * @see {@link DescribeICD10CMInferenceJobCommandOutput} for command's `response` shape.
31
38
  * @see {@link ComprehendMedicalClientResolvedConfig | config} for ComprehendMedicalClient's `config` shape.
@@ -51,11 +58,20 @@ export interface DescribeICD10CMInferenceJobCommandOutput extends DescribeICD10C
51
58
  export declare class DescribeICD10CMInferenceJobCommand extends $Command<DescribeICD10CMInferenceJobCommandInput, DescribeICD10CMInferenceJobCommandOutput, ComprehendMedicalClientResolvedConfig> {
52
59
  readonly input: DescribeICD10CMInferenceJobCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: DescribeICD10CMInferenceJobCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendMedicalClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeICD10CMInferenceJobCommandInput, DescribeICD10CMInferenceJobCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ComprehendMedicalClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendMedicalClient";
5
5
  import { DescribePHIDetectionJobRequest, DescribePHIDetectionJobResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribePHIDetectionJobCommand}.
8
10
  */
9
11
  export interface DescribePHIDetectionJobCommandInput extends DescribePHIDetectionJobRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribePHIDetectionJobCommand}.
13
17
  */
14
18
  export interface DescribePHIDetectionJobCommandOutput extends DescribePHIDetectionJobResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the properties associated with a protected health information (PHI) detection job.
18
23
  * Use this operation to get the status of a detection job.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DescribePHIDetectionJobCommandOutput extends DescribePHIDetecti
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DescribePHIDetectionJobCommandInput - {@link DescribePHIDetectionJobCommandInput}
35
+ * @returns {@link DescribePHIDetectionJobCommandOutput}
29
36
  * @see {@link DescribePHIDetectionJobCommandInput} for command's `input` shape.
30
37
  * @see {@link DescribePHIDetectionJobCommandOutput} for command's `response` shape.
31
38
  * @see {@link ComprehendMedicalClientResolvedConfig | config} for ComprehendMedicalClient's `config` shape.
@@ -51,11 +58,20 @@ export interface DescribePHIDetectionJobCommandOutput extends DescribePHIDetecti
51
58
  export declare class DescribePHIDetectionJobCommand extends $Command<DescribePHIDetectionJobCommandInput, DescribePHIDetectionJobCommandOutput, ComprehendMedicalClientResolvedConfig> {
52
59
  readonly input: DescribePHIDetectionJobCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: DescribePHIDetectionJobCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendMedicalClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribePHIDetectionJobCommandInput, DescribePHIDetectionJobCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ComprehendMedicalClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendMedicalClient";
5
5
  import { DescribeRxNormInferenceJobRequest, DescribeRxNormInferenceJobResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeRxNormInferenceJobCommand}.
8
10
  */
9
11
  export interface DescribeRxNormInferenceJobCommandInput extends DescribeRxNormInferenceJobRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeRxNormInferenceJobCommand}.
13
17
  */
14
18
  export interface DescribeRxNormInferenceJobCommandOutput extends DescribeRxNormInferenceJobResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the properties associated with an InferRxNorm job. Use this operation to get the
18
23
  * status of an inference job.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DescribeRxNormInferenceJobCommandOutput extends DescribeRxNormI
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DescribeRxNormInferenceJobCommandInput - {@link DescribeRxNormInferenceJobCommandInput}
35
+ * @returns {@link DescribeRxNormInferenceJobCommandOutput}
29
36
  * @see {@link DescribeRxNormInferenceJobCommandInput} for command's `input` shape.
30
37
  * @see {@link DescribeRxNormInferenceJobCommandOutput} for command's `response` shape.
31
38
  * @see {@link ComprehendMedicalClientResolvedConfig | config} for ComprehendMedicalClient's `config` shape.
@@ -51,11 +58,20 @@ export interface DescribeRxNormInferenceJobCommandOutput extends DescribeRxNormI
51
58
  export declare class DescribeRxNormInferenceJobCommand extends $Command<DescribeRxNormInferenceJobCommandInput, DescribeRxNormInferenceJobCommandOutput, ComprehendMedicalClientResolvedConfig> {
52
59
  readonly input: DescribeRxNormInferenceJobCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: DescribeRxNormInferenceJobCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendMedicalClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeRxNormInferenceJobCommandInput, DescribeRxNormInferenceJobCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ComprehendMedicalClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendMedicalClient";
5
5
  import { DescribeSNOMEDCTInferenceJobRequest, DescribeSNOMEDCTInferenceJobResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeSNOMEDCTInferenceJobCommand}.
8
10
  */
9
11
  export interface DescribeSNOMEDCTInferenceJobCommandInput extends DescribeSNOMEDCTInferenceJobRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeSNOMEDCTInferenceJobCommand}.
13
17
  */
14
18
  export interface DescribeSNOMEDCTInferenceJobCommandOutput extends DescribeSNOMEDCTInferenceJobResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>
18
23
  * Gets the properties associated with an InferSNOMEDCT job. Use this operation to get the status of an inference job.
19
24
  * </p>
@@ -27,6 +32,8 @@ export interface DescribeSNOMEDCTInferenceJobCommandOutput extends DescribeSNOME
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DescribeSNOMEDCTInferenceJobCommandInput - {@link DescribeSNOMEDCTInferenceJobCommandInput}
36
+ * @returns {@link DescribeSNOMEDCTInferenceJobCommandOutput}
30
37
  * @see {@link DescribeSNOMEDCTInferenceJobCommandInput} for command's `input` shape.
31
38
  * @see {@link DescribeSNOMEDCTInferenceJobCommandOutput} for command's `response` shape.
32
39
  * @see {@link ComprehendMedicalClientResolvedConfig | config} for ComprehendMedicalClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DescribeSNOMEDCTInferenceJobCommandOutput extends DescribeSNOME
52
59
  export declare class DescribeSNOMEDCTInferenceJobCommand extends $Command<DescribeSNOMEDCTInferenceJobCommandInput, DescribeSNOMEDCTInferenceJobCommandOutput, ComprehendMedicalClientResolvedConfig> {
53
60
  readonly input: DescribeSNOMEDCTInferenceJobCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DescribeSNOMEDCTInferenceJobCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendMedicalClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeSNOMEDCTInferenceJobCommandInput, DescribeSNOMEDCTInferenceJobCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ComprehendMedicalClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendMedicalClient";
5
5
  import { DetectEntitiesRequest, DetectEntitiesResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DetectEntitiesCommand}.
8
10
  */
9
11
  export interface DetectEntitiesCommandInput extends DetectEntitiesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DetectEntitiesCommand}.
13
17
  */
14
18
  export interface DetectEntitiesCommandOutput extends DetectEntitiesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * @deprecated
18
23
  *
19
24
  * <p>The <code>DetectEntities</code> operation is deprecated. You should use the <a>DetectEntitiesV2</a> operation instead.</p>
@@ -30,6 +35,8 @@ export interface DetectEntitiesCommandOutput extends DetectEntitiesResponse, __M
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param DetectEntitiesCommandInput - {@link DetectEntitiesCommandInput}
39
+ * @returns {@link DetectEntitiesCommandOutput}
33
40
  * @see {@link DetectEntitiesCommandInput} for command's `input` shape.
34
41
  * @see {@link DetectEntitiesCommandOutput} for command's `response` shape.
35
42
  * @see {@link ComprehendMedicalClientResolvedConfig | config} for ComprehendMedicalClient's `config` shape.
@@ -63,11 +70,20 @@ export interface DetectEntitiesCommandOutput extends DetectEntitiesResponse, __M
63
70
  export declare class DetectEntitiesCommand extends $Command<DetectEntitiesCommandInput, DetectEntitiesCommandOutput, ComprehendMedicalClientResolvedConfig> {
64
71
  readonly input: DetectEntitiesCommandInput;
65
72
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
73
+ /**
74
+ * @public
75
+ */
66
76
  constructor(input: DetectEntitiesCommandInput);
67
77
  /**
68
78
  * @internal
69
79
  */
70
80
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendMedicalClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DetectEntitiesCommandInput, DetectEntitiesCommandOutput>;
81
+ /**
82
+ * @internal
83
+ */
71
84
  private serialize;
85
+ /**
86
+ * @internal
87
+ */
72
88
  private deserialize;
73
89
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ComprehendMedicalClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendMedicalClient";
5
5
  import { DetectEntitiesV2Request, DetectEntitiesV2Response } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DetectEntitiesV2Command}.
8
10
  */
9
11
  export interface DetectEntitiesV2CommandInput extends DetectEntitiesV2Request {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DetectEntitiesV2Command}.
13
17
  */
14
18
  export interface DetectEntitiesV2CommandOutput extends DetectEntitiesV2Response, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Inspects the clinical text for a variety of medical entities and returns specific
18
23
  * information about them such as entity category, location, and confidence score on that
19
24
  * information. Amazon Comprehend Medical only detects medical entities in English language
@@ -34,6 +39,8 @@ export interface DetectEntitiesV2CommandOutput extends DetectEntitiesV2Response,
34
39
  * const response = await client.send(command);
35
40
  * ```
36
41
  *
42
+ * @param DetectEntitiesV2CommandInput - {@link DetectEntitiesV2CommandInput}
43
+ * @returns {@link DetectEntitiesV2CommandOutput}
37
44
  * @see {@link DetectEntitiesV2CommandInput} for command's `input` shape.
38
45
  * @see {@link DetectEntitiesV2CommandOutput} for command's `response` shape.
39
46
  * @see {@link ComprehendMedicalClientResolvedConfig | config} for ComprehendMedicalClient's `config` shape.
@@ -67,11 +74,20 @@ export interface DetectEntitiesV2CommandOutput extends DetectEntitiesV2Response,
67
74
  export declare class DetectEntitiesV2Command extends $Command<DetectEntitiesV2CommandInput, DetectEntitiesV2CommandOutput, ComprehendMedicalClientResolvedConfig> {
68
75
  readonly input: DetectEntitiesV2CommandInput;
69
76
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
77
+ /**
78
+ * @public
79
+ */
70
80
  constructor(input: DetectEntitiesV2CommandInput);
71
81
  /**
72
82
  * @internal
73
83
  */
74
84
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendMedicalClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DetectEntitiesV2CommandInput, DetectEntitiesV2CommandOutput>;
85
+ /**
86
+ * @internal
87
+ */
75
88
  private serialize;
89
+ /**
90
+ * @internal
91
+ */
76
92
  private deserialize;
77
93
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ComprehendMedicalClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendMedicalClient";
5
5
  import { DetectPHIRequest, DetectPHIResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DetectPHICommand}.
8
10
  */
9
11
  export interface DetectPHICommandInput extends DetectPHIRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DetectPHICommand}.
13
17
  */
14
18
  export interface DetectPHICommandOutput extends DetectPHIResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p> Inspects the clinical text for protected health information (PHI) entities and returns
18
23
  * the entity category, location, and confidence score for each entity. Amazon Comprehend Medical
19
24
  * only detects entities in English language texts.</p>
@@ -27,6 +32,8 @@ export interface DetectPHICommandOutput extends DetectPHIResponse, __MetadataBea
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DetectPHICommandInput - {@link DetectPHICommandInput}
36
+ * @returns {@link DetectPHICommandOutput}
30
37
  * @see {@link DetectPHICommandInput} for command's `input` shape.
31
38
  * @see {@link DetectPHICommandOutput} for command's `response` shape.
32
39
  * @see {@link ComprehendMedicalClientResolvedConfig | config} for ComprehendMedicalClient's `config` shape.
@@ -60,11 +67,20 @@ export interface DetectPHICommandOutput extends DetectPHIResponse, __MetadataBea
60
67
  export declare class DetectPHICommand extends $Command<DetectPHICommandInput, DetectPHICommandOutput, ComprehendMedicalClientResolvedConfig> {
61
68
  readonly input: DetectPHICommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: DetectPHICommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendMedicalClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DetectPHICommandInput, DetectPHICommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ComprehendMedicalClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendMedicalClient";
5
5
  import { InferICD10CMRequest, InferICD10CMResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link InferICD10CMCommand}.
8
10
  */
9
11
  export interface InferICD10CMCommandInput extends InferICD10CMRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link InferICD10CMCommand}.
13
17
  */
14
18
  export interface InferICD10CMCommandOutput extends InferICD10CMResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>InferICD10CM detects medical conditions as entities listed in a patient record and links
18
23
  * those entities to normalized concept identifiers in the ICD-10-CM knowledge base from the
19
24
  * Centers for Disease Control. Amazon Comprehend Medical only detects medical entities in
@@ -28,6 +33,8 @@ export interface InferICD10CMCommandOutput extends InferICD10CMResponse, __Metad
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param InferICD10CMCommandInput - {@link InferICD10CMCommandInput}
37
+ * @returns {@link InferICD10CMCommandOutput}
31
38
  * @see {@link InferICD10CMCommandInput} for command's `input` shape.
32
39
  * @see {@link InferICD10CMCommandOutput} for command's `response` shape.
33
40
  * @see {@link ComprehendMedicalClientResolvedConfig | config} for ComprehendMedicalClient's `config` shape.
@@ -61,11 +68,20 @@ export interface InferICD10CMCommandOutput extends InferICD10CMResponse, __Metad
61
68
  export declare class InferICD10CMCommand extends $Command<InferICD10CMCommandInput, InferICD10CMCommandOutput, ComprehendMedicalClientResolvedConfig> {
62
69
  readonly input: InferICD10CMCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: InferICD10CMCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendMedicalClientResolvedConfig, options?: __HttpHandlerOptions): Handler<InferICD10CMCommandInput, InferICD10CMCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ComprehendMedicalClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendMedicalClient";
5
5
  import { InferRxNormRequest, InferRxNormResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link InferRxNormCommand}.
8
10
  */
9
11
  export interface InferRxNormCommandInput extends InferRxNormRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link InferRxNormCommand}.
13
17
  */
14
18
  export interface InferRxNormCommandOutput extends InferRxNormResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>InferRxNorm detects medications as entities listed in a patient record and links to the
18
23
  * normalized concept identifiers in the RxNorm database from the National Library of Medicine.
19
24
  * Amazon Comprehend Medical only detects medical entities in English language texts. </p>
@@ -27,6 +32,8 @@ export interface InferRxNormCommandOutput extends InferRxNormResponse, __Metadat
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param InferRxNormCommandInput - {@link InferRxNormCommandInput}
36
+ * @returns {@link InferRxNormCommandOutput}
30
37
  * @see {@link InferRxNormCommandInput} for command's `input` shape.
31
38
  * @see {@link InferRxNormCommandOutput} for command's `response` shape.
32
39
  * @see {@link ComprehendMedicalClientResolvedConfig | config} for ComprehendMedicalClient's `config` shape.
@@ -60,11 +67,20 @@ export interface InferRxNormCommandOutput extends InferRxNormResponse, __Metadat
60
67
  export declare class InferRxNormCommand extends $Command<InferRxNormCommandInput, InferRxNormCommandOutput, ComprehendMedicalClientResolvedConfig> {
61
68
  readonly input: InferRxNormCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: InferRxNormCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendMedicalClientResolvedConfig, options?: __HttpHandlerOptions): Handler<InferRxNormCommandInput, InferRxNormCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ComprehendMedicalClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendMedicalClient";
5
5
  import { InferSNOMEDCTRequest, InferSNOMEDCTResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link InferSNOMEDCTCommand}.
8
10
  */
9
11
  export interface InferSNOMEDCTCommandInput extends InferSNOMEDCTRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link InferSNOMEDCTCommand}.
13
17
  */
14
18
  export interface InferSNOMEDCTCommandOutput extends InferSNOMEDCTResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>
18
23
  * InferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontology</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface InferSNOMEDCTCommandOutput extends InferSNOMEDCTResponse, __Met
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param InferSNOMEDCTCommandInput - {@link InferSNOMEDCTCommandInput}
35
+ * @returns {@link InferSNOMEDCTCommandOutput}
29
36
  * @see {@link InferSNOMEDCTCommandInput} for command's `input` shape.
30
37
  * @see {@link InferSNOMEDCTCommandOutput} for command's `response` shape.
31
38
  * @see {@link ComprehendMedicalClientResolvedConfig | config} for ComprehendMedicalClient's `config` shape.
@@ -59,11 +66,20 @@ export interface InferSNOMEDCTCommandOutput extends InferSNOMEDCTResponse, __Met
59
66
  export declare class InferSNOMEDCTCommand extends $Command<InferSNOMEDCTCommandInput, InferSNOMEDCTCommandOutput, ComprehendMedicalClientResolvedConfig> {
60
67
  readonly input: InferSNOMEDCTCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: InferSNOMEDCTCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendMedicalClientResolvedConfig, options?: __HttpHandlerOptions): Handler<InferSNOMEDCTCommandInput, InferSNOMEDCTCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
67
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
68
84
  private deserialize;
69
85
  }