@aws-sdk/client-waf-regional 3.288.0 → 3.289.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 (37) hide show
  1. package/dist-types/commands/CreateIPSetCommand.d.ts +27 -0
  2. package/dist-types/commands/CreateRuleCommand.d.ts +30 -0
  3. package/dist-types/commands/CreateSizeConstraintSetCommand.d.ts +31 -0
  4. package/dist-types/commands/CreateSqlInjectionMatchSetCommand.d.ts +29 -0
  5. package/dist-types/commands/CreateWebACLCommand.d.ts +38 -0
  6. package/dist-types/commands/CreateXssMatchSetCommand.d.ts +29 -0
  7. package/dist-types/commands/DeleteByteMatchSetCommand.d.ts +17 -0
  8. package/dist-types/commands/DeleteIPSetCommand.d.ts +17 -0
  9. package/dist-types/commands/DeleteRuleCommand.d.ts +17 -0
  10. package/dist-types/commands/DeleteSizeConstraintSetCommand.d.ts +17 -0
  11. package/dist-types/commands/DeleteSqlInjectionMatchSetCommand.d.ts +17 -0
  12. package/dist-types/commands/DeleteWebACLCommand.d.ts +17 -0
  13. package/dist-types/commands/DeleteXssMatchSetCommand.d.ts +17 -0
  14. package/dist-types/commands/GetByteMatchSetCommand.d.ts +30 -0
  15. package/dist-types/commands/GetChangeTokenCommand.d.ts +14 -0
  16. package/dist-types/commands/GetChangeTokenStatusCommand.d.ts +16 -0
  17. package/dist-types/commands/GetIPSetCommand.d.ts +25 -0
  18. package/dist-types/commands/GetRuleCommand.d.ts +27 -0
  19. package/dist-types/commands/GetSampledRequestsCommand.d.ts +45 -0
  20. package/dist-types/commands/GetSizeConstraintSetCommand.d.ts +29 -0
  21. package/dist-types/commands/GetSqlInjectionMatchSetCommand.d.ts +27 -0
  22. package/dist-types/commands/GetWebACLCommand.d.ts +32 -0
  23. package/dist-types/commands/GetXssMatchSetCommand.d.ts +27 -0
  24. package/dist-types/commands/ListIPSetsCommand.d.ts +21 -0
  25. package/dist-types/commands/ListRulesCommand.d.ts +21 -0
  26. package/dist-types/commands/ListSizeConstraintSetsCommand.d.ts +21 -0
  27. package/dist-types/commands/ListSqlInjectionMatchSetsCommand.d.ts +21 -0
  28. package/dist-types/commands/ListWebACLsCommand.d.ts +21 -0
  29. package/dist-types/commands/ListXssMatchSetsCommand.d.ts +21 -0
  30. package/dist-types/commands/UpdateByteMatchSetCommand.d.ts +31 -0
  31. package/dist-types/commands/UpdateIPSetCommand.d.ts +26 -0
  32. package/dist-types/commands/UpdateRuleCommand.d.ts +27 -0
  33. package/dist-types/commands/UpdateSizeConstraintSetCommand.d.ts +30 -0
  34. package/dist-types/commands/UpdateSqlInjectionMatchSetCommand.d.ts +28 -0
  35. package/dist-types/commands/UpdateWebACLCommand.d.ts +32 -0
  36. package/dist-types/commands/UpdateXssMatchSetCommand.d.ts +28 -0
  37. package/package.json +29 -29
@@ -62,6 +62,33 @@ export interface CreateIPSetCommandOutput extends CreateIPSetResponse, __Metadat
62
62
  * @see {@link CreateIPSetCommandOutput} for command's `response` shape.
63
63
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
64
64
  *
65
+ * @example To create an IP set
66
+ * ```javascript
67
+ * // The following example creates an IP match set named MyIPSetFriendlyName.
68
+ * const input = {
69
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
70
+ * "Name": "MyIPSetFriendlyName"
71
+ * };
72
+ * const command = new CreateIPSetCommand(input);
73
+ * const response = await client.send(command);
74
+ * /* response ==
75
+ * {
76
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
77
+ * "IPSet": {
78
+ * "IPSetDescriptors": [
79
+ * {
80
+ * "Type": "IPV4",
81
+ * "Value": "192.0.2.44/32"
82
+ * }
83
+ * ],
84
+ * "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
85
+ * "Name": "MyIPSetFriendlyName"
86
+ * }
87
+ * }
88
+ * *\/
89
+ * // example id: createipset-1472501003122
90
+ * ```
91
+ *
65
92
  */
