@aws-sdk/client-inspector 3.296.0 → 3.297.0

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { InspectorClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InspectorClient";
 import { SetTagsForResourceRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link SetTagsForResourceCommand}.
  */
 export interface SetTagsForResourceCommandInput extends SetTagsForResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link SetTagsForResourceCommand}.
  */
 export interface SetTagsForResourceCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Sets tags (key and value pairs) to the assessment template that is specified by the
  *          ARN of the assessment template.</p>
  * @example
@@ -26,6 +31,8 @@ export interface SetTagsForResourceCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param SetTagsForResourceCommandInput - {@link SetTagsForResourceCommandInput}
+ * @returns {@link SetTagsForResourceCommandOutput}
  * @see {@link SetTagsForResourceCommandInput} for command's `input` shape.
  * @see {@link SetTagsForResourceCommandOutput} for command's `response` shape.
  * @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
@@ -69,11 +76,20 @@ export interface SetTagsForResourceCommandOutput extends __MetadataBearer {
 export declare class SetTagsForResourceCommand extends $Command<SetTagsForResourceCommandInput, SetTagsForResourceCommandOutput, InspectorClientResolvedConfig> {
     readonly input: SetTagsForResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: SetTagsForResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: InspectorClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SetTagsForResourceCommandInput, SetTagsForResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { InspectorClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InspectorClient";
 import { StartAssessmentRunRequest, StartAssessmentRunResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link StartAssessmentRunCommand}.
  */
 export interface StartAssessmentRunCommandInput extends StartAssessmentRunRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link StartAssessmentRunCommand}.
  */
 export interface StartAssessmentRunCommandOutput extends StartAssessmentRunResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Starts the assessment run specified by the ARN of the assessment template. For this
  *          API to function properly, you must not exceed the limit of running up to 500 concurrent
  *          agents per AWS account.</p>
@@ -27,6 +32,8 @@ export interface StartAssessmentRunCommandOutput extends StartAssessmentRunRespo
  * const response = await client.send(command);
  * ```
  *
+ * @param StartAssessmentRunCommandInput - {@link StartAssessmentRunCommandInput}
+ * @returns {@link StartAssessmentRunCommandOutput}
  * @see {@link StartAssessmentRunCommandInput} for command's `input` shape.
  * @see {@link StartAssessmentRunCommandOutput} for command's `response` shape.
  * @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
@@ -82,11 +89,20 @@ export interface StartAssessmentRunCommandOutput extends StartAssessmentRunRespo
 export declare class StartAssessmentRunCommand extends $Command<StartAssessmentRunCommandInput, StartAssessmentRunCommandOutput, InspectorClientResolvedConfig> {
     readonly input: StartAssessmentRunCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StartAssessmentRunCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: InspectorClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartAssessmentRunCommandInput, StartAssessmentRunCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { InspectorClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InspectorClient";
 import { StopAssessmentRunRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link StopAssessmentRunCommand}.
  */
 export interface StopAssessmentRunCommandInput extends StopAssessmentRunRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link StopAssessmentRunCommand}.
  */
 export interface StopAssessmentRunCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Stops the assessment run that is specified by the ARN of the assessment
  *          run.</p>
  * @example
@@ -26,6 +31,8 @@ export interface StopAssessmentRunCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param StopAssessmentRunCommandInput - {@link StopAssessmentRunCommandInput}
+ * @returns {@link StopAssessmentRunCommandOutput}
  * @see {@link StopAssessmentRunCommandInput} for command's `input` shape.
  * @see {@link StopAssessmentRunCommandOutput} for command's `response` shape.
  * @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
@@ -63,11 +70,20 @@ export interface StopAssessmentRunCommandOutput extends __MetadataBearer {
 export declare class StopAssessmentRunCommand extends $Command<StopAssessmentRunCommandInput, StopAssessmentRunCommandOutput, InspectorClientResolvedConfig> {
     readonly input: StopAssessmentRunCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StopAssessmentRunCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: InspectorClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopAssessmentRunCommandInput, StopAssessmentRunCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { InspectorClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InspectorClient";
 import { SubscribeToEventRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link SubscribeToEventCommand}.
  */
 export interface SubscribeToEventCommandInput extends SubscribeToEventRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link SubscribeToEventCommand}.
  */
 export interface SubscribeToEventCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Enables the process of sending Amazon Simple Notification Service (SNS) notifications
  *          about a specified event to a specified SNS topic.</p>
  * @example
@@ -26,6 +31,8 @@ export interface SubscribeToEventCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param SubscribeToEventCommandInput - {@link SubscribeToEventCommandInput}
+ * @returns {@link SubscribeToEventCommandOutput}
  * @see {@link SubscribeToEventCommandInput} for command's `input` shape.
  * @see {@link SubscribeToEventCommandOutput} for command's `response` shape.
  * @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
@@ -69,11 +76,20 @@ export interface SubscribeToEventCommandOutput extends __MetadataBearer {
 export declare class SubscribeToEventCommand extends $Command<SubscribeToEventCommandInput, SubscribeToEventCommandOutput, InspectorClientResolvedConfig> {
     readonly input: SubscribeToEventCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: SubscribeToEventCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: InspectorClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SubscribeToEventCommandInput, SubscribeToEventCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { InspectorClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InspectorClient";
 import { UnsubscribeFromEventRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UnsubscribeFromEventCommand}.
  */
 export interface UnsubscribeFromEventCommandInput extends UnsubscribeFromEventRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UnsubscribeFromEventCommand}.
  */
 export interface UnsubscribeFromEventCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Disables the process of sending Amazon Simple Notification Service (SNS)
  *          notifications about a specified event to a specified SNS topic.</p>
  * @example
@@ -26,6 +31,8 @@ export interface UnsubscribeFromEventCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param UnsubscribeFromEventCommandInput - {@link UnsubscribeFromEventCommandInput}
+ * @returns {@link UnsubscribeFromEventCommandOutput}
  * @see {@link UnsubscribeFromEventCommandInput} for command's `input` shape.
  * @see {@link UnsubscribeFromEventCommandOutput} for command's `response` shape.
  * @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
@@ -65,11 +72,20 @@ export interface UnsubscribeFromEventCommandOutput extends __MetadataBearer {
 export declare class UnsubscribeFromEventCommand extends $Command<UnsubscribeFromEventCommandInput, UnsubscribeFromEventCommandOutput, InspectorClientResolvedConfig> {
     readonly input: UnsubscribeFromEventCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UnsubscribeFromEventCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: InspectorClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UnsubscribeFromEventCommandInput, UnsubscribeFromEventCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { InspectorClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InspectorClient";
 import { UpdateAssessmentTargetRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateAssessmentTargetCommand}.
  */
 export interface UpdateAssessmentTargetCommandInput extends UpdateAssessmentTargetRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateAssessmentTargetCommand}.
  */
 export interface UpdateAssessmentTargetCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the assessment target that is specified by the ARN of the assessment
  *          target.</p>
  *          <p>If resourceGroupArn is not specified, all EC2 instances in the current AWS account
@@ -28,6 +33,8 @@ export interface UpdateAssessmentTargetCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateAssessmentTargetCommandInput - {@link UpdateAssessmentTargetCommandInput}
+ * @returns {@link UpdateAssessmentTargetCommandOutput}
  * @see {@link UpdateAssessmentTargetCommandInput} for command's `input` shape.
  * @see {@link UpdateAssessmentTargetCommandOutput} for command's `response` shape.
  * @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
@@ -67,11 +74,20 @@ export interface UpdateAssessmentTargetCommandOutput extends __MetadataBearer {
 export declare class UpdateAssessmentTargetCommand extends $Command<UpdateAssessmentTargetCommandInput, UpdateAssessmentTargetCommandOutput, InspectorClientResolvedConfig> {
     readonly input: UpdateAssessmentTargetCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateAssessmentTargetCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: InspectorClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateAssessmentTargetCommandInput, UpdateAssessmentTargetCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/InspectorServiceException.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 Inspector service.
  */
 export declare class InspectorServiceException extends __ServiceException {