@aws-sdk/client-waf-regional 3.288.0 → 3.290.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 (82) hide show
  1. package/dist-types/commands/AssociateWebACLCommand.d.ts +54 -0
  2. package/dist-types/commands/CreateByteMatchSetCommand.d.ts +58 -0
  3. package/dist-types/commands/CreateGeoMatchSetCommand.d.ts +58 -0
  4. package/dist-types/commands/CreateIPSetCommand.d.ts +85 -0
  5. package/dist-types/commands/CreateRateBasedRuleCommand.d.ts +64 -0
  6. package/dist-types/commands/CreateRegexMatchSetCommand.d.ts +15 -0
  7. package/dist-types/commands/CreateRegexPatternSetCommand.d.ts +15 -0
  8. package/dist-types/commands/CreateRuleCommand.d.ts +94 -0
  9. package/dist-types/commands/CreateRuleGroupCommand.d.ts +24 -0
  10. package/dist-types/commands/CreateSizeConstraintSetCommand.d.ts +89 -0
  11. package/dist-types/commands/CreateSqlInjectionMatchSetCommand.d.ts +87 -0
  12. package/dist-types/commands/CreateWebACLCommand.d.ts +105 -0
  13. package/dist-types/commands/CreateWebACLMigrationStackCommand.d.ts +103 -0
  14. package/dist-types/commands/CreateXssMatchSetCommand.d.ts +87 -0
  15. package/dist-types/commands/DeleteByteMatchSetCommand.d.ts +59 -0
  16. package/dist-types/commands/DeleteGeoMatchSetCommand.d.ts +42 -0
  17. package/dist-types/commands/DeleteIPSetCommand.d.ts +59 -0
  18. package/dist-types/commands/DeleteLoggingConfigurationCommand.d.ts +10 -0
  19. package/dist-types/commands/DeletePermissionPolicyCommand.d.ts +10 -0
  20. package/dist-types/commands/DeleteRateBasedRuleCommand.d.ts +48 -0
  21. package/dist-types/commands/DeleteRegexMatchSetCommand.d.ts +42 -0
  22. package/dist-types/commands/DeleteRegexPatternSetCommand.d.ts +42 -0
  23. package/dist-types/commands/DeleteRuleCommand.d.ts +65 -0
  24. package/dist-types/commands/DeleteRuleGroupCommand.d.ts +68 -0
  25. package/dist-types/commands/DeleteSizeConstraintSetCommand.d.ts +59 -0
  26. package/dist-types/commands/DeleteSqlInjectionMatchSetCommand.d.ts +59 -0
  27. package/dist-types/commands/DeleteWebACLCommand.d.ts +65 -0
  28. package/dist-types/commands/DeleteXssMatchSetCommand.d.ts +59 -0
  29. package/dist-types/commands/DisassociateWebACLCommand.d.ts +50 -0
  30. package/dist-types/commands/GetByteMatchSetCommand.d.ts +40 -0
  31. package/dist-types/commands/GetChangeTokenCommand.d.ts +18 -0
  32. package/dist-types/commands/GetChangeTokenStatusCommand.d.ts +23 -0
  33. package/dist-types/commands/GetGeoMatchSetCommand.d.ts +10 -0
  34. package/dist-types/commands/GetIPSetCommand.d.ts +35 -0
  35. package/dist-types/commands/GetLoggingConfigurationCommand.d.ts +7 -0
  36. package/dist-types/commands/GetPermissionPolicyCommand.d.ts +7 -0
  37. package/dist-types/commands/GetRateBasedRuleCommand.d.ts +10 -0
  38. package/dist-types/commands/GetRateBasedRuleManagedKeysCommand.d.ts +50 -0
  39. package/dist-types/commands/GetRegexMatchSetCommand.d.ts +10 -0
  40. package/dist-types/commands/GetRegexPatternSetCommand.d.ts +10 -0
  41. package/dist-types/commands/GetRuleCommand.d.ts +37 -0
  42. package/dist-types/commands/GetRuleGroupCommand.d.ts +7 -0
  43. package/dist-types/commands/GetSampledRequestsCommand.d.ts +52 -0
  44. package/dist-types/commands/GetSizeConstraintSetCommand.d.ts +39 -0
  45. package/dist-types/commands/GetSqlInjectionMatchSetCommand.d.ts +37 -0
  46. package/dist-types/commands/GetWebACLCommand.d.ts +42 -0
  47. package/dist-types/commands/GetWebACLForResourceCommand.d.ts +54 -0
  48. package/dist-types/commands/GetXssMatchSetCommand.d.ts +37 -0
  49. package/dist-types/commands/ListActivatedRulesInRuleGroupCommand.d.ts +47 -0
  50. package/dist-types/commands/ListByteMatchSetsCommand.d.ts +7 -0
  51. package/dist-types/commands/ListGeoMatchSetsCommand.d.ts +7 -0
  52. package/dist-types/commands/ListIPSetsCommand.d.ts +28 -0
  53. package/dist-types/commands/ListLoggingConfigurationsCommand.d.ts +47 -0
  54. package/dist-types/commands/ListRateBasedRulesCommand.d.ts +7 -0
  55. package/dist-types/commands/ListRegexMatchSetsCommand.d.ts +7 -0
  56. package/dist-types/commands/ListRegexPatternSetsCommand.d.ts +7 -0
  57. package/dist-types/commands/ListResourcesForWebACLCommand.d.ts +50 -0
  58. package/dist-types/commands/ListRuleGroupsCommand.d.ts +4 -0
  59. package/dist-types/commands/ListRulesCommand.d.ts +28 -0
  60. package/dist-types/commands/ListSizeConstraintSetsCommand.d.ts +28 -0
  61. package/dist-types/commands/ListSqlInjectionMatchSetsCommand.d.ts +28 -0
  62. package/dist-types/commands/ListSubscribedRuleGroupsCommand.d.ts +7 -0
  63. package/dist-types/commands/ListTagsForResourceCommand.d.ts +56 -0
  64. package/dist-types/commands/ListWebACLsCommand.d.ts +28 -0
  65. package/dist-types/commands/ListXssMatchSetsCommand.d.ts +28 -0
  66. package/dist-types/commands/PutLoggingConfigurationCommand.d.ts +13 -0
  67. package/dist-types/commands/PutPermissionPolicyCommand.d.ts +42 -0
  68. package/dist-types/commands/TagResourceCommand.d.ts +61 -0
  69. package/dist-types/commands/UntagResourceCommand.d.ts +56 -0
  70. package/dist-types/commands/UpdateByteMatchSetCommand.d.ts +130 -0
  71. package/dist-types/commands/UpdateGeoMatchSetCommand.d.ts +110 -0
  72. package/dist-types/commands/UpdateIPSetCommand.d.ts +136 -0
  73. package/dist-types/commands/UpdateRateBasedRuleCommand.d.ts +110 -0
  74. package/dist-types/commands/UpdateRegexMatchSetCommand.d.ts +62 -0
  75. package/dist-types/commands/UpdateRegexPatternSetCommand.d.ts +62 -0
  76. package/dist-types/commands/UpdateRuleCommand.d.ts +137 -0
  77. package/dist-types/commands/UpdateRuleGroupCommand.d.ts +96 -0
  78. package/dist-types/commands/UpdateSizeConstraintSetCommand.d.ts +140 -0
  79. package/dist-types/commands/UpdateSqlInjectionMatchSetCommand.d.ts +127 -0
  80. package/dist-types/commands/UpdateWebACLCommand.d.ts +145 -0
  81. package/dist-types/commands/UpdateXssMatchSetCommand.d.ts +127 -0
  82. package/package.json +29 -29
