@aws-sdk/client-wafv2 3.422.0 → 3.425.0

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

@@ -1,115 +1,35 @@
-import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
-import { Command as $Command } from "@smithy/smithy-client";
-import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
-import { CreateAPIKeyRequest, CreateAPIKeyResponse } from "../models/models_0";
-import { ServiceInputTypes, ServiceOutputTypes, WAFV2ClientResolvedConfig } from "../WAFV2Client";
-/**
- * @public
- */
-export { __MetadataBearer, $Command };
-/**
- * @public
- *
- * The input for {@link CreateAPIKeyCommand}.
- */
-export interface CreateAPIKeyCommandInput extends CreateAPIKeyRequest {
-}
-/**
- * @public
- *
- * The output of {@link CreateAPIKeyCommand}.
- */
-export interface CreateAPIKeyCommandOutput extends CreateAPIKeyResponse, __MetadataBearer {
-}
-/**
- * @public
- * <p>Creates an API key that contains a set of token domains.</p>
- *          <p>API keys are required for the integration of the CAPTCHA API in your JavaScript client applications.
- *            The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users.
- *            For more information about the CAPTCHA JavaScript integration, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html">WAF client application integration</a> in the <i>WAF Developer Guide</i>.</p>
- *          <p>You can use a single key for up to 5 domains. After you generate a key, you can copy it for use in your JavaScript
- *            integration. </p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { WAFV2Client, CreateAPIKeyCommand } from "@aws-sdk/client-wafv2"; // ES Modules import
- * // const { WAFV2Client, CreateAPIKeyCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import
- * const client = new WAFV2Client(config);
- * const input = { // CreateAPIKeyRequest
- *   Scope: "CLOUDFRONT" || "REGIONAL", // required
- *   TokenDomains: [ // APIKeyTokenDomains // required
- *     "STRING_VALUE",
- *   ],
- * };
- * const command = new CreateAPIKeyCommand(input);
- * const response = await client.send(command);
- * // { // CreateAPIKeyResponse
- * //   APIKey: "STRING_VALUE",
- * // };
- *
- * ```
- *
- * @param CreateAPIKeyCommandInput - {@link CreateAPIKeyCommandInput}
- * @returns {@link CreateAPIKeyCommandOutput}
- * @see {@link CreateAPIKeyCommandInput} for command's `input` shape.
- * @see {@link CreateAPIKeyCommandOutput} for command's `response` shape.
- * @see {@link WAFV2ClientResolvedConfig | config} for WAFV2Client's `config` shape.
- *
- * @throws {@link WAFInternalErrorException} (server fault)
- *  <p>Your request is valid, but WAF couldn’t perform the operation because of a system
- *          problem. Retry your request. </p>
- *
- * @throws {@link WAFInvalidOperationException} (client fault)
- *  <p>The operation isn't valid. </p>
- *
- * @throws {@link WAFInvalidParameterException} (client fault)
- *  <p>The operation failed because WAF didn't recognize a parameter in the request. For
- *          example: </p>
- *          <ul>
- *             <li>
- *                <p>You specified a parameter name or value that isn't valid.</p>
- *             </li>
- *             <li>
- *                <p>Your nested statement isn't valid. You might have tried to nest a statement that
- *                can’t be nested. </p>
- *             </li>
- *             <li>
- *                <p>You tried to update a <code>WebACL</code> with a <code>DefaultAction</code> that
- *                isn't among the types available at <a>DefaultAction</a>.</p>
- *             </li>
- *             <li>
- *                <p>Your request references an ARN that is malformed, or corresponds to a resource
- *                with which a web ACL can't be associated.</p>
- *             </li>
- *          </ul>
- *
- * @throws {@link WAFLimitsExceededException} (client fault)
- *  <p>WAF couldn’t perform the operation because you exceeded your resource limit. For
- *          example, the maximum number of <code>WebACL</code> objects that you can create for an Amazon Web Services
- *          account. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/limits.html">WAF quotas</a> in the
- *             <i>WAF Developer Guide</i>.</p>
- *
- * @throws {@link WAFV2ServiceException}
- * <p>Base exception class for all service exceptions from WAFV2 service.</p>
- *
- */
-export declare class CreateAPIKeyCommand extends $Command<CreateAPIKeyCommandInput, CreateAPIKeyCommandOutput, WAFV2ClientResolvedConfig> {
-    readonly input: CreateAPIKeyCommandInput;
-    static getEndpointParameterInstructions(): EndpointParameterInstructions;
-    /**
-     * @public
-     */
-    constructor(input: CreateAPIKeyCommandInput);
-    /**
-     * @internal
-     */
-    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAPIKeyCommandInput, CreateAPIKeyCommandOutput>;
-    /**
-     * @internal
-     */
-    private serialize;
-    /**
-     * @internal
-     */
-    private deserialize;
-}
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import {
+  Handler,
+  HttpHandlerOptions as __HttpHandlerOptions,
+  MetadataBearer as __MetadataBearer,
+  MiddlewareStack,
+} from "@smithy/types";
+import { CreateAPIKeyRequest, CreateAPIKeyResponse } from "../models/models_0";
+import {
+  ServiceInputTypes,
+  ServiceOutputTypes,
+  WAFV2ClientResolvedConfig,
+} from "../WAFV2Client";
+export { __MetadataBearer, $Command };
+export interface CreateAPIKeyCommandInput extends CreateAPIKeyRequest {}
+export interface CreateAPIKeyCommandOutput
+  extends CreateAPIKeyResponse,
+    __MetadataBearer {}
+export declare class CreateAPIKeyCommand extends $Command<
+  CreateAPIKeyCommandInput,
+  CreateAPIKeyCommandOutput,
+  WAFV2ClientResolvedConfig
+> {
+  readonly input: CreateAPIKeyCommandInput;
+  static getEndpointParameterInstructions(): EndpointParameterInstructions;
+  constructor(input: CreateAPIKeyCommandInput);
+  resolveMiddleware(
+    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
+    configuration: WAFV2ClientResolvedConfig,
+    options?: __HttpHandlerOptions
+  ): Handler<CreateAPIKeyCommandInput, CreateAPIKeyCommandOutput>;
+  private serialize;
+  private deserialize;
+}

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

