@aws-sdk/client-wafv2 3.422.0 → 3.425.0

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

@@ -1,118 +1,38 @@
-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 { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
-import { ServiceInputTypes, ServiceOutputTypes, WAFV2ClientResolvedConfig } from "../WAFV2Client";
-/**
- * @public
- */
-export { __MetadataBearer, $Command };
-/**
- * @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
- *          can add up to 50 tags to each Amazon Web Services resource.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { WAFV2Client, UntagResourceCommand } from "@aws-sdk/client-wafv2"; // ES Modules import
- * // const { WAFV2Client, UntagResourceCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import
- * const client = new WAFV2Client(config);
- * const input = { // UntagResourceRequest
- *   ResourceARN: "STRING_VALUE", // required
- *   TagKeys: [ // TagKeyList // required
- *     "STRING_VALUE",
- *   ],
- * };
- * const command = new UntagResourceCommand(input);
- * 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.
- *
- * @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 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 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;
-}
+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 {
+  UntagResourceRequest,
+  UntagResourceResponse,
+} from "../models/models_0";
+import {
+  ServiceInputTypes,
+  ServiceOutputTypes,
+  WAFV2ClientResolvedConfig,
+} from "../WAFV2Client";
+export { __MetadataBearer, $Command };
+export interface UntagResourceCommandInput extends UntagResourceRequest {}
+export interface UntagResourceCommandOutput
+  extends UntagResourceResponse,
+    __MetadataBearer {}
+export declare class UntagResourceCommand extends $Command<
+  UntagResourceCommandInput,
+  UntagResourceCommandOutput,
+  WAFV2ClientResolvedConfig
+> {
+  readonly input: UntagResourceCommandInput;
+  static getEndpointParameterInstructions(): EndpointParameterInstructions;
+  constructor(input: UntagResourceCommandInput);
+  resolveMiddleware(
+    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
+    configuration: WAFV2ClientResolvedConfig,
+    options?: __HttpHandlerOptions
+  ): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+  private serialize;
+  private deserialize;
+}

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

@@ -1,146 +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 { UpdateIPSetRequest, UpdateIPSetResponse } from "../models/models_0";
-import { ServiceInputTypes, ServiceOutputTypes, WAFV2ClientResolvedConfig } from "../WAFV2Client";
-/**
- * @public
- */
-export { __MetadataBearer, $Command };
-/**
- * @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>
- *             <p>To modify an IP set, do the following: </p>
- *             <ol>
- *                <li>
- *                   <p>Retrieve it by calling <a>GetIPSet</a>
- *                   </p>
- *                </li>
- *                <li>
- *                   <p>Update its settings as needed</p>
- *                </li>
- *                <li>
- *                   <p>Provide the complete IP set specification to this call</p>
- *                </li>
- *             </ol>
- *          </note>
- *          <p>When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { WAFV2Client, UpdateIPSetCommand } from "@aws-sdk/client-wafv2"; // ES Modules import
- * // const { WAFV2Client, UpdateIPSetCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import
- * const client = new WAFV2Client(config);
- * const input = { // UpdateIPSetRequest
- *   Name: "STRING_VALUE", // required
- *   Scope: "CLOUDFRONT" || "REGIONAL", // required
- *   Id: "STRING_VALUE", // required
- *   Description: "STRING_VALUE",
- *   Addresses: [ // IPAddresses // required
- *     "STRING_VALUE",
- *   ],
- *   LockToken: "STRING_VALUE", // required
- * };
- * const command = new UpdateIPSetCommand(input);
- * const response = await client.send(command);
- * // { // UpdateIPSetResponse
- * //   NextLockToken: "STRING_VALUE",
- * // };
- *
- * ```
- *
- * @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.
- *
- * @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 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 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 WAFV2ServiceException}
- * <p>Base exception class for all service exceptions from WAFV2 service.</p>
- *
- */
-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;
-}
+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 { UpdateIPSetRequest, UpdateIPSetResponse } from "../models/models_0";
+import {
+  ServiceInputTypes,
+  ServiceOutputTypes,
+  WAFV2ClientResolvedConfig,
+} from "../WAFV2Client";
+export { __MetadataBearer, $Command };
+export interface UpdateIPSetCommandInput extends UpdateIPSetRequest {}
+export interface UpdateIPSetCommandOutput
+  extends UpdateIPSetResponse,
+    __MetadataBearer {}
+export declare class UpdateIPSetCommand extends $Command<
+  UpdateIPSetCommandInput,
+  UpdateIPSetCommandOutput,
+  WAFV2ClientResolvedConfig
+> {
+  readonly input: UpdateIPSetCommandInput;
+  static getEndpointParameterInstructions(): EndpointParameterInstructions;
+  constructor(input: UpdateIPSetCommandInput);
+  resolveMiddleware(
+    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
+    configuration: WAFV2ClientResolvedConfig,
+    options?: __HttpHandlerOptions
+  ): Handler<UpdateIPSetCommandInput, UpdateIPSetCommandOutput>;
+  private serialize;
+  private deserialize;
+}

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

