@aws-sdk/client-fms 3.295.0 → 3.297.0

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { FMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FMSClient";
 import { PutAppsListRequest, PutAppsListResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link PutAppsListCommand}.
  */
 export interface PutAppsListCommandInput extends PutAppsListRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link PutAppsListCommand}.
  */
 export interface PutAppsListCommandOutput extends PutAppsListResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates an Firewall Manager applications list.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface PutAppsListCommandOutput extends PutAppsListResponse, __Metadat
  * const response = await client.send(command);
  * ```
  *
+ * @param PutAppsListCommandInput - {@link PutAppsListCommandInput}
+ * @returns {@link PutAppsListCommandOutput}
  * @see {@link PutAppsListCommandInput} for command's `input` shape.
  * @see {@link PutAppsListCommandOutput} for command's `response` shape.
  * @see {@link FMSClientResolvedConfig | config} for FMSClient's `config` shape.
@@ -57,11 +64,20 @@ export interface PutAppsListCommandOutput extends PutAppsListResponse, __Metadat
 export declare class PutAppsListCommand extends $Command<PutAppsListCommandInput, PutAppsListCommandOutput, FMSClientResolvedConfig> {
     readonly input: PutAppsListCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PutAppsListCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutAppsListCommandInput, PutAppsListCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { FMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FMSClient";
 import { PutNotificationChannelRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link PutNotificationChannelCommand}.
  */
 export interface PutNotificationChannelCommandInput extends PutNotificationChannelRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link PutNotificationChannelCommand}.
  */
 export interface PutNotificationChannelCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Designates the IAM role and Amazon Simple Notification Service (SNS) topic that
  *       Firewall Manager uses to record SNS logs.</p>
  *          <p>To perform this action outside of the console, you must configure the SNS topic to allow the Firewall Manager
@@ -29,6 +34,8 @@ export interface PutNotificationChannelCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param PutNotificationChannelCommandInput - {@link PutNotificationChannelCommandInput}
+ * @returns {@link PutNotificationChannelCommandOutput}
  * @see {@link PutNotificationChannelCommandInput} for command's `input` shape.
  * @see {@link PutNotificationChannelCommandOutput} for command's `response` shape.
  * @see {@link FMSClientResolvedConfig | config} for FMSClient's `config` shape.
@@ -52,11 +59,20 @@ export interface PutNotificationChannelCommandOutput extends __MetadataBearer {
 export declare class PutNotificationChannelCommand extends $Command<PutNotificationChannelCommandInput, PutNotificationChannelCommandOutput, FMSClientResolvedConfig> {
     readonly input: PutNotificationChannelCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PutNotificationChannelCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutNotificationChannelCommandInput, PutNotificationChannelCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { FMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FMSClient";
 import { PutPolicyRequest, PutPolicyResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link PutPolicyCommand}.
  */
 export interface PutPolicyCommandInput extends PutPolicyRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link PutPolicyCommand}.
  */
 export interface PutPolicyCommandOutput extends PutPolicyResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates an Firewall Manager policy.</p>
  *          <p>Firewall Manager provides the following types of policies: </p>
  *          <ul>
@@ -57,6 +62,8 @@ export interface PutPolicyCommandOutput extends PutPolicyResponse, __MetadataBea
  * const response = await client.send(command);
  * ```
  *
+ * @param PutPolicyCommandInput - {@link PutPolicyCommandInput}
+ * @returns {@link PutPolicyCommandOutput}
  * @see {@link PutPolicyCommandInput} for command's `input` shape.
  * @see {@link PutPolicyCommandOutput} for command's `response` shape.
  * @see {@link FMSClientResolvedConfig | config} for FMSClient's `config` shape.
@@ -92,11 +99,20 @@ export interface PutPolicyCommandOutput extends PutPolicyResponse, __MetadataBea
 export declare class PutPolicyCommand extends $Command<PutPolicyCommandInput, PutPolicyCommandOutput, FMSClientResolvedConfig> {
     readonly input: PutPolicyCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PutPolicyCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutPolicyCommandInput, PutPolicyCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { FMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FMSClient";
 import { PutProtocolsListRequest, PutProtocolsListResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link PutProtocolsListCommand}.
  */
 export interface PutProtocolsListCommandInput extends PutProtocolsListRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link PutProtocolsListCommand}.
  */
 export interface PutProtocolsListCommandOutput extends PutProtocolsListResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates an Firewall Manager protocols list.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface PutProtocolsListCommandOutput extends PutProtocolsListResponse,
  * const response = await client.send(command);
  * ```
  *
+ * @param PutProtocolsListCommandInput - {@link PutProtocolsListCommandInput}
+ * @returns {@link PutProtocolsListCommandOutput}
  * @see {@link PutProtocolsListCommandInput} for command's `input` shape.
  * @see {@link PutProtocolsListCommandOutput} for command's `response` shape.
  * @see {@link FMSClientResolvedConfig | config} for FMSClient's `config` shape.
@@ -57,11 +64,20 @@ export interface PutProtocolsListCommandOutput extends PutProtocolsListResponse,
 export declare class PutProtocolsListCommand extends $Command<PutProtocolsListCommandInput, PutProtocolsListCommandOutput, FMSClientResolvedConfig> {
     readonly input: PutProtocolsListCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PutProtocolsListCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutProtocolsListCommandInput, PutProtocolsListCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { FMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FMSClient";
 import { PutResourceSetRequest, PutResourceSetResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link PutResourceSetCommand}.
  */
 export interface PutResourceSetCommandInput extends PutResourceSetRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link PutResourceSetCommand}.
  */
 export interface PutResourceSetCommandOutput extends PutResourceSetResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates the resource set.</p>
  *          <p>An Firewall Manager resource set defines the resources to import into an Firewall Manager policy from another Amazon Web Services service.</p>
  * @example
@@ -26,6 +31,8 @@ export interface PutResourceSetCommandOutput extends PutResourceSetResponse, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param PutResourceSetCommandInput - {@link PutResourceSetCommandInput}
+ * @returns {@link PutResourceSetCommandOutput}
  * @see {@link PutResourceSetCommandInput} for command's `input` shape.
  * @see {@link PutResourceSetCommandOutput} for command's `response` shape.
  * @see {@link FMSClientResolvedConfig | config} for FMSClient's `config` shape.
@@ -55,11 +62,20 @@ export interface PutResourceSetCommandOutput extends PutResourceSetResponse, __M
 export declare class PutResourceSetCommand extends $Command<PutResourceSetCommandInput, PutResourceSetCommandOutput, FMSClientResolvedConfig> {
     readonly input: PutResourceSetCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PutResourceSetCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutResourceSetCommandInput, PutResourceSetCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { FMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FMSClient";
 import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link TagResourceCommand}.
  */
 export interface TagResourceCommandInput extends TagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link TagResourceCommand}.
  */
 export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Adds one or more tags to an Amazon Web Services resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  * const response = await client.send(command);
  * ```
  *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
  * @see {@link TagResourceCommandInput} for command's `input` shape.
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
  * @see {@link FMSClientResolvedConfig | config} for FMSClient's `config` shape.
@@ -57,11 +64,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, FMSClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { FMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FMSClient";
 import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandInput extends UntagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Removes one or more tags from an Amazon Web Services resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
  * @see {@link FMSClientResolvedConfig | config} for FMSClient's `config` shape.
@@ -51,11 +58,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, FMSClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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