-
Notifications
You must be signed in to change notification settings - Fork 594
/
fms.2018-01-01.json
4650 lines (4650 loc) · 240 KB
/
fms.2018-01-01.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
{
"smithy": "1.0",
"metadata": {
"suppressions": [
{
"id": "HttpMethodSemantics",
"namespace": "*"
},
{
"id": "HttpResponseCodeSemantics",
"namespace": "*"
},
{
"id": "PaginatedTrait",
"namespace": "*"
},
{
"id": "HttpHeaderTrait",
"namespace": "*"
},
{
"id": "HttpUriConflict",
"namespace": "*"
},
{
"id": "Service",
"namespace": "*"
}
]
},
"shapes": {
"com.amazonaws.fms#AWSAccountId": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 1024
},
"smithy.api#pattern": "^[0-9]+$"
}
},
"com.amazonaws.fms#AWSFMS_20180101": {
"type": "service",
"traits": {
"aws.api#service": {
"sdkId": "FMS",
"arnNamespace": "fms",
"cloudFormationName": "FMS",
"cloudTrailEventSource": "fms.amazonaws.com",
"endpointPrefix": "fms"
},
"aws.auth#sigv4": {
"name": "fms"
},
"aws.protocols#awsJson1_1": {},
"smithy.api#documentation": "<p>This is the <i>Firewall Manager API Reference</i>. This guide is for\n developers who need detailed information about the Firewall Manager API actions, data types, and\n errors. For detailed information about Firewall Manager features, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html\">Firewall Manager\n Developer Guide</a>.</p>\n <p>Some API actions require explicit resource permissions. For information, see the\n developer guide topic <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/fms-api-permissions-ref.html\">Firewall Manager required permissions\n for API actions</a>. </p>",
"smithy.api#title": "Firewall Management Service"
},
"version": "2018-01-01",
"operations": [
{
"target": "com.amazonaws.fms#AssociateAdminAccount"
},
{
"target": "com.amazonaws.fms#DeleteAppsList"
},
{
"target": "com.amazonaws.fms#DeleteNotificationChannel"
},
{
"target": "com.amazonaws.fms#DeletePolicy"
},
{
"target": "com.amazonaws.fms#DeleteProtocolsList"
},
{
"target": "com.amazonaws.fms#DisassociateAdminAccount"
},
{
"target": "com.amazonaws.fms#GetAdminAccount"
},
{
"target": "com.amazonaws.fms#GetAppsList"
},
{
"target": "com.amazonaws.fms#GetComplianceDetail"
},
{
"target": "com.amazonaws.fms#GetNotificationChannel"
},
{
"target": "com.amazonaws.fms#GetPolicy"
},
{
"target": "com.amazonaws.fms#GetProtectionStatus"
},
{
"target": "com.amazonaws.fms#GetProtocolsList"
},
{
"target": "com.amazonaws.fms#GetViolationDetails"
},
{
"target": "com.amazonaws.fms#ListAppsLists"
},
{
"target": "com.amazonaws.fms#ListComplianceStatus"
},
{
"target": "com.amazonaws.fms#ListMemberAccounts"
},
{
"target": "com.amazonaws.fms#ListPolicies"
},
{
"target": "com.amazonaws.fms#ListProtocolsLists"
},
{
"target": "com.amazonaws.fms#ListTagsForResource"
},
{
"target": "com.amazonaws.fms#PutAppsList"
},
{
"target": "com.amazonaws.fms#PutNotificationChannel"
},
{
"target": "com.amazonaws.fms#PutPolicy"
},
{
"target": "com.amazonaws.fms#PutProtocolsList"
},
{
"target": "com.amazonaws.fms#TagResource"
},
{
"target": "com.amazonaws.fms#UntagResource"
}
]
},
"com.amazonaws.fms#AccountRoleStatus": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "READY",
"name": "Ready"
},
{
"value": "CREATING",
"name": "Creating"
},
{
"value": "PENDING_DELETION",
"name": "PendingDeletion"
},
{
"value": "DELETING",
"name": "Deleting"
},
{
"value": "DELETED",
"name": "Deleted"
}
]
}
},
"com.amazonaws.fms#ActionTarget": {
"type": "structure",
"members": {
"ResourceId": {
"target": "com.amazonaws.fms#ResourceId",
"traits": {
"smithy.api#documentation": "<p>The ID of the remediation target.</p>"
}
},
"Description": {
"target": "com.amazonaws.fms#LengthBoundedString",
"traits": {
"smithy.api#documentation": "<p>A description of the remediation action target.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Describes a remediation action target.</p>"
}
},
"com.amazonaws.fms#App": {
"type": "structure",
"members": {
"AppName": {
"target": "com.amazonaws.fms#ResourceName",
"traits": {
"smithy.api#documentation": "<p>The application's name.</p>",
"smithy.api#required": {}
}
},
"Protocol": {
"target": "com.amazonaws.fms#Protocol",
"traits": {
"smithy.api#documentation": "<p>The IP protocol name or number. The name can be one of <code>tcp</code>,\n <code>udp</code>, or <code>icmp</code>. For information on possible numbers, see <a href=\"https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml\">Protocol\n Numbers</a>.</p>",
"smithy.api#required": {}
}
},
"Port": {
"target": "com.amazonaws.fms#IPPortNumber",
"traits": {
"smithy.api#documentation": "<p>The application's port number, for example <code>80</code>.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>An individual Firewall Manager application.</p>"
}
},
"com.amazonaws.fms#AppsList": {
"type": "list",
"member": {
"target": "com.amazonaws.fms#App"
}
},
"com.amazonaws.fms#AppsListData": {
"type": "structure",
"members": {
"ListId": {
"target": "com.amazonaws.fms#ListId",
"traits": {
"smithy.api#documentation": "<p>The ID of the Firewall Manager applications list.</p>"
}
},
"ListName": {
"target": "com.amazonaws.fms#ResourceName",
"traits": {
"smithy.api#documentation": "<p>The name of the Firewall Manager applications list.</p>",
"smithy.api#required": {}
}
},
"ListUpdateToken": {
"target": "com.amazonaws.fms#UpdateToken",
"traits": {
"smithy.api#documentation": "<p>A unique identifier for each update to the list. When you update the list, the update\n token must match the token of the current version of the application list. You can retrieve\n the update token by getting the list. </p>"
}
},
"CreateTime": {
"target": "com.amazonaws.fms#TimeStamp",
"traits": {
"smithy.api#documentation": "<p>The time that the Firewall Manager applications list was created.</p>"
}
},
"LastUpdateTime": {
"target": "com.amazonaws.fms#TimeStamp",
"traits": {
"smithy.api#documentation": "<p>The time that the Firewall Manager applications list was last updated.</p>"
}
},
"AppsList": {
"target": "com.amazonaws.fms#AppsList",
"traits": {
"smithy.api#documentation": "<p>An array of applications in the Firewall Manager applications list.</p>",
"smithy.api#required": {}
}
},
"PreviousAppsList": {
"target": "com.amazonaws.fms#PreviousAppsList",
"traits": {
"smithy.api#documentation": "<p>A map of previous version numbers to their corresponding <code>App</code> object\n arrays.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An Firewall Manager applications list.</p>"
}
},
"com.amazonaws.fms#AppsListDataSummary": {
"type": "structure",
"members": {
"ListArn": {
"target": "com.amazonaws.fms#ResourceArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the applications list.</p>"
}
},
"ListId": {
"target": "com.amazonaws.fms#ListId",
"traits": {
"smithy.api#documentation": "<p>The ID of the applications list.</p>"
}
},
"ListName": {
"target": "com.amazonaws.fms#ResourceName",
"traits": {
"smithy.api#documentation": "<p>The name of the applications list.</p>"
}
},
"AppsList": {
"target": "com.amazonaws.fms#AppsList",
"traits": {
"smithy.api#documentation": "<p>An array of <code>App</code> objects in the Firewall Manager applications list.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Details of the Firewall Manager applications list.</p>"
}
},
"com.amazonaws.fms#AppsListsData": {
"type": "list",
"member": {
"target": "com.amazonaws.fms#AppsListDataSummary"
}
},
"com.amazonaws.fms#AssociateAdminAccount": {
"type": "operation",
"input": {
"target": "com.amazonaws.fms#AssociateAdminAccountRequest"
},
"errors": [
{
"target": "com.amazonaws.fms#InternalErrorException"
},
{
"target": "com.amazonaws.fms#InvalidInputException"
},
{
"target": "com.amazonaws.fms#InvalidOperationException"
},
{
"target": "com.amazonaws.fms#LimitExceededException"
},
{
"target": "com.amazonaws.fms#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Sets the Firewall Manager administrator account. The account must be a member of the\n organization in Organizations whose resources you want to protect. Firewall Manager sets the\n permissions that allow the account to administer your Firewall Manager policies.</p>\n <p>The account that you associate with Firewall Manager is called the Firewall Manager administrator\n account. </p>"
}
},
"com.amazonaws.fms#AssociateAdminAccountRequest": {
"type": "structure",
"members": {
"AdminAccount": {
"target": "com.amazonaws.fms#AWSAccountId",
"traits": {
"smithy.api#documentation": "<p>The Amazon Web Services account ID to associate with Firewall Manager as the Firewall Manager administrator account.\n This must be an Organizations member account. For more information about Organizations, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts.html\">Managing the Amazon Web Services Accounts in Your Organization</a>. </p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.fms#AwsEc2InstanceViolation": {
"type": "structure",
"members": {
"ViolationTarget": {
"target": "com.amazonaws.fms#ViolationTarget",
"traits": {
"smithy.api#documentation": "<p>The resource ID of the EC2 instance.</p>"
}
},
"AwsEc2NetworkInterfaceViolations": {
"target": "com.amazonaws.fms#AwsEc2NetworkInterfaceViolations",
"traits": {
"smithy.api#documentation": "<p>Violation detail for network interfaces associated with the EC2 instance.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Violation detail for an EC2 instance resource.</p>"
}
},
"com.amazonaws.fms#AwsEc2NetworkInterfaceViolation": {
"type": "structure",
"members": {
"ViolationTarget": {
"target": "com.amazonaws.fms#ViolationTarget",
"traits": {
"smithy.api#documentation": "<p>The resource ID of the network interface.</p>"
}
},
"ViolatingSecurityGroups": {
"target": "com.amazonaws.fms#ResourceIdList",
"traits": {
"smithy.api#documentation": "<p>List of security groups that violate the rules specified in the primary security group\n of the Firewall Manager policy.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Violation detail for network interfaces associated with an EC2 instance.</p>"
}
},
"com.amazonaws.fms#AwsEc2NetworkInterfaceViolations": {
"type": "list",
"member": {
"target": "com.amazonaws.fms#AwsEc2NetworkInterfaceViolation"
}
},
"com.amazonaws.fms#AwsVPCSecurityGroupViolation": {
"type": "structure",
"members": {
"ViolationTarget": {
"target": "com.amazonaws.fms#ViolationTarget",
"traits": {
"smithy.api#documentation": "<p>The security group rule that is being evaluated.</p>"
}
},
"ViolationTargetDescription": {
"target": "com.amazonaws.fms#LengthBoundedString",
"traits": {
"smithy.api#documentation": "<p>A description of the security group that violates the policy.</p>"
}
},
"PartialMatches": {
"target": "com.amazonaws.fms#PartialMatches",
"traits": {
"smithy.api#documentation": "<p>List of rules specified in the security group of the Firewall Manager policy that partially\n match the <code>ViolationTarget</code> rule.</p>"
}
},
"PossibleSecurityGroupRemediationActions": {
"target": "com.amazonaws.fms#SecurityGroupRemediationActions",
"traits": {
"smithy.api#documentation": "<p>Remediation options for the rule specified in the <code>ViolationTarget</code>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Violation detail for the rule violation in a security group when compared to the primary\n security group of the Firewall Manager policy.</p>"
}
},
"com.amazonaws.fms#BasicInteger": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": -2147483648,
"max": 2147483647
}
}
},
"com.amazonaws.fms#Boolean": {
"type": "boolean"
},
"com.amazonaws.fms#CIDR": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 256
},
"smithy.api#pattern": "^[a-f0-9:./]+$"
}
},
"com.amazonaws.fms#ComplianceViolator": {
"type": "structure",
"members": {
"ResourceId": {
"target": "com.amazonaws.fms#ResourceId",
"traits": {
"smithy.api#documentation": "<p>The resource ID.</p>"
}
},
"ViolationReason": {
"target": "com.amazonaws.fms#ViolationReason",
"traits": {
"smithy.api#documentation": "<p>The reason that the resource is not protected by the policy.</p>"
}
},
"ResourceType": {
"target": "com.amazonaws.fms#ResourceType",
"traits": {
"smithy.api#documentation": "<p>The resource type. This is in the format shown in the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html\">Amazon Web Services\n Resource Types Reference</a>. For example:\n <code>AWS::ElasticLoadBalancingV2::LoadBalancer</code>,\n <code>AWS::CloudFront::Distribution</code>, or\n <code>AWS::NetworkFirewall::FirewallPolicy</code>.</p>"
}
},
"Metadata": {
"target": "com.amazonaws.fms#ComplianceViolatorMetadata",
"traits": {
"smithy.api#documentation": "<p>Metadata about the resource that doesn't comply with the policy scope.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Details of the resource that is not protected by the policy.</p>"
}
},
"com.amazonaws.fms#ComplianceViolatorMetadata": {
"type": "map",
"key": {
"target": "com.amazonaws.fms#LengthBoundedString"
},
"value": {
"target": "com.amazonaws.fms#LengthBoundedString"
}
},
"com.amazonaws.fms#ComplianceViolators": {
"type": "list",
"member": {
"target": "com.amazonaws.fms#ComplianceViolator"
}
},
"com.amazonaws.fms#CustomerPolicyScopeId": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 1024
},
"smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
}
},
"com.amazonaws.fms#CustomerPolicyScopeIdList": {
"type": "list",
"member": {
"target": "com.amazonaws.fms#CustomerPolicyScopeId"
}
},
"com.amazonaws.fms#CustomerPolicyScopeIdType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "ACCOUNT",
"name": "ACCOUNT"
},
{
"value": "ORG_UNIT",
"name": "ORG_UNIT"
}
]
}
},
"com.amazonaws.fms#CustomerPolicyScopeMap": {
"type": "map",
"key": {
"target": "com.amazonaws.fms#CustomerPolicyScopeIdType"
},
"value": {
"target": "com.amazonaws.fms#CustomerPolicyScopeIdList"
}
},
"com.amazonaws.fms#DeleteAppsList": {
"type": "operation",
"input": {
"target": "com.amazonaws.fms#DeleteAppsListRequest"
},
"errors": [
{
"target": "com.amazonaws.fms#InternalErrorException"
},
{
"target": "com.amazonaws.fms#InvalidOperationException"
},
{
"target": "com.amazonaws.fms#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Permanently deletes an Firewall Manager applications list.</p>"
}
},
"com.amazonaws.fms#DeleteAppsListRequest": {
"type": "structure",
"members": {
"ListId": {
"target": "com.amazonaws.fms#ListId",
"traits": {
"smithy.api#documentation": "<p>The ID of the applications list that you want to delete. You can retrieve this ID from\n <code>PutAppsList</code>, <code>ListAppsLists</code>, and\n <code>GetAppsList</code>.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.fms#DeleteNotificationChannel": {
"type": "operation",
"input": {
"target": "com.amazonaws.fms#DeleteNotificationChannelRequest"
},
"errors": [
{
"target": "com.amazonaws.fms#InternalErrorException"
},
{
"target": "com.amazonaws.fms#InvalidOperationException"
},
{
"target": "com.amazonaws.fms#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes an Firewall Manager association with the IAM role and the Amazon Simple Notification\n Service (SNS) topic that is used to record Firewall Manager SNS logs.</p>"
}
},
"com.amazonaws.fms#DeleteNotificationChannelRequest": {
"type": "structure",
"members": {}
},
"com.amazonaws.fms#DeletePolicy": {
"type": "operation",
"input": {
"target": "com.amazonaws.fms#DeletePolicyRequest"
},
"errors": [
{
"target": "com.amazonaws.fms#InternalErrorException"
},
{
"target": "com.amazonaws.fms#InvalidInputException"
},
{
"target": "com.amazonaws.fms#InvalidOperationException"
},
{
"target": "com.amazonaws.fms#LimitExceededException"
},
{
"target": "com.amazonaws.fms#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Permanently deletes an Firewall Manager policy. </p>"
}
},
"com.amazonaws.fms#DeletePolicyRequest": {
"type": "structure",
"members": {
"PolicyId": {
"target": "com.amazonaws.fms#PolicyId",
"traits": {
"smithy.api#documentation": "<p>The ID of the policy that you want to delete. You can retrieve this ID from\n <code>PutPolicy</code> and <code>ListPolicies</code>.</p>",
"smithy.api#required": {}
}
},
"DeleteAllPolicyResources": {
"target": "com.amazonaws.fms#Boolean",
"traits": {
"smithy.api#documentation": "<p>If <code>True</code>, the request performs cleanup according to the policy type. </p>\n <p>For WAF and Shield Advanced policies, the cleanup does the following:</p>\n <ul>\n <li>\n <p>Deletes rule groups created by Firewall Manager</p>\n </li>\n <li>\n <p>Removes web ACLs from in-scope resources</p>\n </li>\n <li>\n <p>Deletes web ACLs that contain no rules or rule groups</p>\n </li>\n </ul>\n <p>For security group policies, the cleanup does the following for each security group\n in the policy:</p>\n <ul>\n <li>\n <p>Disassociates the security group from in-scope resources </p>\n </li>\n <li>\n <p>Deletes the security group if it was created through Firewall Manager and if it's no\n longer associated with any resources through another policy</p>\n </li>\n </ul>\n <p>After the cleanup, in-scope resources are no longer protected by web ACLs in this\n policy. Protection of out-of-scope resources remains unchanged. Scope is determined by tags\n that you create and accounts that you associate with the policy. When creating the policy,\n if you specify that only resources in specific accounts or with specific tags are in scope\n of the policy, those accounts and resources are handled by the policy. All others are out\n of scope. If you don't specify tags or accounts, all resources are in scope. </p>"
}
}
}
},
"com.amazonaws.fms#DeleteProtocolsList": {
"type": "operation",
"input": {
"target": "com.amazonaws.fms#DeleteProtocolsListRequest"
},
"errors": [
{
"target": "com.amazonaws.fms#InternalErrorException"
},
{
"target": "com.amazonaws.fms#InvalidOperationException"
},
{
"target": "com.amazonaws.fms#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Permanently deletes an Firewall Manager protocols list.</p>"
}
},
"com.amazonaws.fms#DeleteProtocolsListRequest": {
"type": "structure",
"members": {
"ListId": {
"target": "com.amazonaws.fms#ListId",
"traits": {
"smithy.api#documentation": "<p>The ID of the protocols list that you want to delete. You can retrieve this ID from\n <code>PutProtocolsList</code>, <code>ListProtocolsLists</code>, and\n <code>GetProtocolsLost</code>.</p>",
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.fms#DependentServiceName": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "AWSCONFIG",
"name": "AWSConfig"
},
{
"value": "AWSWAF",
"name": "AWSWAF"
},
{
"value": "AWSSHIELD_ADVANCED",
"name": "AWSShieldAdvanced"
},
{
"value": "AWSVPC",
"name": "AWSVirtualPrivateCloud"
}
]
}
},
"com.amazonaws.fms#DestinationType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "IPV4",
"name": "IPV4"
},
{
"value": "IPV6",
"name": "IPV6"
},
{
"value": "PREFIX_LIST",
"name": "PrefixList"
}
]
}
},
"com.amazonaws.fms#DetailedInfo": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 1024
},
"smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=,+\\-@]*)$"
}
},
"com.amazonaws.fms#DisassociateAdminAccount": {
"type": "operation",
"input": {
"target": "com.amazonaws.fms#DisassociateAdminAccountRequest"
},
"errors": [
{
"target": "com.amazonaws.fms#InternalErrorException"
},
{
"target": "com.amazonaws.fms#InvalidOperationException"
},
{
"target": "com.amazonaws.fms#ResourceNotFoundException"
}
],
"traits": {
"smithy.api#documentation": "<p>Disassociates the account that has been set as the Firewall Manager administrator account. To\n set a different account as the administrator account, you must submit an\n <code>AssociateAdminAccount</code> request.</p>"
}
},
"com.amazonaws.fms#DisassociateAdminAccountRequest": {
"type": "structure",
"members": {}
},
"com.amazonaws.fms#DnsDuplicateRuleGroupViolation": {
"type": "structure",
"members": {
"ViolationTarget": {
"target": "com.amazonaws.fms#ViolationTarget",
"traits": {
"smithy.api#documentation": "<p>Information about the VPC ID. </p>"
}
},
"ViolationTargetDescription": {
"target": "com.amazonaws.fms#LengthBoundedString",
"traits": {
"smithy.api#documentation": "<p>A description of the violation that specifies the rule group and VPC.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A DNS Firewall rule group that Firewall Manager tried to associate with a VPC is already associated\n with the VPC and can't be associated again. </p>"
}
},
"com.amazonaws.fms#DnsRuleGroupLimitExceededViolation": {
"type": "structure",
"members": {
"ViolationTarget": {
"target": "com.amazonaws.fms#ViolationTarget",
"traits": {
"smithy.api#documentation": "<p>Information about the VPC ID. </p>"
}
},
"ViolationTargetDescription": {
"target": "com.amazonaws.fms#LengthBoundedString",
"traits": {
"smithy.api#documentation": "<p>A description of the violation that specifies the rule group and VPC.</p>"
}
},
"NumberOfRuleGroupsAlreadyAssociated": {
"target": "com.amazonaws.fms#BasicInteger",
"traits": {
"smithy.api#documentation": "<p>The number of rule groups currently associated with the VPC. </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The VPC that Firewall Manager was applying a DNS Fireall policy to reached the limit for associated\n DNS Firewall rule groups. Firewall Manager tried to associate another rule group with the VPC and\n failed due to the limit. </p>"
}
},
"com.amazonaws.fms#DnsRuleGroupPriorities": {
"type": "list",
"member": {
"target": "com.amazonaws.fms#DnsRuleGroupPriority"
}
},
"com.amazonaws.fms#DnsRuleGroupPriority": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": 0,
"max": 10000
}
}
},
"com.amazonaws.fms#DnsRuleGroupPriorityConflictViolation": {
"type": "structure",
"members": {
"ViolationTarget": {
"target": "com.amazonaws.fms#ViolationTarget",
"traits": {
"smithy.api#documentation": "<p>Information about the VPC ID. </p>"
}
},
"ViolationTargetDescription": {
"target": "com.amazonaws.fms#LengthBoundedString",
"traits": {
"smithy.api#documentation": "<p>A description of the violation that specifies the VPC and the rule group that's already\n associated with it.</p>"
}
},
"ConflictingPriority": {
"target": "com.amazonaws.fms#DnsRuleGroupPriority",
"traits": {
"smithy.api#documentation": "<p>The priority setting of the two conflicting rule groups.</p>"
}
},
"ConflictingPolicyId": {
"target": "com.amazonaws.fms#PolicyId",
"traits": {
"smithy.api#documentation": "<p>The ID of the Firewall Manager DNS Firewall policy that was already applied to the VPC. This policy\n contains the rule group that's already associated with the VPC. </p>"
}
},
"UnavailablePriorities": {
"target": "com.amazonaws.fms#DnsRuleGroupPriorities",
"traits": {
"smithy.api#documentation": "<p>The priorities of rule groups that are already associated with the VPC. To retry your\n operation, choose priority settings that aren't in this list for the rule groups in your\n new DNS Firewall policy. </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A rule group that Firewall Manager tried to associate with a VPC has the same priority as a rule\n group that's already associated. </p>"
}
},
"com.amazonaws.fms#EC2AssociateRouteTableAction": {
"type": "structure",
"members": {
"Description": {
"target": "com.amazonaws.fms#LengthBoundedString",
"traits": {
"smithy.api#documentation": "<p>A description of the EC2 route table that is associated with the remediation\n action.</p>"
}
},
"RouteTableId": {
"target": "com.amazonaws.fms#ActionTarget",
"traits": {
"smithy.api#documentation": "<p>The ID of the EC2 route table that is associated with the remediation action.</p>",
"smithy.api#required": {}
}
},
"SubnetId": {
"target": "com.amazonaws.fms#ActionTarget",
"traits": {
"smithy.api#documentation": "<p>The ID of the subnet for the EC2 route table that is associated with the remediation\n action.</p>"
}
},
"GatewayId": {
"target": "com.amazonaws.fms#ActionTarget",
"traits": {
"smithy.api#documentation": "<p>The ID of the gateway to be used with the EC2 route table that is associated with the\n remediation action.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The action of associating an EC2 resource, such as a subnet or internet gateway, with a\n route table.</p>"
}
},
"com.amazonaws.fms#EC2CopyRouteTableAction": {
"type": "structure",
"members": {
"Description": {
"target": "com.amazonaws.fms#LengthBoundedString",
"traits": {
"smithy.api#documentation": "<p>A description of the copied EC2 route table that is associated with the remediation\n action.</p>"
}
},
"VpcId": {
"target": "com.amazonaws.fms#ActionTarget",
"traits": {
"smithy.api#documentation": "<p>The VPC ID of the copied EC2 route table that is associated with the remediation\n action.</p>",
"smithy.api#required": {}
}
},
"RouteTableId": {
"target": "com.amazonaws.fms#ActionTarget",
"traits": {
"smithy.api#documentation": "<p>The ID of the copied EC2 route table that is associated with the remediation\n action.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>An action that copies the EC2 route table for use in remediation.</p>"
}
},
"com.amazonaws.fms#EC2CreateRouteAction": {
"type": "structure",
"members": {
"Description": {
"target": "com.amazonaws.fms#LengthBoundedString",
"traits": {
"smithy.api#documentation": "<p>A description of CreateRoute action in Amazon EC2.</p>"
}
},
"DestinationCidrBlock": {
"target": "com.amazonaws.fms#CIDR",
"traits": {
"smithy.api#documentation": "<p>Information about the IPv4 CIDR address block used for the destination match.</p>"
}
},
"DestinationPrefixListId": {
"target": "com.amazonaws.fms#ResourceId",
"traits": {
"smithy.api#documentation": "<p>Information about the ID of a prefix list used for the destination match.</p>"
}
},
"DestinationIpv6CidrBlock": {
"target": "com.amazonaws.fms#CIDR",
"traits": {
"smithy.api#documentation": "<p>Information about the IPv6 CIDR block destination.</p>"
}
},
"VpcEndpointId": {
"target": "com.amazonaws.fms#ActionTarget",
"traits": {
"smithy.api#documentation": "<p>Information about the ID of a VPC endpoint. Supported for Gateway Load Balancer\n endpoints only.</p>"
}
},
"GatewayId": {
"target": "com.amazonaws.fms#ActionTarget",
"traits": {
"smithy.api#documentation": "<p>Information about the ID of an internet gateway or virtual private gateway attached to\n your VPC.</p>"
}
},
"RouteTableId": {
"target": "com.amazonaws.fms#ActionTarget",
"traits": {
"smithy.api#documentation": "<p>Information about the ID of the route table for the route.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Information about the CreateRoute action in Amazon EC2.</p>"
}
},
"com.amazonaws.fms#EC2CreateRouteTableAction": {
"type": "structure",
"members": {
"Description": {
"target": "com.amazonaws.fms#LengthBoundedString",
"traits": {
"smithy.api#documentation": "<p>A description of the CreateRouteTable action.</p>"
}
},
"VpcId": {
"target": "com.amazonaws.fms#ActionTarget",
"traits": {
"smithy.api#documentation": "<p>Information about the ID of a VPC.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Information about the CreateRouteTable action in Amazon EC2.</p>"
}
},
"com.amazonaws.fms#EC2DeleteRouteAction": {
"type": "structure",
"members": {
"Description": {
"target": "com.amazonaws.fms#LengthBoundedString",
"traits": {
"smithy.api#documentation": "<p>A description of the DeleteRoute action.</p>"
}
},
"DestinationCidrBlock": {
"target": "com.amazonaws.fms#CIDR",
"traits": {
"smithy.api#documentation": "<p>Information about the IPv4 CIDR range for the route. The value you specify must match\n the CIDR for the route exactly.</p>"
}
},
"DestinationPrefixListId": {
"target": "com.amazonaws.fms#ResourceId",
"traits": {
"smithy.api#documentation": "<p>Information about the ID of the prefix list for the route.</p>"
}
},
"DestinationIpv6CidrBlock": {
"target": "com.amazonaws.fms#CIDR",