66
93
  export declare class CreateIPSetCommand extends $Command<CreateIPSetCommandInput, CreateIPSetCommandOutput, WAFRegionalClientResolvedConfig> {
67
94
  readonly input: CreateIPSetCommandInput;
@@ -80,6 +80,36 @@ export interface CreateRuleCommandOutput extends CreateRuleResponse, __MetadataB
80
80
  * @see {@link CreateRuleCommandOutput} for command's `response` shape.
81
81
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
82
82
  *
83
+ * @example To create a rule
84
+ * ```javascript
85
+ * // The following example creates a rule named WAFByteHeaderRule.
86
+ * const input = {
87
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
88
+ * "MetricName": "WAFByteHeaderRule",
89
+ * "Name": "WAFByteHeaderRule"
90
+ * };
91
+ * const command = new CreateRuleCommand(input);
92
+ * const response = await client.send(command);
93
+ * /* response ==
94
+ * {
95
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
96
+ * "Rule": {
97
+ * "MetricName": "WAFByteHeaderRule",
98
+ * "Name": "WAFByteHeaderRule",
99
+ * "Predicates": [
100
+ * {
101
+ * "DataId": "MyByteMatchSetID",
102
+ * "Negated": false,
103
+ * "Type": "ByteMatch"
104
+ * }
105
+ * ],
106
+ * "RuleId": "WAFRule-1-Example"
107
+ * }
108
+ * }
109
+ * *\/
110
+ * // example id: createrule-1474072675555
111
+ * ```
112
+ *
83
113
  */
84
114
  export declare class CreateRuleCommand extends $Command<CreateRuleCommandInput, CreateRuleCommandOutput, WAFRegionalClientResolvedConfig> {
85
115
  readonly input: CreateRuleCommandInput;
@@ -60,6 +60,37 @@ export interface CreateSizeConstraintSetCommandOutput extends CreateSizeConstrai
60
60
  * @see {@link CreateSizeConstraintSetCommandOutput} for command's `response` shape.
61
61
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
62
62
  *
63
+ * @example To create a size constraint
64
+ * ```javascript
65
+ * // The following example creates size constraint set named MySampleSizeConstraintSet.
66
+ * const input = {
67
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
68
+ * "Name": "MySampleSizeConstraintSet"
69
+ * };
70
+ * const command = new CreateSizeConstraintSetCommand(input);
71
+ * const response = await client.send(command);
72
+ * /* response ==
73
+ * {
74
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
75
+ * "SizeConstraintSet": {
76
+ * "Name": "MySampleSizeConstraintSet",
77
+ * "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
78
+ * "SizeConstraints": [
79
+ * {
80
+ * "ComparisonOperator": "GT",
81
+ * "FieldToMatch": {
82
+ * "Type": "QUERY_STRING"
83
+ * },
84
+ * "Size": 0,
85
+ * "TextTransformation": "NONE"
86
+ * }
87
+ * ]
88
+ * }
89
+ * }
90
+ * *\/
91
+ * // example id: createsizeconstraint-1474299140754
92
+ * ```
93
+ *
63
94
  */
64
95
  export declare class CreateSizeConstraintSetCommand extends $Command<CreateSizeConstraintSetCommandInput, CreateSizeConstraintSetCommandOutput, WAFRegionalClientResolvedConfig> {
65
96
  readonly input: CreateSizeConstraintSetCommandInput;
@@ -58,6 +58,35 @@ export interface CreateSqlInjectionMatchSetCommandOutput extends CreateSqlInject
58
58
  * @see {@link CreateSqlInjectionMatchSetCommandOutput} for command's `response` shape.
59
59
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
60
60
  *
61
+ * @example To create a SQL injection match set
62
+ * ```javascript
63
+ * // The following example creates a SQL injection match set named MySQLInjectionMatchSet.
64
+ * const input = {
65
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
66
+ * "Name": "MySQLInjectionMatchSet"
67
+ * };
68
+ * const command = new CreateSqlInjectionMatchSetCommand(input);
69
+ * const response = await client.send(command);
70
+ * /* response ==
71
+ * {
72
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
73
+ * "SqlInjectionMatchSet": {
74
+ * "Name": "MySQLInjectionMatchSet",
75
+ * "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
76
+ * "SqlInjectionMatchTuples": [
77
+ * {
78
+ * "FieldToMatch": {
79
+ * "Type": "QUERY_STRING"
80
+ * },
81
+ * "TextTransformation": "URL_DECODE"
82
+ * }
83
+ * ]
84
+ * }
85
+ * }
86
+ * *\/
87
+ * // example id: createsqlinjectionmatchset-1474492796105
88
+ * ```
89
+ *
61
90
  */
62
91
  export declare class CreateSqlInjectionMatchSetCommand extends $Command<CreateSqlInjectionMatchSetCommandInput, CreateSqlInjectionMatchSetCommandOutput, WAFRegionalClientResolvedConfig> {
63
92
  readonly input: CreateSqlInjectionMatchSetCommandInput;
@@ -68,6 +68,44 @@ export interface CreateWebACLCommandOutput extends CreateWebACLResponse, __Metad
68
68
  * @see {@link CreateWebACLCommandOutput} for command's `response` shape.
69
69
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
70
70
  *
71
+ * @example To create a web ACL
72
+ * ```javascript
73
+ * // The following example creates a web ACL named CreateExample.
74
+ * const input = {
75
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
76
+ * "DefaultAction": {
77
+ * "Type": "ALLOW"
78
+ * },
79
+ * "MetricName": "CreateExample",
80
+ * "Name": "CreateExample"
81
+ * };
82
+ * const command = new CreateWebACLCommand(input);
83
+ * const response = await client.send(command);
84
+ * /* response ==
85
+ * {
86
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
87
+ * "WebACL": {
88
+ * "DefaultAction": {
89
+ * "Type": "ALLOW"
90
+ * },
91
+ * "MetricName": "CreateExample",
92
+ * "Name": "CreateExample",
93
+ * "Rules": [
94
+ * {
95
+ * "Action": {
96
+ * "Type": "ALLOW"
97
+ * },
98
+ * "Priority": 1,
99
+ * "RuleId": "WAFRule-1-Example"
100
+ * }
101
+ * ],
102
+ * "WebACLId": "example-46da-4444-5555-example"
103
+ * }
104
+ * }
105
+ * *\/
106
+ * // example id: createwebacl-1472061481310
107
+ * ```
108
+ *
71
109
  */
72
110
  export declare class CreateWebACLCommand extends $Command<CreateWebACLCommandInput, CreateWebACLCommandOutput, WAFRegionalClientResolvedConfig> {
73
111
  readonly input: CreateWebACLCommandInput;
@@ -58,6 +58,35 @@ export interface CreateXssMatchSetCommandOutput extends CreateXssMatchSetRespons
58
58
  * @see {@link CreateXssMatchSetCommandOutput} for command's `response` shape.
59
59
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
60
60
  *
61
+ * @example To create an XSS match set
62
+ * ```javascript
63
+ * // The following example creates an XSS match set named MySampleXssMatchSet.
64
+ * const input = {
65
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
66
+ * "Name": "MySampleXssMatchSet"
67
+ * };
68
+ * const command = new CreateXssMatchSetCommand(input);
69
+ * const response = await client.send(command);
70
+ * /* response ==
71
+ * {
72
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
73
+ * "XssMatchSet": {
74
+ * "Name": "MySampleXssMatchSet",
75
+ * "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
76
+ * "XssMatchTuples": [
77
+ * {
78
+ * "FieldToMatch": {
79
+ * "Type": "QUERY_STRING"
80
+ * },
81
+ * "TextTransformation": "URL_DECODE"
82
+ * }
83
+ * ]
84
+ * }
85
+ * }
86
+ * *\/
87
+ * // example id: createxssmatchset-1474560868500
88
+ * ```
89
+ *
61
90
  */
62
91
  export declare class CreateXssMatchSetCommand extends $Command<CreateXssMatchSetCommandInput, CreateXssMatchSetCommandOutput, WAFRegionalClientResolvedConfig> {
63
92
  readonly input: CreateXssMatchSetCommandInput;
@@ -52,6 +52,23 @@ export interface DeleteByteMatchSetCommandOutput extends DeleteByteMatchSetRespo
52
52
  * @see {@link DeleteByteMatchSetCommandOutput} for command's `response` shape.
53
53
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
54
54
  *
55
+ * @example To delete a byte match set
56
+ * ```javascript
57
+ * // The following example deletes a byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.
58
+ * const input = {
59
+ * "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5",
60
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
61
+ * };
62
+ * const command = new DeleteByteMatchSetCommand(input);
63
+ * const response = await client.send(command);
64
+ * /* response ==
65
+ * {
66
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
67
+ * }
68
+ * *\/
69
+ * // example id: deletebytematchset-1473367566229
70
+ * ```
71
+ *
55
72
  */
56
73
  export declare class DeleteByteMatchSetCommand extends $Command<DeleteByteMatchSetCommandInput, DeleteByteMatchSetCommandOutput, WAFRegionalClientResolvedConfig> {
57
74
  readonly input: DeleteByteMatchSetCommandInput;
@@ -52,6 +52,23 @@ export interface DeleteIPSetCommandOutput extends DeleteIPSetResponse, __Metadat
52
52
  * @see {@link DeleteIPSetCommandOutput} for command's `response` shape.
53
53
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
54
54
  *
55
+ * @example To delete an IP set
56
+ * ```javascript
57
+ * // The following example deletes an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
58
+ * const input = {
59
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
60
+ * "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
61
+ * };
62
+ * const command = new DeleteIPSetCommand(input);
63
+ * const response = await client.send(command);
64
+ * /* response ==
65
+ * {
66
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
67
+ * }
68
+ * *\/
69
+ * // example id: deleteipset-1472767434306
70
+ * ```
71
+ *
55
72
  */
56
73
  export declare class DeleteIPSetCommand extends $Command<DeleteIPSetCommandInput, DeleteIPSetCommandOutput, WAFRegionalClientResolvedConfig> {
57
74
  readonly input: DeleteIPSetCommandInput;
@@ -52,6 +52,23 @@ export interface DeleteRuleCommandOutput extends DeleteRuleResponse, __MetadataB
52
52
  * @see {@link DeleteRuleCommandOutput} for command's `response` shape.
53
53
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
54
54
  *
55
+ * @example To delete a rule
56
+ * ```javascript
57
+ * // The following example deletes a rule with the ID WAFRule-1-Example.
58
+ * const input = {
59
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
60
+ * "RuleId": "WAFRule-1-Example"
61
+ * };
62
+ * const command = new DeleteRuleCommand(input);
63
+ * const response = await client.send(command);
64
+ * /* response ==
65
+ * {
66
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
67
+ * }
68
+ * *\/
69
+ * // example id: deleterule-1474073108749
70
+ * ```
71
+ *
55
72
  */
56
73
  export declare class DeleteRuleCommand extends $Command<DeleteRuleCommandInput, DeleteRuleCommandOutput, WAFRegionalClientResolvedConfig> {
57
74
  readonly input: DeleteRuleCommandInput;
@@ -52,6 +52,23 @@ export interface DeleteSizeConstraintSetCommandOutput extends DeleteSizeConstrai
52
52
  * @see {@link DeleteSizeConstraintSetCommandOutput} for command's `response` shape.
53
53
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
54
54
  *
55
+ * @example To delete a size constraint set
56
+ * ```javascript
57
+ * // The following example deletes a size constraint set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
58
+ * const input = {
59
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
60
+ * "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
61
+ * };
62
+ * const command = new DeleteSizeConstraintSetCommand(input);
63
+ * const response = await client.send(command);
64
+ * /* response ==
65
+ * {
66
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
67
+ * }
68
+ * *\/
69
+ * // example id: deletesizeconstraintset-1474299857905
70
+ * ```
71
+ *
55
72
  */
56
73
  export declare class DeleteSizeConstraintSetCommand extends $Command<DeleteSizeConstraintSetCommandInput, DeleteSizeConstraintSetCommandOutput, WAFRegionalClientResolvedConfig> {
57
74
  readonly input: DeleteSizeConstraintSetCommandInput;
@@ -53,6 +53,23 @@ export interface DeleteSqlInjectionMatchSetCommandOutput extends DeleteSqlInject
53
53
  * @see {@link DeleteSqlInjectionMatchSetCommandOutput} for command's `response` shape.
54
54
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
55
55
  *
56
+ * @example To delete a SQL injection match set
57
+ * ```javascript
58
+ * // The following example deletes a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
59
+ * const input = {
60
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
61
+ * "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
62
+ * };
63
+ * const command = new DeleteSqlInjectionMatchSetCommand(input);
64
+ * const response = await client.send(command);
65
+ * /* response ==
66
+ * {
67
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
68
+ * }
69
+ * *\/
70
+ * // example id: deletesqlinjectionmatchset-1474493373197
71
+ * ```
72
+ *
56
73
  */
57
74
  export declare class DeleteSqlInjectionMatchSetCommand extends $Command<DeleteSqlInjectionMatchSetCommandInput, DeleteSqlInjectionMatchSetCommandOutput, WAFRegionalClientResolvedConfig> {
58
75
  readonly input: DeleteSqlInjectionMatchSetCommandInput;
@@ -50,6 +50,23 @@ export interface DeleteWebACLCommandOutput extends DeleteWebACLResponse, __Metad
50
50
  * @see {@link DeleteWebACLCommandOutput} for command's `response` shape.
51
51
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
52
52
  *
53
+ * @example To delete a web ACL
54
+ * ```javascript
55
+ * // The following example deletes a web ACL with the ID example-46da-4444-5555-example.
56
+ * const input = {
57
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
58
+ * "WebACLId": "example-46da-4444-5555-example"
59
+ * };
60
+ * const command = new DeleteWebACLCommand(input);
61
+ * const response = await client.send(command);
62
+ * /* response ==
63
+ * {
64
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
65
+ * }
66
+ * *\/
67
+ * // example id: deletewebacl-1472767755931
68
+ * ```
69
+ *
53
70
  */
54
71
  export declare class DeleteWebACLCommand extends $Command<DeleteWebACLCommandInput, DeleteWebACLCommandOutput, WAFRegionalClientResolvedConfig> {
55
72
  readonly input: DeleteWebACLCommandInput;
@@ -53,6 +53,23 @@ export interface DeleteXssMatchSetCommandOutput extends DeleteXssMatchSetRespons
53
53
  * @see {@link DeleteXssMatchSetCommandOutput} for command's `response` shape.
54
54
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
55
55
  *
56
+ * @example To delete an XSS match set
57
+ * ```javascript
58
+ * // The following example deletes an XSS match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
59
+ * const input = {
60
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
61
+ * "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
62
+ * };
63
+ * const command = new DeleteXssMatchSetCommand(input);
64
+ * const response = await client.send(command);
65
+ * /* response ==
66
+ * {
67
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
68
+ * }
69
+ * *\/
70
+ * // example id: deletexssmatchset-1474561302618
71
+ * ```
72
+ *
56
73
  */
57
74
  export declare class DeleteXssMatchSetCommand extends $Command<DeleteXssMatchSetCommandInput, DeleteXssMatchSetCommandOutput, WAFRegionalClientResolvedConfig> {
58
75
  readonly input: DeleteXssMatchSetCommandInput;
@@ -37,6 +37,36 @@ 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
+ * @example To get a byte match set
41
+ * ```javascript
42
+ * // The following example returns the details of a byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.
43
+ * const input = {
44
+ * "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5"
45
+ * };
46
+ * const command = new GetByteMatchSetCommand(input);
47
+ * const response = await client.send(command);
48
+ * /* response ==
49
+ * {
50
+ * "ByteMatchSet": {
51
+ * "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5",
52
+ * "ByteMatchTuples": [
53
+ * {
54
+ * "FieldToMatch": {
55
+ * "Data": "referer",
56
+ * "Type": "HEADER"
57
+ * },
58
+ * "PositionalConstraint": "CONTAINS",
59
+ * "TargetString": "badrefer1",
60
+ * "TextTransformation": "NONE"
61
+ * }
62
+ * ],
63
+ * "Name": "ByteMatchNameExample"
64
+ * }
65
+ * }
66
+ * *\/
67
+ * // example id: getbytematchset-1473273311532
68
+ * ```
69
+ *
40
70
  */
41
71
  export declare class GetByteMatchSetCommand extends $Command<GetByteMatchSetCommandInput, GetByteMatchSetCommandOutput, WAFRegionalClientResolvedConfig> {
42
72
  readonly input: GetByteMatchSetCommandInput;
@@ -43,6 +43,20 @@ 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
+ * @example To get a change token
47
+ * ```javascript
48
+ * // The following example returns a change token to use for a create, update or delete operation.
49
+ * const input = {};
50
+ * const command = new GetChangeTokenCommand(input);
51
+ * const response = await client.send(command);
52
+ * /* response ==
53
+ * {
54
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
55
+ * }
56
+ * *\/
57
+ * // example id: get-change-token-example-1471635120794
58
+ * ```
59
+ *
46
60
  */
47
61
  export declare class GetChangeTokenCommand extends $Command<GetChangeTokenCommandInput, GetChangeTokenCommandOutput, WAFRegionalClientResolvedConfig> {
48
62
  readonly input: GetChangeTokenCommandInput;
@@ -53,6 +53,22 @@ 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
+ * @example To get the change token status
57
+ * ```javascript
58
+ * // The following example returns the status of a change token with the ID abcd12f2-46da-4fdb-b8d5-fbd4c466928f.
59
+ * const input = {
60
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
61
+ * };
62
+ * const command = new GetChangeTokenStatusCommand(input);
63
+ * const response = await client.send(command);
64
+ * /* response ==
65
+ * {
66
+ * "ChangeTokenStatus": "PENDING"
67
+ * }
68
+ * *\/
69
+ * // example id: getchangetokenstatus-1474658417107
70
+ * ```
71
+ *
56
72
  */
57
73
  export declare class GetChangeTokenStatusCommand extends $Command<GetChangeTokenStatusCommandInput, GetChangeTokenStatusCommandOutput, WAFRegionalClientResolvedConfig> {
58
74
  readonly input: GetChangeTokenStatusCommandInput;
@@ -37,6 +37,31 @@ 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
+ * @example To get an IP set
41
+ * ```javascript
42
+ * // The following example returns the details of an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
43
+ * const input = {
44
+ * "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
45
+ * };
46
+ * const command = new GetIPSetCommand(input);
47
+ * const response = await client.send(command);
48
+ * /* response ==
49
+ * {
50
+ * "IPSet": {
51
+ * "IPSetDescriptors": [
52
+ * {
53
+ * "Type": "IPV4",
54
+ * "Value": "192.0.2.44/32"
55
+ * }
56
+ * ],
57
+ * "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
58
+ * "Name": "MyIPSetFriendlyName"
59
+ * }
60
+ * }
61
+ * *\/
62
+ * // example id: getipset-1474658688675
63
+ * ```
64
+ *
40
65
  */
41
66
  export declare class GetIPSetCommand extends $Command<GetIPSetCommandInput, GetIPSetCommandOutput, WAFRegionalClientResolvedConfig> {
42
67
  readonly input: GetIPSetCommandInput;
@@ -37,6 +37,33 @@ 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
+ * @example To get a rule
41
+ * ```javascript
42
+ * // The following example returns the details of a rule with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
43
+ * const input = {
44
+ * "RuleId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
45
+ * };
46
+ * const command = new GetRuleCommand(input);
47
+ * const response = await client.send(command);
48
+ * /* response ==
49
+ * {
50
+ * "Rule": {
51
+ * "MetricName": "WAFByteHeaderRule",
52
+ * "Name": "WAFByteHeaderRule",
53
+ * "Predicates": [
54
+ * {
55
+ * "DataId": "MyByteMatchSetID",
56
+ * "Negated": false,
57
+ * "Type": "ByteMatch"
58
+ * }
59
+ * ],
60
+ * "RuleId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
61
+ * }
62
+ * }
63
+ * *\/
64
+ * // example id: getrule-1474659238790
65
+ * ```
66
+ *
40
67
  */
41
68
  export declare class GetRuleCommand extends $Command<GetRuleCommandInput, GetRuleCommandOutput, WAFRegionalClientResolvedConfig> {
42
69
  readonly input: GetRuleCommandInput;
@@ -41,6 +41,51 @@ 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
+ * @example To get a sampled requests
45
+ * ```javascript
46
+ * // 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.
47
+ * const input = {
48
+ * "MaxItems": 100,
49
+ * "RuleId": "WAFRule-1-Example",
50
+ * "TimeWindow": {
51
+ * "EndTime": "2016-09-27T15:50Z",
52
+ * "StartTime": "2016-09-27T15:50Z"
53
+ * },
54
+ * "WebAclId": "createwebacl-1472061481310"
55
+ * };
56
+ * const command = new GetSampledRequestsCommand(input);
57
+ * const response = await client.send(command);
58
+ * /* response ==
59
+ * {
60
+ * "PopulationSize": 50,
61
+ * "SampledRequests": [
62
+ * {
63
+ * "Action": "BLOCK",
64
+ * "Request": {
65
+ * "ClientIP": "192.0.2.44",
66
+ * "Country": "US",
67
+ * "HTTPVersion": "HTTP/1.1",
68
+ * "Headers": [
69
+ * {
70
+ * "Name": "User-Agent",
71
+ * "Value": "BadBot "
72
+ * }
73
+ * ],
74
+ * "Method": "HEAD"
75
+ * },
76
+ * "Timestamp": "2016-09-27T14:55Z",
77
+ * "Weight": 1
78
+ * }
79
+ * ],
80
+ * "TimeWindow": {
81
+ * "EndTime": "2016-09-27T15:50Z",
82
+ * "StartTime": "2016-09-27T14:50Z"
83
+ * }
84
+ * }
85
+ * *\/
86
+ * // example id: getsampledrequests-1474927997195
87
+ * ```
88
+ *
44
89
  */
45
90
  export declare class GetSampledRequestsCommand extends $Command<GetSampledRequestsCommandInput, GetSampledRequestsCommandOutput, WAFRegionalClientResolvedConfig> {
46
91
  readonly input: GetSampledRequestsCommandInput;
@@ -37,6 +37,35 @@ 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
+ * @example To get a size constraint set
41
+ * ```javascript
42
+ * // The following example returns the details of a size constraint match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
43
+ * const input = {
44
+ * "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
45
+ * };
46
+ * const command = new GetSizeConstraintSetCommand(input);
47
+ * const response = await client.send(command);
48
+ * /* response ==
49
+ * {
50
+ * "SizeConstraintSet": {
51
+ * "Name": "MySampleSizeConstraintSet",
52
+ * "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
53
+ * "SizeConstraints": [
54
+ * {
55
+ * "ComparisonOperator": "GT",
56
+ * "FieldToMatch": {
57
+ * "Type": "QUERY_STRING"
58
+ * },
59
+ * "Size": 0,
60
+ * "TextTransformation": "NONE"
61
+ * }
62
+ * ]
63
+ * }
64
+ * }
65
+ * *\/
66
+ * // example id: getsizeconstraintset-1475005422493
67
+ * ```
68
+ *
40
69
  */
41
70
  export declare class GetSizeConstraintSetCommand extends $Command<GetSizeConstraintSetCommandInput, GetSizeConstraintSetCommandOutput, WAFRegionalClientResolvedConfig> {
42
71
  readonly input: GetSizeConstraintSetCommandInput;
@@ -37,6 +37,33 @@ 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
+ * @example To get a SQL injection match set
41
+ * ```javascript
42
+ * // The following example returns the details of a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
43
+ * const input = {
44
+ * "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
45
+ * };
46
+ * const command = new GetSqlInjectionMatchSetCommand(input);
47
+ * const response = await client.send(command);
48
+ * /* response ==
49
+ * {
50
+ * "SqlInjectionMatchSet": {
51
+ * "Name": "MySQLInjectionMatchSet",
52
+ * "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
53
+ * "SqlInjectionMatchTuples": [
54
+ * {
55
+ * "FieldToMatch": {
56
+ * "Type": "QUERY_STRING"
57
+ * },
58
+ * "TextTransformation": "URL_DECODE"
59
+ * }
60
+ * ]
61
+ * }
62
+ * }
63
+ * *\/
64
+ * // example id: getsqlinjectionmatchset-1475005940137
65
+ * ```
66
+ *
40
67
  */
41
68
  export declare class GetSqlInjectionMatchSetCommand extends $Command<GetSqlInjectionMatchSetCommandInput, GetSqlInjectionMatchSetCommandOutput, WAFRegionalClientResolvedConfig> {
42
69
  readonly input: GetSqlInjectionMatchSetCommandInput;
@@ -37,6 +37,38 @@ 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
+ * @example To get a web ACL
41
+ * ```javascript
42
+ * // The following example returns the details of a web ACL with the ID createwebacl-1472061481310.
43
+ * const input = {
44
+ * "WebACLId": "createwebacl-1472061481310"
45
+ * };
46
+ * const command = new GetWebACLCommand(input);
47
+ * const response = await client.send(command);
48
+ * /* response ==
49
+ * {
50
+ * "WebACL": {
51
+ * "DefaultAction": {
52
+ * "Type": "ALLOW"
53
+ * },
54
+ * "MetricName": "CreateExample",
55
+ * "Name": "CreateExample",
56
+ * "Rules": [
57
+ * {
58
+ * "Action": {
59
+ * "Type": "ALLOW"
60
+ * },
61
+ * "Priority": 1,
62
+ * "RuleId": "WAFRule-1-Example"
63
+ * }
64
+ * ],
65
+ * "WebACLId": "createwebacl-1472061481310"
66
+ * }
67
+ * }
68
+ * *\/
69
+ * // example id: getwebacl-1475006348525
70
+ * ```
71
+ *
40
72
  */
41
73
  export declare class GetWebACLCommand extends $Command<GetWebACLCommandInput, GetWebACLCommandOutput, WAFRegionalClientResolvedConfig> {
42
74
  readonly input: GetWebACLCommandInput;
@@ -37,6 +37,33 @@ export interface GetXssMatchSetCommandOutput extends GetXssMatchSetResponse, __M
37
37
  * @see {@link GetXssMatchSetCommandOutput} for command's `response` shape.
38
38
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
39
39
  *
40
+ * @example To get an XSS match set
41
+ * ```javascript
42
+ * // The following example returns the details of an XSS match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
43
+ * const input = {
44
+ * "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
45
+ * };
46
+ * const command = new GetXssMatchSetCommand(input);
47
+ * const response = await client.send(command);
48
+ * /* response ==
49
+ * {
50
+ * "XssMatchSet": {
51
+ * "Name": "MySampleXssMatchSet",
52
+ * "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
53
+ * "XssMatchTuples": [
54
+ * {
55
+ * "FieldToMatch": {
56
+ * "Type": "QUERY_STRING"
57
+ * },
58
+ * "TextTransformation": "URL_DECODE"
59
+ * }
60
+ * ]
61
+ * }
62
+ * }
63
+ * *\/
64
+ * // example id: getxssmatchset-1475187879017
65
+ * ```
66
+ *
40
67
  */
41
68
  export declare class GetXssMatchSetCommand extends $Command<GetXssMatchSetCommandInput, GetXssMatchSetCommandOutput, WAFRegionalClientResolvedConfig> {
42
69
  readonly input: GetXssMatchSetCommandInput;
@@ -37,6 +37,27 @@ export interface ListIPSetsCommandOutput extends ListIPSetsResponse, __MetadataB
37
37
  * @see {@link ListIPSetsCommandOutput} for command's `response` shape.
38
38
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
39
39
  *
40
+ * @example To list IP sets
41
+ * ```javascript
42
+ * // The following example returns an array of up to 100 IP match sets.
43
+ * const input = {
44
+ * "Limit": 100
45
+ * };
46
+ * const command = new ListIPSetsCommand(input);
47
+ * const response = await client.send(command);
48
+ * /* response ==
49
+ * {
50
+ * "IPSets": [
51
+ * {
52
+ * "IPSetId": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
53
+ * "Name": "MyIPSetFriendlyName"
54
+ * }
55
+ * ]
56
+ * }
57
+ * *\/
58
+ * // example id: listipsets-1472235676229
59
+ * ```
60
+ *
40
61
  */
41
62
  export declare class ListIPSetsCommand extends $Command<ListIPSetsCommandInput, ListIPSetsCommandOutput, WAFRegionalClientResolvedConfig> {
42
63
  readonly input: ListIPSetsCommandInput;
@@ -37,6 +37,27 @@ export interface ListRulesCommandOutput extends ListRulesResponse, __MetadataBea
37
37
  * @see {@link ListRulesCommandOutput} for command's `response` shape.
38
38
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
39
39
  *
40
+ * @example To list rules
41
+ * ```javascript
42
+ * // The following example returns an array of up to 100 rules.
43
+ * const input = {
44
+ * "Limit": 100
45
+ * };
46
+ * const command = new ListRulesCommand(input);
47
+ * const response = await client.send(command);
48
+ * /* response ==
49
+ * {
50
+ * "Rules": [
51
+ * {
52
+ * "Name": "WAFByteHeaderRule",
53
+ * "RuleId": "WAFRule-1-Example"
54
+ * }
55
+ * ]
56
+ * }
57
+ * *\/
58
+ * // example id: listrules-1475258406433
59
+ * ```
60
+ *
40
61
  */
41
62
  export declare class ListRulesCommand extends $Command<ListRulesCommandInput, ListRulesCommandOutput, WAFRegionalClientResolvedConfig> {
42
63
  readonly input: ListRulesCommandInput;
@@ -37,6 +37,27 @@ export interface ListSizeConstraintSetsCommandOutput extends ListSizeConstraintS
37
37
  * @see {@link ListSizeConstraintSetsCommandOutput} for command's `response` shape.
38
38
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
39
39
  *
40
+ * @example To list a size constraint sets
41
+ * ```javascript
42
+ * // The following example returns an array of up to 100 size contraint match sets.
43
+ * const input = {
44
+ * "Limit": 100
45
+ * };
46
+ * const command = new ListSizeConstraintSetsCommand(input);
47
+ * const response = await client.send(command);
48
+ * /* response ==
49
+ * {
50
+ * "SizeConstraintSets": [
51
+ * {
52
+ * "Name": "MySampleSizeConstraintSet",
53
+ * "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
54
+ * }
55
+ * ]
56
+ * }
57
+ * *\/
58
+ * // example id: listsizeconstraintsets-1474300067597
59
+ * ```
60
+ *
40
61
  */
41
62
  export declare class ListSizeConstraintSetsCommand extends $Command<ListSizeConstraintSetsCommandInput, ListSizeConstraintSetsCommandOutput, WAFRegionalClientResolvedConfig> {
42
63
  readonly input: ListSizeConstraintSetsCommandInput;
@@ -37,6 +37,27 @@ export interface ListSqlInjectionMatchSetsCommandOutput extends ListSqlInjection
37
37
  * @see {@link ListSqlInjectionMatchSetsCommandOutput} for command's `response` shape.
38
38
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
39
39
  *
40
+ * @example To list SQL injection match sets
41
+ * ```javascript
42
+ * // The following example returns an array of up to 100 SQL injection match sets.
43
+ * const input = {
44
+ * "Limit": 100
45
+ * };
46
+ * const command = new ListSqlInjectionMatchSetsCommand(input);
47
+ * const response = await client.send(command);
48
+ * /* response ==
49
+ * {
50
+ * "SqlInjectionMatchSets": [
51
+ * {
52
+ * "Name": "MySQLInjectionMatchSet",
53
+ * "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
54
+ * }
55
+ * ]
56
+ * }
57
+ * *\/
58
+ * // example id: listsqlinjectionmatchset-1474493560103
59
+ * ```
60
+ *
40
61
  */
41
62
  export declare class ListSqlInjectionMatchSetsCommand extends $Command<ListSqlInjectionMatchSetsCommandInput, ListSqlInjectionMatchSetsCommandOutput, WAFRegionalClientResolvedConfig> {
42
63
  readonly input: ListSqlInjectionMatchSetsCommandInput;
@@ -37,6 +37,27 @@ export interface ListWebACLsCommandOutput extends ListWebACLsResponse, __Metadat
37
37
  * @see {@link ListWebACLsCommandOutput} for command's `response` shape.
38
38
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
39
39
  *
40
+ * @example To list Web ACLs
41
+ * ```javascript
42
+ * // The following example returns an array of up to 100 web ACLs.
43
+ * const input = {
44
+ * "Limit": 100
45
+ * };
46
+ * const command = new ListWebACLsCommand(input);
47
+ * const response = await client.send(command);
48
+ * /* response ==
49
+ * {
50
+ * "WebACLs": [
51
+ * {
52
+ * "Name": "WebACLexample",
53
+ * "WebACLId": "webacl-1472061481310"
54
+ * }
55
+ * ]
56
+ * }
57
+ * *\/
58
+ * // example id: listwebacls-1475258732691
59
+ * ```
60
+ *
40
61
  */
41
62
  export declare class ListWebACLsCommand extends $Command<ListWebACLsCommandInput, ListWebACLsCommandOutput, WAFRegionalClientResolvedConfig> {
42
63
  readonly input: ListWebACLsCommandInput;
@@ -37,6 +37,27 @@ export interface ListXssMatchSetsCommandOutput extends ListXssMatchSetsResponse,
37
37
  * @see {@link ListXssMatchSetsCommandOutput} for command's `response` shape.
38
38
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
39
39
  *
40
+ * @example To list XSS match sets
41
+ * ```javascript
42
+ * // The following example returns an array of up to 100 XSS match sets.
43
+ * const input = {
44
+ * "Limit": 100
45
+ * };
46
+ * const command = new ListXssMatchSetsCommand(input);
47
+ * const response = await client.send(command);
48
+ * /* response ==
49
+ * {
50
+ * "XssMatchSets": [
51
+ * {
52
+ * "Name": "MySampleXssMatchSet",
53
+ * "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
54
+ * }
55
+ * ]
56
+ * }
57
+ * *\/
58
+ * // example id: listxssmatchsets-1474561481168
59
+ * ```
60
+ *
40
61
  */
41
62
  export declare class ListXssMatchSetsCommand extends $Command<ListXssMatchSetsCommandInput, ListXssMatchSetsCommandOutput, WAFRegionalClientResolvedConfig> {
42
63
  readonly input: ListXssMatchSetsCommandInput;
@@ -75,6 +75,37 @@ export interface UpdateByteMatchSetCommandOutput extends UpdateByteMatchSetRespo
75
75
  * @see {@link UpdateByteMatchSetCommandOutput} for command's `response` shape.
76
76
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
77
77
  *
78
+ * @example To update a byte match set
79
+ * ```javascript
80
+ * // The following example deletes a ByteMatchTuple object (filters) in an byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.
81
+ * const input = {
82
+ * "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5",
83
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
84
+ * "Updates": [
85
+ * {
86
+ * "Action": "DELETE",
87
+ * "ByteMatchTuple": {
88
+ * "FieldToMatch": {
89
+ * "Data": "referer",
90
+ * "Type": "HEADER"
91
+ * },
92
+ * "PositionalConstraint": "CONTAINS",
93
+ * "TargetString": "badrefer1",
94
+ * "TextTransformation": "NONE"
95
+ * }
96
+ * }
97
+ * ]
98
+ * };
99
+ * const command = new UpdateByteMatchSetCommand(input);
100
+ * const response = await client.send(command);
101
+ * /* response ==
102
+ * {
103
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
104
+ * }
105
+ * *\/
106
+ * // example id: updatebytematchset-1475259074558
107
+ * ```
108
+ *
78
109
  */
79
110
  export declare class UpdateByteMatchSetCommand extends $Command<UpdateByteMatchSetCommandInput, UpdateByteMatchSetCommandOutput, WAFRegionalClientResolvedConfig> {
80
111
  readonly input: UpdateByteMatchSetCommandInput;
@@ -102,6 +102,32 @@ export interface UpdateIPSetCommandOutput extends UpdateIPSetResponse, __Metadat
102
102
  * @see {@link UpdateIPSetCommandOutput} for command's `response` shape.
103
103
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
104
104
  *
105
+ * @example To update an IP set
106
+ * ```javascript
107
+ * // The following example deletes an IPSetDescriptor object in an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
108
+ * const input = {
109
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
110
+ * "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
111
+ * "Updates": [
112
+ * {
113
+ * "Action": "DELETE",
114
+ * "IPSetDescriptor": {
115
+ * "Type": "IPV4",
116
+ * "Value": "192.0.2.44/32"
117
+ * }
118
+ * }
119
+ * ]
120
+ * };
121
+ * const command = new UpdateIPSetCommand(input);
122
+ * const response = await client.send(command);
123
+ * /* response ==
124
+ * {
125
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
126
+ * }
127
+ * *\/
128
+ * // example id: updateipset-1475259733625
129
+ * ```
130
+ *
105
131
  */
106
132
  export declare class UpdateIPSetCommand extends $Command<UpdateIPSetCommandInput, UpdateIPSetCommandOutput, WAFRegionalClientResolvedConfig> {
107
133
  readonly input: UpdateIPSetCommandInput;
@@ -78,6 +78,33 @@ export interface UpdateRuleCommandOutput extends UpdateRuleResponse, __MetadataB
78
78
  * @see {@link UpdateRuleCommandOutput} for command's `response` shape.
79
79
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
80
80
  *
81
+ * @example To update a rule
82
+ * ```javascript
83
+ * // The following example deletes a Predicate object in a rule with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
84
+ * const input = {
85
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
86
+ * "RuleId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
87
+ * "Updates": [
88
+ * {
89
+ * "Action": "DELETE",
90
+ * "Predicate": {
91
+ * "DataId": "MyByteMatchSetID",
92
+ * "Negated": false,
93
+ * "Type": "ByteMatch"
94
+ * }
95
+ * }
96
+ * ]
97
+ * };
98
+ * const command = new UpdateRuleCommand(input);
99
+ * const response = await client.send(command);
100
+ * /* response ==
101
+ * {
102
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
103
+ * }
104
+ * *\/
105
+ * // example id: updaterule-1475260064720
106
+ * ```
107
+ *
81
108
  */
82
109
  export declare class UpdateRuleCommand extends $Command<UpdateRuleCommandInput, UpdateRuleCommandOutput, WAFRegionalClientResolvedConfig> {
83
110
  readonly input: UpdateRuleCommandInput;
@@ -79,6 +79,36 @@ export interface UpdateSizeConstraintSetCommandOutput extends UpdateSizeConstrai
79
79
  * @see {@link UpdateSizeConstraintSetCommandOutput} for command's `response` shape.
80
80
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
81
81
  *
82
+ * @example To update a size constraint set
83
+ * ```javascript
84
+ * // The following example deletes a SizeConstraint object (filters) in a size constraint set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
85
+ * const input = {
86
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
87
+ * "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
88
+ * "Updates": [
89
+ * {
90
+ * "Action": "DELETE",
91
+ * "SizeConstraint": {
92
+ * "ComparisonOperator": "GT",
93
+ * "FieldToMatch": {
94
+ * "Type": "QUERY_STRING"
95
+ * },
96
+ * "Size": 0,
97
+ * "TextTransformation": "NONE"
98
+ * }
99
+ * }
100
+ * ]
101
+ * };
102
+ * const command = new UpdateSizeConstraintSetCommand(input);
103
+ * const response = await client.send(command);
104
+ * /* response ==
105
+ * {
106
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
107
+ * }
108
+ * *\/
109
+ * // example id: updatesizeconstraintset-1475531697891
110
+ * ```
111
+ *
82
112
  */
83
113
  export declare class UpdateSizeConstraintSetCommand extends $Command<UpdateSizeConstraintSetCommandInput, UpdateSizeConstraintSetCommandOutput, WAFRegionalClientResolvedConfig> {
84
114
  readonly input: UpdateSizeConstraintSetCommandInput;
@@ -78,6 +78,34 @@ export interface UpdateSqlInjectionMatchSetCommandOutput extends UpdateSqlInject
78
78
  * @see {@link UpdateSqlInjectionMatchSetCommandOutput} for command's `response` shape.
79
79
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
80
80
  *
81
+ * @example To update a SQL injection match set
82
+ * ```javascript
83
+ * // The following example deletes a SqlInjectionMatchTuple object (filters) in a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
84
+ * const input = {
85
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
86
+ * "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5",
87
+ * "Updates": [
88
+ * {
89
+ * "Action": "DELETE",
90
+ * "SqlInjectionMatchTuple": {
91
+ * "FieldToMatch": {
92
+ * "Type": "QUERY_STRING"
93
+ * },
94
+ * "TextTransformation": "URL_DECODE"
95
+ * }
96
+ * }
97
+ * ]
98
+ * };
99
+ * const command = new UpdateSqlInjectionMatchSetCommand(input);
100
+ * const response = await client.send(command);
101
+ * /* response ==
102
+ * {
103
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
104
+ * }
105
+ * *\/
106
+ * // example id: updatesqlinjectionmatchset-1475532094686
107
+ * ```
108
+ *
81
109
  */
82
110
  export declare class UpdateSqlInjectionMatchSetCommand extends $Command<UpdateSqlInjectionMatchSetCommandInput, UpdateSqlInjectionMatchSetCommandOutput, WAFRegionalClientResolvedConfig> {
83
111
  readonly input: UpdateSqlInjectionMatchSetCommandInput;
@@ -108,6 +108,38 @@ export interface UpdateWebACLCommandOutput extends UpdateWebACLResponse, __Metad
108
108
  * @see {@link UpdateWebACLCommandOutput} for command's `response` shape.
109
109
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
110
110
  *
111
+ * @example To update a Web ACL
112
+ * ```javascript
113
+ * // The following example deletes an ActivatedRule object in a WebACL with the ID webacl-1472061481310.
114
+ * const input = {
115
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
116
+ * "DefaultAction": {
117
+ * "Type": "ALLOW"
118
+ * },
119
+ * "Updates": [
120
+ * {
121
+ * "Action": "DELETE",
122
+ * "ActivatedRule": {
123
+ * "Action": {
124
+ * "Type": "ALLOW"
125
+ * },
126
+ * "Priority": 1,
127
+ * "RuleId": "WAFRule-1-Example"
128
+ * }
129
+ * }
130
+ * ],
131
+ * "WebACLId": "webacl-1472061481310"
132
+ * };
133
+ * const command = new UpdateWebACLCommand(input);
134
+ * const response = await client.send(command);
135
+ * /* response ==
136
+ * {
137
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
138
+ * }
139
+ * *\/
140
+ * // example id: updatewebacl-1475533627385
141
+ * ```
142
+ *
111
143
  */
112
144
  export declare class UpdateWebACLCommand extends $Command<UpdateWebACLCommandInput, UpdateWebACLCommandOutput, WAFRegionalClientResolvedConfig> {
113
145
  readonly input: UpdateWebACLCommandInput;
@@ -80,6 +80,34 @@ export interface UpdateXssMatchSetCommandOutput extends UpdateXssMatchSetRespons
80
80
  * @see {@link UpdateXssMatchSetCommandOutput} for command's `response` shape.
81
81
  * @see {@link WAFRegionalClientResolvedConfig | config} for WAFRegionalClient's `config` shape.
82
82
  *
83
+ * @example To update an XSS match set
84
+ * ```javascript
85
+ * // The following example deletes an XssMatchTuple object (filters) in an XssMatchSet with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
86
+ * const input = {
87
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
88
+ * "Updates": [
89
+ * {
90
+ * "Action": "DELETE",
91
+ * "XssMatchTuple": {
92
+ * "FieldToMatch": {
93
+ * "Type": "QUERY_STRING"
94
+ * },
95
+ * "TextTransformation": "URL_DECODE"
96
+ * }
97
+ * }
98
+ * ],
99
+ * "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
100
+ * };
101
+ * const command = new UpdateXssMatchSetCommand(input);
102
+ * const response = await client.send(command);
103
+ * /* response ==
104
+ * {
105
+ * "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
106
+ * }
107
+ * *\/
108
+ * // example id: updatexssmatchset-1475534098881
109
+ * ```
110
+ *
83
111
  */
84
112
  export declare class UpdateXssMatchSetCommand extends $Command<UpdateXssMatchSetCommandInput, UpdateXssMatchSetCommandOutput, WAFRegionalClientResolvedConfig> {
85
113
  readonly input: UpdateXssMatchSetCommandInput;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-waf-regional",
3
3
  "description": "AWS SDK for JavaScript Waf Regional Client for Node.js, Browser and React Native",
4
- "version": "3.288.0",
4
+ "version": "3.289.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,37 +20,37 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.288.0",
24
- "@aws-sdk/config-resolver": "3.287.0",
25
- "@aws-sdk/credential-provider-node": "3.288.0",
26
- "@aws-sdk/fetch-http-handler": "3.282.0",
27
- "@aws-sdk/hash-node": "3.272.0",
28
- "@aws-sdk/invalid-dependency": "3.272.0",
29
- "@aws-sdk/middleware-content-length": "3.282.0",
30
- "@aws-sdk/middleware-endpoint": "3.282.0",
31
- "@aws-sdk/middleware-host-header": "3.282.0",
32
- "@aws-sdk/middleware-logger": "3.288.0",
33
- "@aws-sdk/middleware-recursion-detection": "3.282.0",
34
- "@aws-sdk/middleware-retry": "3.287.0",
35
- "@aws-sdk/middleware-serde": "3.272.0",
36
- "@aws-sdk/middleware-signing": "3.282.0",
37
- "@aws-sdk/middleware-stack": "3.272.0",
38
- "@aws-sdk/middleware-user-agent": "3.282.0",
39
- "@aws-sdk/node-config-provider": "3.287.0",
40
- "@aws-sdk/node-http-handler": "3.282.0",
41
- "@aws-sdk/protocol-http": "3.282.0",
42
- "@aws-sdk/smithy-client": "3.279.0",
43
- "@aws-sdk/types": "3.272.0",
44
- "@aws-sdk/url-parser": "3.272.0",
23
+ "@aws-sdk/client-sts": "3.289.0",
24
+ "@aws-sdk/config-resolver": "3.289.0",
25
+ "@aws-sdk/credential-provider-node": "3.289.0",
26
+ "@aws-sdk/fetch-http-handler": "3.289.0",
27
+ "@aws-sdk/hash-node": "3.289.0",
28
+ "@aws-sdk/invalid-dependency": "3.289.0",
29
+ "@aws-sdk/middleware-content-length": "3.289.0",
30
+ "@aws-sdk/middleware-endpoint": "3.289.0",
31
+ "@aws-sdk/middleware-host-header": "3.289.0",
32
+ "@aws-sdk/middleware-logger": "3.289.0",
33
+ "@aws-sdk/middleware-recursion-detection": "3.289.0",
34
+ "@aws-sdk/middleware-retry": "3.289.0",
35
+ "@aws-sdk/middleware-serde": "3.289.0",
36
+ "@aws-sdk/middleware-signing": "3.289.0",
37
+ "@aws-sdk/middleware-stack": "3.289.0",
38
+ "@aws-sdk/middleware-user-agent": "3.289.0",
39
+ "@aws-sdk/node-config-provider": "3.289.0",
40
+ "@aws-sdk/node-http-handler": "3.289.0",
41
+ "@aws-sdk/protocol-http": "3.289.0",
42
+ "@aws-sdk/smithy-client": "3.289.0",
43
+ "@aws-sdk/types": "3.289.0",
44
+ "@aws-sdk/url-parser": "3.289.0",
45
45
  "@aws-sdk/util-base64": "3.208.0",
46
46
  "@aws-sdk/util-body-length-browser": "3.188.0",
47
47
  "@aws-sdk/util-body-length-node": "3.208.0",
48
- "@aws-sdk/util-defaults-mode-browser": "3.279.0",
49
- "@aws-sdk/util-defaults-mode-node": "3.287.0",
50
- "@aws-sdk/util-endpoints": "3.272.0",
51
- "@aws-sdk/util-retry": "3.272.0",
52
- "@aws-sdk/util-user-agent-browser": "3.282.0",
53
- "@aws-sdk/util-user-agent-node": "3.287.0",
48
+ "@aws-sdk/util-defaults-mode-browser": "3.289.0",
49
+ "@aws-sdk/util-defaults-mode-node": "3.289.0",
50
+ "@aws-sdk/util-endpoints": "3.289.0",
51
+ "@aws-sdk/util-retry": "3.289.0",
52
+ "@aws-sdk/util-user-agent-browser": "3.289.0",
53
+ "@aws-sdk/util-user-agent-node": "3.289.0",
54
54
  "@aws-sdk/util-utf8": "3.254.0",
55
55
  "tslib": "^2.3.1"
56
56
  },