@aws-sdk/client-comprehendmedical 3.296.0 → 3.297.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 (31) hide show
  1. package/dist-types/ComprehendMedical.d.ts +27 -0
  2. package/dist-types/ComprehendMedicalClient.d.ts +24 -4
  3. package/dist-types/commands/DescribeEntitiesDetectionV2JobCommand.d.ts +16 -0
  4. package/dist-types/commands/DescribeICD10CMInferenceJobCommand.d.ts +16 -0
  5. package/dist-types/commands/DescribePHIDetectionJobCommand.d.ts +16 -0
  6. package/dist-types/commands/DescribeRxNormInferenceJobCommand.d.ts +16 -0
  7. package/dist-types/commands/DescribeSNOMEDCTInferenceJobCommand.d.ts +16 -0
  8. package/dist-types/commands/DetectEntitiesCommand.d.ts +16 -0
  9. package/dist-types/commands/DetectEntitiesV2Command.d.ts +16 -0
  10. package/dist-types/commands/DetectPHICommand.d.ts +16 -0
  11. package/dist-types/commands/InferICD10CMCommand.d.ts +16 -0
  12. package/dist-types/commands/InferRxNormCommand.d.ts +16 -0
  13. package/dist-types/commands/InferSNOMEDCTCommand.d.ts +16 -0
  14. package/dist-types/commands/ListEntitiesDetectionV2JobsCommand.d.ts +16 -0
  15. package/dist-types/commands/ListICD10CMInferenceJobsCommand.d.ts +16 -0
  16. package/dist-types/commands/ListPHIDetectionJobsCommand.d.ts +16 -0
  17. package/dist-types/commands/ListRxNormInferenceJobsCommand.d.ts +16 -0
  18. package/dist-types/commands/ListSNOMEDCTInferenceJobsCommand.d.ts +16 -0
  19. package/dist-types/commands/StartEntitiesDetectionV2JobCommand.d.ts +16 -0
  20. package/dist-types/commands/StartICD10CMInferenceJobCommand.d.ts +16 -0
  21. package/dist-types/commands/StartPHIDetectionJobCommand.d.ts +16 -0
  22. package/dist-types/commands/StartRxNormInferenceJobCommand.d.ts +16 -0
  23. package/dist-types/commands/StartSNOMEDCTInferenceJobCommand.d.ts +16 -0
  24. package/dist-types/commands/StopEntitiesDetectionV2JobCommand.d.ts +16 -0
  25. package/dist-types/commands/StopICD10CMInferenceJobCommand.d.ts +16 -0
  26. package/dist-types/commands/StopPHIDetectionJobCommand.d.ts +16 -0
  27. package/dist-types/commands/StopRxNormInferenceJobCommand.d.ts +16 -0
  28. package/dist-types/commands/StopSNOMEDCTInferenceJobCommand.d.ts +16 -0
  29. package/dist-types/models/ComprehendMedicalServiceException.d.ts +2 -0
  30. package/dist-types/models/models_0.d.ts +246 -0
  31. package/package.json +3 -3
@@ -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
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ComprehendMedicalClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendMedicalClient";
5
5
  import { ListEntitiesDetectionV2JobsRequest, ListEntitiesDetectionV2JobsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListEntitiesDetectionV2JobsCommand}.
8
10
  */
9
11
  export interface ListEntitiesDetectionV2JobsCommandInput extends ListEntitiesDetectionV2JobsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListEntitiesDetectionV2JobsCommand}.
13
17
  */
14
18
  export interface ListEntitiesDetectionV2JobsCommandOutput extends ListEntitiesDetectionV2JobsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets a list of medical entity detection jobs that you have submitted.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListEntitiesDetectionV2JobsCommandOutput extends ListEntitiesDe
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListEntitiesDetectionV2JobsCommandInput - {@link ListEntitiesDetectionV2JobsCommandInput}
34
+ * @returns {@link ListEntitiesDetectionV2JobsCommandOutput}
28
35
  * @see {@link ListEntitiesDetectionV2JobsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListEntitiesDetectionV2JobsCommandOutput} for command's `response` shape.
30
37
  * @see {@link ComprehendMedicalClientResolvedConfig | config} for ComprehendMedicalClient's `config` shape.
