@aws-sdk/client-wafv2 3.419.0 → 3.422.0

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

@@ -1,42 +1,114 @@
-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 {
-  DescribeManagedProductsByVendorRequest,
-  DescribeManagedProductsByVendorResponse,
-} from "../models/models_0";
-import {
-  ServiceInputTypes,
-  ServiceOutputTypes,
-  WAFV2ClientResolvedConfig,
-} from "../WAFV2Client";
-export { __MetadataBearer, $Command };
-export interface DescribeManagedProductsByVendorCommandInput
-  extends DescribeManagedProductsByVendorRequest {}
-export interface DescribeManagedProductsByVendorCommandOutput
-  extends DescribeManagedProductsByVendorResponse,
-    __MetadataBearer {}
-export declare class DescribeManagedProductsByVendorCommand extends $Command<
-  DescribeManagedProductsByVendorCommandInput,
-  DescribeManagedProductsByVendorCommandOutput,
-  WAFV2ClientResolvedConfig
-> {
-  readonly input: DescribeManagedProductsByVendorCommandInput;
-  static getEndpointParameterInstructions(): EndpointParameterInstructions;
-  constructor(input: DescribeManagedProductsByVendorCommandInput);
-  resolveMiddleware(
-    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
-    configuration: WAFV2ClientResolvedConfig,
-    options?: __HttpHandlerOptions
-  ): Handler<
-    DescribeManagedProductsByVendorCommandInput,
-    DescribeManagedProductsByVendorCommandOutput
-  >;
-  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 { DescribeManagedProductsByVendorRequest, DescribeManagedProductsByVendorResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, WAFV2ClientResolvedConfig } from "../WAFV2Client";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link DescribeManagedProductsByVendorCommand}.
+ */
+export interface DescribeManagedProductsByVendorCommandInput extends DescribeManagedProductsByVendorRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DescribeManagedProductsByVendorCommand}.
+ */
+export interface DescribeManagedProductsByVendorCommandOutput extends DescribeManagedProductsByVendorResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Provides high-level information for the managed rule groups owned by a specific vendor.  </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WAFV2Client, DescribeManagedProductsByVendorCommand } from "@aws-sdk/client-wafv2"; // ES Modules import
+ * // const { WAFV2Client, DescribeManagedProductsByVendorCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import
+ * const client = new WAFV2Client(config);
+ * const input = { // DescribeManagedProductsByVendorRequest
+ *   VendorName: "STRING_VALUE", // required
+ *   Scope: "CLOUDFRONT" || "REGIONAL", // required
+ * };
+ * const command = new DescribeManagedProductsByVendorCommand(input);
+ * const response = await client.send(command);
+ * // { // DescribeManagedProductsByVendorResponse
+ * //   ManagedProducts: [ // ManagedProductDescriptors
+ * //     { // ManagedProductDescriptor
+ * //       VendorName: "STRING_VALUE",
+ * //       ManagedRuleSetName: "STRING_VALUE",
+ * //       ProductId: "STRING_VALUE",
+ * //       ProductLink: "STRING_VALUE",
+ * //       ProductTitle: "STRING_VALUE",
+ * //       ProductDescription: "STRING_VALUE",
+ * //       SnsTopicArn: "STRING_VALUE",
+ * //       IsVersioningSupported: true || false,
+ * //       IsAdvancedManagedRuleSet: true || false,
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param DescribeManagedProductsByVendorCommandInput - {@link DescribeManagedProductsByVendorCommandInput}
+ * @returns {@link DescribeManagedProductsByVendorCommandOutput}
+ * @see {@link DescribeManagedProductsByVendorCommandInput} for command's `input` shape.
+ * @see {@link DescribeManagedProductsByVendorCommandOutput} 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 WAFV2ServiceException}
+ * <p>Base exception class for all service exceptions from WAFV2 service.</p>
+ *
+ */
+export declare class DescribeManagedProductsByVendorCommand extends $Command<DescribeManagedProductsByVendorCommandInput, DescribeManagedProductsByVendorCommandOutput, WAFV2ClientResolvedConfig> {
+    readonly input: DescribeManagedProductsByVendorCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: DescribeManagedProductsByVendorCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeManagedProductsByVendorCommandInput, DescribeManagedProductsByVendorCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -1,42 +1,191 @@
-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 {
-  DescribeManagedRuleGroupRequest,
-  DescribeManagedRuleGroupResponse,
-} from "../models/models_0";
-import {
-  ServiceInputTypes,
-  ServiceOutputTypes,
-  WAFV2ClientResolvedConfig,
-} from "../WAFV2Client";
-export { __MetadataBearer, $Command };
-export interface DescribeManagedRuleGroupCommandInput
-  extends DescribeManagedRuleGroupRequest {}
-export interface DescribeManagedRuleGroupCommandOutput
-  extends DescribeManagedRuleGroupResponse,
-    __MetadataBearer {}
-export declare class DescribeManagedRuleGroupCommand extends $Command<
-  DescribeManagedRuleGroupCommandInput,
-  DescribeManagedRuleGroupCommandOutput,
-  WAFV2ClientResolvedConfig
-> {
-  readonly input: DescribeManagedRuleGroupCommandInput;
-  static getEndpointParameterInstructions(): EndpointParameterInstructions;
-  constructor(input: DescribeManagedRuleGroupCommandInput);
-  resolveMiddleware(
-    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
-    configuration: WAFV2ClientResolvedConfig,
-    options?: __HttpHandlerOptions
-  ): Handler<
-    DescribeManagedRuleGroupCommandInput,
-    DescribeManagedRuleGroupCommandOutput
-  >;
-  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 { DescribeManagedRuleGroupRequest, DescribeManagedRuleGroupResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, WAFV2ClientResolvedConfig } from "../WAFV2Client";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link DescribeManagedRuleGroupCommand}.
+ */
+export interface DescribeManagedRuleGroupCommandInput extends DescribeManagedRuleGroupRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DescribeManagedRuleGroupCommand}.
+ */
+export interface DescribeManagedRuleGroupCommandOutput extends DescribeManagedRuleGroupResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Provides high-level information for a managed rule group, including descriptions of the rules. </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WAFV2Client, DescribeManagedRuleGroupCommand } from "@aws-sdk/client-wafv2"; // ES Modules import
+ * // const { WAFV2Client, DescribeManagedRuleGroupCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import
+ * const client = new WAFV2Client(config);
+ * const input = { // DescribeManagedRuleGroupRequest
+ *   VendorName: "STRING_VALUE", // required
+ *   Name: "STRING_VALUE", // required
+ *   Scope: "CLOUDFRONT" || "REGIONAL", // required
+ *   VersionName: "STRING_VALUE",
+ * };
+ * const command = new DescribeManagedRuleGroupCommand(input);
+ * const response = await client.send(command);
+ * // { // DescribeManagedRuleGroupResponse
+ * //   VersionName: "STRING_VALUE",
+ * //   SnsTopicArn: "STRING_VALUE",
+ * //   Capacity: Number("long"),
+ * //   Rules: [ // RuleSummaries
+ * //     { // RuleSummary
+ * //       Name: "STRING_VALUE",
+ * //       Action: { // RuleAction
+ * //         Block: { // BlockAction
+ * //           CustomResponse: { // CustomResponse
+ * //             ResponseCode: Number("int"), // required
+ * //             CustomResponseBodyKey: "STRING_VALUE",
+ * //             ResponseHeaders: [ // CustomHTTPHeaders
+ * //               { // CustomHTTPHeader
+ * //                 Name: "STRING_VALUE", // required
+ * //                 Value: "STRING_VALUE", // required
+ * //               },
+ * //             ],
+ * //           },
+ * //         },
+ * //         Allow: { // AllowAction
+ * //           CustomRequestHandling: { // CustomRequestHandling
+ * //             InsertHeaders: [ // required
+ * //               {
+ * //                 Name: "STRING_VALUE", // required
+ * //                 Value: "STRING_VALUE", // required
+ * //               },
+ * //             ],
+ * //           },
+ * //         },
+ * //         Count: { // CountAction
+ * //           CustomRequestHandling: {
+ * //             InsertHeaders: [ // required
+ * //               {
+ * //                 Name: "STRING_VALUE", // required
+ * //                 Value: "STRING_VALUE", // required
+ * //               },
+ * //             ],
+ * //           },
+ * //         },
+ * //         Captcha: { // CaptchaAction
+ * //           CustomRequestHandling: {
+ * //             InsertHeaders: [ // required
+ * //               {
+ * //                 Name: "STRING_VALUE", // required
+ * //                 Value: "STRING_VALUE", // required
+ * //               },
+ * //             ],
+ * //           },
+ * //         },
+ * //         Challenge: { // ChallengeAction
+ * //           CustomRequestHandling: {
+ * //             InsertHeaders: [ // required
+ * //               {
+ * //                 Name: "STRING_VALUE", // required
+ * //                 Value: "STRING_VALUE", // required
+ * //               },
+ * //             ],
+ * //           },
+ * //         },
+ * //       },
+ * //     },
+ * //   ],
+ * //   LabelNamespace: "STRING_VALUE",
+ * //   AvailableLabels: [ // LabelSummaries
+ * //     { // LabelSummary
+ * //       Name: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   ConsumedLabels: [
+ * //     {
+ * //       Name: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param DescribeManagedRuleGroupCommandInput - {@link DescribeManagedRuleGroupCommandInput}
+ * @returns {@link DescribeManagedRuleGroupCommandOutput}
+ * @see {@link DescribeManagedRuleGroupCommandInput} for command's `input` shape.
+ * @see {@link DescribeManagedRuleGroupCommandOutput} for command's `response` shape.
+ * @see {@link WAFV2ClientResolvedConfig | config} for WAFV2Client's `config` shape.
+ *
+ * @throws {@link WAFExpiredManagedRuleGroupVersionException} (client fault)
+ *  <p>The operation failed because the specified version for the managed rule group has
+ *          expired. You can retrieve the available versions for the managed rule group by calling
+ *             <a>ListAvailableManagedRuleGroupVersions</a>.</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 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 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 DescribeManagedRuleGroupCommand extends $Command<DescribeManagedRuleGroupCommandInput, DescribeManagedRuleGroupCommandOutput, WAFV2ClientResolvedConfig> {
+    readonly input: DescribeManagedRuleGroupCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: DescribeManagedRuleGroupCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeManagedRuleGroupCommandInput, DescribeManagedRuleGroupCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -1,39 +1,109 @@
-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 {
-  DisassociateWebACLRequest,
-  DisassociateWebACLResponse,
-} from "../models/models_0";
-import {
-  ServiceInputTypes,
-  ServiceOutputTypes,
-  WAFV2ClientResolvedConfig,
-} from "../WAFV2Client";
-export { __MetadataBearer, $Command };
-export interface DisassociateWebACLCommandInput
-  extends DisassociateWebACLRequest {}
-export interface DisassociateWebACLCommandOutput
-  extends DisassociateWebACLResponse,
-    __MetadataBearer {}
-export declare class DisassociateWebACLCommand extends $Command<
-  DisassociateWebACLCommandInput,
-  DisassociateWebACLCommandOutput,
-  WAFV2ClientResolvedConfig
-> {
-  readonly input: DisassociateWebACLCommandInput;
-  static getEndpointParameterInstructions(): EndpointParameterInstructions;
-  constructor(input: DisassociateWebACLCommandInput);
-  resolveMiddleware(
-    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
-    configuration: WAFV2ClientResolvedConfig,
-    options?: __HttpHandlerOptions
-  ): Handler<DisassociateWebACLCommandInput, DisassociateWebACLCommandOutput>;
-  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 { DisassociateWebACLRequest, DisassociateWebACLResponse } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, WAFV2ClientResolvedConfig } from "../WAFV2Client";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link DisassociateWebACLCommand}.
+ */
+export interface DisassociateWebACLCommandInput extends DisassociateWebACLRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DisassociateWebACLCommand}.
+ */
+export interface DisassociateWebACLCommandOutput extends DisassociateWebACLResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Disassociates the specified regional application resource from any existing web ACL
+ *          association. A resource can have at most one web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.  </p>
+ *          <p>For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To
+ *          disassociate a web ACL, provide an empty web ACL ID in the CloudFront call
+ *             <code>UpdateDistribution</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html">UpdateDistribution</a> in the <i>Amazon CloudFront API Reference</i>. </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WAFV2Client, DisassociateWebACLCommand } from "@aws-sdk/client-wafv2"; // ES Modules import
+ * // const { WAFV2Client, DisassociateWebACLCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import
+ * const client = new WAFV2Client(config);
+ * const input = { // DisassociateWebACLRequest
+ *   ResourceArn: "STRING_VALUE", // required
+ * };
+ * const command = new DisassociateWebACLCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param DisassociateWebACLCommandInput - {@link DisassociateWebACLCommandInput}
+ * @returns {@link DisassociateWebACLCommandOutput}
+ * @see {@link DisassociateWebACLCommandInput} for command's `input` shape.
+ * @see {@link DisassociateWebACLCommandOutput} 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 DisassociateWebACLCommand extends $Command<DisassociateWebACLCommandInput, DisassociateWebACLCommandOutput, WAFV2ClientResolvedConfig> {
+    readonly input: DisassociateWebACLCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: DisassociateWebACLCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisassociateWebACLCommandInput, DisassociateWebACLCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}