@aws-sdk/client-comprehendmedical 3.295.0 → 3.297.0

package/dist-types/commands/StartRxNormInferenceJobCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ComprehendMedicalClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendMedicalClient";
 import { StartRxNormInferenceJobRequest, StartRxNormInferenceJobResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link StartRxNormInferenceJobCommand}.
  */
 export interface StartRxNormInferenceJobCommandInput extends StartRxNormInferenceJobRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link StartRxNormInferenceJobCommand}.
  */
 export interface StartRxNormInferenceJobCommandOutput extends StartRxNormInferenceJobResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Starts an asynchronous job to detect medication entities and link them to the RxNorm
  *       ontology. Use the <code>DescribeRxNormInferenceJob</code> operation to track the status of a
  *       job.</p>
@@ -27,6 +32,8 @@ export interface StartRxNormInferenceJobCommandOutput extends StartRxNormInferen
  * const response = await client.send(command);
  * ```
  *
+ * @param StartRxNormInferenceJobCommandInput - {@link StartRxNormInferenceJobCommandInput}
+ * @returns {@link StartRxNormInferenceJobCommandOutput}
  * @see {@link StartRxNormInferenceJobCommandInput} for command's `input` shape.
  * @see {@link StartRxNormInferenceJobCommandOutput} for command's `response` shape.
  * @see {@link ComprehendMedicalClientResolvedConfig | config} for ComprehendMedicalClient's `config` shape.
@@ -52,11 +59,20 @@ export interface StartRxNormInferenceJobCommandOutput extends StartRxNormInferen
 export declare class StartRxNormInferenceJobCommand extends $Command<StartRxNormInferenceJobCommandInput, StartRxNormInferenceJobCommandOutput, ComprehendMedicalClientResolvedConfig> {
     readonly input: StartRxNormInferenceJobCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StartRxNormInferenceJobCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendMedicalClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartRxNormInferenceJobCommandInput, StartRxNormInferenceJobCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/StartSNOMEDCTInferenceJobCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ComprehendMedicalClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendMedicalClient";
 import { StartSNOMEDCTInferenceJobRequest, StartSNOMEDCTInferenceJobResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link StartSNOMEDCTInferenceJobCommand}.
  */
 export interface StartSNOMEDCTInferenceJobCommandInput extends StartSNOMEDCTInferenceJobRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link StartSNOMEDCTInferenceJobCommand}.
  */
 export interface StartSNOMEDCTInferenceJobCommandOutput extends StartSNOMEDCTInferenceJobResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>
  *       Starts an asynchronous job to detect medical concepts and link them to the SNOMED-CT ontology. Use the DescribeSNOMEDCTInferenceJob operation to track the status of a job.
  *     </p>
@@ -27,6 +32,8 @@ export interface StartSNOMEDCTInferenceJobCommandOutput extends StartSNOMEDCTInf
  * const response = await client.send(command);
  * ```
  *
+ * @param StartSNOMEDCTInferenceJobCommandInput - {@link StartSNOMEDCTInferenceJobCommandInput}
+ * @returns {@link StartSNOMEDCTInferenceJobCommandOutput}
  * @see {@link StartSNOMEDCTInferenceJobCommandInput} for command's `input` shape.
  * @see {@link StartSNOMEDCTInferenceJobCommandOutput} for command's `response` shape.
  * @see {@link ComprehendMedicalClientResolvedConfig | config} for ComprehendMedicalClient's `config` shape.