@@ -50,11 +57,20 @@ export interface ListEntitiesDetectionV2JobsCommandOutput extends ListEntitiesDe
50
57
  export declare class ListEntitiesDetectionV2JobsCommand extends $Command<ListEntitiesDetectionV2JobsCommandInput, ListEntitiesDetectionV2JobsCommandOutput, ComprehendMedicalClientResolvedConfig> {
51
58
  readonly input: ListEntitiesDetectionV2JobsCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: ListEntitiesDetectionV2JobsCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendMedicalClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListEntitiesDetectionV2JobsCommandInput, ListEntitiesDetectionV2JobsCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ComprehendMedicalClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendMedicalClient";
5
5
  import { ListICD10CMInferenceJobsRequest, ListICD10CMInferenceJobsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListICD10CMInferenceJobsCommand}.
8
10
  */
9
11
  export interface ListICD10CMInferenceJobsCommandInput extends ListICD10CMInferenceJobsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListICD10CMInferenceJobsCommand}.
13
17
  */
14
18
  export interface ListICD10CMInferenceJobsCommandOutput extends ListICD10CMInferenceJobsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets a list of InferICD10CM jobs that you have submitted.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListICD10CMInferenceJobsCommandOutput extends ListICD10CMInfere
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListICD10CMInferenceJobsCommandInput - {@link ListICD10CMInferenceJobsCommandInput}
34
+ * @returns {@link ListICD10CMInferenceJobsCommandOutput}
28
35
  * @see {@link ListICD10CMInferenceJobsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListICD10CMInferenceJobsCommandOutput} for command's `response` shape.
30
37
  * @see {@link ComprehendMedicalClientResolvedConfig | config} for ComprehendMedicalClient's `config` shape.
@@ -50,11 +57,20 @@ export interface ListICD10CMInferenceJobsCommandOutput extends ListICD10CMInfere
50
57
  export declare class ListICD10CMInferenceJobsCommand extends $Command<ListICD10CMInferenceJobsCommandInput, ListICD10CMInferenceJobsCommandOutput, ComprehendMedicalClientResolvedConfig> {
51
58
  readonly input: ListICD10CMInferenceJobsCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: ListICD10CMInferenceJobsCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendMedicalClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListICD10CMInferenceJobsCommandInput, ListICD10CMInferenceJobsCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ComprehendMedicalClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendMedicalClient";
5
5
  import { ListPHIDetectionJobsRequest, ListPHIDetectionJobsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListPHIDetectionJobsCommand}.
8
10
  */
9
11
  export interface ListPHIDetectionJobsCommandInput extends ListPHIDetectionJobsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListPHIDetectionJobsCommand}.
13
17
  */
14
18
  export interface ListPHIDetectionJobsCommandOutput extends ListPHIDetectionJobsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets a list of protected health information (PHI) detection jobs that you have
18
23
  * submitted.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ListPHIDetectionJobsCommandOutput extends ListPHIDetectionJobsR
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ListPHIDetectionJobsCommandInput - {@link ListPHIDetectionJobsCommandInput}
35
+ * @returns {@link ListPHIDetectionJobsCommandOutput}
29
36
  * @see {@link ListPHIDetectionJobsCommandInput} for command's `input` shape.
30
37
  * @see {@link ListPHIDetectionJobsCommandOutput} for command's `response` shape.
31
38
  * @see {@link ComprehendMedicalClientResolvedConfig | config} for ComprehendMedicalClient's `config` shape.
@@ -51,11 +58,20 @@ export interface ListPHIDetectionJobsCommandOutput extends ListPHIDetectionJobsR
51
58
  export declare class ListPHIDetectionJobsCommand extends $Command<ListPHIDetectionJobsCommandInput, ListPHIDetectionJobsCommandOutput, ComprehendMedicalClientResolvedConfig> {
52
59
  readonly input: ListPHIDetectionJobsCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: ListPHIDetectionJobsCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendMedicalClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListPHIDetectionJobsCommandInput, ListPHIDetectionJobsCommandOutput>;
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 { ListRxNormInferenceJobsRequest, ListRxNormInferenceJobsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListRxNormInferenceJobsCommand}.
8
10
  */
9
11
  export interface ListRxNormInferenceJobsCommandInput extends ListRxNormInferenceJobsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListRxNormInferenceJobsCommand}.
13
17
  */