@@ -1,125 +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 { UpdateManagedRuleSetVersionExpiryDateRequest, UpdateManagedRuleSetVersionExpiryDateResponse } from "../models/models_0";
-import { ServiceInputTypes, ServiceOutputTypes, WAFV2ClientResolvedConfig } from "../WAFV2Client";
-/**
- * @public
- */
-export { __MetadataBearer, $Command };
-/**
- * @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>
- *          <note>
- *             <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. </p>
- *             <p>Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are <code>ListManagedRuleSets</code>, <code>GetManagedRuleSet</code>, <code>PutManagedRuleSetVersions</code>, and <code>UpdateManagedRuleSetVersionExpiryDate</code>.</p>
- *          </note>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { WAFV2Client, UpdateManagedRuleSetVersionExpiryDateCommand } from "@aws-sdk/client-wafv2"; // ES Modules import
- * // const { WAFV2Client, UpdateManagedRuleSetVersionExpiryDateCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import
- * const client = new WAFV2Client(config);
- * const input = { // UpdateManagedRuleSetVersionExpiryDateRequest
- *   Name: "STRING_VALUE", // required
- *   Scope: "CLOUDFRONT" || "REGIONAL", // required
- *   Id: "STRING_VALUE", // required
- *   LockToken: "STRING_VALUE", // required
- *   VersionToExpire: "STRING_VALUE", // required
- *   ExpiryTimestamp: new Date("TIMESTAMP"), // required
- * };
- * const command = new UpdateManagedRuleSetVersionExpiryDateCommand(input);
- * const response = await client.send(command);
- * // { // UpdateManagedRuleSetVersionExpiryDateResponse
- * //   ExpiringVersion: "STRING_VALUE",
- * //   ExpiryTimestamp: new Date("TIMESTAMP"),
- * //   NextLockToken: "STRING_VALUE",
- * // };
- *
- * ```
- *
- * @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.
- *
- * @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 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 WAFV2ServiceException}
- * <p>Base exception class for all service exceptions from WAFV2 service.</p>
- *
- */
-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;
-}
+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 {
+  UpdateManagedRuleSetVersionExpiryDateRequest,
+  UpdateManagedRuleSetVersionExpiryDateResponse,
+} from "../models/models_0";
+import {
+  ServiceInputTypes,
+  ServiceOutputTypes,
+  WAFV2ClientResolvedConfig,
+} from "../WAFV2Client";
+export { __MetadataBearer, $Command };
+export interface UpdateManagedRuleSetVersionExpiryDateCommandInput
+  extends UpdateManagedRuleSetVersionExpiryDateRequest {}
+export interface UpdateManagedRuleSetVersionExpiryDateCommandOutput
+  extends UpdateManagedRuleSetVersionExpiryDateResponse,
+    __MetadataBearer {}
+export declare class UpdateManagedRuleSetVersionExpiryDateCommand extends $Command<
+  UpdateManagedRuleSetVersionExpiryDateCommandInput,
+  UpdateManagedRuleSetVersionExpiryDateCommandOutput,
+  WAFV2ClientResolvedConfig
+> {
+  readonly input: UpdateManagedRuleSetVersionExpiryDateCommandInput;
+  static getEndpointParameterInstructions(): EndpointParameterInstructions;
+  constructor(input: UpdateManagedRuleSetVersionExpiryDateCommandInput);
+  resolveMiddleware(
+    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
+    configuration: WAFV2ClientResolvedConfig,
+    options?: __HttpHandlerOptions
+  ): Handler<
+    UpdateManagedRuleSetVersionExpiryDateCommandInput,
+    UpdateManagedRuleSetVersionExpiryDateCommandOutput
+  >;
+  private serialize;
+  private deserialize;
+}