@@ -52,11 +59,20 @@ export interface StartSNOMEDCTInferenceJobCommandOutput extends StartSNOMEDCTInf
 export declare class StartSNOMEDCTInferenceJobCommand extends $Command<StartSNOMEDCTInferenceJobCommandInput, StartSNOMEDCTInferenceJobCommandOutput, ComprehendMedicalClientResolvedConfig> {
     readonly input: StartSNOMEDCTInferenceJobCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StartSNOMEDCTInferenceJobCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendMedicalClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartSNOMEDCTInferenceJobCommandInput, StartSNOMEDCTInferenceJobCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/StopEntitiesDetectionV2JobCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ComprehendMedicalClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendMedicalClient";
 import { StopEntitiesDetectionV2JobRequest, StopEntitiesDetectionV2JobResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link StopEntitiesDetectionV2JobCommand}.
  */
 export interface StopEntitiesDetectionV2JobCommandInput extends StopEntitiesDetectionV2JobRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link StopEntitiesDetectionV2JobCommand}.
  */
 export interface StopEntitiesDetectionV2JobCommandOutput extends StopEntitiesDetectionV2JobResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Stops a medical entities detection job in progress.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface StopEntitiesDetectionV2JobCommandOutput extends StopEntitiesDet
  * const response = await client.send(command);
  * ```
  *
+ * @param StopEntitiesDetectionV2JobCommandInput - {@link StopEntitiesDetectionV2JobCommandInput}
+ * @returns {@link StopEntitiesDetectionV2JobCommandOutput}
  * @see {@link StopEntitiesDetectionV2JobCommandInput} for command's `input` shape.
  * @see {@link StopEntitiesDetectionV2JobCommandOutput} for command's `response` shape.
  * @see {@link ComprehendMedicalClientResolvedConfig | config} for ComprehendMedicalClient's `config` shape.
@@ -45,11 +52,20 @@ export interface StopEntitiesDetectionV2JobCommandOutput extends StopEntitiesDet
 export declare class StopEntitiesDetectionV2JobCommand extends $Command<StopEntitiesDetectionV2JobCommandInput, StopEntitiesDetectionV2JobCommandOutput, ComprehendMedicalClientResolvedConfig> {
     readonly input: StopEntitiesDetectionV2JobCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StopEntitiesDetectionV2JobCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendMedicalClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopEntitiesDetectionV2JobCommandInput, StopEntitiesDetectionV2JobCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/StopICD10CMInferenceJobCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ComprehendMedicalClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendMedicalClient";
 import { StopICD10CMInferenceJobRequest, StopICD10CMInferenceJobResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link StopICD10CMInferenceJobCommand}.
  */
 export interface StopICD10CMInferenceJobCommandInput extends StopICD10CMInferenceJobRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link StopICD10CMInferenceJobCommand}.
  */
 export interface StopICD10CMInferenceJobCommandOutput extends StopICD10CMInferenceJobResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Stops an InferICD10CM inference job in progress.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface StopICD10CMInferenceJobCommandOutput extends StopICD10CMInferen
  * const response = await client.send(command);
  * ```
  *
+ * @param StopICD10CMInferenceJobCommandInput - {@link StopICD10CMInferenceJobCommandInput}
+ * @returns {@link StopICD10CMInferenceJobCommandOutput}
  * @see {@link StopICD10CMInferenceJobCommandInput} for command's `input` shape.
  * @see {@link StopICD10CMInferenceJobCommandOutput} for command's `response` shape.
  * @see {@link ComprehendMedicalClientResolvedConfig | config} for ComprehendMedicalClient's `config` shape.
@@ -45,11 +52,20 @@ export interface StopICD10CMInferenceJobCommandOutput extends StopICD10CMInferen
 export declare class StopICD10CMInferenceJobCommand extends $Command<StopICD10CMInferenceJobCommandInput, StopICD10CMInferenceJobCommandOutput, ComprehendMedicalClientResolvedConfig> {
     readonly input: StopICD10CMInferenceJobCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StopICD10CMInferenceJobCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendMedicalClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopICD10CMInferenceJobCommandInput, StopICD10CMInferenceJobCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/StopPHIDetectionJobCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ComprehendMedicalClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendMedicalClient";
 import { StopPHIDetectionJobRequest, StopPHIDetectionJobResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link StopPHIDetectionJobCommand}.
  */
 export interface StopPHIDetectionJobCommandInput extends StopPHIDetectionJobRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link StopPHIDetectionJobCommand}.
  */
 export interface StopPHIDetectionJobCommandOutput extends StopPHIDetectionJobResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Stops a protected health information (PHI) detection job in progress.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface StopPHIDetectionJobCommandOutput extends StopPHIDetectionJobRes
  * const response = await client.send(command);
  * ```
  *
+ * @param StopPHIDetectionJobCommandInput - {@link StopPHIDetectionJobCommandInput}
+ * @returns {@link StopPHIDetectionJobCommandOutput}
  * @see {@link StopPHIDetectionJobCommandInput} for command's `input` shape.
  * @see {@link StopPHIDetectionJobCommandOutput} for command's `response` shape.
  * @see {@link ComprehendMedicalClientResolvedConfig | config} for ComprehendMedicalClient's `config` shape.
@@ -45,11 +52,20 @@ export interface StopPHIDetectionJobCommandOutput extends StopPHIDetectionJobRes
 export declare class StopPHIDetectionJobCommand extends $Command<StopPHIDetectionJobCommandInput, StopPHIDetectionJobCommandOutput, ComprehendMedicalClientResolvedConfig> {
     readonly input: StopPHIDetectionJobCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StopPHIDetectionJobCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendMedicalClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopPHIDetectionJobCommandInput, StopPHIDetectionJobCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/StopRxNormInferenceJobCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ComprehendMedicalClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendMedicalClient";
 import { StopRxNormInferenceJobRequest, StopRxNormInferenceJobResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link StopRxNormInferenceJobCommand}.
  */
 export interface StopRxNormInferenceJobCommandInput extends StopRxNormInferenceJobRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link StopRxNormInferenceJobCommand}.
  */
 export interface StopRxNormInferenceJobCommandOutput extends StopRxNormInferenceJobResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Stops an InferRxNorm inference job in progress.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface StopRxNormInferenceJobCommandOutput extends StopRxNormInference
  * const response = await client.send(command);
  * ```
  *