@@ -37,6 +37,46 @@ export interface GetByteMatchSetCommandOutput extends GetByteMatchSetResponse, _
37
37
  * @see {@link GetByteMatchSetCommandOutput} for command's `response` shape.
38
38
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
39
39
  *
40
+ * @throws {@link WAFInternalErrorException} (server fault)
41
+ * <p>The operation failed because of a system problem, even though the request was valid. Retry your request.</p>
42
+ *
43
+ * @throws {@link WAFInvalidAccountException} (client fault)
44
+ * <p>The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.</p>
45
+ *
46
+ * @throws {@link WAFNonexistentItemException} (client fault)
47
+ * <p>The operation failed because the referenced object doesn't exist.</p>
48
+ *
49
+ *
50
+ * @example To get a byte match set
51
+ * ```javascript
52
+ * // The following example returns the details of a byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.
53
+ * const input = {
54
+ * "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5"
55
+ * };
56
+ * const command = new GetByteMatchSetCommand(input);
57
+ * const response = await client.send(command);
58
+ * /* response ==
59
+ * {
60
+ * "ByteMatchSet": {
61
+ * "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5",
62
+ * "ByteMatchTuples": [
63
+ * {
64
+ * "FieldToMatch": {
65
+ * "Data": "referer",
66
+ * "Type": "HEADER"
67
+ * },
68
+ * "PositionalConstraint": "CONTAINS",
69
+ * "TargetString": "badrefer1",
70
+ * "TextTransformation": "NONE"
71
+ * }
72
+ * ],
73
+ * "Name": "ByteMatchNameExample"
74
+ * }
75
+ * }
76
+ * *\/
77
+ * // example id: getbytematchset-1473273311532
78
+ * ```
79
+ *
40
80
  */
