@aws-sdk/client-wafv2 3.419.0 → 3.422.0

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

@@ -1,42 +1,110 @@
-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 {
-  GenerateMobileSdkReleaseUrlRequest,
-  GenerateMobileSdkReleaseUrlResponse,
-} from "../models/models_0";
-import {
-  ServiceInputTypes,
-  ServiceOutputTypes,
-  WAFV2ClientResolvedConfig,
-} from "../WAFV2Client";
-export { __MetadataBearer, $Command };
-export interface GenerateMobileSdkReleaseUrlCommandInput
-  extends GenerateMobileSdkReleaseUrlRequest {}
-export interface GenerateMobileSdkReleaseUrlCommandOutput
-  extends GenerateMobileSdkReleaseUrlResponse,
-    __MetadataBearer {}
-export declare class GenerateMobileSdkReleaseUrlCommand extends $Command<
-  GenerateMobileSdkReleaseUrlCommandInput,
-  GenerateMobileSdkReleaseUrlCommandOutput,
-  WAFV2ClientResolvedConfig
-> {
-  readonly input: GenerateMobileSdkReleaseUrlCommandInput;
-  static getEndpointParameterInstructions(): EndpointParameterInstructions;
-  constructor(input: GenerateMobileSdkReleaseUrlCommandInput);
-  resolveMiddleware(
-    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
-    configuration: WAFV2ClientResolvedConfig,
-    options?: __HttpHandlerOptions
-  ): Handler<
-    GenerateMobileSdkReleaseUrlCommandInput,
-    GenerateMobileSdkReleaseUrlCommandOutput
-  >;
-  private serialize;
-  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 { GenerateMobileSdkReleaseUrlRequest, GenerateMobileSdkReleaseUrlResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, WAFV2ClientResolvedConfig } from "../WAFV2Client";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link GenerateMobileSdkReleaseUrlCommand}.
+ */
+export interface GenerateMobileSdkReleaseUrlCommandInput extends GenerateMobileSdkReleaseUrlRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GenerateMobileSdkReleaseUrlCommand}.
+ */
+export interface GenerateMobileSdkReleaseUrlCommandOutput extends GenerateMobileSdkReleaseUrlResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Generates a presigned download URL for the specified release of the mobile SDK.</p>
+ *          <p>The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, 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>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WAFV2Client, GenerateMobileSdkReleaseUrlCommand } from "@aws-sdk/client-wafv2"; // ES Modules import
+ * // const { WAFV2Client, GenerateMobileSdkReleaseUrlCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import
+ * const client = new WAFV2Client(config);
+ * const input = { // GenerateMobileSdkReleaseUrlRequest
+ *   Platform: "IOS" || "ANDROID", // required
+ *   ReleaseVersion: "STRING_VALUE", // required
+ * };
+ * const command = new GenerateMobileSdkReleaseUrlCommand(input);
+ * const response = await client.send(command);
+ * // { // GenerateMobileSdkReleaseUrlResponse
+ * //   Url: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param GenerateMobileSdkReleaseUrlCommandInput - {@link GenerateMobileSdkReleaseUrlCommandInput}
+ * @returns {@link GenerateMobileSdkReleaseUrlCommandOutput}
+ * @see {@link GenerateMobileSdkReleaseUrlCommandInput} for command's `input` shape.
+ * @see {@link GenerateMobileSdkReleaseUrlCommandOutput} 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 WAFNonexistentItemException} (client fault)
+ *  <p>WAF couldn’t perform the operation because your resource doesn't exist.
+ *        If you've just created a resource that you're using in this operation, you might
+ *        just need to wait a few minutes. It can take from a few seconds to a number of minutes
+ *        for changes to propagate. </p>
+ *
+ * @throws {@link WAFV2ServiceException}
+ * <p>Base exception class for all service exceptions from WAFV2 service.</p>
+ *
+ */
+export declare class GenerateMobileSdkReleaseUrlCommand extends $Command<GenerateMobileSdkReleaseUrlCommandInput, GenerateMobileSdkReleaseUrlCommandOutput, WAFV2ClientResolvedConfig> {
+    readonly input: GenerateMobileSdkReleaseUrlCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: GenerateMobileSdkReleaseUrlCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GenerateMobileSdkReleaseUrlCommandInput, GenerateMobileSdkReleaseUrlCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -1,39 +1,112 @@
-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 {
-  GetDecryptedAPIKeyRequest,
-  GetDecryptedAPIKeyResponse,
-} from "../models/models_0";
-import {
-  ServiceInputTypes,
-  ServiceOutputTypes,
-  WAFV2ClientResolvedConfig,
-} from "../WAFV2Client";
-export { __MetadataBearer, $Command };
-export interface GetDecryptedAPIKeyCommandInput
-  extends GetDecryptedAPIKeyRequest {}
-export interface GetDecryptedAPIKeyCommandOutput
-  extends GetDecryptedAPIKeyResponse,
-    __MetadataBearer {}
-export declare class GetDecryptedAPIKeyCommand extends $Command<
-  GetDecryptedAPIKeyCommandInput,
-  GetDecryptedAPIKeyCommandOutput,
-  WAFV2ClientResolvedConfig
-> {
-  readonly input: GetDecryptedAPIKeyCommandInput;
-  static getEndpointParameterInstructions(): EndpointParameterInstructions;
-  constructor(input: GetDecryptedAPIKeyCommandInput);
-  resolveMiddleware(
-    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
-    configuration: WAFV2ClientResolvedConfig,
-    options?: __HttpHandlerOptions
-  ): Handler<GetDecryptedAPIKeyCommandInput, GetDecryptedAPIKeyCommandOutput>;
-  private serialize;
-  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 { GetDecryptedAPIKeyRequest, GetDecryptedAPIKeyResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, WAFV2ClientResolvedConfig } from "../WAFV2Client";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetDecryptedAPIKeyCommand}.
+ */
+export interface GetDecryptedAPIKeyCommandInput extends GetDecryptedAPIKeyRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetDecryptedAPIKeyCommand}.
+ */
+export interface GetDecryptedAPIKeyCommandOutput extends GetDecryptedAPIKeyResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Returns your API key in decrypted form. Use this to check the token domains that you have defined for the key. </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>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WAFV2Client, GetDecryptedAPIKeyCommand } from "@aws-sdk/client-wafv2"; // ES Modules import
+ * // const { WAFV2Client, GetDecryptedAPIKeyCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import
+ * const client = new WAFV2Client(config);
+ * const input = { // GetDecryptedAPIKeyRequest
+ *   Scope: "CLOUDFRONT" || "REGIONAL", // required
+ *   APIKey: "STRING_VALUE", // required
+ * };
+ * const command = new GetDecryptedAPIKeyCommand(input);
+ * const response = await client.send(command);
+ * // { // GetDecryptedAPIKeyResponse
+ * //   TokenDomains: [ // TokenDomains
+ * //     "STRING_VALUE",
+ * //   ],
+ * //   CreationTimestamp: new Date("TIMESTAMP"),
+ * // };
+ *
+ * ```
+ *
+ * @param GetDecryptedAPIKeyCommandInput - {@link GetDecryptedAPIKeyCommandInput}
+ * @returns {@link GetDecryptedAPIKeyCommandOutput}
+ * @see {@link GetDecryptedAPIKeyCommandInput} for command's `input` shape.
+ * @see {@link GetDecryptedAPIKeyCommandOutput} 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 WAFInvalidResourceException} (client fault)
+ *  <p>WAF couldn’t perform the operation because the resource that you requested isn’t
+ *          valid. Check the resource, and try again.</p>
+ *
+ * @throws {@link WAFV2ServiceException}
+ * <p>Base exception class for all service exceptions from WAFV2 service.</p>
+ *
+ */
+export declare class GetDecryptedAPIKeyCommand extends $Command<GetDecryptedAPIKeyCommandInput, GetDecryptedAPIKeyCommandOutput, WAFV2ClientResolvedConfig> {
+    readonly input: GetDecryptedAPIKeyCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: GetDecryptedAPIKeyCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDecryptedAPIKeyCommandInput, GetDecryptedAPIKeyCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -1,35 +1,119 @@
-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 { GetIPSetRequest, GetIPSetResponse } from "../models/models_0";
-import {
-  ServiceInputTypes,
-  ServiceOutputTypes,
-  WAFV2ClientResolvedConfig,
-} from "../WAFV2Client";
-export { __MetadataBearer, $Command };
-export interface GetIPSetCommandInput extends GetIPSetRequest {}
-export interface GetIPSetCommandOutput
-  extends GetIPSetResponse,
-    __MetadataBearer {}
-export declare class GetIPSetCommand extends $Command<
-  GetIPSetCommandInput,
-  GetIPSetCommandOutput,
-  WAFV2ClientResolvedConfig
-> {
-  readonly input: GetIPSetCommandInput;
-  static getEndpointParameterInstructions(): EndpointParameterInstructions;
-  constructor(input: GetIPSetCommandInput);
-  resolveMiddleware(
-    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
-    configuration: WAFV2ClientResolvedConfig,
-    options?: __HttpHandlerOptions
-  ): Handler<GetIPSetCommandInput, GetIPSetCommandOutput>;
-  private serialize;
-  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 { GetIPSetRequest, GetIPSetResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, WAFV2ClientResolvedConfig } from "../WAFV2Client";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetIPSetCommand}.
+ */
+export interface GetIPSetCommandInput extends GetIPSetRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetIPSetCommand}.
+ */
+export interface GetIPSetCommandOutput extends GetIPSetResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Retrieves the specified <a>IPSet</a>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WAFV2Client, GetIPSetCommand } from "@aws-sdk/client-wafv2"; // ES Modules import
+ * // const { WAFV2Client, GetIPSetCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import
+ * const client = new WAFV2Client(config);
+ * const input = { // GetIPSetRequest
+ *   Name: "STRING_VALUE", // required
+ *   Scope: "CLOUDFRONT" || "REGIONAL", // required
+ *   Id: "STRING_VALUE", // required
+ * };
+ * const command = new GetIPSetCommand(input);
+ * const response = await client.send(command);
+ * // { // GetIPSetResponse
+ * //   IPSet: { // IPSet
+ * //     Name: "STRING_VALUE", // required
+ * //     Id: "STRING_VALUE", // required
+ * //     ARN: "STRING_VALUE", // required
+ * //     Description: "STRING_VALUE",
+ * //     IPAddressVersion: "IPV4" || "IPV6", // required
+ * //     Addresses: [ // IPAddresses // required
+ * //       "STRING_VALUE",
+ * //     ],
+ * //   },
+ * //   LockToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param GetIPSetCommandInput - {@link GetIPSetCommandInput}
+ * @returns {@link GetIPSetCommandOutput}
+ * @see {@link GetIPSetCommandInput} for command's `input` shape.
+ * @see {@link GetIPSetCommandOutput} 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 WAFNonexistentItemException} (client fault)
+ *  <p>WAF couldn’t perform the operation because your resource doesn't exist.
+ *        If you've just created a resource that you're using in this operation, you might
+ *        just need to wait a few minutes. It can take from a few seconds to a number of minutes
+ *        for changes to propagate. </p>
+ *
+ * @throws {@link WAFV2ServiceException}
+ * <p>Base exception class for all service exceptions from WAFV2 service.</p>
+ *
+ */
+export declare class GetIPSetCommand extends $Command<GetIPSetCommandInput, GetIPSetCommandOutput, WAFV2ClientResolvedConfig> {
+    readonly input: GetIPSetCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: GetIPSetCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetIPSetCommandInput, GetIPSetCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}