+ * @param StopRxNormInferenceJobCommandInput - {@link StopRxNormInferenceJobCommandInput}
+ * @returns {@link StopRxNormInferenceJobCommandOutput}
  * @see {@link StopRxNormInferenceJobCommandInput} for command's `input` shape.
  * @see {@link StopRxNormInferenceJobCommandOutput} for command's `response` shape.
  * @see {@link ComprehendMedicalClientResolvedConfig | config} for ComprehendMedicalClient's `config` shape.
@@ -45,11 +52,20 @@ export interface StopRxNormInferenceJobCommandOutput extends StopRxNormInference
 export declare class StopRxNormInferenceJobCommand extends $Command<StopRxNormInferenceJobCommandInput, StopRxNormInferenceJobCommandOutput, ComprehendMedicalClientResolvedConfig> {
     readonly input: StopRxNormInferenceJobCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StopRxNormInferenceJobCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendMedicalClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopRxNormInferenceJobCommandInput, StopRxNormInferenceJobCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/StopSNOMEDCTInferenceJobCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ComprehendMedicalClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendMedicalClient";
 import { StopSNOMEDCTInferenceJobRequest, StopSNOMEDCTInferenceJobResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link StopSNOMEDCTInferenceJobCommand}.
  */
 export interface StopSNOMEDCTInferenceJobCommandInput extends StopSNOMEDCTInferenceJobRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link StopSNOMEDCTInferenceJobCommand}.
  */
 export interface StopSNOMEDCTInferenceJobCommandOutput extends StopSNOMEDCTInferenceJobResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>
  *       Stops an InferSNOMEDCT inference job in progress.
  *     </p>
@@ -27,6 +32,8 @@ export interface StopSNOMEDCTInferenceJobCommandOutput extends StopSNOMEDCTInfer
  * const response = await client.send(command);
  * ```
  *
+ * @param StopSNOMEDCTInferenceJobCommandInput - {@link StopSNOMEDCTInferenceJobCommandInput}
+ * @returns {@link StopSNOMEDCTInferenceJobCommandOutput}
  * @see {@link StopSNOMEDCTInferenceJobCommandInput} for command's `input` shape.
  * @see {@link StopSNOMEDCTInferenceJobCommandOutput} for command's `response` shape.
  * @see {@link ComprehendMedicalClientResolvedConfig | config} for ComprehendMedicalClient's `config` shape.
@@ -52,11 +59,20 @@ export interface StopSNOMEDCTInferenceJobCommandOutput extends StopSNOMEDCTInfer
 export declare class StopSNOMEDCTInferenceJobCommand extends $Command<StopSNOMEDCTInferenceJobCommandInput, StopSNOMEDCTInferenceJobCommandOutput, ComprehendMedicalClientResolvedConfig> {
     readonly input: StopSNOMEDCTInferenceJobCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StopSNOMEDCTInferenceJobCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendMedicalClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopSNOMEDCTInferenceJobCommandInput, StopSNOMEDCTInferenceJobCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/ComprehendMedicalServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from ComprehendMedical service.
  */
 export declare class ComprehendMedicalServiceException extends __ServiceException {