@aws-sdk/client-wafv2 3.421.0 → 3.422.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (72) hide show
  1. package/dist-types/models/models_0.d.ts +26 -6
  2. package/dist-types/ts3.4/WAFV2.d.ts +438 -918
  3. package/dist-types/ts3.4/WAFV2Client.d.ts +277 -436
  4. package/dist-types/ts3.4/commands/AssociateWebACLCommand.d.ts +118 -38
  5. package/dist-types/ts3.4/commands/CheckCapacityCommand.d.ts +1093 -38
  6. package/dist-types/ts3.4/commands/CreateAPIKeyCommand.d.ts +115 -35
  7. package/dist-types/ts3.4/commands/CreateIPSetCommand.d.ts +144 -35
  8. package/dist-types/ts3.4/commands/CreateRegexPatternSetCommand.d.ts +143 -42
  9. package/dist-types/ts3.4/commands/CreateRuleGroupCommand.d.ts +1116 -38
  10. package/dist-types/ts3.4/commands/CreateWebACLCommand.d.ts +1145 -35
  11. package/dist-types/ts3.4/commands/DeleteFirewallManagerRuleGroupsCommand.d.ts +115 -42
  12. package/dist-types/ts3.4/commands/DeleteIPSetCommand.d.ts +124 -35
  13. package/dist-types/ts3.4/commands/DeleteLoggingConfigurationCommand.d.ts +110 -42
  14. package/dist-types/ts3.4/commands/DeletePermissionPolicyCommand.d.ts +103 -42
  15. package/dist-types/ts3.4/commands/DeleteRegexPatternSetCommand.d.ts +124 -42
  16. package/dist-types/ts3.4/commands/DeleteRuleGroupCommand.d.ts +124 -38
  17. package/dist-types/ts3.4/commands/DeleteWebACLCommand.d.ts +158 -35
  18. package/dist-types/ts3.4/commands/DescribeAllManagedProductsCommand.d.ts +92 -42
  19. package/dist-types/ts3.4/commands/DescribeManagedProductsByVendorCommand.d.ts +114 -42
  20. package/dist-types/ts3.4/commands/DescribeManagedRuleGroupCommand.d.ts +191 -42
  21. package/dist-types/ts3.4/commands/DisassociateWebACLCommand.d.ts +109 -39
  22. package/dist-types/ts3.4/commands/GenerateMobileSdkReleaseUrlCommand.d.ts +110 -42
  23. package/dist-types/ts3.4/commands/GetDecryptedAPIKeyCommand.d.ts +112 -39
  24. package/dist-types/ts3.4/commands/GetIPSetCommand.d.ts +119 -35
  25. package/dist-types/ts3.4/commands/GetLoggingConfigurationCommand.d.ts +192 -42
  26. package/dist-types/ts3.4/commands/GetManagedRuleSetCommand.d.ts +131 -39
  27. package/dist-types/ts3.4/commands/GetMobileSdkReleaseCommand.d.ts +121 -39
  28. package/dist-types/ts3.4/commands/GetPermissionPolicyCommand.d.ts +105 -39
  29. package/dist-types/ts3.4/commands/GetRateBasedStatementManagedKeysCommand.d.ts +142 -42
  30. package/dist-types/ts3.4/commands/GetRegexPatternSetCommand.d.ts +120 -39
  31. package/dist-types/ts3.4/commands/GetRuleGroupCommand.d.ts +1088 -35
  32. package/dist-types/ts3.4/commands/GetSampledRequestsCommand.d.ts +168 -39
  33. package/dist-types/ts3.4/commands/GetWebACLCommand.d.ts +1283 -35
  34. package/dist-types/ts3.4/commands/GetWebACLForResourceCommand.d.ts +1286 -42
  35. package/dist-types/ts3.4/commands/ListAPIKeysCommand.d.ts +121 -35
  36. package/dist-types/ts3.4/commands/ListAvailableManagedRuleGroupVersionsCommand.d.ts +118 -42
  37. package/dist-types/ts3.4/commands/ListAvailableManagedRuleGroupsCommand.d.ts +113 -42
  38. package/dist-types/ts3.4/commands/ListIPSetsCommand.d.ts +113 -35
  39. package/dist-types/ts3.4/commands/ListLoggingConfigurationsCommand.d.ts +191 -42
  40. package/dist-types/ts3.4/commands/ListManagedRuleSetsCommand.d.ts +117 -39
  41. package/dist-types/ts3.4/commands/ListMobileSdkReleasesCommand.d.ts +112 -42
  42. package/dist-types/ts3.4/commands/ListRegexPatternSetsCommand.d.ts +113 -42
  43. package/dist-types/ts3.4/commands/ListResourcesForWebACLCommand.d.ts +112 -42
  44. package/dist-types/ts3.4/commands/ListRuleGroupsCommand.d.ts +113 -38
  45. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +132 -39
  46. package/dist-types/ts3.4/commands/ListWebACLsCommand.d.ts +113 -35
  47. package/dist-types/ts3.4/commands/PutLoggingConfigurationCommand.d.ts +345 -42
  48. package/dist-types/ts3.4/commands/PutManagedRuleSetVersionsCommand.d.ts +133 -42
  49. package/dist-types/ts3.4/commands/PutPermissionPolicyCommand.d.ts +145 -39
  50. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +131 -35
  51. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +118 -38
  52. package/dist-types/ts3.4/commands/UpdateIPSetCommand.d.ts +146 -35
  53. package/dist-types/ts3.4/commands/UpdateManagedRuleSetVersionExpiryDateCommand.d.ts +125 -42
  54. package/dist-types/ts3.4/commands/UpdateRegexPatternSetCommand.d.ts +148 -42
  55. package/dist-types/ts3.4/commands/UpdateRuleGroupCommand.d.ts +1128 -38
  56. package/dist-types/ts3.4/commands/UpdateWebACLCommand.d.ts +1146 -35
  57. package/dist-types/ts3.4/commands/index.d.ts +53 -53
  58. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +22 -33
  59. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +5 -8
  60. package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -2
  61. package/dist-types/ts3.4/extensionConfiguration.d.ts +8 -7
  62. package/dist-types/ts3.4/index.d.ts +68 -6
  63. package/dist-types/ts3.4/models/WAFV2ServiceException.d.ts +13 -8
  64. package/dist-types/ts3.4/models/index.d.ts +1 -1
  65. package/dist-types/ts3.4/models/models_0.d.ts +7951 -1764
  66. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +479 -641
  67. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +46 -97
  68. package/dist-types/ts3.4/runtimeConfig.d.ts +46 -97
  69. package/dist-types/ts3.4/runtimeConfig.native.d.ts +45 -88
  70. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +19 -19
  71. package/dist-types/ts3.4/runtimeExtensions.d.ts +17 -11
  72. package/package.json +1 -1