@@ -1,144 +1,35 @@
-import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
-import { Command as $Command } from "@smithy/smithy-client";
-import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
-import { CreateIPSetRequest, CreateIPSetResponse } from "../models/models_0";
-import { ServiceInputTypes, ServiceOutputTypes, WAFV2ClientResolvedConfig } from "../WAFV2Client";
-/**
- * @public
- */
-export { __MetadataBearer, $Command };
-/**
- * @public
- *
- * The input for {@link CreateIPSetCommand}.
- */
-export interface CreateIPSetCommandInput extends CreateIPSetRequest {
-}
-/**
- * @public
- *
- * The output of {@link CreateIPSetCommand}.
- */
-export interface CreateIPSetCommandOutput extends CreateIPSetResponse, __MetadataBearer {
-}
-/**
- * @public
- * <p>Creates an <a>IPSet</a>, which you use to identify web requests that
- *          originate from specific IP addresses or ranges of IP addresses. For example, if you're
- *          receiving a lot of requests from a ranges of IP addresses, you can configure WAF to
- *          block them using an IPSet that lists those IP addresses. </p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { WAFV2Client, CreateIPSetCommand } from "@aws-sdk/client-wafv2"; // ES Modules import
- * // const { WAFV2Client, CreateIPSetCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import
- * const client = new WAFV2Client(config);
- * const input = { // CreateIPSetRequest
- *   Name: "STRING_VALUE", // required
- *   Scope: "CLOUDFRONT" || "REGIONAL", // required
- *   Description: "STRING_VALUE",
- *   IPAddressVersion: "IPV4" || "IPV6", // required
- *   Addresses: [ // IPAddresses // required
- *     "STRING_VALUE",
- *   ],
- *   Tags: [ // TagList
- *     { // Tag
- *       Key: "STRING_VALUE", // required
- *       Value: "STRING_VALUE", // required
- *     },
- *   ],
- * };
- * const command = new CreateIPSetCommand(input);
- * const response = await client.send(command);
- * // { // CreateIPSetResponse
- * //   Summary: { // IPSetSummary
- * //     Name: "STRING_VALUE",
- * //     Id: "STRING_VALUE",
- * //     Description: "STRING_VALUE",
- * //     LockToken: "STRING_VALUE",
- * //     ARN: "STRING_VALUE",
- * //   },
- * // };
- *
- * ```
- *
- * @param CreateIPSetCommandInput - {@link CreateIPSetCommandInput}
- * @returns {@link CreateIPSetCommandOutput}
- * @see {@link CreateIPSetCommandInput} for command's `input` shape.
- * @see {@link CreateIPSetCommandOutput} for command's `response` shape.
- * @see {@link WAFV2ClientResolvedConfig | config} for WAFV2Client's `config` shape.
- *
- * @throws {@link WAFDuplicateItemException} (client fault)
- *  <p>WAF couldn’t perform the operation because the resource that you tried to save is
- *          a duplicate of an existing one.</p>
- *
- * @throws {@link WAFInternalErrorException} (server fault)
- *  <p>Your request is valid, but WAF couldn’t perform the operation because of a system
- *          problem. Retry your request. </p>
- *
- * @throws {@link WAFInvalidOperationException} (client fault)
- *  <p>The operation isn't valid. </p>
- *
- * @throws {@link WAFInvalidParameterException} (client fault)
- *  <p>The operation failed because WAF didn't recognize a parameter in the request. For
- *          example: </p>
- *          <ul>
- *             <li>
- *                <p>You specified a parameter name or value that isn't valid.</p>
- *             </li>
- *             <li>
- *                <p>Your nested statement isn't valid. You might have tried to nest a statement that
- *                can’t be nested. </p>
- *             </li>
- *             <li>
- *                <p>You tried to update a <code>WebACL</code> with a <code>DefaultAction</code> that
- *                isn't among the types available at <a>DefaultAction</a>.</p>
- *             </li>
- *             <li>
- *                <p>Your request references an ARN that is malformed, or corresponds to a resource
- *                with which a web ACL can't be associated.</p>
- *             </li>
- *          </ul>
- *
- * @throws {@link WAFLimitsExceededException} (client fault)
- *  <p>WAF couldn’t perform the operation because you exceeded your resource limit. For
- *          example, the maximum number of <code>WebACL</code> objects that you can create for an Amazon Web Services
- *          account. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/limits.html">WAF quotas</a> in the
- *             <i>WAF Developer Guide</i>.</p>
- *
- * @throws {@link WAFOptimisticLockException} (client fault)
- *  <p>WAF couldn’t save your changes because you tried to update or delete a resource
- *          that has changed since you last retrieved it. Get the resource again, make any changes you
- *          need to make to the new copy, and retry your operation. </p>
- *
- * @throws {@link WAFTagOperationException} (client fault)
- *  <p>An error occurred during the tagging operation. Retry your request.</p>
- *
- * @throws {@link WAFTagOperationInternalErrorException} (server fault)
- *  <p>WAF couldn’t perform your tagging operation because of an internal error. Retry
- *          your request.</p>
- *
- * @throws {@link WAFV2ServiceException}
- * <p>Base exception class for all service exceptions from WAFV2 service.</p>
- *
- */
-export declare class CreateIPSetCommand extends $Command<CreateIPSetCommandInput, CreateIPSetCommandOutput, WAFV2ClientResolvedConfig> {
-    readonly input: CreateIPSetCommandInput;
-    static getEndpointParameterInstructions(): EndpointParameterInstructions;
-    /**
-     * @public
-     */
-    constructor(input: CreateIPSetCommandInput);
-    /**
-     * @internal
-     */
-    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateIPSetCommandInput, CreateIPSetCommandOutput>;
-    /**
-     * @internal
-     */
-    private serialize;
-    /**
-     * @internal
-     */
-    private deserialize;
-}
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import {
+  Handler,
+  HttpHandlerOptions as __HttpHandlerOptions,
+  MetadataBearer as __MetadataBearer,
+  MiddlewareStack,
+} from "@smithy/types";
+import { CreateIPSetRequest, CreateIPSetResponse } from "../models/models_0";
+import {
+  ServiceInputTypes,
+  ServiceOutputTypes,
+  WAFV2ClientResolvedConfig,
+} from "../WAFV2Client";
+export { __MetadataBearer, $Command };
+export interface CreateIPSetCommandInput extends CreateIPSetRequest {}
+export interface CreateIPSetCommandOutput
+  extends CreateIPSetResponse,
+    __MetadataBearer {}
+export declare class CreateIPSetCommand extends $Command<
+  CreateIPSetCommandInput,
+  CreateIPSetCommandOutput,
+  WAFV2ClientResolvedConfig
+> {
+  readonly input: CreateIPSetCommandInput;
+  static getEndpointParameterInstructions(): EndpointParameterInstructions;
+  constructor(input: CreateIPSetCommandInput);
+  resolveMiddleware(
+    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
+    configuration: WAFV2ClientResolvedConfig,
+    options?: __HttpHandlerOptions
+  ): Handler<CreateIPSetCommandInput, CreateIPSetCommandOutput>;
+  private serialize;
+  private deserialize;
+}

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

