@aws-sdk/client-wafv2 3.419.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.
- package/README.md +7 -7
- package/dist-types/models/models_0.d.ts +26 -6
- package/dist-types/ts3.4/WAFV2.d.ts +438 -918
- package/dist-types/ts3.4/WAFV2Client.d.ts +277 -436
- package/dist-types/ts3.4/commands/AssociateWebACLCommand.d.ts +118 -38
- package/dist-types/ts3.4/commands/CheckCapacityCommand.d.ts +1093 -38
- package/dist-types/ts3.4/commands/CreateAPIKeyCommand.d.ts +115 -35
- package/dist-types/ts3.4/commands/CreateIPSetCommand.d.ts +144 -35
- package/dist-types/ts3.4/commands/CreateRegexPatternSetCommand.d.ts +143 -42
- package/dist-types/ts3.4/commands/CreateRuleGroupCommand.d.ts +1116 -38
- package/dist-types/ts3.4/commands/CreateWebACLCommand.d.ts +1145 -35
- package/dist-types/ts3.4/commands/DeleteFirewallManagerRuleGroupsCommand.d.ts +115 -42
- package/dist-types/ts3.4/commands/DeleteIPSetCommand.d.ts +124 -35
- package/dist-types/ts3.4/commands/DeleteLoggingConfigurationCommand.d.ts +110 -42
- package/dist-types/ts3.4/commands/DeletePermissionPolicyCommand.d.ts +103 -42
- package/dist-types/ts3.4/commands/DeleteRegexPatternSetCommand.d.ts +124 -42
- package/dist-types/ts3.4/commands/DeleteRuleGroupCommand.d.ts +124 -38
- package/dist-types/ts3.4/commands/DeleteWebACLCommand.d.ts +158 -35
- package/dist-types/ts3.4/commands/DescribeAllManagedProductsCommand.d.ts +92 -42
- package/dist-types/ts3.4/commands/DescribeManagedProductsByVendorCommand.d.ts +114 -42
- package/dist-types/ts3.4/commands/DescribeManagedRuleGroupCommand.d.ts +191 -42
- package/dist-types/ts3.4/commands/DisassociateWebACLCommand.d.ts +109 -39
- package/dist-types/ts3.4/commands/GenerateMobileSdkReleaseUrlCommand.d.ts +110 -42
- package/dist-types/ts3.4/commands/GetDecryptedAPIKeyCommand.d.ts +112 -39
- package/dist-types/ts3.4/commands/GetIPSetCommand.d.ts +119 -35
- package/dist-types/ts3.4/commands/GetLoggingConfigurationCommand.d.ts +192 -42
- package/dist-types/ts3.4/commands/GetManagedRuleSetCommand.d.ts +131 -39
- package/dist-types/ts3.4/commands/GetMobileSdkReleaseCommand.d.ts +121 -39
- package/dist-types/ts3.4/commands/GetPermissionPolicyCommand.d.ts +105 -39
- package/dist-types/ts3.4/commands/GetRateBasedStatementManagedKeysCommand.d.ts +142 -42
- package/dist-types/ts3.4/commands/GetRegexPatternSetCommand.d.ts +120 -39
- package/dist-types/ts3.4/commands/GetRuleGroupCommand.d.ts +1088 -35
- package/dist-types/ts3.4/commands/GetSampledRequestsCommand.d.ts +168 -39
- package/dist-types/ts3.4/commands/GetWebACLCommand.d.ts +1283 -35
- package/dist-types/ts3.4/commands/GetWebACLForResourceCommand.d.ts +1286 -42
- package/dist-types/ts3.4/commands/ListAPIKeysCommand.d.ts +121 -35
- package/dist-types/ts3.4/commands/ListAvailableManagedRuleGroupVersionsCommand.d.ts +118 -42
- package/dist-types/ts3.4/commands/ListAvailableManagedRuleGroupsCommand.d.ts +113 -42
- package/dist-types/ts3.4/commands/ListIPSetsCommand.d.ts +113 -35
- package/dist-types/ts3.4/commands/ListLoggingConfigurationsCommand.d.ts +191 -42
- package/dist-types/ts3.4/commands/ListManagedRuleSetsCommand.d.ts +117 -39
- package/dist-types/ts3.4/commands/ListMobileSdkReleasesCommand.d.ts +112 -42
- package/dist-types/ts3.4/commands/ListRegexPatternSetsCommand.d.ts +113 -42
- package/dist-types/ts3.4/commands/ListResourcesForWebACLCommand.d.ts +112 -42
- package/dist-types/ts3.4/commands/ListRuleGroupsCommand.d.ts +113 -38
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +132 -39
- package/dist-types/ts3.4/commands/ListWebACLsCommand.d.ts +113 -35
- package/dist-types/ts3.4/commands/PutLoggingConfigurationCommand.d.ts +345 -42
- package/dist-types/ts3.4/commands/PutManagedRuleSetVersionsCommand.d.ts +133 -42
- package/dist-types/ts3.4/commands/PutPermissionPolicyCommand.d.ts +145 -39
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +131 -35
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +118 -38
- package/dist-types/ts3.4/commands/UpdateIPSetCommand.d.ts +146 -35
- package/dist-types/ts3.4/commands/UpdateManagedRuleSetVersionExpiryDateCommand.d.ts +125 -42
- package/dist-types/ts3.4/commands/UpdateRegexPatternSetCommand.d.ts +148 -42
- package/dist-types/ts3.4/commands/UpdateRuleGroupCommand.d.ts +1128 -38
- package/dist-types/ts3.4/commands/UpdateWebACLCommand.d.ts +1146 -35
- package/dist-types/ts3.4/commands/index.d.ts +53 -53
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +22 -33
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +5 -8
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -2
- package/dist-types/ts3.4/extensionConfiguration.d.ts +8 -7
- package/dist-types/ts3.4/index.d.ts +68 -6
- package/dist-types/ts3.4/models/WAFV2ServiceException.d.ts +13 -8
- package/dist-types/ts3.4/models/index.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +7951 -1764
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +479 -641
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +46 -97
- package/dist-types/ts3.4/runtimeConfig.d.ts +46 -97
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +45 -88
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +19 -19
- package/dist-types/ts3.4/runtimeExtensions.d.ts +17 -11
- package/package.json +3 -3
|
@@ -1,42 +1,133 @@
|
|
|
1
|
-
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
-
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
-
import {
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
>
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
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 { PutManagedRuleSetVersionsRequest, PutManagedRuleSetVersionsResponse } 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 PutManagedRuleSetVersionsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface PutManagedRuleSetVersionsCommandInput extends PutManagedRuleSetVersionsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link PutManagedRuleSetVersionsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface PutManagedRuleSetVersionsCommandOutput extends PutManagedRuleSetVersionsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Defines the versions of your managed rule set that you are offering to the customers.
|
|
27
|
+
* Customers see your offerings as managed rule groups with versioning.</p>
|
|
28
|
+
* <note>
|
|
29
|
+
* <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>
|
|
30
|
+
* <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>
|
|
31
|
+
* </note>
|
|
32
|
+
* <p>Customers retrieve their managed rule group list by calling <a>ListAvailableManagedRuleGroups</a>. The name that you provide here for your
|
|
33
|
+
* managed rule set is the name the customer sees for the corresponding managed rule group.
|
|
34
|
+
* Customers can retrieve the available versions for a managed rule group by calling <a>ListAvailableManagedRuleGroupVersions</a>. You provide a rule group
|
|
35
|
+
* specification for each version. For each managed rule set, you must specify a version that
|
|
36
|
+
* you recommend using. </p>
|
|
37
|
+
* <p>To initiate the expiration of a managed rule group version, use <a>UpdateManagedRuleSetVersionExpiryDate</a>.</p>
|
|
38
|
+
* @example
|
|
39
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
40
|
+
* ```javascript
|
|
41
|
+
* import { WAFV2Client, PutManagedRuleSetVersionsCommand } from "@aws-sdk/client-wafv2"; // ES Modules import
|
|
42
|
+
* // const { WAFV2Client, PutManagedRuleSetVersionsCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import
|
|
43
|
+
* const client = new WAFV2Client(config);
|
|
44
|
+
* const input = { // PutManagedRuleSetVersionsRequest
|
|
45
|
+
* Name: "STRING_VALUE", // required
|
|
46
|
+
* Scope: "CLOUDFRONT" || "REGIONAL", // required
|
|
47
|
+
* Id: "STRING_VALUE", // required
|
|
48
|
+
* LockToken: "STRING_VALUE", // required
|
|
49
|
+
* RecommendedVersion: "STRING_VALUE",
|
|
50
|
+
* VersionsToPublish: { // VersionsToPublish
|
|
51
|
+
* "<keys>": { // VersionToPublish
|
|
52
|
+
* AssociatedRuleGroupArn: "STRING_VALUE",
|
|
53
|
+
* ForecastedLifetime: Number("int"),
|
|
54
|
+
* },
|
|
55
|
+
* },
|
|
56
|
+
* };
|
|
57
|
+
* const command = new PutManagedRuleSetVersionsCommand(input);
|
|
58
|
+
* const response = await client.send(command);
|
|
59
|
+
* // { // PutManagedRuleSetVersionsResponse
|
|
60
|
+
* // NextLockToken: "STRING_VALUE",
|
|
61
|
+
* // };
|
|
62
|
+
*
|
|
63
|
+
* ```
|
|
64
|
+
*
|
|
65
|
+
* @param PutManagedRuleSetVersionsCommandInput - {@link PutManagedRuleSetVersionsCommandInput}
|
|
66
|
+
* @returns {@link PutManagedRuleSetVersionsCommandOutput}
|
|
67
|
+
* @see {@link PutManagedRuleSetVersionsCommandInput} for command's `input` shape.
|
|
68
|
+
* @see {@link PutManagedRuleSetVersionsCommandOutput} for command's `response` shape.
|
|
69
|
+
* @see {@link WAFV2ClientResolvedConfig | config} for WAFV2Client's `config` shape.
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link WAFInternalErrorException} (server fault)
|
|
72
|
+
* <p>Your request is valid, but WAF couldn’t perform the operation because of a system
|
|
73
|
+
* problem. Retry your request. </p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link WAFInvalidOperationException} (client fault)
|
|
76
|
+
* <p>The operation isn't valid. </p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link WAFInvalidParameterException} (client fault)
|
|
79
|
+
* <p>The operation failed because WAF didn't recognize a parameter in the request. For
|
|
80
|
+
* example: </p>
|
|
81
|
+
* <ul>
|
|
82
|
+
* <li>
|
|
83
|
+
* <p>You specified a parameter name or value that isn't valid.</p>
|
|
84
|
+
* </li>
|
|
85
|
+
* <li>
|
|
86
|
+
* <p>Your nested statement isn't valid. You might have tried to nest a statement that
|
|
87
|
+
* can’t be nested. </p>
|
|
88
|
+
* </li>
|
|
89
|
+
* <li>
|
|
90
|
+
* <p>You tried to update a <code>WebACL</code> with a <code>DefaultAction</code> that
|
|
91
|
+
* isn't among the types available at <a>DefaultAction</a>.</p>
|
|
92
|
+
* </li>
|
|
93
|
+
* <li>
|
|
94
|
+
* <p>Your request references an ARN that is malformed, or corresponds to a resource
|
|
95
|
+
* with which a web ACL can't be associated.</p>
|
|
96
|
+
* </li>
|
|
97
|
+
* </ul>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link WAFNonexistentItemException} (client fault)
|
|
100
|
+
* <p>WAF couldn’t perform the operation because your resource doesn't exist.
|
|
101
|
+
* If you've just created a resource that you're using in this operation, you might
|
|
102
|
+
* just need to wait a few minutes. It can take from a few seconds to a number of minutes
|
|
103
|
+
* for changes to propagate. </p>
|
|
104
|
+
*
|
|
105
|
+
* @throws {@link WAFOptimisticLockException} (client fault)
|
|
106
|
+
* <p>WAF couldn’t save your changes because you tried to update or delete a resource
|
|
107
|
+
* that has changed since you last retrieved it. Get the resource again, make any changes you
|
|
108
|
+
* need to make to the new copy, and retry your operation. </p>
|
|
109
|
+
*
|
|
110
|
+
* @throws {@link WAFV2ServiceException}
|
|
111
|
+
* <p>Base exception class for all service exceptions from WAFV2 service.</p>
|
|
112
|
+
*
|
|
113
|
+
*/
|
|
114
|
+
export declare class PutManagedRuleSetVersionsCommand extends $Command<PutManagedRuleSetVersionsCommandInput, PutManagedRuleSetVersionsCommandOutput, WAFV2ClientResolvedConfig> {
|
|
115
|
+
readonly input: PutManagedRuleSetVersionsCommandInput;
|
|
116
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
117
|
+
/**
|
|
118
|
+
* @public
|
|
119
|
+
*/
|
|
120
|
+
constructor(input: PutManagedRuleSetVersionsCommandInput);
|
|
121
|
+
/**
|
|
122
|
+
* @internal
|
|
123
|
+
*/
|
|
124
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutManagedRuleSetVersionsCommandInput, PutManagedRuleSetVersionsCommandOutput>;
|
|
125
|
+
/**
|
|
126
|
+
* @internal
|
|
127
|
+
*/
|
|
128
|
+
private serialize;
|
|
129
|
+
/**
|
|
130
|
+
* @internal
|
|
131
|
+
*/
|
|
132
|
+
private deserialize;
|
|
133
|
+
}
|
|
@@ -1,39 +1,145 @@
|
|
|
1
|
-
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
-
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
-
import {
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
>
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
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 { PutPermissionPolicyRequest, PutPermissionPolicyResponse } 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 PutPermissionPolicyCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface PutPermissionPolicyCommandInput extends PutPermissionPolicyRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link PutPermissionPolicyCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface PutPermissionPolicyCommandOutput extends PutPermissionPolicyResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Attaches an IAM policy to the specified resource. Use this to share a rule group across
|
|
27
|
+
* accounts.</p>
|
|
28
|
+
* <p>You must be the owner of the rule group to perform this operation.</p>
|
|
29
|
+
* <p>This action is subject to the following restrictions:</p>
|
|
30
|
+
* <ul>
|
|
31
|
+
* <li>
|
|
32
|
+
* <p>You can attach only one policy with each <code>PutPermissionPolicy</code>
|
|
33
|
+
* request.</p>
|
|
34
|
+
* </li>
|
|
35
|
+
* <li>
|
|
36
|
+
* <p>The ARN in the request must be a valid WAF <a>RuleGroup</a> ARN and the
|
|
37
|
+
* rule group must exist in the same Region.</p>
|
|
38
|
+
* </li>
|
|
39
|
+
* <li>
|
|
40
|
+
* <p>The user making the request must be the owner of the rule group.</p>
|
|
41
|
+
* </li>
|
|
42
|
+
* </ul>
|
|
43
|
+
* @example
|
|
44
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
45
|
+
* ```javascript
|
|
46
|
+
* import { WAFV2Client, PutPermissionPolicyCommand } from "@aws-sdk/client-wafv2"; // ES Modules import
|
|
47
|
+
* // const { WAFV2Client, PutPermissionPolicyCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import
|
|
48
|
+
* const client = new WAFV2Client(config);
|
|
49
|
+
* const input = { // PutPermissionPolicyRequest
|
|
50
|
+
* ResourceArn: "STRING_VALUE", // required
|
|
51
|
+
* Policy: "STRING_VALUE", // required
|
|
52
|
+
* };
|
|
53
|
+
* const command = new PutPermissionPolicyCommand(input);
|
|
54
|
+
* const response = await client.send(command);
|
|
55
|
+
* // {};
|
|
56
|
+
*
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
59
|
+
* @param PutPermissionPolicyCommandInput - {@link PutPermissionPolicyCommandInput}
|
|
60
|
+
* @returns {@link PutPermissionPolicyCommandOutput}
|
|
61
|
+
* @see {@link PutPermissionPolicyCommandInput} for command's `input` shape.
|
|
62
|
+
* @see {@link PutPermissionPolicyCommandOutput} for command's `response` shape.
|
|
63
|
+
* @see {@link WAFV2ClientResolvedConfig | config} for WAFV2Client's `config` shape.
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link WAFInternalErrorException} (server fault)
|
|
66
|
+
* <p>Your request is valid, but WAF couldn’t perform the operation because of a system
|
|
67
|
+
* problem. Retry your request. </p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link WAFInvalidParameterException} (client fault)
|
|
70
|
+
* <p>The operation failed because WAF didn't recognize a parameter in the request. For
|
|
71
|
+
* example: </p>
|
|
72
|
+
* <ul>
|
|
73
|
+
* <li>
|
|
74
|
+
* <p>You specified a parameter name or value that isn't valid.</p>
|
|
75
|
+
* </li>
|
|
76
|
+
* <li>
|
|
77
|
+
* <p>Your nested statement isn't valid. You might have tried to nest a statement that
|
|
78
|
+
* can’t be nested. </p>
|
|
79
|
+
* </li>
|
|
80
|
+
* <li>
|
|
81
|
+
* <p>You tried to update a <code>WebACL</code> with a <code>DefaultAction</code> that
|
|
82
|
+
* isn't among the types available at <a>DefaultAction</a>.</p>
|
|
83
|
+
* </li>
|
|
84
|
+
* <li>
|
|
85
|
+
* <p>Your request references an ARN that is malformed, or corresponds to a resource
|
|
86
|
+
* with which a web ACL can't be associated.</p>
|
|
87
|
+
* </li>
|
|
88
|
+
* </ul>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link WAFInvalidPermissionPolicyException} (client fault)
|
|
91
|
+
* <p>The operation failed because the specified policy isn't in the proper format. </p>
|
|
92
|
+
* <p>The policy specifications must conform to the following:</p>
|
|
93
|
+
* <ul>
|
|
94
|
+
* <li>
|
|
95
|
+
* <p>The policy must be composed using IAM Policy version 2012-10-17.</p>
|
|
96
|
+
* </li>
|
|
97
|
+
* <li>
|
|
98
|
+
* <p>The policy must include specifications for <code>Effect</code>, <code>Action</code>, and <code>Principal</code>.</p>
|
|
99
|
+
* </li>
|
|
100
|
+
* <li>
|
|
101
|
+
* <p>
|
|
102
|
+
* <code>Effect</code> must specify <code>Allow</code>.</p>
|
|
103
|
+
* </li>
|
|
104
|
+
* <li>
|
|
105
|
+
* <p>
|
|
106
|
+
* <code>Action</code> must specify <code>wafv2:CreateWebACL</code>, <code>wafv2:UpdateWebACL</code>, and
|
|
107
|
+
* <code>wafv2:PutFirewallManagerRuleGroups</code> and may optionally specify <code>wafv2:GetRuleGroup</code>.
|
|
108
|
+
* WAF rejects any extra actions or wildcard actions in the policy.</p>
|
|
109
|
+
* </li>
|
|
110
|
+
* <li>
|
|
111
|
+
* <p>The policy must not include a <code>Resource</code> parameter.</p>
|
|
112
|
+
* </li>
|
|
113
|
+
* </ul>
|
|
114
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html">IAM Policies</a>. </p>
|
|
115
|
+
*
|
|
116
|
+
* @throws {@link WAFNonexistentItemException} (client fault)
|
|
117
|
+
* <p>WAF couldn’t perform the operation because your resource doesn't exist.
|
|
118
|
+
* If you've just created a resource that you're using in this operation, you might
|
|
119
|
+
* just need to wait a few minutes. It can take from a few seconds to a number of minutes
|
|
120
|
+
* for changes to propagate. </p>
|
|
121
|
+
*
|
|
122
|
+
* @throws {@link WAFV2ServiceException}
|
|
123
|
+
* <p>Base exception class for all service exceptions from WAFV2 service.</p>
|
|
124
|
+
*
|
|
125
|
+
*/
|
|
126
|
+
export declare class PutPermissionPolicyCommand extends $Command<PutPermissionPolicyCommandInput, PutPermissionPolicyCommandOutput, WAFV2ClientResolvedConfig> {
|
|
127
|
+
readonly input: PutPermissionPolicyCommandInput;
|
|
128
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
129
|
+
/**
|
|
130
|
+
* @public
|
|
131
|
+
*/
|
|
132
|
+
constructor(input: PutPermissionPolicyCommandInput);
|
|
133
|
+
/**
|
|
134
|
+
* @internal
|
|
135
|
+
*/
|
|
136
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutPermissionPolicyCommandInput, PutPermissionPolicyCommandOutput>;
|
|
137
|
+
/**
|
|
138
|
+
* @internal
|
|
139
|
+
*/
|
|
140
|
+
private serialize;
|
|
141
|
+
/**
|
|
142
|
+
* @internal
|
|
143
|
+
*/
|
|
144
|
+
private deserialize;
|
|
145
|
+
}
|
|
@@ -1,35 +1,131 @@
|
|
|
1
|
-
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
-
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
-
import {
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
export
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
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 { TagResourceRequest, TagResourceResponse } 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 TagResourceCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface TagResourceCommandInput extends TagResourceRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link TagResourceCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Associates tags with the specified Amazon Web Services resource. Tags are key:value pairs that you can
|
|
27
|
+
* use to categorize and manage your resources, for purposes like billing. For example, you
|
|
28
|
+
* might set the tag key to "customer" and the value to the customer name or ID. You can
|
|
29
|
+
* specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a
|
|
30
|
+
* resource.</p>
|
|
31
|
+
* <p>You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule
|
|
32
|
+
* groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF
|
|
33
|
+
* console. </p>
|
|
34
|
+
* @example
|
|
35
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
36
|
+
* ```javascript
|
|
37
|
+
* import { WAFV2Client, TagResourceCommand } from "@aws-sdk/client-wafv2"; // ES Modules import
|
|
38
|
+
* // const { WAFV2Client, TagResourceCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import
|
|
39
|
+
* const client = new WAFV2Client(config);
|
|
40
|
+
* const input = { // TagResourceRequest
|
|
41
|
+
* ResourceARN: "STRING_VALUE", // required
|
|
42
|
+
* Tags: [ // TagList // required
|
|
43
|
+
* { // Tag
|
|
44
|
+
* Key: "STRING_VALUE", // required
|
|
45
|
+
* Value: "STRING_VALUE", // required
|
|
46
|
+
* },
|
|
47
|
+
* ],
|
|
48
|
+
* };
|
|
49
|
+
* const command = new TagResourceCommand(input);
|
|
50
|
+
* const response = await client.send(command);
|
|
51
|
+
* // {};
|
|
52
|
+
*
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
55
|
+
* @param TagResourceCommandInput - {@link TagResourceCommandInput}
|
|
56
|
+
* @returns {@link TagResourceCommandOutput}
|
|
57
|
+
* @see {@link TagResourceCommandInput} for command's `input` shape.
|
|
58
|
+
* @see {@link TagResourceCommandOutput} for command's `response` shape.
|
|
59
|
+
* @see {@link WAFV2ClientResolvedConfig | config} for WAFV2Client's `config` shape.
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link WAFInternalErrorException} (server fault)
|
|
62
|
+
* <p>Your request is valid, but WAF couldn’t perform the operation because of a system
|
|
63
|
+
* problem. Retry your request. </p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link WAFInvalidOperationException} (client fault)
|
|
66
|
+
* <p>The operation isn't valid. </p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link WAFInvalidParameterException} (client fault)
|
|
69
|
+
* <p>The operation failed because WAF didn't recognize a parameter in the request. For
|
|
70
|
+
* example: </p>
|
|
71
|
+
* <ul>
|
|
72
|
+
* <li>
|
|
73
|
+
* <p>You specified a parameter name or value that isn't valid.</p>
|
|
74
|
+
* </li>
|
|
75
|
+
* <li>
|
|
76
|
+
* <p>Your nested statement isn't valid. You might have tried to nest a statement that
|
|
77
|
+
* can’t be nested. </p>
|
|
78
|
+
* </li>
|
|
79
|
+
* <li>
|
|
80
|
+
* <p>You tried to update a <code>WebACL</code> with a <code>DefaultAction</code> that
|
|
81
|
+
* isn't among the types available at <a>DefaultAction</a>.</p>
|
|
82
|
+
* </li>
|
|
83
|
+
* <li>
|
|
84
|
+
* <p>Your request references an ARN that is malformed, or corresponds to a resource
|
|
85
|
+
* with which a web ACL can't be associated.</p>
|
|
86
|
+
* </li>
|
|
87
|
+
* </ul>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link WAFLimitsExceededException} (client fault)
|
|
90
|
+
* <p>WAF couldn’t perform the operation because you exceeded your resource limit. For
|
|
91
|
+
* example, the maximum number of <code>WebACL</code> objects that you can create for an Amazon Web Services
|
|
92
|
+
* account. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/limits.html">WAF quotas</a> in the
|
|
93
|
+
* <i>WAF Developer Guide</i>.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link WAFNonexistentItemException} (client fault)
|
|
96
|
+
* <p>WAF couldn’t perform the operation because your resource doesn't exist.
|
|
97
|
+
* If you've just created a resource that you're using in this operation, you might
|
|
98
|
+
* just need to wait a few minutes. It can take from a few seconds to a number of minutes
|
|
99
|
+
* for changes to propagate. </p>
|
|
100
|
+
*
|
|
101
|
+
* @throws {@link WAFTagOperationException} (client fault)
|
|
102
|
+
* <p>An error occurred during the tagging operation. Retry your request.</p>
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link WAFTagOperationInternalErrorException} (server fault)
|
|
105
|
+
* <p>WAF couldn’t perform your tagging operation because of an internal error. Retry
|
|
106
|
+
* your request.</p>
|
|
107
|
+
*
|
|
108
|
+
* @throws {@link WAFV2ServiceException}
|
|
109
|
+
* <p>Base exception class for all service exceptions from WAFV2 service.</p>
|
|
110
|
+
*
|
|
111
|
+
*/
|
|
112
|
+
export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, WAFV2ClientResolvedConfig> {
|
|
113
|
+
readonly input: TagResourceCommandInput;
|
|
114
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
115
|
+
/**
|
|
116
|
+
* @public
|
|
117
|
+
*/
|
|
118
|
+
constructor(input: TagResourceCommandInput);
|
|
119
|
+
/**
|
|
120
|
+
* @internal
|
|
121
|
+
*/
|
|
122
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WAFV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
|
|
123
|
+
/**
|
|
124
|
+
* @internal
|
|
125
|
+
*/
|
|
126
|
+
private serialize;
|
|
127
|
+
/**
|
|
128
|
+
* @internal
|
|
129
|
+
*/
|
|
130
|
+
private deserialize;
|
|
131
|
+
}
|