41
81
  export declare class GetByteMatchSetCommand extends $Command<GetByteMatchSetCommandInput, GetByteMatchSetCommandOutput, WAFRegionalClientResolvedConfig> {
42
82
  readonly input: GetByteMatchSetCommandInput;
@@ -43,6 +43,24 @@ export interface GetChangeTokenCommandOutput extends GetChangeTokenResponse, __M
43
43
  * @see {@link GetChangeTokenCommandOutput} for command's `response` shape.
44
44
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
45
45
  *
46
+ * @throws {@link WAFInternalErrorException} (server fault)
47
+ * <p>The operation failed because of a system problem, even though the request was valid. Retry your request.</p>
48
+ *
49
+ *
50
+ * @example To get a change token
51
+ * ```javascript
52
+ * // The following example returns a change token to use for a create, update or delete operation.
53
+ * const input = {};
54
+ * const command = new GetChangeTokenCommand(input);
55
+ * const response = await client.send(command);
56
+ * /* response ==
57
+ * {
58
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
59
+ * }
60
+ * *\/
61
+ * // example id: get-change-token-example-1471635120794
62
+ * ```
63
+ *
46
64
  */
47
65
  export declare class GetChangeTokenCommand extends $Command<GetChangeTokenCommandInput, GetChangeTokenCommandOutput, WAFRegionalClientResolvedConfig> {
48
66
  readonly input: GetChangeTokenCommandInput;
@@ -53,6 +53,29 @@ export interface GetChangeTokenStatusCommandOutput extends GetChangeTokenStatusR
53
53
  * @see {@link GetChangeTokenStatusCommandOutput} for command's `response` shape.
54
54
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
55
55
  *
56
+ * @throws {@link WAFInternalErrorException} (server fault)
57
+ * <p>The operation failed because of a system problem, even though the request was valid. Retry your request.</p>
58
+ *
59
+ * @throws {@link WAFNonexistentItemException} (client fault)
60
+ * <p>The operation failed because the referenced object doesn't exist.</p>
61
+ *
62
+ *
63
+ * @example To get the change token status
64
+ * ```javascript
65
+ * // The following example returns the status of a change token with the ID abcd12f2-46da-4fdb-b8d5-fbd4c466928f.
66
+ * const input = {
67
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
68
+ * };
69
+ * const command = new GetChangeTokenStatusCommand(input);
70
+ * const response = await client.send(command);
71
+ * /* response ==
72
+ * {
73
+ * "ChangeTokenStatus": "PENDING"
74
+ * }
75
+ * *\/
76
+ * // example id: getchangetokenstatus-1474658417107
77
+ * ```
78
+ *
56
79
  */
57
80
  export declare class GetChangeTokenStatusCommand extends $Command<GetChangeTokenStatusCommandInput, GetChangeTokenStatusCommandOutput, WAFRegionalClientResolvedConfig> {
58
81
  readonly input: GetChangeTokenStatusCommandInput;
@@ -37,6 +37,16 @@ export interface GetGeoMatchSetCommandOutput extends GetGeoMatchSetResponse, __M
37
37
  * @see {@link GetGeoMatchSetCommandOutput} for command's `response` shape.
38
38
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
39
39
  *
40
+ * @throws {@link WAFInternalErrorException} (server fault)
41
+ * <p>The operation failed because of a system problem, even though the request was valid. Retry your request.</p>
42
+ *
43
+ * @throws {@link WAFInvalidAccountException} (client fault)
44
+ * <p>The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.</p>
45
+ *
46
+ * @throws {@link WAFNonexistentItemException} (client fault)
47
+ * <p>The operation failed because the referenced object doesn't exist.</p>
48
+ *
49
+ *
40
50
  */
41
51
  export declare class GetGeoMatchSetCommand extends $Command<GetGeoMatchSetCommandInput, GetGeoMatchSetCommandOutput, WAFRegionalClientResolvedConfig> {
42
52
  readonly input: GetGeoMatchSetCommandInput;
@@ -37,6 +37,41 @@ export interface GetIPSetCommandOutput extends GetIPSetResponse, __MetadataBeare
37
37
  * @see {@link GetIPSetCommandOutput} for command's `response` shape.
38
38
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
39
39
  *
40
+ * @throws {@link WAFInternalErrorException} (server fault)
41
+ * <p>The operation failed because of a system problem, even though the request was valid. Retry your request.</p>
42
+ *
43
+ * @throws {@link WAFInvalidAccountException} (client fault)
44
+ * <p>The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.</p>
45
+ *
46
+ * @throws {@link WAFNonexistentItemException} (client fault)
47
+ * <p>The operation failed because the referenced object doesn't exist.</p>
48
+ *
49
+ *
50
+ * @example To get an IP set
51
+ * ```javascript
52
+ * // The following example returns the details of an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
53
+ * const input = {
54
+ * "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
55
+ * };
56
+ * const command = new GetIPSetCommand(input);
57
+ * const response = await client.send(command);
58
+ * /* response ==
59
+ * {
60
+ * "IPSet": {
61
+ * "IPSetDescriptors": [
62
+ * {
63
+ * "Type": "IPV4",
64
+ * "Value": "192.0.2.44/32"
65
+ * }
66
+ * ],
67
+ * "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
68
+ * "Name": "MyIPSetFriendlyName"
69
+ * }
70
+ * }
71
+ * *\/
72
+ * // example id: getipset-1474658688675
73
+ * ```
74
+ *
40
75
  */
41
76
  export declare class GetIPSetCommand extends $Command<GetIPSetCommandInput, GetIPSetCommandOutput, WAFRegionalClientResolvedConfig> {
42
77
  readonly input: GetIPSetCommandInput;
@@ -37,6 +37,13 @@ export interface GetLoggingConfigurationCommandOutput extends GetLoggingConfigur
37
37
  * @see {@link GetLoggingConfigurationCommandOutput} for command's `response` shape.
38
38
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
39
39
  *
40
+ * @throws {@link WAFInternalErrorException} (server fault)
41
+ * <p>The operation failed because of a system problem, even though the request was valid. Retry your request.</p>
42
+ *
43
+ * @throws {@link WAFNonexistentItemException} (client fault)
44
+ * <p>The operation failed because the referenced object doesn't exist.</p>
45
+ *
46
+ *
40
47
  */
41
48
  export declare class GetLoggingConfigurationCommand extends $Command<GetLoggingConfigurationCommandInput, GetLoggingConfigurationCommandOutput, WAFRegionalClientResolvedConfig> {
42
49
  readonly input: GetLoggingConfigurationCommandInput;
@@ -37,6 +37,13 @@ export interface GetPermissionPolicyCommandOutput extends GetPermissionPolicyRes
37
37
  * @see {@link GetPermissionPolicyCommandOutput} for command's `response` shape.
38
38
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
39
39
  *
40
+ * @throws {@link WAFInternalErrorException} (server fault)
41
+ * <p>The operation failed because of a system problem, even though the request was valid. Retry your request.</p>
42
+ *
43
+ * @throws {@link WAFNonexistentItemException} (client fault)
44
+ * <p>The operation failed because the referenced object doesn't exist.</p>
45
+ *
46
+ *
40
47
  */
41
48
  export declare class GetPermissionPolicyCommand extends $Command<GetPermissionPolicyCommandInput, GetPermissionPolicyCommandOutput, WAFRegionalClientResolvedConfig> {
42
49
  readonly input: GetPermissionPolicyCommandInput;
@@ -39,6 +39,16 @@ export interface GetRateBasedRuleCommandOutput extends GetRateBasedRuleResponse,
39
39
  * @see {@link GetRateBasedRuleCommandOutput} for command's `response` shape.
40
40
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
41
41
  *
42
+ * @throws {@link WAFInternalErrorException} (server fault)
43
+ * <p>The operation failed because of a system problem, even though the request was valid. Retry your request.</p>
44
+ *
45
+ * @throws {@link WAFInvalidAccountException} (client fault)
46
+ * <p>The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.</p>
47
+ *
48
+ * @throws {@link WAFNonexistentItemException} (client fault)
49
+ * <p>The operation failed because the referenced object doesn't exist.</p>
50
+ *
51
+ *
42
52
  */
43
53
  export declare class GetRateBasedRuleCommand extends $Command<GetRateBasedRuleCommandInput, GetRateBasedRuleCommandOutput, WAFRegionalClientResolvedConfig> {
44
54
  readonly input: GetRateBasedRuleCommandInput;
@@ -39,6 +39,56 @@ export interface GetRateBasedRuleManagedKeysCommandOutput extends GetRateBasedRu
39
39
  * @see {@link GetRateBasedRuleManagedKeysCommandOutput} for command's `response` shape.
40
40
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
41
41
  *
42
+ * @throws {@link WAFInternalErrorException} (server fault)
43
+ * <p>The operation failed because of a system problem, even though the request was valid. Retry your request.</p>
44
+ *
45
+ * @throws {@link WAFInvalidAccountException} (client fault)
46
+ * <p>The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.</p>
47
+ *
48
+ * @throws {@link WAFInvalidParameterException} (client fault)
49
+ * <p>The operation failed because AWS WAF didn't recognize a parameter in the request. For example:</p>
50
+ * <ul>
51
+ * <li>
52
+ * <p>You specified an invalid parameter name.</p>
53
+ * </li>
54
+ * <li>
55
+ * <p>You specified an invalid value.</p>
56
+ * </li>
57
+ * <li>
58
+ * <p>You tried to update an object (<code>ByteMatchSet</code>, <code>IPSet</code>, <code>Rule</code>, or <code>WebACL</code>)
59
+ * using an action other than <code>INSERT</code> or <code>DELETE</code>.</p>
60
+ * </li>
61
+ * <li>
62
+ * <p>You tried to create a <code>WebACL</code> with a <code>DefaultAction</code>
63
+ * <code>Type</code> other than
64
+ * <code>ALLOW</code>, <code>BLOCK</code>, or <code>COUNT</code>.</p>
65
+ * </li>
66
+ * <li>
67
+ * <p>You tried to create a <code>RateBasedRule</code> with a <code>RateKey</code> value other than <code>IP</code>.</p>
68
+ * </li>
69
+ * <li>
70
+ * <p>You tried to update a <code>WebACL</code> with a <code>WafAction</code>
71
+ * <code>Type</code> other than
72
+ * <code>ALLOW</code>, <code>BLOCK</code>, or <code>COUNT</code>.</p>
73
+ * </li>
74
+ * <li>
75
+ * <p>You tried to update a <code>ByteMatchSet</code> with a <code>FieldToMatch</code>
76
+ * <code>Type</code> other than
77
+ * HEADER, METHOD, QUERY_STRING, URI, or BODY.</p>
78
+ * </li>
79
+ * <li>
80
+ * <p>You tried to update a <code>ByteMatchSet</code> with a <code>Field</code> of <code>HEADER</code>
81
+ * but no value for <code>Data</code>.</p>
82
+ * </li>
83
+ * <li>
84
+ * <p>Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.</p>
85
+ * </li>
86
+ * </ul>
87
+ *
88
+ * @throws {@link WAFNonexistentItemException} (client fault)
89
+ * <p>The operation failed because the referenced object doesn't exist.</p>
90
+ *
91
+ *
42
92
  */
43
93
  export declare class GetRateBasedRuleManagedKeysCommand extends $Command<GetRateBasedRuleManagedKeysCommandInput, GetRateBasedRuleManagedKeysCommandOutput, WAFRegionalClientResolvedConfig> {
44
94
  readonly input: GetRateBasedRuleManagedKeysCommandInput;
@@ -37,6 +37,16 @@ export interface GetRegexMatchSetCommandOutput extends GetRegexMatchSetResponse,
37
37
  * @see {@link GetRegexMatchSetCommandOutput} for command's `response` shape.
38
38
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
39
39
  *
40
+ * @throws {@link WAFInternalErrorException} (server fault)
41
+ * <p>The operation failed because of a system problem, even though the request was valid. Retry your request.</p>
42
+ *
43
+ * @throws {@link WAFInvalidAccountException} (client fault)
44
+ * <p>The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.</p>
45
+ *
46
+ * @throws {@link WAFNonexistentItemException} (client fault)
47
+ * <p>The operation failed because the referenced object doesn't exist.</p>
48
+ *
49
+ *
40
50
  */
41
51
  export declare class GetRegexMatchSetCommand extends $Command<GetRegexMatchSetCommandInput, GetRegexMatchSetCommandOutput, WAFRegionalClientResolvedConfig> {
42
52
  readonly input: GetRegexMatchSetCommandInput;
@@ -37,6 +37,16 @@ export interface GetRegexPatternSetCommandOutput extends GetRegexPatternSetRespo
37
37
  * @see {@link GetRegexPatternSetCommandOutput} for command's `response` shape.
38
38
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
39
39
  *
40
+ * @throws {@link WAFInternalErrorException} (server fault)
41
+ * <p>The operation failed because of a system problem, even though the request was valid. Retry your request.</p>
42
+ *
43
+ * @throws {@link WAFInvalidAccountException} (client fault)
44
+ * <p>The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.</p>
45
+ *
46
+ * @throws {@link WAFNonexistentItemException} (client fault)
47
+ * <p>The operation failed because the referenced object doesn't exist.</p>
48
+ *
49
+ *
40
50
  */
41
51
  export declare class GetRegexPatternSetCommand extends $Command<GetRegexPatternSetCommandInput, GetRegexPatternSetCommandOutput, WAFRegionalClientResolvedConfig> {
42
52
  readonly input: GetRegexPatternSetCommandInput;
@@ -37,6 +37,43 @@ export interface GetRuleCommandOutput extends GetRuleResponse, __MetadataBearer
37
37
  * @see {@link GetRuleCommandOutput} for command's `response` shape.
38
38
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
39
39
  *
40
+ * @throws {@link WAFInternalErrorException} (server fault)
41
+ * <p>The operation failed because of a system problem, even though the request was valid. Retry your request.</p>
42
+ *
43
+ * @throws {@link WAFInvalidAccountException} (client fault)
44
+ * <p>The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.</p>
45
+ *
46
+ * @throws {@link WAFNonexistentItemException} (client fault)
47
+ * <p>The operation failed because the referenced object doesn't exist.</p>
48
+ *
49
+ *
50
+ * @example To get a rule
51
+ * ```javascript
52
+ * // The following example returns the details of a rule with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
53
+ * const input = {
54
+ * "RuleId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
55
+ * };
56
+ * const command = new GetRuleCommand(input);
57
+ * const response = await client.send(command);
58
+ * /* response ==
59
+ * {
60
+ * "Rule": {
61
+ * "MetricName": "WAFByteHeaderRule",
62
+ * "Name": "WAFByteHeaderRule",
63
+ * "Predicates": [
64
+ * {
65
+ * "DataId": "MyByteMatchSetID",
66
+ * "Negated": false,
67
+ * "Type": "ByteMatch"
68
+ * }
69
+ * ],
70
+ * "RuleId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
71
+ * }
72
+ * }
73
+ * *\/
74
+ * // example id: getrule-1474659238790
75
+ * ```
76
+ *
40
77
  */
41
78
  export declare class GetRuleCommand extends $Command<GetRuleCommandInput, GetRuleCommandOutput, WAFRegionalClientResolvedConfig> {
42
79
  readonly input: GetRuleCommandInput;
@@ -38,6 +38,13 @@ export interface GetRuleGroupCommandOutput extends GetRuleGroupResponse, __Metad
38
38
  * @see {@link GetRuleGroupCommandOutput} for command's `response` shape.
39
39
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
40
40
  *
41
+ * @throws {@link WAFInternalErrorException} (server fault)
42
+ * <p>The operation failed because of a system problem, even though the request was valid. Retry your request.</p>
43
+ *
44
+ * @throws {@link WAFNonexistentItemException} (client fault)
45
+ * <p>The operation failed because the referenced object doesn't exist.</p>
46
+ *
47
+ *
41
48
  */
42
49
  export declare class GetRuleGroupCommand extends $Command<GetRuleGroupCommandInput, GetRuleGroupCommandOutput, WAFRegionalClientResolvedConfig> {
43
50
  readonly input: GetRuleGroupCommandInput;
@@ -41,6 +41,58 @@ export interface GetSampledRequestsCommandOutput extends GetSampledRequestsRespo
41
41
  * @see {@link GetSampledRequestsCommandOutput} for command's `response` shape.
42
42
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
43
43
  *
44
+ * @throws {@link WAFInternalErrorException} (server fault)
45
+ * <p>The operation failed because of a system problem, even though the request was valid. Retry your request.</p>
46
+ *
47
+ * @throws {@link WAFNonexistentItemException} (client fault)
48
+ * <p>The operation failed because the referenced object doesn't exist.</p>
49
+ *
50
+ *
51
+ * @example To get a sampled requests
52
+ * ```javascript
53
+ * // The following example returns detailed information about 100 requests --a sample-- that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received between the time period 2016-09-27T15:50Z to 2016-09-27T15:50Z.
54
+ * const input = {
55
+ * "MaxItems": 100,
56
+ * "RuleId": "WAFRule-1-Example",
57
+ * "TimeWindow": {
58
+ * "EndTime": "2016-09-27T15:50Z",
59
+ * "StartTime": "2016-09-27T15:50Z"
60
+ * },
61
+ * "WebAclId": "createwebacl-1472061481310"
62
+ * };
63
+ * const command = new GetSampledRequestsCommand(input);
64
+ * const response = await client.send(command);
65
+ * /* response ==
66
+ * {
67
+ * "PopulationSize": 50,
68
+ * "SampledRequests": [
69
+ * {
70
+ * "Action": "BLOCK",
71
+ * "Request": {
72
+ * "ClientIP": "192.0.2.44",
73
+ * "Country": "US",
74
+ * "HTTPVersion": "HTTP/1.1",
75
+ * "Headers": [
76
+ * {
77
+ * "Name": "User-Agent",
78
+ * "Value": "BadBot "
79
+ * }
80
+ * ],
81
+ * "Method": "HEAD"
82
+ * },
83
+ * "Timestamp": "2016-09-27T14:55Z",
84
+ * "Weight": 1
85
+ * }
86
+ * ],
87
+ * "TimeWindow": {
88
+ * "EndTime": "2016-09-27T15:50Z",
89
+ * "StartTime": "2016-09-27T14:50Z"
90
+ * }
91
+ * }
92
+ * *\/
93
+ * // example id: getsampledrequests-1474927997195
94
+ * ```
95
+ *
44
96
  */
45
97
  export declare class GetSampledRequestsCommand extends $Command<GetSampledRequestsCommandInput, GetSampledRequestsCommandOutput, WAFRegionalClientResolvedConfig> {
46
98
  readonly input: GetSampledRequestsCommandInput;
@@ -37,6 +37,45 @@ export interface GetSizeConstraintSetCommandOutput extends GetSizeConstraintSetR
37
37
  * @see {@link GetSizeConstraintSetCommandOutput} for command's `response` shape.
38
38
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
39
39
  *
40
+ * @throws {@link WAFInternalErrorException} (server fault)
41
+ * <p>The operation failed because of a system problem, even though the request was valid. Retry your request.</p>
42
+ *
43
+ * @throws {@link WAFInvalidAccountException} (client fault)
44
+ * <p>The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.</p>
45
+ *
46
+ * @throws {@link WAFNonexistentItemException} (client fault)
47
+ * <p>The operation failed because the referenced object doesn't exist.</p>
48
+ *
49
+ *
50
+ * @example To get a size constraint set
51
+ * ```javascript
52
+ * // The following example returns the details of a size constraint match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
53
+ * const input = {
54
+ * "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
55
+ * };
56
+ * const command = new GetSizeConstraintSetCommand(input);
57
+ * const response = await client.send(command);
58
+ * /* response ==
59
+ * {
60
+ * "SizeConstraintSet": {
61
+ * "Name": "MySampleSizeConstraintSet",
62
+ * "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
63
+ * "SizeConstraints": [
64
+ * {
65
+ * "ComparisonOperator": "GT",
66
+ * "FieldToMatch": {
67
+ * "Type": "QUERY_STRING"
68
+ * },
69
+ * "Size": 0,
70
+ * "TextTransformation": "NONE"
71
+ * }
72
+ * ]
73
+ * }
74
+ * }
75
+ * *\/
76
+ * // example id: getsizeconstraintset-1475005422493
77
+ * ```
78
+ *
40
79
  */
41
80
  export declare class GetSizeConstraintSetCommand extends $Command<GetSizeConstraintSetCommandInput, GetSizeConstraintSetCommandOutput, WAFRegionalClientResolvedConfig> {
42
81
  readonly input: GetSizeConstraintSetCommandInput;
@@ -37,6 +37,43 @@ export interface GetSqlInjectionMatchSetCommandOutput extends GetSqlInjectionMat
37
37
  * @see {@link GetSqlInjectionMatchSetCommandOutput} for command's `response` shape.
38
38
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
39
39
  *
40
+ * @throws {@link WAFInternalErrorException} (server fault)
41
+ * <p>The operation failed because of a system problem, even though the request was valid. Retry your request.</p>
42
+ *
43
+ * @throws {@link WAFInvalidAccountException} (client fault)
44
+ * <p>The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.</p>
45
+ *
46
+ * @throws {@link WAFNonexistentItemException} (client fault)
47
+ * <p>The operation failed because the referenced object doesn't exist.</p>
48
+ *
49
+ *
50
+ * @example To get a SQL injection match set
51
+ * ```javascript
52
+ * // The following example returns the details of a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
53
+ * const input = {
54
+ * "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
55
+ * };
56
+ * const command = new GetSqlInjectionMatchSetCommand(input);
57
+ * const response = await client.send(command);
58
+ * /* response ==
59
+ * {
60
+ * "SqlInjectionMatchSet": {
61
+ * "Name": "MySQLInjectionMatchSet",
62
+ * "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
63
+ * "SqlInjectionMatchTuples": [
64
+ * {
65
+ * "FieldToMatch": {
66
+ * "Type": "QUERY_STRING"
67
+ * },
68
+ * "TextTransformation": "URL_DECODE"
69
+ * }
70
+ * ]
71
+ * }
72
+ * }
73
+ * *\/
74
+ * // example id: getsqlinjectionmatchset-1475005940137
75
+ * ```
76
+ *
40
77
  */
41
78
  export declare class GetSqlInjectionMatchSetCommand extends $Command<GetSqlInjectionMatchSetCommandInput, GetSqlInjectionMatchSetCommandOutput, WAFRegionalClientResolvedConfig> {
42
79
  readonly input: GetSqlInjectionMatchSetCommandInput;
@@ -37,6 +37,48 @@ export interface GetWebACLCommandOutput extends GetWebACLResponse, __MetadataBea
37
37
  * @see {@link GetWebACLCommandOutput} for command's `response` shape.
38
38
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
39
39
  *
40
+ * @throws {@link WAFInternalErrorException} (server fault)
41
+ * <p>The operation failed because of a system problem, even though the request was valid. Retry your request.</p>
42
+ *
43
+ * @throws {@link WAFInvalidAccountException} (client fault)
44
+ * <p>The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.</p>
45
+ *
46
+ * @throws {@link WAFNonexistentItemException} (client fault)
47
+ * <p>The operation failed because the referenced object doesn't exist.</p>
48
+ *
49
+ *
50
+ * @example To get a web ACL
51
+ * ```javascript
52
+ * // The following example returns the details of a web ACL with the ID createwebacl-1472061481310.
53
+ * const input = {
54
+ * "WebACLId": "createwebacl-1472061481310"
55
+ * };
56
+ * const command = new GetWebACLCommand(input);
57
+ * const response = await client.send(command);
58
+ * /* response ==
59
+ * {
60
+ * "WebACL": {
61
+ * "DefaultAction": {
62
+ * "Type": "ALLOW"
63
+ * },
64
+ * "MetricName": "CreateExample",
65
+ * "Name": "CreateExample",
66
+ * "Rules": [
67
+ * {
68
+ * "Action": {
69
+ * "Type": "ALLOW"
70
+ * },
71
+ * "Priority": 1,
72
+ * "RuleId": "WAFRule-1-Example"
73
+ * }
74
+ * ],
75
+ * "WebACLId": "createwebacl-1472061481310"
76
+ * }
77
+ * }
78
+ * *\/
79
+ * // example id: getwebacl-1475006348525
80
+ * ```
81
+ *
40
82
  */
41
83
  export declare class GetWebACLCommand extends $Command<GetWebACLCommandInput, GetWebACLCommandOutput, WAFRegionalClientResolvedConfig> {
42
84
  readonly input: GetWebACLCommandInput;
@@ -37,6 +37,60 @@ export interface GetWebACLForResourceCommandOutput extends GetWebACLForResourceR
37
37
  * @see {@link GetWebACLForResourceCommandOutput} for command's `response` shape.
38
38
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
39
39
  *
40
+ * @throws {@link WAFInternalErrorException} (server fault)
41
+ * <p>The operation failed because of a system problem, even though the request was valid. Retry your request.</p>
42
+ *
43
+ * @throws {@link WAFInvalidAccountException} (client fault)
44
+ * <p>The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.</p>
45
+ *
46
+ * @throws {@link WAFInvalidParameterException} (client fault)
47
+ * <p>The operation failed because AWS WAF didn't recognize a parameter in the request. For example:</p>
48
+ * <ul>
49
+ * <li>
50
+ * <p>You specified an invalid parameter name.</p>
51
+ * </li>
52
+ * <li>
53
+ * <p>You specified an invalid value.</p>
54
+ * </li>
55
+ * <li>
56
+ * <p>You tried to update an object (<code>ByteMatchSet</code>, <code>IPSet</code>, <code>Rule</code>, or <code>WebACL</code>)
57
+ * using an action other than <code>INSERT</code> or <code>DELETE</code>.</p>
58
+ * </li>
59
+ * <li>
60
+ * <p>You tried to create a <code>WebACL</code> with a <code>DefaultAction</code>
61
+ * <code>Type</code> other than
62
+ * <code>ALLOW</code>, <code>BLOCK</code>, or <code>COUNT</code>.</p>
63
+ * </li>
64
+ * <li>
65
+ * <p>You tried to create a <code>RateBasedRule</code> with a <code>RateKey</code> value other than <code>IP</code>.</p>
66
+ * </li>
67
+ * <li>
68
+ * <p>You tried to update a <code>WebACL</code> with a <code>WafAction</code>
69
+ * <code>Type</code> other than
70
+ * <code>ALLOW</code>, <code>BLOCK</code>, or <code>COUNT</code>.</p>
71
+ * </li>
72
+ * <li>
73
+ * <p>You tried to update a <code>ByteMatchSet</code> with a <code>FieldToMatch</code>
74
+ * <code>Type</code> other than
75
+ * HEADER, METHOD, QUERY_STRING, URI, or BODY.</p>
76
+ * </li>
77
+ * <li>
78
+ * <p>You tried to update a <code>ByteMatchSet</code> with a <code>Field</code> of <code>HEADER</code>
79
+ * but no value for <code>Data</code>.</p>
80
+ * </li>
81
+ * <li>
82
+ * <p>Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.</p>
83
+ * </li>
84
+ * </ul>
85
+ *
86
+ * @throws {@link WAFNonexistentItemException} (client fault)
87
+ * <p>The operation failed because the referenced object doesn't exist.</p>
88
+ *
89
+ * @throws {@link WAFUnavailableEntityException} (client fault)
90
+ * <p>The operation failed because the entity
91
+ * referenced is temporarily unavailable. Retry your request.</p>
92
+ *
93
+ *
40
94
  */
41
95
  export declare class GetWebACLForResourceCommand extends $Command<GetWebACLForResourceCommandInput, GetWebACLForResourceCommandOutput, WAFRegionalClientResolvedConfig> {
42
96
  readonly input: GetWebACLForResourceCommandInput;