@aws-sdk/client-network-firewall 3.296.0 → 3.298.0

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateFirewallDescriptionRequest, UpdateFirewallDescriptionResponse } from "../models/models_0";
 import { NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NetworkFirewallClient";
 /**
+ * @public
+ *
  * The input for {@link UpdateFirewallDescriptionCommand}.
  */
 export interface UpdateFirewallDescriptionCommandInput extends UpdateFirewallDescriptionRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateFirewallDescriptionCommand}.
  */
 export interface UpdateFirewallDescriptionCommandOutput extends UpdateFirewallDescriptionResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Modifies the description for the specified firewall. Use the description to help you
  *          identify the firewall when you're working with it. </p>
  * @example
@@ -26,6 +31,8 @@ export interface UpdateFirewallDescriptionCommandOutput extends UpdateFirewallDe
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateFirewallDescriptionCommandInput - {@link UpdateFirewallDescriptionCommandInput}
+ * @returns {@link UpdateFirewallDescriptionCommandOutput}
  * @see {@link UpdateFirewallDescriptionCommandInput} for command's `input` shape.
  * @see {@link UpdateFirewallDescriptionCommandOutput} for command's `response` shape.
  * @see {@link NetworkFirewallClientResolvedConfig | config} for NetworkFirewallClient's `config` shape.
@@ -64,11 +71,20 @@ export interface UpdateFirewallDescriptionCommandOutput extends UpdateFirewallDe
 export declare class UpdateFirewallDescriptionCommand extends $Command<UpdateFirewallDescriptionCommandInput, UpdateFirewallDescriptionCommandOutput, NetworkFirewallClientResolvedConfig> {
     readonly input: UpdateFirewallDescriptionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateFirewallDescriptionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: NetworkFirewallClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateFirewallDescriptionCommandInput, UpdateFirewallDescriptionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateFirewallEncryptionConfigurationRequest, UpdateFirewallEncryptionConfigurationResponse } from "../models/models_0";
 import { NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NetworkFirewallClient";
 /**
+ * @public
+ *
  * The input for {@link UpdateFirewallEncryptionConfigurationCommand}.
  */
 export interface UpdateFirewallEncryptionConfigurationCommandInput extends UpdateFirewallEncryptionConfigurationRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateFirewallEncryptionConfigurationCommand}.
  */
 export interface UpdateFirewallEncryptionConfigurationCommandOutput extends UpdateFirewallEncryptionConfigurationResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>A complex type that contains settings for encryption of your firewall resources.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateFirewallEncryptionConfigurationCommandOutput extends Upda
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateFirewallEncryptionConfigurationCommandInput - {@link UpdateFirewallEncryptionConfigurationCommandInput}
+ * @returns {@link UpdateFirewallEncryptionConfigurationCommandOutput}
  * @see {@link UpdateFirewallEncryptionConfigurationCommandInput} for command's `input` shape.
  * @see {@link UpdateFirewallEncryptionConfigurationCommandOutput} for command's `response` shape.
  * @see {@link NetworkFirewallClientResolvedConfig | config} for NetworkFirewallClient's `config` shape.
@@ -66,11 +73,20 @@ export interface UpdateFirewallEncryptionConfigurationCommandOutput extends Upda
 export declare class UpdateFirewallEncryptionConfigurationCommand extends $Command<UpdateFirewallEncryptionConfigurationCommandInput, UpdateFirewallEncryptionConfigurationCommandOutput, NetworkFirewallClientResolvedConfig> {
     readonly input: UpdateFirewallEncryptionConfigurationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateFirewallEncryptionConfigurationCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: NetworkFirewallClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateFirewallEncryptionConfigurationCommandInput, UpdateFirewallEncryptionConfigurationCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateFirewallPolicyChangeProtectionRequest, UpdateFirewallPolicyChangeProtectionResponse } from "../models/models_0";
 import { NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NetworkFirewallClient";
 /**
+ * @public
+ *
  * The input for {@link UpdateFirewallPolicyChangeProtectionCommand}.
  */
 export interface UpdateFirewallPolicyChangeProtectionCommandInput extends UpdateFirewallPolicyChangeProtectionRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateFirewallPolicyChangeProtectionCommand}.
  */
 export interface UpdateFirewallPolicyChangeProtectionCommandOutput extends UpdateFirewallPolicyChangeProtectionResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Modifies the flag, <code>ChangeProtection</code>, which indicates whether it
  *          is possible to change the firewall. If the flag is set to <code>TRUE</code>, the firewall is protected
  *          from changes. This setting helps protect against accidentally changing a firewall that's in use.</p>
@@ -27,6 +32,8 @@ export interface UpdateFirewallPolicyChangeProtectionCommandOutput extends Updat
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateFirewallPolicyChangeProtectionCommandInput - {@link UpdateFirewallPolicyChangeProtectionCommandInput}
+ * @returns {@link UpdateFirewallPolicyChangeProtectionCommandOutput}
  * @see {@link UpdateFirewallPolicyChangeProtectionCommandInput} for command's `input` shape.
  * @see {@link UpdateFirewallPolicyChangeProtectionCommandOutput} for command's `response` shape.
  * @see {@link NetworkFirewallClientResolvedConfig | config} for NetworkFirewallClient's `config` shape.
