@aws-sdk/client-wafv2 3.295.0 → 3.297.0

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { PutManagedRuleSetVersionsRequest, PutManagedRuleSetVersionsResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, WAFV2ClientResolvedConfig } from "../WAFV2Client";
 /**
+ * @public
+ *
  * The input for {@link PutManagedRuleSetVersionsCommand}.
  */
 export interface PutManagedRuleSetVersionsCommandInput extends PutManagedRuleSetVersionsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link PutManagedRuleSetVersionsCommand}.
  */
 export interface PutManagedRuleSetVersionsCommandOutput extends PutManagedRuleSetVersionsResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Defines the versions of your managed rule set that you are offering to the customers.
  *          Customers see your offerings as managed rule groups with versioning.</p>
  *          <note>
@@ -36,6 +41,8 @@ export interface PutManagedRuleSetVersionsCommandOutput extends PutManagedRuleSe
  * const response = await client.send(command);
  * ```
  *
+ * @param PutManagedRuleSetVersionsCommandInput - {@link PutManagedRuleSetVersionsCommandInput}
+ * @returns {@link PutManagedRuleSetVersionsCommandOutput}
  * @see {@link PutManagedRuleSetVersionsCommandInput} for command's `input` shape.
  * @see {@link PutManagedRuleSetVersionsCommandOutput} for command's `response` shape.
  * @see {@link WAFV2ClientResolvedConfig | config} for WAFV2Client's `config` shape.
@@ -84,11 +91,20 @@ export interface PutManagedRuleSetVersionsCommandOutput extends PutManagedRuleSe
 export declare class PutManagedRuleSetVersionsCommand extends $Command<PutManagedRuleSetVersionsCommandInput, PutManagedRuleSetVersionsCommandOutput, WAFV2ClientResolvedConfig> {
     readonly input: PutManagedRuleSetVersionsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PutManagedRuleSetVersionsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutManagedRuleSetVersionsCommandInput, PutManagedRuleSetVersionsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { PutPermissionPolicyRequest, PutPermissionPolicyResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, WAFV2ClientResolvedConfig } from "../WAFV2Client";
 /**
+ * @public
+ *
  * The input for {@link PutPermissionPolicyCommand}.
  */
 export interface PutPermissionPolicyCommandInput extends PutPermissionPolicyRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link PutPermissionPolicyCommand}.
  */
 export interface PutPermissionPolicyCommandOutput extends PutPermissionPolicyResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Attaches an IAM policy to the specified resource. Use this to share a rule group across
  *          accounts.</p>
  *          <p>You must be the owner of the rule group to perform this operation.</p>
@@ -41,6 +46,8 @@ export interface PutPermissionPolicyCommandOutput extends PutPermissionPolicyRes
  * const response = await client.send(command);
  * ```
  *
+ * @param PutPermissionPolicyCommandInput - {@link PutPermissionPolicyCommandInput}
+ * @returns {@link PutPermissionPolicyCommandOutput}
  * @see {@link PutPermissionPolicyCommandInput} for command's `input` shape.
  * @see {@link PutPermissionPolicyCommandOutput} for command's `response` shape.
  * @see {@link WAFV2ClientResolvedConfig | config} for WAFV2Client's `config` shape.