@@ -1,143 +1,42 @@
-import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
-import { Command as $Command } from "@smithy/smithy-client";
-import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
-import { CreateRegexPatternSetRequest, CreateRegexPatternSetResponse } from "../models/models_0";
-import { ServiceInputTypes, ServiceOutputTypes, WAFV2ClientResolvedConfig } from "../WAFV2Client";
-/**
- * @public
- */
-export { __MetadataBearer, $Command };
-/**
- * @public
- *
- * The input for {@link CreateRegexPatternSetCommand}.
- */
-export interface CreateRegexPatternSetCommandInput extends CreateRegexPatternSetRequest {
-}
-/**
- * @public
- *
- * The output of {@link CreateRegexPatternSetCommand}.
- */
-export interface CreateRegexPatternSetCommandOutput extends CreateRegexPatternSetResponse, __MetadataBearer {
-}
-/**
- * @public
- * <p>Creates a <a>RegexPatternSet</a>, which you reference in a <a>RegexPatternSetReferenceStatement</a>, to have WAF inspect a web request
- *          component for the specified patterns.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { WAFV2Client, CreateRegexPatternSetCommand } from "@aws-sdk/client-wafv2"; // ES Modules import
- * // const { WAFV2Client, CreateRegexPatternSetCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import
- * const client = new WAFV2Client(config);
- * const input = { // CreateRegexPatternSetRequest
- *   Name: "STRING_VALUE", // required
- *   Scope: "CLOUDFRONT" || "REGIONAL", // required
- *   Description: "STRING_VALUE",
- *   RegularExpressionList: [ // RegularExpressionList // required
- *     { // Regex
- *       RegexString: "STRING_VALUE",
- *     },
- *   ],
- *   Tags: [ // TagList
- *     { // Tag
- *       Key: "STRING_VALUE", // required
- *       Value: "STRING_VALUE", // required
- *     },
- *   ],
- * };
- * const command = new CreateRegexPatternSetCommand(input);
- * const response = await client.send(command);
- * // { // CreateRegexPatternSetResponse
- * //   Summary: { // RegexPatternSetSummary
- * //     Name: "STRING_VALUE",
- * //     Id: "STRING_VALUE",
- * //     Description: "STRING_VALUE",
- * //     LockToken: "STRING_VALUE",
- * //     ARN: "STRING_VALUE",
- * //   },
- * // };
- *
- * ```
- *
- * @param CreateRegexPatternSetCommandInput - {@link CreateRegexPatternSetCommandInput}
- * @returns {@link CreateRegexPatternSetCommandOutput}
- * @see {@link CreateRegexPatternSetCommandInput} for command's `input` shape.
- * @see {@link CreateRegexPatternSetCommandOutput} for command's `response` shape.
- * @see {@link WAFV2ClientResolvedConfig | config} for WAFV2Client's `config` shape.
- *
- * @throws {@link WAFDuplicateItemException} (client fault)
- *  <p>WAF couldn’t perform the operation because the resource that you tried to save is
- *          a duplicate of an existing one.</p>
- *
- * @throws {@link WAFInternalErrorException} (server fault)
- *  <p>Your request is valid, but WAF couldn’t perform the operation because of a system
- *          problem. Retry your request. </p>
- *
- * @throws {@link WAFInvalidOperationException} (client fault)
- *  <p>The operation isn't valid. </p>
- *
- * @throws {@link WAFInvalidParameterException} (client fault)
- *  <p>The operation failed because WAF didn't recognize a parameter in the request. For
- *          example: </p>
- *          <ul>
- *             <li>
- *                <p>You specified a parameter name or value that isn't valid.</p>
- *             </li>
- *             <li>
- *                <p>Your nested statement isn't valid. You might have tried to nest a statement that
- *                can’t be nested. </p>
- *             </li>
- *             <li>
- *                <p>You tried to update a <code>WebACL</code> with a <code>DefaultAction</code> that
- *                isn't among the types available at <a>DefaultAction</a>.</p>
- *             </li>
- *             <li>
- *                <p>Your request references an ARN that is malformed, or corresponds to a resource
- *                with which a web ACL can't be associated.</p>
- *             </li>
- *          </ul>
- *
- * @throws {@link WAFLimitsExceededException} (client fault)
- *  <p>WAF couldn’t perform the operation because you exceeded your resource limit. For
- *          example, the maximum number of <code>WebACL</code> objects that you can create for an Amazon Web Services
- *          account. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/limits.html">WAF quotas</a> in the
- *             <i>WAF Developer Guide</i>.</p>
- *
- * @throws {@link WAFOptimisticLockException} (client fault)
- *  <p>WAF couldn’t save your changes because you tried to update or delete a resource
- *          that has changed since you last retrieved it. Get the resource again, make any changes you
- *          need to make to the new copy, and retry your operation. </p>
- *
- * @throws {@link WAFTagOperationException} (client fault)
- *  <p>An error occurred during the tagging operation. Retry your request.</p>
- *
- * @throws {@link WAFTagOperationInternalErrorException} (server fault)
- *  <p>WAF couldn’t perform your tagging operation because of an internal error. Retry
- *          your request.</p>
- *
- * @throws {@link WAFV2ServiceException}
- * <p>Base exception class for all service exceptions from WAFV2 service.</p>
- *
- */
-export declare class CreateRegexPatternSetCommand extends $Command<CreateRegexPatternSetCommandInput, CreateRegexPatternSetCommandOutput, WAFV2ClientResolvedConfig> {
-    readonly input: CreateRegexPatternSetCommandInput;
-    static getEndpointParameterInstructions(): EndpointParameterInstructions;
-    /**
-     * @public
-     */
-    constructor(input: CreateRegexPatternSetCommandInput);
-    /**
-     * @internal
-     */
-    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateRegexPatternSetCommandInput, CreateRegexPatternSetCommandOutput>;
-    /**
-     * @internal
-     */
-    private serialize;
-    /**
-     * @internal
-     */
-    private deserialize;
-}
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import {
+  Handler,
+  HttpHandlerOptions as __HttpHandlerOptions,
+  MetadataBearer as __MetadataBearer,
+  MiddlewareStack,
+} from "@smithy/types";
+import {
+  CreateRegexPatternSetRequest,
+  CreateRegexPatternSetResponse,
+} from "../models/models_0";
+import {
+  ServiceInputTypes,
+  ServiceOutputTypes,
+  WAFV2ClientResolvedConfig,
+} from "../WAFV2Client";
+export { __MetadataBearer, $Command };
+export interface CreateRegexPatternSetCommandInput
+  extends CreateRegexPatternSetRequest {}
+export interface CreateRegexPatternSetCommandOutput
+  extends CreateRegexPatternSetResponse,
+    __MetadataBearer {}
+export declare class CreateRegexPatternSetCommand extends $Command<
+  CreateRegexPatternSetCommandInput,
+  CreateRegexPatternSetCommandOutput,
+  WAFV2ClientResolvedConfig
+> {
+  readonly input: CreateRegexPatternSetCommandInput;
+  static getEndpointParameterInstructions(): EndpointParameterInstructions;
+  constructor(input: CreateRegexPatternSetCommandInput);
+  resolveMiddleware(
+    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
+    configuration: WAFV2ClientResolvedConfig,
+    options?: __HttpHandlerOptions
+  ): Handler<
+    CreateRegexPatternSetCommandInput,
+    CreateRegexPatternSetCommandOutput
+  >;
+  private serialize;
+  private deserialize;
+}