14
18
  export interface ListRxNormInferenceJobsCommandOutput extends ListRxNormInferenceJobsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets a list of InferRxNorm jobs that you have submitted.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListRxNormInferenceJobsCommandOutput extends ListRxNormInferenc
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListRxNormInferenceJobsCommandInput - {@link ListRxNormInferenceJobsCommandInput}
34
+ * @returns {@link ListRxNormInferenceJobsCommandOutput}
28
35
  * @see {@link ListRxNormInferenceJobsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListRxNormInferenceJobsCommandOutput} for command's `response` shape.
30
37
  * @see {@link ComprehendMedicalClientResolvedConfig | config} for ComprehendMedicalClient's `config` shape.
@@ -50,11 +57,20 @@ export interface ListRxNormInferenceJobsCommandOutput extends ListRxNormInferenc
50
57
  export declare class ListRxNormInferenceJobsCommand extends $Command<ListRxNormInferenceJobsCommandInput, ListRxNormInferenceJobsCommandOutput, ComprehendMedicalClientResolvedConfig> {
51
58
  readonly input: ListRxNormInferenceJobsCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: ListRxNormInferenceJobsCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendMedicalClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListRxNormInferenceJobsCommandInput, ListRxNormInferenceJobsCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ComprehendMedicalClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendMedicalClient";
5
5
  import { ListSNOMEDCTInferenceJobsRequest, ListSNOMEDCTInferenceJobsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListSNOMEDCTInferenceJobsCommand}.
8
10
  */
9
11
  export interface ListSNOMEDCTInferenceJobsCommandInput extends ListSNOMEDCTInferenceJobsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListSNOMEDCTInferenceJobsCommand}.
13
17
  */
14
18
  export interface ListSNOMEDCTInferenceJobsCommandOutput extends ListSNOMEDCTInferenceJobsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>
18
23
  * Gets a list of InferSNOMEDCT jobs a user has submitted.
19
24
  * </p>
@@ -27,6 +32,8 @@ export interface ListSNOMEDCTInferenceJobsCommandOutput extends ListSNOMEDCTInfe
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param ListSNOMEDCTInferenceJobsCommandInput - {@link ListSNOMEDCTInferenceJobsCommandInput}
36
+ * @returns {@link ListSNOMEDCTInferenceJobsCommandOutput}
30
37
  * @see {@link ListSNOMEDCTInferenceJobsCommandInput} for command's `input` shape.
31
38
  * @see {@link ListSNOMEDCTInferenceJobsCommandOutput} for command's `response` shape.
32
39
  * @see {@link ComprehendMedicalClientResolvedConfig | config} for ComprehendMedicalClient's `config` shape.
@@ -52,11 +59,20 @@ export interface ListSNOMEDCTInferenceJobsCommandOutput extends ListSNOMEDCTInfe
52
59
  export declare class ListSNOMEDCTInferenceJobsCommand extends $Command<ListSNOMEDCTInferenceJobsCommandInput, ListSNOMEDCTInferenceJobsCommandOutput, ComprehendMedicalClientResolvedConfig> {
53
60
  readonly input: ListSNOMEDCTInferenceJobsCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: ListSNOMEDCTInferenceJobsCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendMedicalClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListSNOMEDCTInferenceJobsCommandInput, ListSNOMEDCTInferenceJobsCommandOutput>;
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 { StartEntitiesDetectionV2JobRequest, StartEntitiesDetectionV2JobResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartEntitiesDetectionV2JobCommand}.
8
10
  */
9
11
  export interface StartEntitiesDetectionV2JobCommandInput extends StartEntitiesDetectionV2JobRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartEntitiesDetectionV2JobCommand}.
13
17
  */
14
18
  export interface StartEntitiesDetectionV2JobCommandOutput extends StartEntitiesDetectionV2JobResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Starts an asynchronous medical entity detection job for a collection of documents. Use the
18
23
  * <code>DescribeEntitiesDetectionV2Job</code> operation to track the status of a job.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface StartEntitiesDetectionV2JobCommandOutput extends StartEntitiesD
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param StartEntitiesDetectionV2JobCommandInput - {@link StartEntitiesDetectionV2JobCommandInput}
35
+ * @returns {@link StartEntitiesDetectionV2JobCommandOutput}
29
36
  * @see {@link StartEntitiesDetectionV2JobCommandInput} for command's `input` shape.
