@aws-sdk/client-wafv2 3.422.0 → 3.423.0

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

@@ -1,133 +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 { PutManagedRuleSetVersionsRequest, PutManagedRuleSetVersionsResponse } from "../models/models_0";
-import { ServiceInputTypes, ServiceOutputTypes, WAFV2ClientResolvedConfig } from "../WAFV2Client";
-/**
- * @public
- */
-export { __MetadataBearer, $Command };
-/**
- * @public
- *
- * The input for {@link PutManagedRuleSetVersionsCommand}.
- */
-export interface PutManagedRuleSetVersionsCommandInput extends PutManagedRuleSetVersionsRequest {
-}
-/**
- * @public
- *
- * The output of {@link PutManagedRuleSetVersionsCommand}.
- */
-export interface PutManagedRuleSetVersionsCommandOutput extends PutManagedRuleSetVersionsResponse, __MetadataBearer {
-}
-/**
- * @public
- * <p>Defines the versions of your managed rule set that you are offering to the customers.
- *          Customers see your offerings as managed rule groups with versioning.</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>
- *          <p>Customers retrieve their managed rule group list by calling <a>ListAvailableManagedRuleGroups</a>. The name that you provide here for your
- *          managed rule set is the name the customer sees for the corresponding managed rule group.
- *          Customers can retrieve the available versions for a managed rule group by calling <a>ListAvailableManagedRuleGroupVersions</a>. You provide a rule group
- *          specification for each version. For each managed rule set, you must specify a version that
- *          you recommend using. </p>
- *          <p>To initiate the expiration of a managed rule group version, use <a>UpdateManagedRuleSetVersionExpiryDate</a>.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { WAFV2Client, PutManagedRuleSetVersionsCommand } from "@aws-sdk/client-wafv2"; // ES Modules import
- * // const { WAFV2Client, PutManagedRuleSetVersionsCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import
- * const client = new WAFV2Client(config);
- * const input = { // PutManagedRuleSetVersionsRequest
- *   Name: "STRING_VALUE", // required
- *   Scope: "CLOUDFRONT" || "REGIONAL", // required
- *   Id: "STRING_VALUE", // required
- *   LockToken: "STRING_VALUE", // required
- *   RecommendedVersion: "STRING_VALUE",
- *   VersionsToPublish: { // VersionsToPublish
- *     "<keys>": { // VersionToPublish
- *       AssociatedRuleGroupArn: "STRING_VALUE",
- *       ForecastedLifetime: Number("int"),
- *     },
- *   },
- * };
- * const command = new PutManagedRuleSetVersionsCommand(input);
- * const response = await client.send(command);
- * // { // PutManagedRuleSetVersionsResponse
- * //   NextLockToken: "STRING_VALUE",
- * // };
- *
- * ```
- *
- * @param PutManagedRuleSetVersionsCommandInput - {@link PutManagedRuleSetVersionsCommandInput}
- * @returns {@link PutManagedRuleSetVersionsCommandOutput}
- * @see {@link PutManagedRuleSetVersionsCommandInput} for command's `input` shape.
- * @see {@link PutManagedRuleSetVersionsCommandOutput} 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 PutManagedRuleSetVersionsCommand extends $Command<PutManagedRuleSetVersionsCommandInput, PutManagedRuleSetVersionsCommandOutput, WAFV2ClientResolvedConfig> {
-    readonly input: PutManagedRuleSetVersionsCommandInput;
-    static getEndpointParameterInstructions(): EndpointParameterInstructions;
-    /**
-     * @public
-     */
-    constructor(input: PutManagedRuleSetVersionsCommandInput);
-    /**
-     * @internal
-     */
-    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutManagedRuleSetVersionsCommandInput, PutManagedRuleSetVersionsCommandOutput>;
-    /**
-     * @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 {
+  PutManagedRuleSetVersionsRequest,
+  PutManagedRuleSetVersionsResponse,
+} from "../models/models_0";
+import {
+  ServiceInputTypes,
+  ServiceOutputTypes,
+  WAFV2ClientResolvedConfig,
+} from "../WAFV2Client";
+export { __MetadataBearer, $Command };
+export interface PutManagedRuleSetVersionsCommandInput
+  extends PutManagedRuleSetVersionsRequest {}
+export interface PutManagedRuleSetVersionsCommandOutput
+  extends PutManagedRuleSetVersionsResponse,
+    __MetadataBearer {}
+export declare class PutManagedRuleSetVersionsCommand extends $Command<
+  PutManagedRuleSetVersionsCommandInput,
+  PutManagedRuleSetVersionsCommandOutput,
+  WAFV2ClientResolvedConfig
+> {
+  readonly input: PutManagedRuleSetVersionsCommandInput;
+  static getEndpointParameterInstructions(): EndpointParameterInstructions;
+  constructor(input: PutManagedRuleSetVersionsCommandInput);
+  resolveMiddleware(
+    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
+    configuration: WAFV2ClientResolvedConfig,
+    options?: __HttpHandlerOptions
+  ): Handler<
+    PutManagedRuleSetVersionsCommandInput,
+    PutManagedRuleSetVersionsCommandOutput
+  >;
+  private serialize;
+  private deserialize;
+}

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

@@ -1,145 +1,39 @@
-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 { PutPermissionPolicyRequest, PutPermissionPolicyResponse } from "../models/models_0";
-import { ServiceInputTypes, ServiceOutputTypes, WAFV2ClientResolvedConfig } from "../WAFV2Client";
-/**
- * @public
- */
-export { __MetadataBearer, $Command };
-/**
- * @public
- *
- * The input for {@link PutPermissionPolicyCommand}.
- */
-export interface PutPermissionPolicyCommandInput extends PutPermissionPolicyRequest {
-}
-/**
- * @public
- *
- * The output of {@link PutPermissionPolicyCommand}.
- */
-export interface PutPermissionPolicyCommandOutput extends PutPermissionPolicyResponse, __MetadataBearer {
-}
-/**
- * @public
- * <p>Attaches an IAM policy to the specified resource. Use this to share a rule group across
- *          accounts.</p>
- *          <p>You must be the owner of the rule group to perform this operation.</p>
- *          <p>This action is subject to the following restrictions:</p>
- *          <ul>
- *             <li>
- *                <p>You can attach only one policy with each <code>PutPermissionPolicy</code>
- *                request.</p>
- *             </li>
- *             <li>
- *                <p>The ARN in the request must be a valid WAF <a>RuleGroup</a> ARN and the
- *                rule group must exist in the same Region.</p>
- *             </li>
- *             <li>
- *                <p>The user making the request must be the owner of the rule group.</p>
- *             </li>
- *          </ul>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { WAFV2Client, PutPermissionPolicyCommand } from "@aws-sdk/client-wafv2"; // ES Modules import
- * // const { WAFV2Client, PutPermissionPolicyCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import
- * const client = new WAFV2Client(config);
- * const input = { // PutPermissionPolicyRequest
- *   ResourceArn: "STRING_VALUE", // required
- *   Policy: "STRING_VALUE", // required
- * };
- * const command = new PutPermissionPolicyCommand(input);
- * const response = await client.send(command);
- * // {};
- *
- * ```
- *
- * @param PutPermissionPolicyCommandInput - {@link PutPermissionPolicyCommandInput}
- * @returns {@link PutPermissionPolicyCommandOutput}
- * @see {@link PutPermissionPolicyCommandInput} for command's `input` shape.
- * @see {@link PutPermissionPolicyCommandOutput} 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 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 WAFInvalidPermissionPolicyException} (client fault)
- *  <p>The operation failed because the specified policy isn't in the proper format. </p>
- *          <p>The policy specifications must conform to the following:</p>
- *          <ul>
- *             <li>
- *                <p>The policy must be composed using IAM Policy version 2012-10-17.</p>
- *             </li>
- *             <li>
- *                <p>The policy must include specifications for <code>Effect</code>, <code>Action</code>, and <code>Principal</code>.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <code>Effect</code> must specify <code>Allow</code>.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <code>Action</code> must specify <code>wafv2:CreateWebACL</code>, <code>wafv2:UpdateWebACL</code>, and
- *              <code>wafv2:PutFirewallManagerRuleGroups</code> and may optionally specify <code>wafv2:GetRuleGroup</code>.
- *                  WAF rejects any extra actions or wildcard actions in the policy.</p>
- *             </li>
- *             <li>
- *                <p>The policy must not include a <code>Resource</code> parameter.</p>
- *             </li>
- *          </ul>
- *          <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html">IAM Policies</a>.  </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 PutPermissionPolicyCommand extends $Command<PutPermissionPolicyCommandInput, PutPermissionPolicyCommandOutput, WAFV2ClientResolvedConfig> {
-    readonly input: PutPermissionPolicyCommandInput;
-    static getEndpointParameterInstructions(): EndpointParameterInstructions;
-    /**
-     * @public
-     */
-    constructor(input: PutPermissionPolicyCommandInput);
-    /**
-     * @internal
-     */
-    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutPermissionPolicyCommandInput, PutPermissionPolicyCommandOutput>;
-    /**
-     * @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 {
+  PutPermissionPolicyRequest,
+  PutPermissionPolicyResponse,
+} from "../models/models_0";
+import {
+  ServiceInputTypes,
+  ServiceOutputTypes,
+  WAFV2ClientResolvedConfig,
+} from "../WAFV2Client";
+export { __MetadataBearer, $Command };
+export interface PutPermissionPolicyCommandInput
+  extends PutPermissionPolicyRequest {}
+export interface PutPermissionPolicyCommandOutput
+  extends PutPermissionPolicyResponse,
+    __MetadataBearer {}
+export declare class PutPermissionPolicyCommand extends $Command<
+  PutPermissionPolicyCommandInput,
+  PutPermissionPolicyCommandOutput,
+  WAFV2ClientResolvedConfig
+> {
+  readonly input: PutPermissionPolicyCommandInput;
+  static getEndpointParameterInstructions(): EndpointParameterInstructions;
+  constructor(input: PutPermissionPolicyCommandInput);
+  resolveMiddleware(
+    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
+    configuration: WAFV2ClientResolvedConfig,
+    options?: __HttpHandlerOptions
+  ): Handler<PutPermissionPolicyCommandInput, PutPermissionPolicyCommandOutput>;
+  private serialize;
+  private deserialize;
+}

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

@@ -1,131 +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 { TagResourceRequest, TagResourceResponse } from "../models/models_0";
-import { ServiceInputTypes, ServiceOutputTypes, WAFV2ClientResolvedConfig } from "../WAFV2Client";
-/**
- * @public
- */
-export { __MetadataBearer, $Command };
-/**
- * @public
- *
- * The input for {@link TagResourceCommand}.
- */
-export interface TagResourceCommandInput extends TagResourceRequest {
-}
-/**
- * @public
- *
- * The output of {@link TagResourceCommand}.
- */
-export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
-}
-/**
- * @public
- * <p>Associates tags with the specified Amazon Web Services resource. Tags are key:value pairs that you can
- *          use to categorize and manage your resources, for purposes like billing. For example, you
- *          might set the tag key to "customer" and the value to the customer name or ID. You can
- *          specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a
- *          resource.</p>
- *          <p>You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule
- *          groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF
- *          console. </p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { WAFV2Client, TagResourceCommand } from "@aws-sdk/client-wafv2"; // ES Modules import
- * // const { WAFV2Client, TagResourceCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import
- * const client = new WAFV2Client(config);
- * const input = { // TagResourceRequest
- *   ResourceARN: "STRING_VALUE", // required
- *   Tags: [ // TagList // required
- *     { // Tag
- *       Key: "STRING_VALUE", // required
- *       Value: "STRING_VALUE", // required
- *     },
- *   ],
- * };
- * const command = new TagResourceCommand(input);
- * const response = await client.send(command);
- * // {};
- *
- * ```
- *
- * @param TagResourceCommandInput - {@link TagResourceCommandInput}
- * @returns {@link TagResourceCommandOutput}
- * @see {@link TagResourceCommandInput} for command's `input` shape.
- * @see {@link TagResourceCommandOutput} 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 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 TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, WAFV2ClientResolvedConfig> {
-    readonly input: TagResourceCommandInput;
-    static getEndpointParameterInstructions(): EndpointParameterInstructions;
-    /**
-     * @public
-     */
-    constructor(input: TagResourceCommandInput);
-    /**
-     * @internal
-     */
-    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
-    /**
-     * @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 { TagResourceRequest, TagResourceResponse } from "../models/models_0";
+import {
+  ServiceInputTypes,
+  ServiceOutputTypes,
+  WAFV2ClientResolvedConfig,
+} from "../WAFV2Client";
+export { __MetadataBearer, $Command };
+export interface TagResourceCommandInput extends TagResourceRequest {}
+export interface TagResourceCommandOutput
+  extends TagResourceResponse,
+    __MetadataBearer {}
+export declare class TagResourceCommand extends $Command<
+  TagResourceCommandInput,
+  TagResourceCommandOutput,
+  WAFV2ClientResolvedConfig
+> {
+  readonly input: TagResourceCommandInput;
+  static getEndpointParameterInstructions(): EndpointParameterInstructions;
+  constructor(input: TagResourceCommandInput);
+  resolveMiddleware(
+    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
+    configuration: WAFV2ClientResolvedConfig,
+    options?: __HttpHandlerOptions
+  ): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+  private serialize;
+  private deserialize;
+}