@@ -68,11 +75,20 @@ export interface UpdateFirewallPolicyChangeProtectionCommandOutput extends Updat
 export declare class UpdateFirewallPolicyChangeProtectionCommand extends $Command<UpdateFirewallPolicyChangeProtectionCommandInput, UpdateFirewallPolicyChangeProtectionCommandOutput, NetworkFirewallClientResolvedConfig> {
     readonly input: UpdateFirewallPolicyChangeProtectionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateFirewallPolicyChangeProtectionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: NetworkFirewallClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateFirewallPolicyChangeProtectionCommandInput, UpdateFirewallPolicyChangeProtectionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateFirewallPolicyRequest, UpdateFirewallPolicyResponse } from "../models/models_0";
 import { NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NetworkFirewallClient";
 /**
+ * @public
+ *
  * The input for {@link UpdateFirewallPolicyCommand}.
  */
 export interface UpdateFirewallPolicyCommandInput extends UpdateFirewallPolicyRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateFirewallPolicyCommand}.
  */
 export interface UpdateFirewallPolicyCommandOutput extends UpdateFirewallPolicyResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the properties of the specified firewall policy.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateFirewallPolicyCommandOutput extends UpdateFirewallPolicyR
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateFirewallPolicyCommandInput - {@link UpdateFirewallPolicyCommandInput}
+ * @returns {@link UpdateFirewallPolicyCommandOutput}
  * @see {@link UpdateFirewallPolicyCommandInput} for command's `input` shape.
  * @see {@link UpdateFirewallPolicyCommandOutput} for command's `response` shape.
  * @see {@link NetworkFirewallClientResolvedConfig | config} for NetworkFirewallClient's `config` shape.
@@ -63,11 +70,20 @@ export interface UpdateFirewallPolicyCommandOutput extends UpdateFirewallPolicyR
 export declare class UpdateFirewallPolicyCommand extends $Command<UpdateFirewallPolicyCommandInput, UpdateFirewallPolicyCommandOutput, NetworkFirewallClientResolvedConfig> {
     readonly input: UpdateFirewallPolicyCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateFirewallPolicyCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: NetworkFirewallClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateFirewallPolicyCommandInput, UpdateFirewallPolicyCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateLoggingConfigurationRequest, UpdateLoggingConfigurationResponse } from "../models/models_0";
 import { NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NetworkFirewallClient";
 /**
+ * @public
+ *
  * The input for {@link UpdateLoggingConfigurationCommand}.
  */
 export interface UpdateLoggingConfigurationCommandInput extends UpdateLoggingConfigurationRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateLoggingConfigurationCommand}.
  */
 export interface UpdateLoggingConfigurationCommandOutput extends UpdateLoggingConfigurationResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Sets the logging configuration for the specified firewall. </p>
  *          <p>To change the logging configuration, retrieve the <a>LoggingConfiguration</a> by calling <a>DescribeLoggingConfiguration</a>, then change it and provide
  *          the modified object to this update call. You must change the logging configuration one
@@ -50,6 +55,8 @@ export interface UpdateLoggingConfigurationCommandOutput extends UpdateLoggingCo
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateLoggingConfigurationCommandInput - {@link UpdateLoggingConfigurationCommandInput}
+ * @returns {@link UpdateLoggingConfigurationCommandOutput}
  * @see {@link UpdateLoggingConfigurationCommandInput} for command's `input` shape.
  * @see {@link UpdateLoggingConfigurationCommandOutput} for command's `response` shape.
  * @see {@link NetworkFirewallClientResolvedConfig | config} for NetworkFirewallClient's `config` shape.
@@ -91,11 +98,20 @@ export interface UpdateLoggingConfigurationCommandOutput extends UpdateLoggingCo
 export declare class UpdateLoggingConfigurationCommand extends $Command<UpdateLoggingConfigurationCommandInput, UpdateLoggingConfigurationCommandOutput, NetworkFirewallClientResolvedConfig> {
     readonly input: UpdateLoggingConfigurationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateLoggingConfigurationCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: NetworkFirewallClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateLoggingConfigurationCommandInput, UpdateLoggingConfigurationCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateRuleGroupRequest, UpdateRuleGroupResponse } from "../models/models_0";
 import { NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NetworkFirewallClient";
 /**
+ * @public
+ *
  * The input for {@link UpdateRuleGroupCommand}.
  */
 export interface UpdateRuleGroupCommandInput extends UpdateRuleGroupRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateRuleGroupCommand}.
  */
 export interface UpdateRuleGroupCommandOutput extends UpdateRuleGroupResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the rule settings for the specified rule group. You use a rule group by
  *          reference in one or more firewall policies. When you modify a rule group, you modify all
  *          firewall policies that use the rule group. </p>
@@ -30,6 +35,8 @@ export interface UpdateRuleGroupCommandOutput extends UpdateRuleGroupResponse, _
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateRuleGroupCommandInput - {@link UpdateRuleGroupCommandInput}
+ * @returns {@link UpdateRuleGroupCommandOutput}
  * @see {@link UpdateRuleGroupCommandInput} for command's `input` shape.
  * @see {@link UpdateRuleGroupCommandOutput} for command's `response` shape.
  * @see {@link NetworkFirewallClientResolvedConfig | config} for NetworkFirewallClient's `config` shape.
@@ -68,11 +75,20 @@ export interface UpdateRuleGroupCommandOutput extends UpdateRuleGroupResponse, _
 export declare class UpdateRuleGroupCommand extends $Command<UpdateRuleGroupCommandInput, UpdateRuleGroupCommandOutput, NetworkFirewallClientResolvedConfig> {
     readonly input: UpdateRuleGroupCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateRuleGroupCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: NetworkFirewallClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateRuleGroupCommandInput, UpdateRuleGroupCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

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

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