@@ -1,38 +1,118 @@
1
- import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
- import { Command as $Command } from "@smithy/smithy-client";
3
- import {
4
- Handler,
5
- HttpHandlerOptions as __HttpHandlerOptions,
6
- MetadataBearer as __MetadataBearer,
7
- MiddlewareStack,
8
- } from "@smithy/types";
9
- import {
10
- UntagResourceRequest,
11
- UntagResourceResponse,
12
- } from "../models/models_0";
13
- import {
14
- ServiceInputTypes,
15
- ServiceOutputTypes,
16
- WAFV2ClientResolvedConfig,
17
- } from "../WAFV2Client";
18
- export { __MetadataBearer, $Command };
19
- export interface UntagResourceCommandInput extends UntagResourceRequest {}
20
- export interface UntagResourceCommandOutput
21
- extends UntagResourceResponse,
22
- __MetadataBearer {}
23
- export declare class UntagResourceCommand extends $Command<
24
- UntagResourceCommandInput,
25
- UntagResourceCommandOutput,
26
- WAFV2ClientResolvedConfig
27
- > {
28
- readonly input: UntagResourceCommandInput;
29
- static getEndpointParameterInstructions(): EndpointParameterInstructions;
30
- constructor(input: UntagResourceCommandInput);
31
- resolveMiddleware(
32
- clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
33
- configuration: WAFV2ClientResolvedConfig,
34
- options?: __HttpHandlerOptions
35
- ): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
36
- private serialize;
37
- private deserialize;
38
- }
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
5
+ import { ServiceInputTypes, ServiceOutputTypes, WAFV2ClientResolvedConfig } from "../WAFV2Client";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link UntagResourceCommand}.
14
+ */
15
+ export interface UntagResourceCommandInput extends UntagResourceRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link UntagResourceCommand}.
21
+ */
22
+ export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can
27
+ * associate with Amazon Web Services resources. For example, the tag key might be "customer" and the tag
28
+ * value might be "companyA." You can specify one or more tags to add to each container. You
29
+ * can add up to 50 tags to each Amazon Web Services resource.</p>
30
+ * @example
31
+ * Use a bare-bones client and the command you need to make an API call.
32
+ * ```javascript
33
+ * import { WAFV2Client, UntagResourceCommand } from "@aws-sdk/client-wafv2"; // ES Modules import
34
+ * // const { WAFV2Client, UntagResourceCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import
35
+ * const client = new WAFV2Client(config);
36
+ * const input = { // UntagResourceRequest
37
+ * ResourceARN: "STRING_VALUE", // required
38
+ * TagKeys: [ // TagKeyList // required
39
+ * "STRING_VALUE",
40
+ * ],
41
+ * };
42
+ * const command = new UntagResourceCommand(input);
43
+ * const response = await client.send(command);
44
+ * // {};
45
+ *
46
+ * ```
47
+ *
48
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
49
+ * @returns {@link UntagResourceCommandOutput}
50
+ * @see {@link UntagResourceCommandInput} for command's `input` shape.
51
+ * @see {@link UntagResourceCommandOutput} for command's `response` shape.
52
+ * @see {@link WAFV2ClientResolvedConfig | config} for WAFV2Client's `config` shape.
53
+ *
54
+ * @throws {@link WAFInternalErrorException} (server fault)
55
+ * <p>Your request is valid, but WAF couldn’t perform the operation because of a system
56
+ * problem. Retry your request. </p>
57
+ *
58
+ * @throws {@link WAFInvalidOperationException} (client fault)
59
+ * <p>The operation isn't valid. </p>
60
+ *
61
+ * @throws {@link WAFInvalidParameterException} (client fault)
62
+ * <p>The operation failed because WAF didn't recognize a parameter in the request. For
63
+ * example: </p>
64
+ * <ul>
65
+ * <li>
66
+ * <p>You specified a parameter name or value that isn't valid.</p>
67
+ * </li>
68
+ * <li>
69
+ * <p>Your nested statement isn't valid. You might have tried to nest a statement that
70
+ * can’t be nested. </p>
71
+ * </li>
72
+ * <li>
73
+ * <p>You tried to update a <code>WebACL</code> with a <code>DefaultAction</code> that
74
+ * isn't among the types available at <a>DefaultAction</a>.</p>
75
+ * </li>
76
+ * <li>
77
+ * <p>Your request references an ARN that is malformed, or corresponds to a resource
78
+ * with which a web ACL can't be associated.</p>
79
+ * </li>
80
+ * </ul>
81
+ *
82
+ * @throws {@link WAFNonexistentItemException} (client fault)
83
+ * <p>WAF couldn’t perform the operation because your resource doesn't exist.
84
+ * If you've just created a resource that you're using in this operation, you might
85
+ * just need to wait a few minutes. It can take from a few seconds to a number of minutes
86
+ * for changes to propagate. </p>
87
+ *
88
+ * @throws {@link WAFTagOperationException} (client fault)
89
+ * <p>An error occurred during the tagging operation. Retry your request.</p>
90
+ *
91
+ * @throws {@link WAFTagOperationInternalErrorException} (server fault)
92
+ * <p>WAF couldn’t perform your tagging operation because of an internal error. Retry
93
+ * your request.</p>
94
+ *
95
+ * @throws {@link WAFV2ServiceException}
96
+ * <p>Base exception class for all service exceptions from WAFV2 service.</p>
97
+ *
98
+ */
99
+ export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, WAFV2ClientResolvedConfig> {
100
+ readonly input: UntagResourceCommandInput;
101
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
102
+ /**
103
+ * @public
104
+ */
105
+ constructor(input: UntagResourceCommandInput);
106
+ /**
107
+ * @internal
108
+ */
109
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
110
+ /**
111
+ * @internal
112
+ */
113
+ private serialize;
114
+ /**
115
+ * @internal
116
+ */
117
+ private deserialize;
118
+ }
@@ -1,35 +1,146 @@
1
- import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
- import { Command as $Command } from "@smithy/smithy-client";
3
- import {
4
- Handler,
5
- HttpHandlerOptions as __HttpHandlerOptions,
6
- MetadataBearer as __MetadataBearer,
7
- MiddlewareStack,
8
- } from "@smithy/types";
9
- import { UpdateIPSetRequest, UpdateIPSetResponse } from "../models/models_0";
10
- import {
11
- ServiceInputTypes,
12
- ServiceOutputTypes,
13
- WAFV2ClientResolvedConfig,
14
- } from "../WAFV2Client";
15
- export { __MetadataBearer, $Command };
16
- export interface UpdateIPSetCommandInput extends UpdateIPSetRequest {}
17
- export interface UpdateIPSetCommandOutput
18
- extends UpdateIPSetResponse,
19
- __MetadataBearer {}
20
- export declare class UpdateIPSetCommand extends $Command<
21
- UpdateIPSetCommandInput,
22
- UpdateIPSetCommandOutput,
23
- WAFV2ClientResolvedConfig
24
- > {
25
- readonly input: UpdateIPSetCommandInput;
26
- static getEndpointParameterInstructions(): EndpointParameterInstructions;
27
- constructor(input: UpdateIPSetCommandInput);
28
- resolveMiddleware(
29
- clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
30
- configuration: WAFV2ClientResolvedConfig,
31
- options?: __HttpHandlerOptions
32
- ): Handler<UpdateIPSetCommandInput, UpdateIPSetCommandOutput>;
33
- private serialize;
34
- private deserialize;
35
- }
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { UpdateIPSetRequest, UpdateIPSetResponse } from "../models/models_0";
5
+ import { ServiceInputTypes, ServiceOutputTypes, WAFV2ClientResolvedConfig } from "../WAFV2Client";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link UpdateIPSetCommand}.
14
+ */
15
+ export interface UpdateIPSetCommandInput extends UpdateIPSetRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link UpdateIPSetCommand}.
21
+ */
22
+ export interface UpdateIPSetCommandOutput extends UpdateIPSetResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Updates the specified <a>IPSet</a>. </p>
27
+ * <note>
28
+ * <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>
29
+ * <p>To modify an IP set, do the following: </p>
30
+ * <ol>
31
+ * <li>
32
+ * <p>Retrieve it by calling <a>GetIPSet</a>
33
+ * </p>
34
+ * </li>
35
+ * <li>
36
+ * <p>Update its settings as needed</p>
37
+ * </li>
38
+ * <li>
39
+ * <p>Provide the complete IP set specification to this call</p>
40
+ * </li>
41
+ * </ol>
42
+ * </note>
43
+ * <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>
44
+ * @example
45
+ * Use a bare-bones client and the command you need to make an API call.
46
+ * ```javascript
47
+ * import { WAFV2Client, UpdateIPSetCommand } from "@aws-sdk/client-wafv2"; // ES Modules import
48
+ * // const { WAFV2Client, UpdateIPSetCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import
49
+ * const client = new WAFV2Client(config);
50
+ * const input = { // UpdateIPSetRequest
51
+ * Name: "STRING_VALUE", // required
52
+ * Scope: "CLOUDFRONT" || "REGIONAL", // required
53
+ * Id: "STRING_VALUE", // required
54
+ * Description: "STRING_VALUE",
55
+ * Addresses: [ // IPAddresses // required
56
+ * "STRING_VALUE",
57
+ * ],
58
+ * LockToken: "STRING_VALUE", // required
59
+ * };
60
+ * const command = new UpdateIPSetCommand(input);
61
+ * const response = await client.send(command);
62
+ * // { // UpdateIPSetResponse
63
+ * // NextLockToken: "STRING_VALUE",
64
+ * // };
65
+ *
66
+ * ```
67
+ *
68
+ * @param UpdateIPSetCommandInput - {@link UpdateIPSetCommandInput}
69
+ * @returns {@link UpdateIPSetCommandOutput}
70
+ * @see {@link UpdateIPSetCommandInput} for command's `input` shape.
71
+ * @see {@link UpdateIPSetCommandOutput} for command's `response` shape.
72
+ * @see {@link WAFV2ClientResolvedConfig | config} for WAFV2Client's `config` shape.
73
+ *
74
+ * @throws {@link WAFDuplicateItemException} (client fault)
75
+ * <p>WAF couldn’t perform the operation because the resource that you tried to save is
76
+ * a duplicate of an existing one.</p>
77
+ *
78
+ * @throws {@link WAFInternalErrorException} (server fault)
79
+ * <p>Your request is valid, but WAF couldn’t perform the operation because of a system
80
+ * problem. Retry your request. </p>
81
+ *
82
+ * @throws {@link WAFInvalidOperationException} (client fault)
83
+ * <p>The operation isn't valid. </p>
84
+ *
85
+ * @throws {@link WAFInvalidParameterException} (client fault)
86
+ * <p>The operation failed because WAF didn't recognize a parameter in the request. For
87
+ * example: </p>
88
+ * <ul>
89
+ * <li>
90
+ * <p>You specified a parameter name or value that isn't valid.</p>
91
+ * </li>
92
+ * <li>
93
+ * <p>Your nested statement isn't valid. You might have tried to nest a statement that
94
+ * can’t be nested. </p>
95
+ * </li>
96
+ * <li>
97
+ * <p>You tried to update a <code>WebACL</code> with a <code>DefaultAction</code> that
98
+ * isn't among the types available at <a>DefaultAction</a>.</p>
99
+ * </li>
100
+ * <li>
101
+ * <p>Your request references an ARN that is malformed, or corresponds to a resource
102
+ * with which a web ACL can't be associated.</p>
103
+ * </li>
104
+ * </ul>
105
+ *
106
+ * @throws {@link WAFLimitsExceededException} (client fault)
107
+ * <p>WAF couldn’t perform the operation because you exceeded your resource limit. For
108
+ * example, the maximum number of <code>WebACL</code> objects that you can create for an Amazon Web Services
109
+ * account. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/limits.html">WAF quotas</a> in the
110
+ * <i>WAF Developer Guide</i>.</p>
111
+ *
112
+ * @throws {@link WAFNonexistentItemException} (client fault)
113
+ * <p>WAF couldn’t perform the operation because your resource doesn't exist.
114
+ * If you've just created a resource that you're using in this operation, you might
115
+ * just need to wait a few minutes. It can take from a few seconds to a number of minutes
116
+ * for changes to propagate. </p>
117
+ *
118
+ * @throws {@link WAFOptimisticLockException} (client fault)
119
+ * <p>WAF couldn’t save your changes because you tried to update or delete a resource
120
+ * that has changed since you last retrieved it. Get the resource again, make any changes you
121
+ * need to make to the new copy, and retry your operation. </p>
122
+ *
123
+ * @throws {@link WAFV2ServiceException}
124
+ * <p>Base exception class for all service exceptions from WAFV2 service.</p>
125
+ *
126
+ */
127
+ export declare class UpdateIPSetCommand extends $Command<UpdateIPSetCommandInput, UpdateIPSetCommandOutput, WAFV2ClientResolvedConfig> {
128
+ readonly input: UpdateIPSetCommandInput;
129
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
130
+ /**
131
+ * @public
132
+ */
133
+ constructor(input: UpdateIPSetCommandInput);
134
+ /**
135
+ * @internal
136
+ */
137
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateIPSetCommandInput, UpdateIPSetCommandOutput>;
138
+ /**
139
+ * @internal
140
+ */
141
+ private serialize;
142
+ /**
143
+ * @internal
144
+ */
145
+ private deserialize;
146
+ }
@@ -1,42 +1,125 @@
1
- import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
- import { Command as $Command } from "@smithy/smithy-client";
3
- import {
4
- Handler,
5
- HttpHandlerOptions as __HttpHandlerOptions,
6
- MetadataBearer as __MetadataBearer,
7
- MiddlewareStack,
8
- } from "@smithy/types";
9
- import {
10
- UpdateManagedRuleSetVersionExpiryDateRequest,
11
- UpdateManagedRuleSetVersionExpiryDateResponse,
12
- } from "../models/models_0";
13
- import {
14
- ServiceInputTypes,
15
- ServiceOutputTypes,
16
- WAFV2ClientResolvedConfig,
17
- } from "../WAFV2Client";
18
- export { __MetadataBearer, $Command };
19
- export interface UpdateManagedRuleSetVersionExpiryDateCommandInput
20
- extends UpdateManagedRuleSetVersionExpiryDateRequest {}
21
- export interface UpdateManagedRuleSetVersionExpiryDateCommandOutput
22
- extends UpdateManagedRuleSetVersionExpiryDateResponse,
23
- __MetadataBearer {}
24
- export declare class UpdateManagedRuleSetVersionExpiryDateCommand extends $Command<
25
- UpdateManagedRuleSetVersionExpiryDateCommandInput,
26
- UpdateManagedRuleSetVersionExpiryDateCommandOutput,
27
- WAFV2ClientResolvedConfig
28
- > {
29
- readonly input: UpdateManagedRuleSetVersionExpiryDateCommandInput;
30
- static getEndpointParameterInstructions(): EndpointParameterInstructions;
31
- constructor(input: UpdateManagedRuleSetVersionExpiryDateCommandInput);
32
- resolveMiddleware(
33
- clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
34
- configuration: WAFV2ClientResolvedConfig,
35
- options?: __HttpHandlerOptions
36
- ): Handler<
37
- UpdateManagedRuleSetVersionExpiryDateCommandInput,
38
- UpdateManagedRuleSetVersionExpiryDateCommandOutput
39
- >;
40
- private serialize;
41
- private deserialize;
42
- }
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { UpdateManagedRuleSetVersionExpiryDateRequest, UpdateManagedRuleSetVersionExpiryDateResponse } from "../models/models_0";
5
+ import { ServiceInputTypes, ServiceOutputTypes, WAFV2ClientResolvedConfig } from "../WAFV2Client";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link UpdateManagedRuleSetVersionExpiryDateCommand}.
14
+ */
15
+ export interface UpdateManagedRuleSetVersionExpiryDateCommandInput extends UpdateManagedRuleSetVersionExpiryDateRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link UpdateManagedRuleSetVersionExpiryDateCommand}.
21
+ */
22
+ export interface UpdateManagedRuleSetVersionExpiryDateCommandOutput extends UpdateManagedRuleSetVersionExpiryDateResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Updates the expiration information for your managed rule set. Use this to initiate the
27
+ * expiration of a managed rule group version. After you initiate expiration for a version,
28
+ * WAF excludes it from the response to <a>ListAvailableManagedRuleGroupVersions</a> for the managed rule group. </p>
29
+ * <note>
30
+ * <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>
31
+ * <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>
32
+ * </note>
33
+ * @example
34
+ * Use a bare-bones client and the command you need to make an API call.
35
+ * ```javascript
36
+ * import { WAFV2Client, UpdateManagedRuleSetVersionExpiryDateCommand } from "@aws-sdk/client-wafv2"; // ES Modules import
37
+ * // const { WAFV2Client, UpdateManagedRuleSetVersionExpiryDateCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import
38
+ * const client = new WAFV2Client(config);
39
+ * const input = { // UpdateManagedRuleSetVersionExpiryDateRequest
40
+ * Name: "STRING_VALUE", // required
41
+ * Scope: "CLOUDFRONT" || "REGIONAL", // required
42
+ * Id: "STRING_VALUE", // required
43
+ * LockToken: "STRING_VALUE", // required
44
+ * VersionToExpire: "STRING_VALUE", // required
45
+ * ExpiryTimestamp: new Date("TIMESTAMP"), // required
46
+ * };
47
+ * const command = new UpdateManagedRuleSetVersionExpiryDateCommand(input);
48
+ * const response = await client.send(command);
49
+ * // { // UpdateManagedRuleSetVersionExpiryDateResponse
50
+ * // ExpiringVersion: "STRING_VALUE",
51
+ * // ExpiryTimestamp: new Date("TIMESTAMP"),
52
+ * // NextLockToken: "STRING_VALUE",
53
+ * // };
54
+ *
55
+ * ```
56
+ *
57
+ * @param UpdateManagedRuleSetVersionExpiryDateCommandInput - {@link UpdateManagedRuleSetVersionExpiryDateCommandInput}
58
+ * @returns {@link UpdateManagedRuleSetVersionExpiryDateCommandOutput}
59
+ * @see {@link UpdateManagedRuleSetVersionExpiryDateCommandInput} for command's `input` shape.
60
+ * @see {@link UpdateManagedRuleSetVersionExpiryDateCommandOutput} for command's `response` shape.
61
+ * @see {@link WAFV2ClientResolvedConfig | config} for WAFV2Client's `config` shape.
62
+ *
63
+ * @throws {@link WAFInternalErrorException} (server fault)
64
+ * <p>Your request is valid, but WAF couldn’t perform the operation because of a system
65
+ * problem. Retry your request. </p>
66
+ *
67
+ * @throws {@link WAFInvalidOperationException} (client fault)
68
+ * <p>The operation isn't valid. </p>
69
+ *
70
+ * @throws {@link WAFInvalidParameterException} (client fault)
71
+ * <p>The operation failed because WAF didn't recognize a parameter in the request. For
72
+ * example: </p>
73
+ * <ul>
74
+ * <li>
75
+ * <p>You specified a parameter name or value that isn't valid.</p>
76
+ * </li>
77
+ * <li>
78
+ * <p>Your nested statement isn't valid. You might have tried to nest a statement that
79
+ * can’t be nested. </p>
80
+ * </li>
81
+ * <li>
82
+ * <p>You tried to update a <code>WebACL</code> with a <code>DefaultAction</code> that
83
+ * isn't among the types available at <a>DefaultAction</a>.</p>
84
+ * </li>
85
+ * <li>
86
+ * <p>Your request references an ARN that is malformed, or corresponds to a resource
87
+ * with which a web ACL can't be associated.</p>
88
+ * </li>
89
+ * </ul>
90
+ *
91
+ * @throws {@link WAFNonexistentItemException} (client fault)
92
+ * <p>WAF couldn’t perform the operation because your resource doesn't exist.
93
+ * If you've just created a resource that you're using in this operation, you might
94
+ * just need to wait a few minutes. It can take from a few seconds to a number of minutes
95
+ * for changes to propagate. </p>
96
+ *
97
+ * @throws {@link WAFOptimisticLockException} (client fault)
98
+ * <p>WAF couldn’t save your changes because you tried to update or delete a resource
99
+ * that has changed since you last retrieved it. Get the resource again, make any changes you
100
+ * need to make to the new copy, and retry your operation. </p>
101
+ *
102
+ * @throws {@link WAFV2ServiceException}
103
+ * <p>Base exception class for all service exceptions from WAFV2 service.</p>
104
+ *
105
+ */
106
+ export declare class UpdateManagedRuleSetVersionExpiryDateCommand extends $Command<UpdateManagedRuleSetVersionExpiryDateCommandInput, UpdateManagedRuleSetVersionExpiryDateCommandOutput, WAFV2ClientResolvedConfig> {
107
+ readonly input: UpdateManagedRuleSetVersionExpiryDateCommandInput;
108
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
109
+ /**
110
+ * @public
111
+ */
112
+ constructor(input: UpdateManagedRuleSetVersionExpiryDateCommandInput);
113
+ /**
114
+ * @internal
115
+ */
116
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateManagedRuleSetVersionExpiryDateCommandInput, UpdateManagedRuleSetVersionExpiryDateCommandOutput>;
117
+ /**
118
+ * @internal
119
+ */
120
+ private serialize;
121
+ /**
122
+ * @internal
123
+ */
124
+ private deserialize;
125
+ }