forked from aws/aws-sdk-js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathwaf-regional-2016-11-28.normal.json
2886 lines (2886 loc) · 188 KB
/
waf-regional-2016-11-28.normal.json
1
2
3
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version":"2.0",
"metadata":{
"apiVersion":"2016-11-28",
"endpointPrefix":"waf-regional",
"jsonVersion":"1.1",
"protocol":"json",
"serviceAbbreviation":"WAF Regional",
"serviceFullName":"AWS WAF Regional",
"signatureVersion":"v4",
"targetPrefix":"AWSWAF_Regional_20161128",
"uid":"waf-regional-2016-11-28"
},
"operations":{
"AssociateWebACL":{
"name":"AssociateWebACL",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AssociateWebACLRequest"},
"output":{"shape":"AssociateWebACLResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFInvalidParameterException"},
{"shape":"WAFNonexistentItemException"},
{"shape":"WAFUnavailableEntityException"}
],
"documentation":"<p>Associates a web ACL with a resource.</p>"
},
"CreateByteMatchSet":{
"name":"CreateByteMatchSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateByteMatchSetRequest"},
"output":{"shape":"CreateByteMatchSetResponse"},
"errors":[
{"shape":"WAFDisallowedNameException"},
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFInvalidParameterException"},
{"shape":"WAFStaleDataException"},
{"shape":"WAFLimitsExceededException"}
],
"documentation":"<p>Creates a <code>ByteMatchSet</code>. You then use <a>UpdateByteMatchSet</a> to identify the part of a web request that you want AWS WAF to inspect, such as the values of the <code>User-Agent</code> header or the query string. For example, you can create a <code>ByteMatchSet</code> that matches any requests with <code>User-Agent</code> headers that contain the string <code>BadBot</code>. You can then configure AWS WAF to reject those requests.</p> <p>To create and configure a <code>ByteMatchSet</code>, perform the following steps:</p> <ol> <li> <p>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateByteMatchSet</code> request.</p> </li> <li> <p>Submit a <code>CreateByteMatchSet</code> request.</p> </li> <li> <p>Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateByteMatchSet</code> request.</p> </li> <li> <p>Submit an <a>UpdateByteMatchSet</a> request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.</p> </li> </ol> <p>For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href=\"http://docs.aws.amazon.com/waf/latest/developerguide/\">AWS WAF Developer Guide</a>.</p>"
},
"CreateIPSet":{
"name":"CreateIPSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateIPSetRequest"},
"output":{"shape":"CreateIPSetResponse"},
"errors":[
{"shape":"WAFStaleDataException"},
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFDisallowedNameException"},
{"shape":"WAFInvalidParameterException"},
{"shape":"WAFLimitsExceededException"}
],
"documentation":"<p>Creates an <a>IPSet</a>, which you use to specify which web requests you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an <code>IPSet</code> that contains those IP addresses and then configure AWS WAF to block the requests. </p> <p>To create and configure an <code>IPSet</code>, perform the following steps:</p> <ol> <li> <p>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateIPSet</code> request.</p> </li> <li> <p>Submit a <code>CreateIPSet</code> request.</p> </li> <li> <p>Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateIPSet</a> request.</p> </li> <li> <p>Submit an <code>UpdateIPSet</code> request to specify the IP addresses that you want AWS WAF to watch for.</p> </li> </ol> <p>For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href=\"http://docs.aws.amazon.com/waf/latest/developerguide/\">AWS WAF Developer Guide</a>.</p>"
},
"CreateRule":{
"name":"CreateRule",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateRuleRequest"},
"output":{"shape":"CreateRuleResponse"},
"errors":[
{"shape":"WAFStaleDataException"},
{"shape":"WAFInternalErrorException"},
{"shape":"WAFDisallowedNameException"},
{"shape":"WAFInvalidParameterException"},
{"shape":"WAFLimitsExceededException"}
],
"documentation":"<p>Creates a <code>Rule</code>, which contains the <code>IPSet</code> objects, <code>ByteMatchSet</code> objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a <code>Rule</code>, a request must match all of the specifications to be allowed or blocked. For example, suppose you add the following to a <code>Rule</code>:</p> <ul> <li> <p>An <code>IPSet</code> that matches the IP address <code>192.0.2.44/32</code> </p> </li> <li> <p>A <code>ByteMatchSet</code> that matches <code>BadBot</code> in the <code>User-Agent</code> header</p> </li> </ul> <p>You then add the <code>Rule</code> to a <code>WebACL</code> and specify that you want to blocks requests that satisfy the <code>Rule</code>. For a request to be blocked, it must come from the IP address 192.0.2.44 <i>and</i> the <code>User-Agent</code> header in the request must contain the value <code>BadBot</code>.</p> <p>To create and configure a <code>Rule</code>, perform the following steps:</p> <ol> <li> <p>Create and update the predicates that you want to include in the <code>Rule</code>. For more information, see <a>CreateByteMatchSet</a>, <a>CreateIPSet</a>, and <a>CreateSqlInjectionMatchSet</a>.</p> </li> <li> <p>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateRule</code> request.</p> </li> <li> <p>Submit a <code>CreateRule</code> request.</p> </li> <li> <p>Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateRule</a> request.</p> </li> <li> <p>Submit an <code>UpdateRule</code> request to specify the predicates that you want to include in the <code>Rule</code>.</p> </li> <li> <p>Create and update a <code>WebACL</code> that contains the <code>Rule</code>. For more information, see <a>CreateWebACL</a>.</p> </li> </ol> <p>For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href=\"http://docs.aws.amazon.com/waf/latest/developerguide/\">AWS WAF Developer Guide</a>.</p>"
},
"CreateSizeConstraintSet":{
"name":"CreateSizeConstraintSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateSizeConstraintSetRequest"},
"output":{"shape":"CreateSizeConstraintSetResponse"},
"errors":[
{"shape":"WAFStaleDataException"},
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFDisallowedNameException"},
{"shape":"WAFInvalidParameterException"},
{"shape":"WAFLimitsExceededException"}
],
"documentation":"<p>Creates a <code>SizeConstraintSet</code>. You then use <a>UpdateSizeConstraintSet</a> to identify the part of a web request that you want AWS WAF to check for length, such as the length of the <code>User-Agent</code> header or the length of the query string. For example, you can create a <code>SizeConstraintSet</code> that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests.</p> <p>To create and configure a <code>SizeConstraintSet</code>, perform the following steps:</p> <ol> <li> <p>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateSizeConstraintSet</code> request.</p> </li> <li> <p>Submit a <code>CreateSizeConstraintSet</code> request.</p> </li> <li> <p>Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateSizeConstraintSet</code> request.</p> </li> <li> <p>Submit an <a>UpdateSizeConstraintSet</a> request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.</p> </li> </ol> <p>For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href=\"http://docs.aws.amazon.com/waf/latest/developerguide/\">AWS WAF Developer Guide</a>.</p>"
},
"CreateSqlInjectionMatchSet":{
"name":"CreateSqlInjectionMatchSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateSqlInjectionMatchSetRequest"},
"output":{"shape":"CreateSqlInjectionMatchSetResponse"},
"errors":[
{"shape":"WAFDisallowedNameException"},
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFInvalidParameterException"},
{"shape":"WAFStaleDataException"},
{"shape":"WAFLimitsExceededException"}
],
"documentation":"<p>Creates a <a>SqlInjectionMatchSet</a>, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.</p> <p>To create and configure a <code>SqlInjectionMatchSet</code>, perform the following steps:</p> <ol> <li> <p>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateSqlInjectionMatchSet</code> request.</p> </li> <li> <p>Submit a <code>CreateSqlInjectionMatchSet</code> request.</p> </li> <li> <p>Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateSqlInjectionMatchSet</a> request.</p> </li> <li> <p>Submit an <a>UpdateSqlInjectionMatchSet</a> request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code.</p> </li> </ol> <p>For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href=\"http://docs.aws.amazon.com/waf/latest/developerguide/\">AWS WAF Developer Guide</a>.</p>"
},
"CreateWebACL":{
"name":"CreateWebACL",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateWebACLRequest"},
"output":{"shape":"CreateWebACLResponse"},
"errors":[
{"shape":"WAFStaleDataException"},
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFDisallowedNameException"},
{"shape":"WAFInvalidParameterException"},
{"shape":"WAFLimitsExceededException"}
],
"documentation":"<p>Creates a <code>WebACL</code>, which contains the <code>Rules</code> that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates <code>Rules</code> in order based on the value of <code>Priority</code> for each <code>Rule</code>.</p> <p>You also specify a default action, either <code>ALLOW</code> or <code>BLOCK</code>. If a web request doesn't match any of the <code>Rules</code> in a <code>WebACL</code>, AWS WAF responds to the request with the default action. </p> <p>To create and configure a <code>WebACL</code>, perform the following steps:</p> <ol> <li> <p>Create and update the <code>ByteMatchSet</code> objects and other predicates that you want to include in <code>Rules</code>. For more information, see <a>CreateByteMatchSet</a>, <a>UpdateByteMatchSet</a>, <a>CreateIPSet</a>, <a>UpdateIPSet</a>, <a>CreateSqlInjectionMatchSet</a>, and <a>UpdateSqlInjectionMatchSet</a>.</p> </li> <li> <p>Create and update the <code>Rules</code> that you want to include in the <code>WebACL</code>. For more information, see <a>CreateRule</a> and <a>UpdateRule</a>.</p> </li> <li> <p>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateWebACL</code> request.</p> </li> <li> <p>Submit a <code>CreateWebACL</code> request.</p> </li> <li> <p>Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateWebACL</a> request.</p> </li> <li> <p>Submit an <a>UpdateWebACL</a> request to specify the <code>Rules</code> that you want to include in the <code>WebACL</code>, to specify the default action, and to associate the <code>WebACL</code> with a CloudFront distribution.</p> </li> </ol> <p>For more information about how to use the AWS WAF API, see the <a href=\"http://docs.aws.amazon.com/waf/latest/developerguide/\">AWS WAF Developer Guide</a>.</p>"
},
"CreateXssMatchSet":{
"name":"CreateXssMatchSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateXssMatchSetRequest"},
"output":{"shape":"CreateXssMatchSetResponse"},
"errors":[
{"shape":"WAFDisallowedNameException"},
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFInvalidParameterException"},
{"shape":"WAFStaleDataException"},
{"shape":"WAFLimitsExceededException"}
],
"documentation":"<p>Creates an <a>XssMatchSet</a>, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.</p> <p>To create and configure an <code>XssMatchSet</code>, perform the following steps:</p> <ol> <li> <p>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateXssMatchSet</code> request.</p> </li> <li> <p>Submit a <code>CreateXssMatchSet</code> request.</p> </li> <li> <p>Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateXssMatchSet</a> request.</p> </li> <li> <p>Submit an <a>UpdateXssMatchSet</a> request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks.</p> </li> </ol> <p>For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href=\"http://docs.aws.amazon.com/waf/latest/developerguide/\">AWS WAF Developer Guide</a>.</p>"
},
"DeleteByteMatchSet":{
"name":"DeleteByteMatchSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteByteMatchSetRequest"},
"output":{"shape":"DeleteByteMatchSetResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFNonexistentItemException"},
{"shape":"WAFReferencedItemException"},
{"shape":"WAFStaleDataException"},
{"shape":"WAFNonEmptyEntityException"}
],
"documentation":"<p>Permanently deletes a <a>ByteMatchSet</a>. You can't delete a <code>ByteMatchSet</code> if it's still used in any <code>Rules</code> or if it still includes any <a>ByteMatchTuple</a> objects (any filters).</p> <p>If you just want to remove a <code>ByteMatchSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>.</p> <p>To permanently delete a <code>ByteMatchSet</code>, perform the following steps:</p> <ol> <li> <p>Update the <code>ByteMatchSet</code> to remove filters, if any. For more information, see <a>UpdateByteMatchSet</a>.</p> </li> <li> <p>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteByteMatchSet</code> request.</p> </li> <li> <p>Submit a <code>DeleteByteMatchSet</code> request.</p> </li> </ol>"
},
"DeleteIPSet":{
"name":"DeleteIPSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteIPSetRequest"},
"output":{"shape":"DeleteIPSetResponse"},
"errors":[
{"shape":"WAFStaleDataException"},
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFNonexistentItemException"},
{"shape":"WAFReferencedItemException"},
{"shape":"WAFNonEmptyEntityException"}
],
"documentation":"<p>Permanently deletes an <a>IPSet</a>. You can't delete an <code>IPSet</code> if it's still used in any <code>Rules</code> or if it still includes any IP addresses.</p> <p>If you just want to remove an <code>IPSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>.</p> <p>To permanently delete an <code>IPSet</code> from AWS WAF, perform the following steps:</p> <ol> <li> <p>Update the <code>IPSet</code> to remove IP address ranges, if any. For more information, see <a>UpdateIPSet</a>.</p> </li> <li> <p>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteIPSet</code> request.</p> </li> <li> <p>Submit a <code>DeleteIPSet</code> request.</p> </li> </ol>"
},
"DeleteRule":{
"name":"DeleteRule",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteRuleRequest"},
"output":{"shape":"DeleteRuleResponse"},
"errors":[
{"shape":"WAFStaleDataException"},
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFNonexistentItemException"},
{"shape":"WAFReferencedItemException"},
{"shape":"WAFNonEmptyEntityException"}
],
"documentation":"<p>Permanently deletes a <a>Rule</a>. You can't delete a <code>Rule</code> if it's still used in any <code>WebACL</code> objects or if it still includes any predicates, such as <code>ByteMatchSet</code> objects.</p> <p>If you just want to remove a <code>Rule</code> from a <code>WebACL</code>, use <a>UpdateWebACL</a>.</p> <p>To permanently delete a <code>Rule</code> from AWS WAF, perform the following steps:</p> <ol> <li> <p>Update the <code>Rule</code> to remove predicates, if any. For more information, see <a>UpdateRule</a>.</p> </li> <li> <p>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteRule</code> request.</p> </li> <li> <p>Submit a <code>DeleteRule</code> request.</p> </li> </ol>"
},
"DeleteSizeConstraintSet":{
"name":"DeleteSizeConstraintSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteSizeConstraintSetRequest"},
"output":{"shape":"DeleteSizeConstraintSetResponse"},
"errors":[
{"shape":"WAFStaleDataException"},
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFNonexistentItemException"},
{"shape":"WAFReferencedItemException"},
{"shape":"WAFNonEmptyEntityException"}
],
"documentation":"<p>Permanently deletes a <a>SizeConstraintSet</a>. You can't delete a <code>SizeConstraintSet</code> if it's still used in any <code>Rules</code> or if it still includes any <a>SizeConstraint</a> objects (any filters).</p> <p>If you just want to remove a <code>SizeConstraintSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>.</p> <p>To permanently delete a <code>SizeConstraintSet</code>, perform the following steps:</p> <ol> <li> <p>Update the <code>SizeConstraintSet</code> to remove filters, if any. For more information, see <a>UpdateSizeConstraintSet</a>.</p> </li> <li> <p>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteSizeConstraintSet</code> request.</p> </li> <li> <p>Submit a <code>DeleteSizeConstraintSet</code> request.</p> </li> </ol>"
},
"DeleteSqlInjectionMatchSet":{
"name":"DeleteSqlInjectionMatchSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteSqlInjectionMatchSetRequest"},
"output":{"shape":"DeleteSqlInjectionMatchSetResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFNonexistentItemException"},
{"shape":"WAFReferencedItemException"},
{"shape":"WAFStaleDataException"},
{"shape":"WAFNonEmptyEntityException"}
],
"documentation":"<p>Permanently deletes a <a>SqlInjectionMatchSet</a>. You can't delete a <code>SqlInjectionMatchSet</code> if it's still used in any <code>Rules</code> or if it still contains any <a>SqlInjectionMatchTuple</a> objects.</p> <p>If you just want to remove a <code>SqlInjectionMatchSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>.</p> <p>To permanently delete a <code>SqlInjectionMatchSet</code> from AWS WAF, perform the following steps:</p> <ol> <li> <p>Update the <code>SqlInjectionMatchSet</code> to remove filters, if any. For more information, see <a>UpdateSqlInjectionMatchSet</a>.</p> </li> <li> <p>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteSqlInjectionMatchSet</code> request.</p> </li> <li> <p>Submit a <code>DeleteSqlInjectionMatchSet</code> request.</p> </li> </ol>"
},
"DeleteWebACL":{
"name":"DeleteWebACL",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteWebACLRequest"},
"output":{"shape":"DeleteWebACLResponse"},
"errors":[
{"shape":"WAFStaleDataException"},
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFNonexistentItemException"},
{"shape":"WAFReferencedItemException"},
{"shape":"WAFNonEmptyEntityException"}
],
"documentation":"<p>Permanently deletes a <a>WebACL</a>. You can't delete a <code>WebACL</code> if it still contains any <code>Rules</code>.</p> <p>To delete a <code>WebACL</code>, perform the following steps:</p> <ol> <li> <p>Update the <code>WebACL</code> to remove <code>Rules</code>, if any. For more information, see <a>UpdateWebACL</a>.</p> </li> <li> <p>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteWebACL</code> request.</p> </li> <li> <p>Submit a <code>DeleteWebACL</code> request.</p> </li> </ol>"
},
"DeleteXssMatchSet":{
"name":"DeleteXssMatchSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteXssMatchSetRequest"},
"output":{"shape":"DeleteXssMatchSetResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFNonexistentItemException"},
{"shape":"WAFReferencedItemException"},
{"shape":"WAFStaleDataException"},
{"shape":"WAFNonEmptyEntityException"}
],
"documentation":"<p>Permanently deletes an <a>XssMatchSet</a>. You can't delete an <code>XssMatchSet</code> if it's still used in any <code>Rules</code> or if it still contains any <a>XssMatchTuple</a> objects.</p> <p>If you just want to remove an <code>XssMatchSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>.</p> <p>To permanently delete an <code>XssMatchSet</code> from AWS WAF, perform the following steps:</p> <ol> <li> <p>Update the <code>XssMatchSet</code> to remove filters, if any. For more information, see <a>UpdateXssMatchSet</a>.</p> </li> <li> <p>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteXssMatchSet</code> request.</p> </li> <li> <p>Submit a <code>DeleteXssMatchSet</code> request.</p> </li> </ol>"
},
"DisassociateWebACL":{
"name":"DisassociateWebACL",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisassociateWebACLRequest"},
"output":{"shape":"DisassociateWebACLResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFInvalidParameterException"},
{"shape":"WAFNonexistentItemException"}
],
"documentation":"<p>Removes a web ACL from the specified resource.</p>"
},
"GetByteMatchSet":{
"name":"GetByteMatchSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetByteMatchSetRequest"},
"output":{"shape":"GetByteMatchSetResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFNonexistentItemException"}
],
"documentation":"<p>Returns the <a>ByteMatchSet</a> specified by <code>ByteMatchSetId</code>.</p>"
},
"GetChangeToken":{
"name":"GetChangeToken",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetChangeTokenRequest"},
"output":{"shape":"GetChangeTokenResponse"},
"errors":[
{"shape":"WAFInternalErrorException"}
],
"documentation":"<p>When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF.</p> <p>Each create, update, or delete request must use a unique change token. If your application submits a <code>GetChangeToken</code> request and then submits a second <code>GetChangeToken</code> request before submitting a create, update, or delete request, the second <code>GetChangeToken</code> request returns the same value as the first <code>GetChangeToken</code> request.</p> <p>When you use a change token in a create, update, or delete request, the status of the change token changes to <code>PENDING</code>, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use <code>GetChangeTokenStatus</code> to determine the status of your change token.</p>"
},
"GetChangeTokenStatus":{
"name":"GetChangeTokenStatus",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetChangeTokenStatusRequest"},
"output":{"shape":"GetChangeTokenStatusResponse"},
"errors":[
{"shape":"WAFNonexistentItemException"},
{"shape":"WAFInternalErrorException"}
],
"documentation":"<p>Returns the status of a <code>ChangeToken</code> that you got by calling <a>GetChangeToken</a>. <code>ChangeTokenStatus</code> is one of the following values:</p> <ul> <li> <p> <code>PROVISIONED</code>: You requested the change token by calling <code>GetChangeToken</code>, but you haven't used it yet in a call to create, update, or delete an AWS WAF object.</p> </li> <li> <p> <code>PENDING</code>: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers.</p> </li> <li> <p> <code>IN_SYNC</code>: Propagation is complete.</p> </li> </ul>"
},
"GetIPSet":{
"name":"GetIPSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetIPSetRequest"},
"output":{"shape":"GetIPSetResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFNonexistentItemException"}
],
"documentation":"<p>Returns the <a>IPSet</a> that is specified by <code>IPSetId</code>.</p>"
},
"GetRule":{
"name":"GetRule",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetRuleRequest"},
"output":{"shape":"GetRuleResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFNonexistentItemException"}
],
"documentation":"<p>Returns the <a>Rule</a> that is specified by the <code>RuleId</code> that you included in the <code>GetRule</code> request.</p>"
},
"GetSampledRequests":{
"name":"GetSampledRequests",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetSampledRequestsRequest"},
"output":{"shape":"GetSampledRequestsResponse"},
"errors":[
{"shape":"WAFNonexistentItemException"},
{"shape":"WAFInternalErrorException"}
],
"documentation":"<p>Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 100 requests, and you can specify any time range in the previous three hours.</p> <p> <code>GetSampledRequests</code> returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, <code>GetSampledRequests</code> returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample.</p>"
},
"GetSizeConstraintSet":{
"name":"GetSizeConstraintSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetSizeConstraintSetRequest"},
"output":{"shape":"GetSizeConstraintSetResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFNonexistentItemException"}
],
"documentation":"<p>Returns the <a>SizeConstraintSet</a> specified by <code>SizeConstraintSetId</code>.</p>"
},
"GetSqlInjectionMatchSet":{
"name":"GetSqlInjectionMatchSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetSqlInjectionMatchSetRequest"},
"output":{"shape":"GetSqlInjectionMatchSetResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFNonexistentItemException"}
],
"documentation":"<p>Returns the <a>SqlInjectionMatchSet</a> that is specified by <code>SqlInjectionMatchSetId</code>.</p>"
},
"GetWebACL":{
"name":"GetWebACL",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetWebACLRequest"},
"output":{"shape":"GetWebACLResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFNonexistentItemException"}
],
"documentation":"<p>Returns the <a>WebACL</a> that is specified by <code>WebACLId</code>.</p>"
},
"GetWebACLForResource":{
"name":"GetWebACLForResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetWebACLForResourceRequest"},
"output":{"shape":"GetWebACLForResourceResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFNonexistentItemException"},
{"shape":"WAFInvalidParameterException"},
{"shape":"WAFUnavailableEntityException"}
],
"documentation":"<p>Returns the web ACL for the specified resource.</p>"
},
"GetXssMatchSet":{
"name":"GetXssMatchSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetXssMatchSetRequest"},
"output":{"shape":"GetXssMatchSetResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFNonexistentItemException"}
],
"documentation":"<p>Returns the <a>XssMatchSet</a> that is specified by <code>XssMatchSetId</code>.</p>"
},
"ListByteMatchSets":{
"name":"ListByteMatchSets",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListByteMatchSetsRequest"},
"output":{"shape":"ListByteMatchSetsResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"}
],
"documentation":"<p>Returns an array of <a>ByteMatchSetSummary</a> objects.</p>"
},
"ListIPSets":{
"name":"ListIPSets",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListIPSetsRequest"},
"output":{"shape":"ListIPSetsResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"}
],
"documentation":"<p>Returns an array of <a>IPSetSummary</a> objects in the response.</p>"
},
"ListResourcesForWebACL":{
"name":"ListResourcesForWebACL",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListResourcesForWebACLRequest"},
"output":{"shape":"ListResourcesForWebACLResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFNonexistentItemException"}
],
"documentation":"<p>Returns an array of resources associated with the specified web ACL.</p>"
},
"ListRules":{
"name":"ListRules",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListRulesRequest"},
"output":{"shape":"ListRulesResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"}
],
"documentation":"<p>Returns an array of <a>RuleSummary</a> objects.</p>"
},
"ListSizeConstraintSets":{
"name":"ListSizeConstraintSets",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListSizeConstraintSetsRequest"},
"output":{"shape":"ListSizeConstraintSetsResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"}
],
"documentation":"<p>Returns an array of <a>SizeConstraintSetSummary</a> objects.</p>"
},
"ListSqlInjectionMatchSets":{
"name":"ListSqlInjectionMatchSets",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListSqlInjectionMatchSetsRequest"},
"output":{"shape":"ListSqlInjectionMatchSetsResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"}
],
"documentation":"<p>Returns an array of <a>SqlInjectionMatchSet</a> objects.</p>"
},
"ListWebACLs":{
"name":"ListWebACLs",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListWebACLsRequest"},
"output":{"shape":"ListWebACLsResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"}
],
"documentation":"<p>Returns an array of <a>WebACLSummary</a> objects in the response.</p>"
},
"ListXssMatchSets":{
"name":"ListXssMatchSets",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListXssMatchSetsRequest"},
"output":{"shape":"ListXssMatchSetsResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"}
],
"documentation":"<p>Returns an array of <a>XssMatchSet</a> objects.</p>"
},
"UpdateByteMatchSet":{
"name":"UpdateByteMatchSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateByteMatchSetRequest"},
"output":{"shape":"UpdateByteMatchSetResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFInvalidOperationException"},
{"shape":"WAFInvalidParameterException"},
{"shape":"WAFNonexistentContainerException"},
{"shape":"WAFNonexistentItemException"},
{"shape":"WAFStaleDataException"},
{"shape":"WAFLimitsExceededException"}
],
"documentation":"<p>Inserts or deletes <a>ByteMatchTuple</a> objects (filters) in a <a>ByteMatchSet</a>. For each <code>ByteMatchTuple</code> object, you specify the following values: </p> <ul> <li> <p>Whether to insert or delete the object from the array. If you want to change a <code>ByteMatchSetUpdate</code> object, you delete the existing object and add a new one.</p> </li> <li> <p>The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the <code>User-Agent</code> header. </p> </li> <li> <p>The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see <code>TargetString</code> in the <a>ByteMatchTuple</a> data type. </p> </li> <li> <p>Where to look, such as at the beginning or the end of a query string.</p> </li> <li> <p>Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.</p> </li> </ul> <p>For example, you can add a <code>ByteMatchSetUpdate</code> object that matches web requests in which <code>User-Agent</code> headers contain the string <code>BadBot</code>. You can then configure AWS WAF to block those requests.</p> <p>To create and configure a <code>ByteMatchSet</code>, perform the following steps:</p> <ol> <li> <p>Create a <code>ByteMatchSet.</code> For more information, see <a>CreateByteMatchSet</a>.</p> </li> <li> <p>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateByteMatchSet</code> request.</p> </li> <li> <p>Submit an <code>UpdateByteMatchSet</code> request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.</p> </li> </ol> <p>For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href=\"http://docs.aws.amazon.com/waf/latest/developerguide/\">AWS WAF Developer Guide</a>.</p>"
},
"UpdateIPSet":{
"name":"UpdateIPSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateIPSetRequest"},
"output":{"shape":"UpdateIPSetResponse"},
"errors":[
{"shape":"WAFStaleDataException"},
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFInvalidOperationException"},
{"shape":"WAFInvalidParameterException"},
{"shape":"WAFNonexistentContainerException"},
{"shape":"WAFNonexistentItemException"},
{"shape":"WAFReferencedItemException"},
{"shape":"WAFLimitsExceededException"}
],
"documentation":"<p>Inserts or deletes <a>IPSetDescriptor</a> objects in an <code>IPSet</code>. For each <code>IPSetDescriptor</code> object, you specify the following values: </p> <ul> <li> <p>Whether to insert or delete the object from the array. If you want to change an <code>IPSetDescriptor</code> object, you delete the existing object and add a new one.</p> </li> <li> <p>The IP address version, <code>IPv4</code> or <code>IPv6</code>. </p> </li> <li> <p>The IP address in CIDR notation, for example, <code>192.0.2.0/24</code> (for the range of IP addresses from <code>192.0.2.0</code> to <code>192.0.2.255</code>) or <code>192.0.2.44/32</code> (for the individual IP address <code>192.0.2.44</code>). </p> </li> </ul> <p>AWS WAF supports /8, /16, /24, and /32 IP address ranges for IPv4, and /24, /32, /48, /56, /64 and /128 for IPv6. For more information about CIDR notation, see the Wikipedia entry <a href=\"https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Classless Inter-Domain Routing</a>.</p> <p>IPv6 addresses can be represented using any of the following formats:</p> <ul> <li> <p>1111:0000:0000:0000:0000:0000:0000:0111/128</p> </li> <li> <p>1111:0:0:0:0:0:0:0111/128</p> </li> <li> <p>1111::0111/128</p> </li> <li> <p>1111::111/128</p> </li> </ul> <p>You use an <code>IPSet</code> to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an <code>IPSet</code> that specifies those IP addresses, and then configure AWS WAF to block the requests. </p> <p>To create and configure an <code>IPSet</code>, perform the following steps:</p> <ol> <li> <p>Submit a <a>CreateIPSet</a> request.</p> </li> <li> <p>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateIPSet</a> request.</p> </li> <li> <p>Submit an <code>UpdateIPSet</code> request to specify the IP addresses that you want AWS WAF to watch for.</p> </li> </ol> <p>When you update an <code>IPSet</code>, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one.</p> <p>For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href=\"http://docs.aws.amazon.com/waf/latest/developerguide/\">AWS WAF Developer Guide</a>.</p>"
},
"UpdateRule":{
"name":"UpdateRule",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateRuleRequest"},
"output":{"shape":"UpdateRuleResponse"},
"errors":[
{"shape":"WAFStaleDataException"},
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFInvalidOperationException"},
{"shape":"WAFInvalidParameterException"},
{"shape":"WAFNonexistentContainerException"},
{"shape":"WAFNonexistentItemException"},
{"shape":"WAFReferencedItemException"},
{"shape":"WAFLimitsExceededException"}
],
"documentation":"<p>Inserts or deletes <a>Predicate</a> objects in a <code>Rule</code>. Each <code>Predicate</code> object identifies a predicate, such as a <a>ByteMatchSet</a> or an <a>IPSet</a>, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a <code>Rule</code>, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose you add the following to a <code>Rule</code>: </p> <ul> <li> <p>A <code>ByteMatchSet</code> that matches the value <code>BadBot</code> in the <code>User-Agent</code> header</p> </li> <li> <p>An <code>IPSet</code> that matches the IP address <code>192.0.2.44</code> </p> </li> </ul> <p>You then add the <code>Rule</code> to a <code>WebACL</code> and specify that you want to block requests that satisfy the <code>Rule</code>. For a request to be blocked, the <code>User-Agent</code> header in the request must contain the value <code>BadBot</code> <i>and</i> the request must originate from the IP address 192.0.2.44.</p> <p>To create and configure a <code>Rule</code>, perform the following steps:</p> <ol> <li> <p>Create and update the predicates that you want to include in the <code>Rule</code>.</p> </li> <li> <p>Create the <code>Rule</code>. See <a>CreateRule</a>.</p> </li> <li> <p>Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateRule</a> request.</p> </li> <li> <p>Submit an <code>UpdateRule</code> request to add predicates to the <code>Rule</code>.</p> </li> <li> <p>Create and update a <code>WebACL</code> that contains the <code>Rule</code>. See <a>CreateWebACL</a>.</p> </li> </ol> <p>If you want to replace one <code>ByteMatchSet</code> or <code>IPSet</code> with another, you delete the existing one and add the new one.</p> <p>For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href=\"http://docs.aws.amazon.com/waf/latest/developerguide/\">AWS WAF Developer Guide</a>.</p>"
},
"UpdateSizeConstraintSet":{
"name":"UpdateSizeConstraintSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateSizeConstraintSetRequest"},
"output":{"shape":"UpdateSizeConstraintSetResponse"},
"errors":[
{"shape":"WAFStaleDataException"},
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFInvalidOperationException"},
{"shape":"WAFInvalidParameterException"},
{"shape":"WAFNonexistentContainerException"},
{"shape":"WAFNonexistentItemException"},
{"shape":"WAFReferencedItemException"},
{"shape":"WAFLimitsExceededException"}
],
"documentation":"<p>Inserts or deletes <a>SizeConstraint</a> objects (filters) in a <a>SizeConstraintSet</a>. For each <code>SizeConstraint</code> object, you specify the following values: </p> <ul> <li> <p>Whether to insert or delete the object from the array. If you want to change a <code>SizeConstraintSetUpdate</code> object, you delete the existing object and add a new one.</p> </li> <li> <p>The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the <code>User-Agent</code> header.</p> </li> <li> <p>Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first <code>8192</code> bytes of your request to AWS WAF.</p> </li> <li> <p>A <code>ComparisonOperator</code> used for evaluating the selected part of the request against the specified <code>Size</code>, such as equals, greater than, less than, and so on.</p> </li> <li> <p>The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation.</p> </li> </ul> <p>For example, you can add a <code>SizeConstraintSetUpdate</code> object that matches web requests in which the length of the <code>User-Agent</code> header is greater than 100 bytes. You can then configure AWS WAF to block those requests.</p> <p>To create and configure a <code>SizeConstraintSet</code>, perform the following steps:</p> <ol> <li> <p>Create a <code>SizeConstraintSet.</code> For more information, see <a>CreateSizeConstraintSet</a>.</p> </li> <li> <p>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateSizeConstraintSet</code> request.</p> </li> <li> <p>Submit an <code>UpdateSizeConstraintSet</code> request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.</p> </li> </ol> <p>For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href=\"http://docs.aws.amazon.com/waf/latest/developerguide/\">AWS WAF Developer Guide</a>.</p>"
},
"UpdateSqlInjectionMatchSet":{
"name":"UpdateSqlInjectionMatchSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateSqlInjectionMatchSetRequest"},
"output":{"shape":"UpdateSqlInjectionMatchSetResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFInvalidOperationException"},
{"shape":"WAFInvalidParameterException"},
{"shape":"WAFNonexistentContainerException"},
{"shape":"WAFNonexistentItemException"},
{"shape":"WAFStaleDataException"},
{"shape":"WAFLimitsExceededException"}
],
"documentation":"<p>Inserts or deletes <a>SqlInjectionMatchTuple</a> objects (filters) in a <a>SqlInjectionMatchSet</a>. For each <code>SqlInjectionMatchTuple</code> object, you specify the following values:</p> <ul> <li> <p> <code>Action</code>: Whether to insert the object into or delete the object from the array. To change a <code>SqlInjectionMatchTuple</code>, you delete the existing object and add a new one.</p> </li> <li> <p> <code>FieldToMatch</code>: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header, the name of the header.</p> </li> <li> <p> <code>TextTransformation</code>: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code.</p> </li> </ul> <p>You use <code>SqlInjectionMatchSet</code> objects to specify which CloudFront requests you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a <code>SqlInjectionMatchSet</code> with the applicable settings, and then configure AWS WAF to block the requests. </p> <p>To create and configure a <code>SqlInjectionMatchSet</code>, perform the following steps:</p> <ol> <li> <p>Submit a <a>CreateSqlInjectionMatchSet</a> request.</p> </li> <li> <p>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateIPSet</a> request.</p> </li> <li> <p>Submit an <code>UpdateSqlInjectionMatchSet</code> request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code.</p> </li> </ol> <p>For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href=\"http://docs.aws.amazon.com/waf/latest/developerguide/\">AWS WAF Developer Guide</a>.</p>"
},
"UpdateWebACL":{
"name":"UpdateWebACL",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateWebACLRequest"},
"output":{"shape":"UpdateWebACLResponse"},
"errors":[
{"shape":"WAFStaleDataException"},
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFInvalidOperationException"},
{"shape":"WAFInvalidParameterException"},
{"shape":"WAFNonexistentContainerException"},
{"shape":"WAFNonexistentItemException"},
{"shape":"WAFReferencedItemException"},
{"shape":"WAFLimitsExceededException"}
],
"documentation":"<p>Inserts or deletes <a>ActivatedRule</a> objects in a <code>WebACL</code>. Each <code>Rule</code> identifies web requests that you want to allow, block, or count. When you update a <code>WebACL</code>, you specify the following values:</p> <ul> <li> <p>A default action for the <code>WebACL</code>, either <code>ALLOW</code> or <code>BLOCK</code>. AWS WAF performs the default action if a request doesn't match the criteria in any of the <code>Rules</code> in a <code>WebACL</code>.</p> </li> <li> <p>The <code>Rules</code> that you want to add and/or delete. If you want to replace one <code>Rule</code> with another, you delete the existing <code>Rule</code> and add the new one.</p> </li> <li> <p>For each <code>Rule</code>, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the <code>Rule</code>.</p> </li> <li> <p>The order in which you want AWS WAF to evaluate the <code>Rules</code> in a <code>WebACL</code>. If you add more than one <code>Rule</code> to a <code>WebACL</code>, AWS WAF evaluates each request against the <code>Rules</code> in order based on the value of <code>Priority</code>. (The <code>Rule</code> that has the lowest value for <code>Priority</code> is evaluated first.) When a web request matches all of the predicates (such as <code>ByteMatchSets</code> and <code>IPSets</code>) in a <code>Rule</code>, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining <code>Rules</code> in the <code>WebACL</code>, if any. </p> </li> <li> <p>The CloudFront distribution that you want to associate with the <code>WebACL</code>.</p> </li> </ul> <p>To create and configure a <code>WebACL</code>, perform the following steps:</p> <ol> <li> <p>Create and update the predicates that you want to include in <code>Rules</code>. For more information, see <a>CreateByteMatchSet</a>, <a>UpdateByteMatchSet</a>, <a>CreateIPSet</a>, <a>UpdateIPSet</a>, <a>CreateSqlInjectionMatchSet</a>, and <a>UpdateSqlInjectionMatchSet</a>.</p> </li> <li> <p>Create and update the <code>Rules</code> that you want to include in the <code>WebACL</code>. For more information, see <a>CreateRule</a> and <a>UpdateRule</a>.</p> </li> <li> <p>Create a <code>WebACL</code>. See <a>CreateWebACL</a>.</p> </li> <li> <p>Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateWebACL</a> request.</p> </li> <li> <p>Submit an <code>UpdateWebACL</code> request to specify the <code>Rules</code> that you want to include in the <code>WebACL</code>, to specify the default action, and to associate the <code>WebACL</code> with a CloudFront distribution. </p> </li> </ol> <p>For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href=\"http://docs.aws.amazon.com/waf/latest/developerguide/\">AWS WAF Developer Guide</a>.</p>"
},
"UpdateXssMatchSet":{
"name":"UpdateXssMatchSet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateXssMatchSetRequest"},
"output":{"shape":"UpdateXssMatchSetResponse"},
"errors":[
{"shape":"WAFInternalErrorException"},
{"shape":"WAFInvalidAccountException"},
{"shape":"WAFInvalidOperationException"},
{"shape":"WAFInvalidParameterException"},
{"shape":"WAFNonexistentContainerException"},
{"shape":"WAFNonexistentItemException"},
{"shape":"WAFStaleDataException"},
{"shape":"WAFLimitsExceededException"}
],
"documentation":"<p>Inserts or deletes <a>XssMatchTuple</a> objects (filters) in an <a>XssMatchSet</a>. For each <code>XssMatchTuple</code> object, you specify the following values:</p> <ul> <li> <p> <code>Action</code>: Whether to insert the object into or delete the object from the array. To change a <code>XssMatchTuple</code>, you delete the existing object and add a new one.</p> </li> <li> <p> <code>FieldToMatch</code>: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header, the name of the header.</p> </li> <li> <p> <code>TextTransformation</code>: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks.</p> </li> </ul> <p>You use <code>XssMatchSet</code> objects to specify which CloudFront requests you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an <code>XssMatchSet</code> with the applicable settings, and then configure AWS WAF to block the requests. </p> <p>To create and configure an <code>XssMatchSet</code>, perform the following steps:</p> <ol> <li> <p>Submit a <a>CreateXssMatchSet</a> request.</p> </li> <li> <p>Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateIPSet</a> request.</p> </li> <li> <p>Submit an <code>UpdateXssMatchSet</code> request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks.</p> </li> </ol> <p>For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href=\"http://docs.aws.amazon.com/waf/latest/developerguide/\">AWS WAF Developer Guide</a>.</p>"
}
},
"shapes":{
"Action":{"type":"string"},
"ActivatedRule":{
"type":"structure",
"required":[
"Priority",
"RuleId",
"Action"
],
"members":{
"Priority":{
"shape":"RulePriority",
"documentation":"<p>Specifies the order in which the <code>Rules</code> in a <code>WebACL</code> are evaluated. Rules with a lower value for <code>Priority</code> are evaluated before <code>Rules</code> with a higher value. The value must be a unique integer. If you add multiple <code>Rules</code> to a <code>WebACL</code>, the values don't need to be consecutive.</p>"
},
"RuleId":{
"shape":"ResourceId",
"documentation":"<p>The <code>RuleId</code> for a <code>Rule</code>. You use <code>RuleId</code> to get more information about a <code>Rule</code> (see <a>GetRule</a>), update a <code>Rule</code> (see <a>UpdateRule</a>), insert a <code>Rule</code> into a <code>WebACL</code> or delete a one from a <code>WebACL</code> (see <a>UpdateWebACL</a>), or delete a <code>Rule</code> from AWS WAF (see <a>DeleteRule</a>).</p> <p> <code>RuleId</code> is returned by <a>CreateRule</a> and by <a>ListRules</a>.</p>"
},
"Action":{
"shape":"WafAction",
"documentation":"<p>Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the <code>Rule</code>. Valid values for <code>Action</code> include the following:</p> <ul> <li> <p> <code>ALLOW</code>: CloudFront responds with the requested object.</p> </li> <li> <p> <code>BLOCK</code>: CloudFront responds with an HTTP 403 (Forbidden) status code.</p> </li> <li> <p> <code>COUNT</code>: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL. </p> </li> </ul>"
}
},
"documentation":"<p>The <code>ActivatedRule</code> object in an <a>UpdateWebACL</a> request specifies a <code>Rule</code> that you want to insert or delete, the priority of the <code>Rule</code> in the <code>WebACL</code>, and the action that you want AWS WAF to take when a web request matches the <code>Rule</code> (<code>ALLOW</code>, <code>BLOCK</code>, or <code>COUNT</code>).</p> <p>To specify whether to insert or delete a <code>Rule</code>, use the <code>Action</code> parameter in the <a>WebACLUpdate</a> data type.</p>"
},
"ActivatedRules":{
"type":"list",
"member":{"shape":"ActivatedRule"}
},
"AssociateWebACLRequest":{
"type":"structure",
"required":[
"WebACLId",
"ResourceArn"
],
"members":{
"WebACLId":{
"shape":"ResourceId",
"documentation":"<p>A unique identifier (ID) for the web ACL.</p>"
},
"ResourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The ARN (Amazon Resource Name) of the resource to be protected.</p>"
}
}
},
"AssociateWebACLResponse":{
"type":"structure",
"members":{
}
},
"ByteMatchSet":{
"type":"structure",
"required":[
"ByteMatchSetId",
"ByteMatchTuples"
],
"members":{
"ByteMatchSetId":{
"shape":"ResourceId",
"documentation":"<p>The <code>ByteMatchSetId</code> for a <code>ByteMatchSet</code>. You use <code>ByteMatchSetId</code> to get information about a <code>ByteMatchSet</code> (see <a>GetByteMatchSet</a>), update a <code>ByteMatchSet</code> (see <a>UpdateByteMatchSet</a>), insert a <code>ByteMatchSet</code> into a <code>Rule</code> or delete one from a <code>Rule</code> (see <a>UpdateRule</a>), and delete a <code>ByteMatchSet</code> from AWS WAF (see <a>DeleteByteMatchSet</a>).</p> <p> <code>ByteMatchSetId</code> is returned by <a>CreateByteMatchSet</a> and by <a>ListByteMatchSets</a>.</p>"
},
"Name":{
"shape":"ResourceName",
"documentation":"<p>A friendly name or description of the <a>ByteMatchSet</a>. You can't change <code>Name</code> after you create a <code>ByteMatchSet</code>.</p>"
},
"ByteMatchTuples":{
"shape":"ByteMatchTuples",
"documentation":"<p>Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.</p>"
}
},
"documentation":"<p>In a <a>GetByteMatchSet</a> request, <code>ByteMatchSet</code> is a complex type that contains the <code>ByteMatchSetId</code> and <code>Name</code> of a <code>ByteMatchSet</code>, and the values that you specified when you updated the <code>ByteMatchSet</code>. </p> <p>A complex type that contains <code>ByteMatchTuple</code> objects, which specify the parts of web requests that you want AWS WAF to inspect and the values that you want AWS WAF to search for. If a <code>ByteMatchSet</code> contains more than one <code>ByteMatchTuple</code> object, a request needs to match the settings in only one <code>ByteMatchTuple</code> to be considered a match.</p>"
},
"ByteMatchSetSummaries":{
"type":"list",
"member":{"shape":"ByteMatchSetSummary"}
},
"ByteMatchSetSummary":{
"type":"structure",
"required":[
"ByteMatchSetId",
"Name"
],
"members":{
"ByteMatchSetId":{
"shape":"ResourceId",
"documentation":"<p>The <code>ByteMatchSetId</code> for a <code>ByteMatchSet</code>. You use <code>ByteMatchSetId</code> to get information about a <code>ByteMatchSet</code>, update a <code>ByteMatchSet</code>, remove a <code>ByteMatchSet</code> from a <code>Rule</code>, and delete a <code>ByteMatchSet</code> from AWS WAF.</p> <p> <code>ByteMatchSetId</code> is returned by <a>CreateByteMatchSet</a> and by <a>ListByteMatchSets</a>.</p>"
},
"Name":{
"shape":"ResourceName",
"documentation":"<p>A friendly name or description of the <a>ByteMatchSet</a>. You can't change <code>Name</code> after you create a <code>ByteMatchSet</code>.</p>"
}
},
"documentation":"<p>Returned by <a>ListByteMatchSets</a>. Each <code>ByteMatchSetSummary</code> object includes the <code>Name</code> and <code>ByteMatchSetId</code> for one <a>ByteMatchSet</a>.</p>"
},
"ByteMatchSetUpdate":{
"type":"structure",
"required":[
"Action",
"ByteMatchTuple"
],
"members":{
"Action":{
"shape":"ChangeAction",
"documentation":"<p>Specifies whether to insert or delete a <a>ByteMatchTuple</a>.</p>"
},
"ByteMatchTuple":{
"shape":"ByteMatchTuple",
"documentation":"<p>Information about the part of a web request that you want AWS WAF to inspect and the value that you want AWS WAF to search for. If you specify <code>DELETE</code> for the value of <code>Action</code>, the <code>ByteMatchTuple</code> values must exactly match the values in the <code>ByteMatchTuple</code> that you want to delete from the <code>ByteMatchSet</code>.</p>"
}
},
"documentation":"<p>In an <a>UpdateByteMatchSet</a> request, <code>ByteMatchSetUpdate</code> specifies whether to insert or delete a <a>ByteMatchTuple</a> and includes the settings for the <code>ByteMatchTuple</code>.</p>"
},
"ByteMatchSetUpdates":{
"type":"list",
"member":{"shape":"ByteMatchSetUpdate"}
},
"ByteMatchTargetString":{"type":"blob"},
"ByteMatchTuple":{
"type":"structure",
"required":[
"FieldToMatch",
"TargetString",
"TextTransformation",
"PositionalConstraint"
],
"members":{
"FieldToMatch":{
"shape":"FieldToMatch",
"documentation":"<p>The part of a web request that you want AWS WAF to search, such as a specified header or a query string. For more information, see <a>FieldToMatch</a>.</p>"
},
"TargetString":{
"shape":"ByteMatchTargetString",
"documentation":"<p>The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you specified in <code>FieldToMatch</code>. The maximum length of the value is 50 bytes.</p> <p>Valid values depend on the values that you specified for <code>FieldToMatch</code>:</p> <ul> <li> <p> <code>HEADER</code>: The value that you want AWS WAF to search for in the request header that you specified in <a>FieldToMatch</a>, for example, the value of the <code>User-Agent</code> or <code>Referer</code> header.</p> </li> <li> <p> <code>METHOD</code>: The HTTP method, which indicates the type of operation specified in the request. CloudFront supports the following methods: <code>DELETE</code>, <code>GET</code>, <code>HEAD</code>, <code>OPTIONS</code>, <code>PATCH</code>, <code>POST</code>, and <code>PUT</code>.</p> </li> <li> <p> <code>QUERY_STRING</code>: The value that you want AWS WAF to search for in the query string, which is the part of a URL that appears after a <code>?</code> character.</p> </li> <li> <p> <code>URI</code>: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, for example, <code>/images/daily-ad.jpg</code>.</p> </li> <li> <p> <code>BODY</code>: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first <code>8192</code> bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see <a>CreateSizeConstraintSet</a>. </p> </li> </ul> <p>If <code>TargetString</code> includes alphabetic characters A-Z and a-z, note that the value is case sensitive.</p> <p> <b>If you're using the AWS WAF API</b> </p> <p>Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.</p> <p>For example, suppose the value of <code>Type</code> is <code>HEADER</code> and the value of <code>Data</code> is <code>User-Agent</code>. If you want to search the <code>User-Agent</code> header for the value <code>BadBot</code>, you base64-encode <code>BadBot</code> using MIME base64 encoding and include the resulting value, <code>QmFkQm90</code>, in the value of <code>TargetString</code>.</p> <p> <b>If you're using the AWS CLI or one of the AWS SDKs</b> </p> <p>The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.</p>"
},
"TextTransformation":{
"shape":"TextTransformation",
"documentation":"<p>Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on <code>TargetString</code> before inspecting a request for a match.</p> <p> <b>CMD_LINE</b> </p> <p>When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:</p> <ul> <li> <p>Delete the following characters: \\ \" ' ^</p> </li> <li> <p>Delete spaces before the following characters: / (</p> </li> <li> <p>Replace the following characters with a space: , ;</p> </li> <li> <p>Replace multiple spaces with one space</p> </li> <li> <p>Convert uppercase letters (A-Z) to lowercase (a-z)</p> </li> </ul> <p> <b>COMPRESS_WHITE_SPACE</b> </p> <p>Use this option to replace the following characters with a space character (decimal 32):</p> <ul> <li> <p>\\f, formfeed, decimal 12</p> </li> <li> <p>\\t, tab, decimal 9</p> </li> <li> <p>\\n, newline, decimal 10</p> </li> <li> <p>\\r, carriage return, decimal 13</p> </li> <li> <p>\\v, vertical tab, decimal 11</p> </li> <li> <p>non-breaking space, decimal 160</p> </li> </ul> <p> <code>COMPRESS_WHITE_SPACE</code> also replaces multiple spaces with one space.</p> <p> <b>HTML_ENTITY_DECODE</b> </p> <p>Use this option to replace HTML-encoded characters with unencoded characters. <code>HTML_ENTITY_DECODE</code> performs the following operations:</p> <ul> <li> <p>Replaces <code>(ampersand)quot;</code> with <code>\"</code> </p> </li> <li> <p>Replaces <code>(ampersand)nbsp;</code> with a non-breaking space, decimal 160</p> </li> <li> <p>Replaces <code>(ampersand)lt;</code> with a \"less than\" symbol</p> </li> <li> <p>Replaces <code>(ampersand)gt;</code> with <code>></code> </p> </li> <li> <p>Replaces characters that are represented in hexadecimal format, <code>(ampersand)#xhhhh;</code>, with the corresponding characters</p> </li> <li> <p>Replaces characters that are represented in decimal format, <code>(ampersand)#nnnn;</code>, with the corresponding characters</p> </li> </ul> <p> <b>LOWERCASE</b> </p> <p>Use this option to convert uppercase letters (A-Z) to lowercase (a-z).</p> <p> <b>URL_DECODE</b> </p> <p>Use this option to decode a URL-encoded value.</p> <p> <b>NONE</b> </p> <p>Specify <code>NONE</code> if you don't want to perform any text transformations.</p>"
},
"PositionalConstraint":{
"shape":"PositionalConstraint",
"documentation":"<p>Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search. Valid values include the following:</p> <p> <b>CONTAINS</b> </p> <p>The specified part of the web request must include the value of <code>TargetString</code>, but the location doesn't matter.</p> <p> <b>CONTAINS_WORD</b> </p> <p>The specified part of the web request must include the value of <code>TargetString</code>, and <code>TargetString</code> must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, <code>TargetString</code> must be a word, which means one of the following:</p> <ul> <li> <p> <code>TargetString</code> exactly matches the value of the specified part of the web request, such as the value of a header.</p> </li> <li> <p> <code>TargetString</code> is at the beginning of the specified part of the web request and is followed by a character other than an alphanumeric character or underscore (_), for example, <code>BadBot;</code>.</p> </li> <li> <p> <code>TargetString</code> is at the end of the specified part of the web request and is preceded by a character other than an alphanumeric character or underscore (_), for example, <code>;BadBot</code>.</p> </li> <li> <p> <code>TargetString</code> is in the middle of the specified part of the web request and is preceded and followed by characters other than alphanumeric characters or underscore (_), for example, <code>-BadBot;</code>.</p> </li> </ul> <p> <b>EXACTLY</b> </p> <p>The value of the specified part of the web request must exactly match the value of <code>TargetString</code>.</p> <p> <b>STARTS_WITH</b> </p> <p>The value of <code>TargetString</code> must appear at the beginning of the specified part of the web request.</p> <p> <b>ENDS_WITH</b> </p> <p>The value of <code>TargetString</code> must appear at the end of the specified part of the web request.</p>"
}
},
"documentation":"<p>The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.</p>"
},
"ByteMatchTuples":{
"type":"list",
"member":{"shape":"ByteMatchTuple"}
},
"ChangeAction":{
"type":"string",
"enum":[
"INSERT",
"DELETE"
]
},
"ChangeToken":{
"type":"string",
"min":1
},
"ChangeTokenStatus":{
"type":"string",
"enum":[
"PROVISIONED",
"PENDING",
"INSYNC"
]
},
"ComparisonOperator":{
"type":"string",
"enum":[
"EQ",
"NE",
"LE",
"LT",
"GE",
"GT"
]
},
"Country":{"type":"string"},
"CreateByteMatchSetRequest":{
"type":"structure",
"required":[
"Name",
"ChangeToken"
],
"members":{
"Name":{
"shape":"ResourceName",
"documentation":"<p>A friendly name or description of the <a>ByteMatchSet</a>. You can't change <code>Name</code> after you create a <code>ByteMatchSet</code>.</p>"
},
"ChangeToken":{
"shape":"ChangeToken",
"documentation":"<p>The value returned by the most recent call to <a>GetChangeToken</a>.</p>"
}
}
},
"CreateByteMatchSetResponse":{
"type":"structure",
"members":{
"ByteMatchSet":{
"shape":"ByteMatchSet",
"documentation":"<p>A <a>ByteMatchSet</a> that contains no <code>ByteMatchTuple</code> objects.</p>"
},
"ChangeToken":{
"shape":"ChangeToken",
"documentation":"<p>The <code>ChangeToken</code> that you used to submit the <code>CreateByteMatchSet</code> request. You can also use this value to query the status of the request. For more information, see <a>GetChangeTokenStatus</a>.</p>"
}
}
},
"CreateIPSetRequest":{
"type":"structure",
"required":[
"Name",
"ChangeToken"
],
"members":{
"Name":{
"shape":"ResourceName",
"documentation":"<p>A friendly name or description of the <a>IPSet</a>. You can't change <code>Name</code> after you create the <code>IPSet</code>.</p>"
},
"ChangeToken":{
"shape":"ChangeToken",
"documentation":"<p>The value returned by the most recent call to <a>GetChangeToken</a>.</p>"
}
}
},
"CreateIPSetResponse":{
"type":"structure",
"members":{
"IPSet":{
"shape":"IPSet",
"documentation":"<p>The <a>IPSet</a> returned in the <code>CreateIPSet</code> response.</p>"
},
"ChangeToken":{
"shape":"ChangeToken",
"documentation":"<p>The <code>ChangeToken</code> that you used to submit the <code>CreateIPSet</code> request. You can also use this value to query the status of the request. For more information, see <a>GetChangeTokenStatus</a>.</p>"
}
}
},
"CreateRuleRequest":{
"type":"structure",
"required":[
"Name",
"MetricName",
"ChangeToken"
],
"members":{
"Name":{
"shape":"ResourceName",
"documentation":"<p>A friendly name or description of the <a>Rule</a>. You can't change the name of a <code>Rule</code> after you create it.</p>"
},
"MetricName":{
"shape":"MetricName",
"documentation":"<p>A friendly name or description for the metrics for this <code>Rule</code>. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the <code>Rule</code>.</p>"
},
"ChangeToken":{
"shape":"ChangeToken",
"documentation":"<p>The value returned by the most recent call to <a>GetChangeToken</a>.</p>"
}
}
},
"CreateRuleResponse":{
"type":"structure",
"members":{
"Rule":{
"shape":"Rule",
"documentation":"<p>The <a>Rule</a> returned in the <code>CreateRule</code> response.</p>"
},
"ChangeToken":{
"shape":"ChangeToken",
"documentation":"<p>The <code>ChangeToken</code> that you used to submit the <code>CreateRule</code> request. You can also use this value to query the status of the request. For more information, see <a>GetChangeTokenStatus</a>.</p>"
}
}
},
"CreateSizeConstraintSetRequest":{
"type":"structure",
"required":[
"Name",
"ChangeToken"