@aws-sdk/client-waf 3.35.0 → 3.38.0

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

@@ -6,108 +6,11 @@ export interface UpdateWebACLCommandInput extends UpdateWebACLRequest {
 }
 export interface UpdateWebACLCommandOutput extends UpdateWebACLResponse, __MetadataBearer {
 }
-/**
- * <note>
- *             <p>This is <b>AWS WAF Classic</b> documentation. For
- *       more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html">AWS
- *       WAF Classic</a> in the developer guide.</p>
- *             <p>
- *                <b>For the latest version of AWS
- *       WAF</b>, use the AWS WAFV2 API and see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. With the latest version, AWS WAF has a single set of endpoints for regional and global use. </p>
- *          </note>
- * 		       <p>Inserts or deletes <a>ActivatedRule</a> objects in a <code>WebACL</code>. Each <code>Rule</code> identifies
- * 			web requests that you want to allow, block, or count. When you update a <code>WebACL</code>, you specify the following values:</p>
- * 		       <ul>
- *             <li>
- *                <p>A default action for the <code>WebACL</code>, either <code>ALLOW</code> or <code>BLOCK</code>.
- * 				AWS WAF performs the default action if a request doesn't match the criteria in any of the <code>Rules</code> in a <code>WebACL</code>.</p>
- *             </li>
- *             <li>
- *                <p>The <code>Rules</code> that you want to add
- *                or
- *                delete. If you want to replace one <code>Rule</code> with another, you delete the
- *                existing <code>Rule</code> and add the new one.</p>
- *             </li>
- *             <li>
- *                <p>For each <code>Rule</code>, whether you want AWS WAF to allow requests, block requests, or count requests that match
- * 				the conditions in the <code>Rule</code>.</p>
- *             </li>
- *             <li>
- *                <p>The order in which you want AWS WAF to evaluate the <code>Rules</code> in a
- *                   <code>WebACL</code>. If you add more than one <code>Rule</code> to a
- *                   <code>WebACL</code>, AWS WAF evaluates each request against the <code>Rules</code>
- *                in order based on the value of <code>Priority</code>. (The <code>Rule</code> that has
- *                the lowest value for <code>Priority</code> is evaluated first.) When a web request
- *                matches all
- *                the
- *                predicates (such as <code>ByteMatchSets</code> and <code>IPSets</code>) in a
- *                   <code>Rule</code>, AWS WAF immediately takes the corresponding action, allow or
- *                block, and doesn't evaluate the request against the remaining <code>Rules</code> in
- *                the <code>WebACL</code>, if any. </p>
- *             </li>
- *          </ul>
- *
- * 		       <p>To create and configure a <code>WebACL</code>, perform the following steps:</p>
- * 		       <ol>
- *             <li>
- *                <p>Create and update the predicates that you want to include in <code>Rules</code>.
- * 				For more information, see <a>CreateByteMatchSet</a>, <a>UpdateByteMatchSet</a>, <a>CreateIPSet</a>, <a>UpdateIPSet</a>,
- * 				<a>CreateSqlInjectionMatchSet</a>, and <a>UpdateSqlInjectionMatchSet</a>.</p>
- *             </li>
- *             <li>
- *                <p>Create and update the <code>Rules</code> that you want to include in the <code>WebACL</code>. For more information, see
- * 				<a>CreateRule</a> and <a>UpdateRule</a>.</p>
- *             </li>
- *             <li>
- *                <p>Create a <code>WebACL</code>. See <a>CreateWebACL</a>.</p>
- *             </li>
- *             <li>
- *                <p>Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an
- * 				<a>UpdateWebACL</a> request.</p>
- *             </li>
- *             <li>
- *                <p>Submit an <code>UpdateWebACL</code> request to specify the <code>Rules</code>
- *                that you want to include in the <code>WebACL</code>, to specify the default action,
- *                and to associate the <code>WebACL</code> with a CloudFront distribution. </p>
- *                <p>The <code>ActivatedRule</code> can be a rule group. If you specify a rule group
- *                as your
- *                <code>ActivatedRule</code>
- *                ,
- *                you can exclude specific rules from that rule group.</p>
- *                <p>If you already have a rule group associated with a web ACL and want to submit
- *                an <code>UpdateWebACL</code> request to exclude certain rules from that rule group,
- *                you must first remove the rule group from the web ACL, the re-insert it again,
- *                specifying the excluded rules.
- *                For details,
- *                see
- *                   <a>ActivatedRule$ExcludedRules</a>
- *                .
- *                </p>
- *             </li>
- *          </ol>
- *          <p>Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the  <a>UpdateWebACL</a> request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist. 		</p>
- * 		       <p>For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { WAFClient, UpdateWebACLCommand } from "@aws-sdk/client-waf"; // ES Modules import
- * // const { WAFClient, UpdateWebACLCommand } = require("@aws-sdk/client-waf"); // CommonJS import
- * const client = new WAFClient(config);
- * const command = new UpdateWebACLCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link UpdateWebACLCommandInput} for command's `input` shape.
- * @see {@link UpdateWebACLCommandOutput} for command's `response` shape.
- * @see {@link WAFClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class UpdateWebACLCommand extends $Command<UpdateWebACLCommandInput, UpdateWebACLCommandOutput, WAFClientResolvedConfig> {
     readonly input: UpdateWebACLCommandInput;
     constructor(input: UpdateWebACLCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateWebACLCommandInput, UpdateWebACLCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/UpdateXssMatchSetCommand.d.ts

@@ -6,80 +6,11 @@ export interface UpdateXssMatchSetCommandInput extends UpdateXssMatchSetRequest
 }
 export interface UpdateXssMatchSetCommandOutput extends UpdateXssMatchSetResponse, __MetadataBearer {
 }
-/**
- * <note>
- *             <p>This is <b>AWS WAF Classic</b> documentation. For
- *       more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html">AWS
- *       WAF Classic</a> in the developer guide.</p>
- *             <p>
- *                <b>For the latest version of AWS
- *       WAF</b>, use the AWS WAFV2 API and see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. With the latest version, AWS WAF has a single set of endpoints for regional and global use. </p>
- *          </note>
- * 		       <p>Inserts or deletes <a>XssMatchTuple</a> objects (filters) in an <a>XssMatchSet</a>.
- * 			For each <code>XssMatchTuple</code> object, you specify the following values:</p>
- * 		       <ul>
- *             <li>
- *                <p>
- *                   <code>Action</code>: Whether to insert the object into or delete the object from the
- *                array. To change an
- *                <code>XssMatchTuple</code>, you delete the existing object and add a new
- *                one.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <code>FieldToMatch</code>: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter,
- * 				the name of the header or parameter.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <code>TextTransformation</code>: Which text transformation, if any, to perform on the web request before
- * 				inspecting the request for cross-site scripting attacks.</p>
- * 				           <p>You can only specify a single type of TextTransformation.</p>
- *             </li>
- *          </ul>
- * 		       <p>You use <code>XssMatchSet</code> objects to specify which CloudFront requests
- *          that
- *          you want to allow, block, or count. For example, if you're receiving
- *          requests that contain cross-site scripting attacks in the request body and you want to
- *          block the requests, you can create an <code>XssMatchSet</code> with the applicable
- *          settings, and then configure AWS WAF to block the requests. </p>
- * 		       <p>To create and configure an <code>XssMatchSet</code>, perform the following steps:</p>
- * 		       <ol>
- *             <li>
- *                <p>Submit a <a>CreateXssMatchSet</a> request.</p>
- *             </li>
- *             <li>
- *                <p>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an
- * 				<a>UpdateIPSet</a> request.</p>
- *             </li>
- *             <li>
- *                <p>Submit an <code>UpdateXssMatchSet</code> request to specify the parts of web requests that you want AWS WAF to
- * 				inspect for cross-site scripting attacks.</p>
- *             </li>
- *          </ol>
- * 		       <p>For more information about how to use the AWS WAF API to allow or block HTTP requests, see the
- * 			<a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { WAFClient, UpdateXssMatchSetCommand } from "@aws-sdk/client-waf"; // ES Modules import
- * // const { WAFClient, UpdateXssMatchSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import
- * const client = new WAFClient(config);
- * const command = new UpdateXssMatchSetCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link UpdateXssMatchSetCommandInput} for command's `input` shape.
- * @see {@link UpdateXssMatchSetCommandOutput} for command's `response` shape.
- * @see {@link WAFClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class UpdateXssMatchSetCommand extends $Command<UpdateXssMatchSetCommandInput, UpdateXssMatchSetCommandOutput, WAFClientResolvedConfig> {
     readonly input: UpdateXssMatchSetCommandInput;
     constructor(input: UpdateXssMatchSetCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateXssMatchSetCommandInput, UpdateXssMatchSetCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/index.d.ts

@@ -0,0 +1,77 @@
+export * from "./CreateByteMatchSetCommand";
+export * from "./CreateGeoMatchSetCommand";
+export * from "./CreateIPSetCommand";
+export * from "./CreateRateBasedRuleCommand";
+export * from "./CreateRegexMatchSetCommand";
+export * from "./CreateRegexPatternSetCommand";
+export * from "./CreateRuleCommand";
+export * from "./CreateRuleGroupCommand";
+export * from "./CreateSizeConstraintSetCommand";
+export * from "./CreateSqlInjectionMatchSetCommand";
+export * from "./CreateWebACLCommand";
+export * from "./CreateWebACLMigrationStackCommand";
+export * from "./CreateXssMatchSetCommand";
+export * from "./DeleteByteMatchSetCommand";
+export * from "./DeleteGeoMatchSetCommand";
+export * from "./DeleteIPSetCommand";
+export * from "./DeleteLoggingConfigurationCommand";
+export * from "./DeletePermissionPolicyCommand";
+export * from "./DeleteRateBasedRuleCommand";
+export * from "./DeleteRegexMatchSetCommand";
+export * from "./DeleteRegexPatternSetCommand";
+export * from "./DeleteRuleCommand";
+export * from "./DeleteRuleGroupCommand";
+export * from "./DeleteSizeConstraintSetCommand";
+export * from "./DeleteSqlInjectionMatchSetCommand";
+export * from "./DeleteWebACLCommand";
+export * from "./DeleteXssMatchSetCommand";
+export * from "./GetByteMatchSetCommand";
+export * from "./GetChangeTokenCommand";
+export * from "./GetChangeTokenStatusCommand";
+export * from "./GetGeoMatchSetCommand";
+export * from "./GetIPSetCommand";
+export * from "./GetLoggingConfigurationCommand";
+export * from "./GetPermissionPolicyCommand";
+export * from "./GetRateBasedRuleCommand";
+export * from "./GetRateBasedRuleManagedKeysCommand";
+export * from "./GetRegexMatchSetCommand";
+export * from "./GetRegexPatternSetCommand";
+export * from "./GetRuleCommand";
+export * from "./GetRuleGroupCommand";
+export * from "./GetSampledRequestsCommand";
+export * from "./GetSizeConstraintSetCommand";
+export * from "./GetSqlInjectionMatchSetCommand";
+export * from "./GetWebACLCommand";
+export * from "./GetXssMatchSetCommand";
+export * from "./ListActivatedRulesInRuleGroupCommand";
+export * from "./ListByteMatchSetsCommand";
+export * from "./ListGeoMatchSetsCommand";
+export * from "./ListIPSetsCommand";
+export * from "./ListLoggingConfigurationsCommand";
+export * from "./ListRateBasedRulesCommand";
+export * from "./ListRegexMatchSetsCommand";
+export * from "./ListRegexPatternSetsCommand";
+export * from "./ListRuleGroupsCommand";
+export * from "./ListRulesCommand";
+export * from "./ListSizeConstraintSetsCommand";
+export * from "./ListSqlInjectionMatchSetsCommand";
+export * from "./ListSubscribedRuleGroupsCommand";
+export * from "./ListTagsForResourceCommand";
+export * from "./ListWebACLsCommand";
+export * from "./ListXssMatchSetsCommand";
+export * from "./PutLoggingConfigurationCommand";
+export * from "./PutPermissionPolicyCommand";
+export * from "./TagResourceCommand";
+export * from "./UntagResourceCommand";
+export * from "./UpdateByteMatchSetCommand";
+export * from "./UpdateGeoMatchSetCommand";
+export * from "./UpdateIPSetCommand";
+export * from "./UpdateRateBasedRuleCommand";
+export * from "./UpdateRegexMatchSetCommand";
+export * from "./UpdateRegexPatternSetCommand";
+export * from "./UpdateRuleCommand";
+export * from "./UpdateRuleGroupCommand";
+export * from "./UpdateSizeConstraintSetCommand";
+export * from "./UpdateSqlInjectionMatchSetCommand";
+export * from "./UpdateWebACLCommand";
+export * from "./UpdateXssMatchSetCommand";

package/dist-types/ts3.4/index.d.ts

@@ -1,80 +1,4 @@
-export * from "./WAFClient";
 export * from "./WAF";
-export * from "./commands/CreateByteMatchSetCommand";
-export * from "./commands/CreateGeoMatchSetCommand";
-export * from "./commands/CreateIPSetCommand";
-export * from "./commands/CreateRateBasedRuleCommand";
-export * from "./commands/CreateRegexMatchSetCommand";
-export * from "./commands/CreateRegexPatternSetCommand";
-export * from "./commands/CreateRuleCommand";
-export * from "./commands/CreateRuleGroupCommand";
-export * from "./commands/CreateSizeConstraintSetCommand";
-export * from "./commands/CreateSqlInjectionMatchSetCommand";
-export * from "./commands/CreateWebACLCommand";
-export * from "./commands/CreateWebACLMigrationStackCommand";
-export * from "./commands/CreateXssMatchSetCommand";
-export * from "./commands/DeleteByteMatchSetCommand";
-export * from "./commands/DeleteGeoMatchSetCommand";
-export * from "./commands/DeleteIPSetCommand";
-export * from "./commands/DeleteLoggingConfigurationCommand";
-export * from "./commands/DeletePermissionPolicyCommand";
-export * from "./commands/DeleteRateBasedRuleCommand";
-export * from "./commands/DeleteRegexMatchSetCommand";
-export * from "./commands/DeleteRegexPatternSetCommand";
-export * from "./commands/DeleteRuleCommand";
-export * from "./commands/DeleteRuleGroupCommand";
-export * from "./commands/DeleteSizeConstraintSetCommand";
-export * from "./commands/DeleteSqlInjectionMatchSetCommand";
-export * from "./commands/DeleteWebACLCommand";
-export * from "./commands/DeleteXssMatchSetCommand";
-export * from "./commands/GetByteMatchSetCommand";
-export * from "./commands/GetChangeTokenCommand";
-export * from "./commands/GetChangeTokenStatusCommand";
-export * from "./commands/GetGeoMatchSetCommand";
-export * from "./commands/GetIPSetCommand";
-export * from "./commands/GetLoggingConfigurationCommand";
-export * from "./commands/GetPermissionPolicyCommand";
-export * from "./commands/GetRateBasedRuleCommand";
-export * from "./commands/GetRateBasedRuleManagedKeysCommand";
-export * from "./commands/GetRegexMatchSetCommand";
-export * from "./commands/GetRegexPatternSetCommand";
-export * from "./commands/GetRuleCommand";
-export * from "./commands/GetRuleGroupCommand";
-export * from "./commands/GetSampledRequestsCommand";
-export * from "./commands/GetSizeConstraintSetCommand";
-export * from "./commands/GetSqlInjectionMatchSetCommand";
-export * from "./commands/GetWebACLCommand";
-export * from "./commands/GetXssMatchSetCommand";
-export * from "./commands/ListActivatedRulesInRuleGroupCommand";
-export * from "./commands/ListByteMatchSetsCommand";
-export * from "./commands/ListGeoMatchSetsCommand";
-export * from "./commands/ListIPSetsCommand";
-export * from "./commands/ListLoggingConfigurationsCommand";
-export * from "./commands/ListRateBasedRulesCommand";
-export * from "./commands/ListRegexMatchSetsCommand";
-export * from "./commands/ListRegexPatternSetsCommand";
-export * from "./commands/ListRuleGroupsCommand";
-export * from "./commands/ListRulesCommand";
-export * from "./commands/ListSizeConstraintSetsCommand";
-export * from "./commands/ListSqlInjectionMatchSetsCommand";
-export * from "./commands/ListSubscribedRuleGroupsCommand";
-export * from "./commands/ListTagsForResourceCommand";
-export * from "./commands/ListWebACLsCommand";
-export * from "./commands/ListXssMatchSetsCommand";
-export * from "./commands/PutLoggingConfigurationCommand";
-export * from "./commands/PutPermissionPolicyCommand";
-export * from "./commands/TagResourceCommand";
-export * from "./commands/UntagResourceCommand";
-export * from "./commands/UpdateByteMatchSetCommand";
-export * from "./commands/UpdateGeoMatchSetCommand";
-export * from "./commands/UpdateIPSetCommand";
-export * from "./commands/UpdateRateBasedRuleCommand";
-export * from "./commands/UpdateRegexMatchSetCommand";
-export * from "./commands/UpdateRegexPatternSetCommand";
-export * from "./commands/UpdateRuleCommand";
-export * from "./commands/UpdateRuleGroupCommand";
-export * from "./commands/UpdateSizeConstraintSetCommand";
-export * from "./commands/UpdateSqlInjectionMatchSetCommand";
-export * from "./commands/UpdateWebACLCommand";
-export * from "./commands/UpdateXssMatchSetCommand";
-export * from "./models/index";
+export * from "./WAFClient";
+export * from "./commands";
+export * from "./models";