xref: /aosp_15_r20/external/aws-sdk-java-v2/services/fms/src/main/resources/codegen-resources/api-2.json (revision 8a52c7834d808308836a99fc2a6e0ed8db339086) 
1{
2  "version":"2.0",
3  "metadata":{
4    "apiVersion":"2018-01-01",
5    "endpointPrefix":"fms",
6    "jsonVersion":"1.1",
7    "protocol":"json",
8    "serviceAbbreviation":"FMS",
9    "serviceFullName":"Firewall Management Service",
10    "serviceId":"FMS",
11    "signatureVersion":"v4",
12    "targetPrefix":"AWSFMS_20180101",
13    "uid":"fms-2018-01-01"
14  },
15  "operations":{
16    "AssociateAdminAccount":{
17      "name":"AssociateAdminAccount",
18      "http":{
19        "method":"POST",
20        "requestUri":"/"
21      },
22      "input":{"shape":"AssociateAdminAccountRequest"},
23      "errors":[
24        {"shape":"InvalidOperationException"},
25        {"shape":"InvalidInputException"},
26        {"shape":"ResourceNotFoundException"},
27        {"shape":"InternalErrorException"}
28      ]
29    },
30    "DeleteNotificationChannel":{
31      "name":"DeleteNotificationChannel",
32      "http":{
33        "method":"POST",
34        "requestUri":"/"
35      },
36      "input":{"shape":"DeleteNotificationChannelRequest"},
37      "errors":[
38        {"shape":"ResourceNotFoundException"},
39        {"shape":"InvalidOperationException"},
40        {"shape":"InternalErrorException"}
41      ]
42    },
43    "DeletePolicy":{
44      "name":"DeletePolicy",
45      "http":{
46        "method":"POST",
47        "requestUri":"/"
48      },
49      "input":{"shape":"DeletePolicyRequest"},
50      "errors":[
51        {"shape":"ResourceNotFoundException"},
52        {"shape":"InvalidOperationException"},
53        {"shape":"InternalErrorException"}
54      ]
55    },
56    "DisassociateAdminAccount":{
57      "name":"DisassociateAdminAccount",
58      "http":{
59        "method":"POST",
60        "requestUri":"/"
61      },
62      "input":{"shape":"DisassociateAdminAccountRequest"},
63      "errors":[
64        {"shape":"InvalidOperationException"},
65        {"shape":"ResourceNotFoundException"},
66        {"shape":"InternalErrorException"}
67      ]
68    },
69    "GetAdminAccount":{
70      "name":"GetAdminAccount",
71      "http":{
72        "method":"POST",
73        "requestUri":"/"
74      },
75      "input":{"shape":"GetAdminAccountRequest"},
76      "output":{"shape":"GetAdminAccountResponse"},
77      "errors":[
78        {"shape":"InvalidOperationException"},
79        {"shape":"ResourceNotFoundException"},
80        {"shape":"InternalErrorException"}
81      ]
82    },
83    "GetComplianceDetail":{
84      "name":"GetComplianceDetail",
85      "http":{
86        "method":"POST",
87        "requestUri":"/"
88      },
89      "input":{"shape":"GetComplianceDetailRequest"},
90      "output":{"shape":"GetComplianceDetailResponse"},
91      "errors":[
92        {"shape":"ResourceNotFoundException"},
93        {"shape":"InternalErrorException"}
94      ]
95    },
96    "GetNotificationChannel":{
97      "name":"GetNotificationChannel",
98      "http":{
99        "method":"POST",
100        "requestUri":"/"
101      },
102      "input":{"shape":"GetNotificationChannelRequest"},
103      "output":{"shape":"GetNotificationChannelResponse"},
104      "errors":[
105        {"shape":"ResourceNotFoundException"},
106        {"shape":"InvalidOperationException"},
107        {"shape":"InternalErrorException"}
108      ]
109    },
110    "GetPolicy":{
111      "name":"GetPolicy",
112      "http":{
113        "method":"POST",
114        "requestUri":"/"
115      },
116      "input":{"shape":"GetPolicyRequest"},
117      "output":{"shape":"GetPolicyResponse"},
118      "errors":[
119        {"shape":"ResourceNotFoundException"},
120        {"shape":"InvalidOperationException"},
121        {"shape":"InternalErrorException"},
122        {"shape":"InvalidTypeException"}
123      ]
124    },
125    "ListComplianceStatus":{
126      "name":"ListComplianceStatus",
127      "http":{
128        "method":"POST",
129        "requestUri":"/"
130      },
131      "input":{"shape":"ListComplianceStatusRequest"},
132      "output":{"shape":"ListComplianceStatusResponse"},
133      "errors":[
134        {"shape":"ResourceNotFoundException"},
135        {"shape":"InternalErrorException"}
136      ]
137    },
138    "ListMemberAccounts":{
139      "name":"ListMemberAccounts",
140      "http":{
141        "method":"POST",
142        "requestUri":"/"
143      },
144      "input":{"shape":"ListMemberAccountsRequest"},
145      "output":{"shape":"ListMemberAccountsResponse"},
146      "errors":[
147        {"shape":"ResourceNotFoundException"},
148        {"shape":"InternalErrorException"}
149      ]
150    },
151    "ListPolicies":{
152      "name":"ListPolicies",
153      "http":{
154        "method":"POST",
155        "requestUri":"/"
156      },
157      "input":{"shape":"ListPoliciesRequest"},
158      "output":{"shape":"ListPoliciesResponse"},
159      "errors":[
160        {"shape":"ResourceNotFoundException"},
161        {"shape":"InvalidOperationException"},
162        {"shape":"LimitExceededException"},
163        {"shape":"InternalErrorException"}
164      ]
165    },
166    "PutNotificationChannel":{
167      "name":"PutNotificationChannel",
168      "http":{
169        "method":"POST",
170        "requestUri":"/"
171      },
172      "input":{"shape":"PutNotificationChannelRequest"},
173      "errors":[
174        {"shape":"ResourceNotFoundException"},
175        {"shape":"InvalidOperationException"},
176        {"shape":"InternalErrorException"}
177      ]
178    },
179    "PutPolicy":{
180      "name":"PutPolicy",
181      "http":{
182        "method":"POST",
183        "requestUri":"/"
184      },
185      "input":{"shape":"PutPolicyRequest"},
186      "output":{"shape":"PutPolicyResponse"},
187      "errors":[
188        {"shape":"ResourceNotFoundException"},
189        {"shape":"InvalidOperationException"},
190        {"shape":"InvalidInputException"},
191        {"shape":"LimitExceededException"},
192        {"shape":"InternalErrorException"},
193        {"shape":"InvalidTypeException"}
194      ]
195    }
196  },
197  "shapes":{
198    "AWSAccountId":{
199      "type":"string",
200      "max":1024,
201      "min":1
202    },
203    "AccountRoleStatus":{
204      "type":"string",
205      "enum":[
206        "READY",
207        "CREATING",
208        "PENDING_DELETION",
209        "DELETING",
210        "DELETED"
211      ]
212    },
213    "AssociateAdminAccountRequest":{
214      "type":"structure",
215      "required":["AdminAccount"],
216      "members":{
217        "AdminAccount":{"shape":"AWSAccountId"}
218      }
219    },
220    "Boolean":{"type":"boolean"},
221    "ComplianceViolator":{
222      "type":"structure",
223      "members":{
224        "ResourceId":{"shape":"ResourceId"},
225        "ViolationReason":{"shape":"ViolationReason"},
226        "ResourceType":{"shape":"ResourceType"}
227      }
228    },
229    "ComplianceViolators":{
230      "type":"list",
231      "member":{"shape":"ComplianceViolator"}
232    },
233    "CustomerPolicyScopeId":{
234      "type":"string",
235      "max":1024,
236      "min":1
237    },
238    "CustomerPolicyScopeIdList":{
239      "type":"list",
240      "member":{"shape":"CustomerPolicyScopeId"}
241    },
242    "CustomerPolicyScopeIdType":{
243      "type":"string",
244      "enum":["ACCOUNT"]
245    },
246    "CustomerPolicyScopeMap":{
247      "type":"map",
248      "key":{"shape":"CustomerPolicyScopeIdType"},
249      "value":{"shape":"CustomerPolicyScopeIdList"}
250    },
251    "DeleteNotificationChannelRequest":{
252      "type":"structure",
253      "members":{
254      }
255    },
256    "DeletePolicyRequest":{
257      "type":"structure",
258      "required":["PolicyId"],
259      "members":{
260        "PolicyId":{"shape":"PolicyId"}
261      }
262    },
263    "DependentServiceName":{
264      "type":"string",
265      "enum":[
266        "AWSCONFIG",
267        "AWSWAF"
268      ]
269    },
270    "DetailedInfo":{
271      "type":"string",
272      "max":1024,
273      "min":1
274    },
275    "DisassociateAdminAccountRequest":{
276      "type":"structure",
277      "members":{
278      }
279    },
280    "ErrorMessage":{"type":"string"},
281    "EvaluationResult":{
282      "type":"structure",
283      "members":{
284        "ComplianceStatus":{"shape":"PolicyComplianceStatusType"},
285        "ViolatorCount":{"shape":"ResourceCount"},
286        "EvaluationLimitExceeded":{"shape":"Boolean"}
287      }
288    },
289    "EvaluationResults":{
290      "type":"list",
291      "member":{"shape":"EvaluationResult"}
292    },
293    "GetAdminAccountRequest":{
294      "type":"structure",
295      "members":{
296      }
297    },
298    "GetAdminAccountResponse":{
299      "type":"structure",
300      "members":{
301        "AdminAccount":{"shape":"AWSAccountId"},
302        "RoleStatus":{"shape":"AccountRoleStatus"}
303      }
304    },
305    "GetComplianceDetailRequest":{
306      "type":"structure",
307      "required":[
308        "PolicyId",
309        "MemberAccount"
310      ],
311      "members":{
312        "PolicyId":{"shape":"PolicyId"},
313        "MemberAccount":{"shape":"AWSAccountId"}
314      }
315    },
316    "GetComplianceDetailResponse":{
317      "type":"structure",
318      "members":{
319        "PolicyComplianceDetail":{"shape":"PolicyComplianceDetail"}
320      }
321    },
322    "GetNotificationChannelRequest":{
323      "type":"structure",
324      "members":{
325      }
326    },
327    "GetNotificationChannelResponse":{
328      "type":"structure",
329      "members":{
330        "SnsTopicArn":{"shape":"ResourceArn"},
331        "SnsRoleName":{"shape":"ResourceArn"}
332      }
333    },
334    "GetPolicyRequest":{
335      "type":"structure",
336      "required":["PolicyId"],
337      "members":{
338        "PolicyId":{"shape":"PolicyId"}
339      }
340    },
341    "GetPolicyResponse":{
342      "type":"structure",
343      "members":{
344        "Policy":{"shape":"Policy"},
345        "PolicyArn":{"shape":"ResourceArn"}
346      }
347    },
348    "InternalErrorException":{
349      "type":"structure",
350      "members":{
351        "Message":{"shape":"ErrorMessage"}
352      },
353      "exception":true
354    },
355    "InvalidInputException":{
356      "type":"structure",
357      "members":{
358        "Message":{"shape":"ErrorMessage"}
359      },
360      "exception":true
361    },
362    "InvalidOperationException":{
363      "type":"structure",
364      "members":{
365        "Message":{"shape":"ErrorMessage"}
366      },
367      "exception":true
368    },
369    "InvalidTypeException":{
370      "type":"structure",
371      "members":{
372        "Message":{"shape":"ErrorMessage"}
373      },
374      "exception":true
375    },
376    "IssueInfoMap":{
377      "type":"map",
378      "key":{"shape":"DependentServiceName"},
379      "value":{"shape":"DetailedInfo"}
380    },
381    "LimitExceededException":{
382      "type":"structure",
383      "members":{
384        "Message":{"shape":"ErrorMessage"}
385      },
386      "exception":true
387    },
388    "ListComplianceStatusRequest":{
389      "type":"structure",
390      "required":["PolicyId"],
391      "members":{
392        "PolicyId":{"shape":"PolicyId"},
393        "NextToken":{"shape":"PaginationToken"},
394        "MaxResults":{"shape":"PaginationMaxResults"}
395      }
396    },
397    "ListComplianceStatusResponse":{
398      "type":"structure",
399      "members":{
400        "PolicyComplianceStatusList":{"shape":"PolicyComplianceStatusList"},
401        "NextToken":{"shape":"PaginationToken"}
402      }
403    },
404    "ListMemberAccountsRequest":{
405      "type":"structure",
406      "members":{
407        "NextToken":{"shape":"PaginationToken"},
408        "MaxResults":{"shape":"PaginationMaxResults"}
409      }
410    },
411    "ListMemberAccountsResponse":{
412      "type":"structure",
413      "members":{
414        "MemberAccounts":{"shape":"MemberAccounts"},
415        "NextToken":{"shape":"PaginationToken"}
416      }
417    },
418    "ListPoliciesRequest":{
419      "type":"structure",
420      "members":{
421        "NextToken":{"shape":"PaginationToken"},
422        "MaxResults":{"shape":"PaginationMaxResults"}
423      }
424    },
425    "ListPoliciesResponse":{
426      "type":"structure",
427      "members":{
428        "PolicyList":{"shape":"PolicySummaryList"},
429        "NextToken":{"shape":"PaginationToken"}
430      }
431    },
432    "ManagedServiceData":{
433      "type":"string",
434      "max":1024,
435      "min":1
436    },
437    "MemberAccounts":{
438      "type":"list",
439      "member":{"shape":"AWSAccountId"}
440    },
441    "PaginationMaxResults":{
442      "type":"integer",
443      "max":100,
444      "min":1
445    },
446    "PaginationToken":{
447      "type":"string",
448      "min":1
449    },
450    "Policy":{
451      "type":"structure",
452      "required":[
453        "PolicyName",
454        "SecurityServicePolicyData",
455        "ResourceType",
456        "ExcludeResourceTags",
457        "RemediationEnabled"
458      ],
459      "members":{
460        "PolicyId":{"shape":"PolicyId"},
461        "PolicyName":{"shape":"ResourceName"},
462        "PolicyUpdateToken":{"shape":"PolicyUpdateToken"},
463        "SecurityServicePolicyData":{"shape":"SecurityServicePolicyData"},
464        "ResourceType":{"shape":"ResourceType"},
465        "ResourceTags":{"shape":"ResourceTags"},
466        "ExcludeResourceTags":{"shape":"Boolean"},
467        "RemediationEnabled":{"shape":"Boolean"},
468        "IncludeMap":{"shape":"CustomerPolicyScopeMap"},
469        "ExcludeMap":{"shape":"CustomerPolicyScopeMap"}
470      }
471    },
472    "PolicyComplianceDetail":{
473      "type":"structure",
474      "members":{
475        "PolicyOwner":{"shape":"AWSAccountId"},
476        "PolicyId":{"shape":"PolicyId"},
477        "MemberAccount":{"shape":"AWSAccountId"},
478        "Violators":{"shape":"ComplianceViolators"},
479        "EvaluationLimitExceeded":{"shape":"Boolean"},
480        "ExpiredAt":{"shape":"TimeStamp"},
481        "IssueInfoMap":{"shape":"IssueInfoMap"}
482      }
483    },
484    "PolicyComplianceStatus":{
485      "type":"structure",
486      "members":{
487        "PolicyOwner":{"shape":"AWSAccountId"},
488        "PolicyId":{"shape":"PolicyId"},
489        "PolicyName":{"shape":"ResourceName"},
490        "MemberAccount":{"shape":"AWSAccountId"},
491        "EvaluationResults":{"shape":"EvaluationResults"},
492        "LastUpdated":{"shape":"TimeStamp"},
493        "IssueInfoMap":{"shape":"IssueInfoMap"}
494      }
495    },
496    "PolicyComplianceStatusList":{
497      "type":"list",
498      "member":{"shape":"PolicyComplianceStatus"}
499    },
500    "PolicyComplianceStatusType":{
501      "type":"string",
502      "enum":[
503        "COMPLIANT",
504        "NON_COMPLIANT"
505      ]
506    },
507    "PolicyId":{
508      "type":"string",
509      "max":36,
510      "min":36
511    },
512    "PolicySummary":{
513      "type":"structure",
514      "members":{
515        "PolicyArn":{"shape":"ResourceArn"},
516        "PolicyId":{"shape":"PolicyId"},
517        "PolicyName":{"shape":"ResourceName"},
518        "ResourceType":{"shape":"ResourceType"},
519        "SecurityServiceType":{"shape":"SecurityServiceType"},
520        "RemediationEnabled":{"shape":"Boolean"}
521      }
522    },
523    "PolicySummaryList":{
524      "type":"list",
525      "member":{"shape":"PolicySummary"}
526    },
527    "PolicyUpdateToken":{
528      "type":"string",
529      "max":1024,
530      "min":1
531    },
532    "PutNotificationChannelRequest":{
533      "type":"structure",
534      "required":[
535        "SnsTopicArn",
536        "SnsRoleName"
537      ],
538      "members":{
539        "SnsTopicArn":{"shape":"ResourceArn"},
540        "SnsRoleName":{"shape":"ResourceArn"}
541      }
542    },
543    "PutPolicyRequest":{
544      "type":"structure",
545      "required":["Policy"],
546      "members":{
547        "Policy":{"shape":"Policy"}
548      }
549    },
550    "PutPolicyResponse":{
551      "type":"structure",
552      "members":{
553        "Policy":{"shape":"Policy"},
554        "PolicyArn":{"shape":"ResourceArn"}
555      }
556    },
557    "ResourceArn":{
558      "type":"string",
559      "max":1024,
560      "min":1
561    },
562    "ResourceCount":{
563      "type":"long",
564      "min":0
565    },
566    "ResourceId":{
567      "type":"string",
568      "max":1024,
569      "min":1
570    },
571    "ResourceName":{
572      "type":"string",
573      "max":128,
574      "min":1
575    },
576    "ResourceNotFoundException":{
577      "type":"structure",
578      "members":{
579        "Message":{"shape":"ErrorMessage"}
580      },
581      "exception":true
582    },
583    "ResourceTag":{
584      "type":"structure",
585      "required":["Key"],
586      "members":{
587        "Key":{"shape":"TagKey"},
588        "Value":{"shape":"TagValue"}
589      }
590    },
591    "ResourceTags":{
592      "type":"list",
593      "member":{"shape":"ResourceTag"},
594      "max":8,
595      "min":0
596    },
597    "ResourceType":{
598      "type":"string",
599      "max":128,
600      "min":1
601    },
602    "SecurityServicePolicyData":{
603      "type":"structure",
604      "required":["Type"],
605      "members":{
606        "Type":{"shape":"SecurityServiceType"},
607        "ManagedServiceData":{"shape":"ManagedServiceData"}
608      }
609    },
610    "SecurityServiceType":{
611      "type":"string",
612      "enum":["WAF"]
613    },
614    "TagKey":{
615      "type":"string",
616      "max":128,
617      "min":1,
618      "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
619    },
620    "TagValue":{
621      "type":"string",
622      "max":256,
623      "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
624    },
625    "TimeStamp":{"type":"timestamp"},
626    "ViolationReason":{
627      "type":"string",
628      "enum":[
629        "WEB_ACL_MISSING_RULE_GROUP",
630        "RESOURCE_MISSING_WEB_ACL",
631        "RESOURCE_INCORRECT_WEB_ACL"
632      ]
633    }
634  }
635}
636