@@ -107,11 +114,20 @@ export interface PutPermissionPolicyCommandOutput extends PutPermissionPolicyRes
 export declare class PutPermissionPolicyCommand extends $Command<PutPermissionPolicyCommandInput, PutPermissionPolicyCommandOutput, WAFV2ClientResolvedConfig> {
     readonly input: PutPermissionPolicyCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PutPermissionPolicyCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutPermissionPolicyCommandInput, PutPermissionPolicyCommandOutput>;
+    /**
+     * @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 { TagResourceRequest, TagResourceResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, WAFV2ClientResolvedConfig } from "../WAFV2Client";
 /**
+ * @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>Associates tags with the specified Amazon Web Services resource. Tags are key:value pairs that you can
  *          use to categorize and manage your resources, for purposes like billing. For example, you
  *          might set the tag key to "customer" and the value to the customer name or ID. You can
@@ -32,6 +37,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 WAFV2ClientResolvedConfig | config} for WAFV2Client's `config` shape.
@@ -88,11 +95,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, WAFV2ClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFV2ClientResolvedConfig, 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 { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, WAFV2ClientResolvedConfig } from "../WAFV2Client";
 /**
+ * @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>Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can
  *          associate with Amazon Web Services resources. For example, the tag key might be "customer" and the tag
  *          value might be "companyA." You can specify one or more tags to add to each container. You
@@ -28,6 +33,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 WAFV2ClientResolvedConfig | config} for WAFV2Client's `config` shape.
@@ -78,11 +85,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, WAFV2ClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateIPSetRequest, UpdateIPSetResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, WAFV2ClientResolvedConfig } from "../WAFV2Client";
 /**
+ * @public
+ *
  * The input for {@link UpdateIPSetCommand}.
  */
 export interface UpdateIPSetCommandInput extends UpdateIPSetRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateIPSetCommand}.
  */
 export interface UpdateIPSetCommandOutput extends UpdateIPSetResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the specified <a>IPSet</a>. </p>
  *          <note>
  *             <p>This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call. </p>
@@ -42,6 +47,8 @@ export interface UpdateIPSetCommandOutput extends UpdateIPSetResponse, __Metadat
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateIPSetCommandInput - {@link UpdateIPSetCommandInput}
+ * @returns {@link UpdateIPSetCommandOutput}
  * @see {@link UpdateIPSetCommandInput} for command's `input` shape.
  * @see {@link UpdateIPSetCommandOutput} for command's `response` shape.
  * @see {@link WAFV2ClientResolvedConfig | config} for WAFV2Client's `config` shape.
@@ -100,11 +107,20 @@ export interface UpdateIPSetCommandOutput extends UpdateIPSetResponse, __Metadat
 export declare class UpdateIPSetCommand extends $Command<UpdateIPSetCommandInput, UpdateIPSetCommandOutput, WAFV2ClientResolvedConfig> {
     readonly input: UpdateIPSetCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateIPSetCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateIPSetCommandInput, UpdateIPSetCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateManagedRuleSetVersionExpiryDateRequest, UpdateManagedRuleSetVersionExpiryDateResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, WAFV2ClientResolvedConfig } from "../WAFV2Client";
 /**
+ * @public
+ *
  * The input for {@link UpdateManagedRuleSetVersionExpiryDateCommand}.
  */
 export interface UpdateManagedRuleSetVersionExpiryDateCommandInput extends UpdateManagedRuleSetVersionExpiryDateRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateManagedRuleSetVersionExpiryDateCommand}.
  */
 export interface UpdateManagedRuleSetVersionExpiryDateCommandOutput extends UpdateManagedRuleSetVersionExpiryDateResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the expiration information for your managed rule set. Use this to initiate the
  *          expiration of a managed rule group version. After you initiate expiration for a version,
  *          WAF excludes it from the response to <a>ListAvailableManagedRuleGroupVersions</a> for the managed rule group. </p>
@@ -31,6 +36,8 @@ export interface UpdateManagedRuleSetVersionExpiryDateCommandOutput extends Upda
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateManagedRuleSetVersionExpiryDateCommandInput - {@link UpdateManagedRuleSetVersionExpiryDateCommandInput}
+ * @returns {@link UpdateManagedRuleSetVersionExpiryDateCommandOutput}
  * @see {@link UpdateManagedRuleSetVersionExpiryDateCommandInput} for command's `input` shape.
  * @see {@link UpdateManagedRuleSetVersionExpiryDateCommandOutput} for command's `response` shape.
  * @see {@link WAFV2ClientResolvedConfig | config} for WAFV2Client's `config` shape.
@@ -79,11 +86,20 @@ export interface UpdateManagedRuleSetVersionExpiryDateCommandOutput extends Upda
 export declare class UpdateManagedRuleSetVersionExpiryDateCommand extends $Command<UpdateManagedRuleSetVersionExpiryDateCommandInput, UpdateManagedRuleSetVersionExpiryDateCommandOutput, WAFV2ClientResolvedConfig> {
     readonly input: UpdateManagedRuleSetVersionExpiryDateCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateManagedRuleSetVersionExpiryDateCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateManagedRuleSetVersionExpiryDateCommandInput, UpdateManagedRuleSetVersionExpiryDateCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateRegexPatternSetRequest, UpdateRegexPatternSetResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, WAFV2ClientResolvedConfig } from "../WAFV2Client";
 /**
+ * @public
+ *
  * The input for {@link UpdateRegexPatternSetCommand}.
  */
 export interface UpdateRegexPatternSetCommandInput extends UpdateRegexPatternSetRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateRegexPatternSetCommand}.
  */
 export interface UpdateRegexPatternSetCommandOutput extends UpdateRegexPatternSetResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the specified <a>RegexPatternSet</a>.</p>
  *          <note>
  *             <p>This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call. </p>
@@ -42,6 +47,8 @@ export interface UpdateRegexPatternSetCommandOutput extends UpdateRegexPatternSe
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateRegexPatternSetCommandInput - {@link UpdateRegexPatternSetCommandInput}
+ * @returns {@link UpdateRegexPatternSetCommandOutput}
  * @see {@link UpdateRegexPatternSetCommandInput} for command's `input` shape.
  * @see {@link UpdateRegexPatternSetCommandOutput} for command's `response` shape.
  * @see {@link WAFV2ClientResolvedConfig | config} for WAFV2Client's `config` shape.
@@ -100,11 +107,20 @@ export interface UpdateRegexPatternSetCommandOutput extends UpdateRegexPatternSe
 export declare class UpdateRegexPatternSetCommand extends $Command<UpdateRegexPatternSetCommandInput, UpdateRegexPatternSetCommandOutput, WAFV2ClientResolvedConfig> {
     readonly input: UpdateRegexPatternSetCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateRegexPatternSetCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateRegexPatternSetCommandInput, UpdateRegexPatternSetCommandOutput>;
+    /**
+     * @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 { ServiceInputTypes, ServiceOutputTypes, WAFV2ClientResolvedConfig } from "../WAFV2Client";
 /**
+ * @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 specified <a>RuleGroup</a>.</p>
  *          <note>
  *             <p>This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call. </p>
@@ -43,6 +48,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 WAFV2ClientResolvedConfig | config} for WAFV2Client's `config` shape.
@@ -125,11 +132,20 @@ export interface UpdateRuleGroupCommandOutput extends UpdateRuleGroupResponse, _
 export declare class UpdateRuleGroupCommand extends $Command<UpdateRuleGroupCommandInput, UpdateRuleGroupCommandOutput, WAFV2ClientResolvedConfig> {
     readonly input: UpdateRuleGroupCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateRuleGroupCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateRuleGroupCommandInput, UpdateRuleGroupCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateWebACLRequest, UpdateWebACLResponse } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, WAFV2ClientResolvedConfig } from "../WAFV2Client";
 /**
+ * @public
+ *
  * The input for {@link UpdateWebACLCommand}.
  */
 export interface UpdateWebACLCommandInput extends UpdateWebACLRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateWebACLCommand}.
  */
 export interface UpdateWebACLCommandOutput extends UpdateWebACLResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the specified <a>WebACL</a>. While updating a web ACL, WAF provides
  *          continuous coverage to the resources that you have associated with the web ACL. </p>
  *          <note>
@@ -44,6 +49,8 @@ export interface UpdateWebACLCommandOutput extends UpdateWebACLResponse, __Metad
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateWebACLCommandInput - {@link UpdateWebACLCommandInput}
+ * @returns {@link UpdateWebACLCommandOutput}
  * @see {@link UpdateWebACLCommandInput} for command's `input` shape.
  * @see {@link UpdateWebACLCommandOutput} for command's `response` shape.
  * @see {@link WAFV2ClientResolvedConfig | config} for WAFV2Client's `config` shape.
@@ -135,11 +142,20 @@ export interface UpdateWebACLCommandOutput extends UpdateWebACLResponse, __Metad
 export declare class UpdateWebACLCommand extends $Command<UpdateWebACLCommandInput, UpdateWebACLCommandOutput, WAFV2ClientResolvedConfig> {
     readonly input: UpdateWebACLCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateWebACLCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateWebACLCommandInput, UpdateWebACLCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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