30
37
  * @see {@link StartEntitiesDetectionV2JobCommandOutput} for command's `response` shape.
31
38
  * @see {@link ComprehendMedicalClientResolvedConfig | config} for ComprehendMedicalClient's `config` shape.
@@ -51,11 +58,20 @@ export interface StartEntitiesDetectionV2JobCommandOutput extends StartEntitiesD
51
58
  export declare class StartEntitiesDetectionV2JobCommand extends $Command<StartEntitiesDetectionV2JobCommandInput, StartEntitiesDetectionV2JobCommandOutput, ComprehendMedicalClientResolvedConfig> {
52
59
  readonly input: StartEntitiesDetectionV2JobCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: StartEntitiesDetectionV2JobCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendMedicalClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartEntitiesDetectionV2JobCommandInput, StartEntitiesDetectionV2JobCommandOutput>;
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 { StartICD10CMInferenceJobRequest, StartICD10CMInferenceJobResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartICD10CMInferenceJobCommand}.
8
10
  */
9
11
  export interface StartICD10CMInferenceJobCommandInput extends StartICD10CMInferenceJobRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartICD10CMInferenceJobCommand}.
13
17
  */
14
18
  export interface StartICD10CMInferenceJobCommandOutput extends StartICD10CMInferenceJobResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Starts an asynchronous job to detect medical conditions and link them to the ICD-10-CM
18
23
  * ontology. Use the <code>DescribeICD10CMInferenceJob</code> operation to track the status of a
19
24
  * job.</p>
@@ -27,6 +32,8 @@ export interface StartICD10CMInferenceJobCommandOutput extends StartICD10CMInfer
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param StartICD10CMInferenceJobCommandInput - {@link StartICD10CMInferenceJobCommandInput}
36
+ * @returns {@link StartICD10CMInferenceJobCommandOutput}
30
37
  * @see {@link StartICD10CMInferenceJobCommandInput} for command's `input` shape.
31
38
  * @see {@link StartICD10CMInferenceJobCommandOutput} for command's `response` shape.
32
39
  * @see {@link ComprehendMedicalClientResolvedConfig | config} for ComprehendMedicalClient's `config` shape.
@@ -52,11 +59,20 @@ export interface StartICD10CMInferenceJobCommandOutput extends StartICD10CMInfer
52
59
  export declare class StartICD10CMInferenceJobCommand extends $Command<StartICD10CMInferenceJobCommandInput, StartICD10CMInferenceJobCommandOutput, ComprehendMedicalClientResolvedConfig> {
53
60
  readonly input: StartICD10CMInferenceJobCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: StartICD10CMInferenceJobCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendMedicalClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartICD10CMInferenceJobCommandInput, StartICD10CMInferenceJobCommandOutput>;
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 { StartPHIDetectionJobRequest, StartPHIDetectionJobResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartPHIDetectionJobCommand}.
8
10
  */
9
11
  export interface StartPHIDetectionJobCommandInput extends StartPHIDetectionJobRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartPHIDetectionJobCommand}.
13
17
  */
14
18
  export interface StartPHIDetectionJobCommandOutput extends StartPHIDetectionJobResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Starts an asynchronous job to detect protected health information (PHI). Use the
18
23
  * <code>DescribePHIDetectionJob</code> operation to track the status of a job.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface StartPHIDetectionJobCommandOutput extends StartPHIDetectionJobR
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param StartPHIDetectionJobCommandInput - {@link StartPHIDetectionJobCommandInput}
35
+ * @returns {@link StartPHIDetectionJobCommandOutput}
29
36
  * @see {@link StartPHIDetectionJobCommandInput} for command's `input` shape.
30
37
  * @see {@link StartPHIDetectionJobCommandOutput} for command's `response` shape.
31
38
  * @see {@link ComprehendMedicalClientResolvedConfig | config} for ComprehendMedicalClient's `config` shape.
@@ -51,11 +58,20 @@ export interface StartPHIDetectionJobCommandOutput extends StartPHIDetectionJobR
51
58
  export declare class StartPHIDetectionJobCommand extends $Command<StartPHIDetectionJobCommandInput, StartPHIDetectionJobCommandOutput, ComprehendMedicalClientResolvedConfig> {
52
59
  readonly input: StartPHIDetectionJobCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: StartPHIDetectionJobCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendMedicalClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartPHIDetectionJobCommandInput, StartPHIDetectionJobCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }