/ cloudformation-templates / node_modules / aws-cdk / node_modules / aws-sdk / apis / shield-2016-06-02.min.json
shield-2016-06-02.min.json
  1  {
  2    "version": "2.0",
  3    "metadata": {
  4      "apiVersion": "2016-06-02",
  5      "endpointPrefix": "shield",
  6      "jsonVersion": "1.1",
  7      "protocol": "json",
  8      "serviceAbbreviation": "AWS Shield",
  9      "serviceFullName": "AWS Shield",
 10      "serviceId": "Shield",
 11      "signatureVersion": "v4",
 12      "targetPrefix": "AWSShield_20160616",
 13      "uid": "shield-2016-06-02"
 14    },
 15    "operations": {
 16      "AssociateDRTLogBucket": {
 17        "input": {
 18          "type": "structure",
 19          "required": [
 20            "LogBucket"
 21          ],
 22          "members": {
 23            "LogBucket": {}
 24          }
 25        },
 26        "output": {
 27          "type": "structure",
 28          "members": {}
 29        }
 30      },
 31      "AssociateDRTRole": {
 32        "input": {
 33          "type": "structure",
 34          "required": [
 35            "RoleArn"
 36          ],
 37          "members": {
 38            "RoleArn": {}
 39          }
 40        },
 41        "output": {
 42          "type": "structure",
 43          "members": {}
 44        }
 45      },
 46      "AssociateHealthCheck": {
 47        "input": {
 48          "type": "structure",
 49          "required": [
 50            "ProtectionId",
 51            "HealthCheckArn"
 52          ],
 53          "members": {
 54            "ProtectionId": {},
 55            "HealthCheckArn": {}
 56          }
 57        },
 58        "output": {
 59          "type": "structure",
 60          "members": {}
 61        }
 62      },
 63      "AssociateProactiveEngagementDetails": {
 64        "input": {
 65          "type": "structure",
 66          "required": [
 67            "EmergencyContactList"
 68          ],
 69          "members": {
 70            "EmergencyContactList": {
 71              "shape": "Sc"
 72            }
 73          }
 74        },
 75        "output": {
 76          "type": "structure",
 77          "members": {}
 78        }
 79      },
 80      "CreateProtection": {
 81        "input": {
 82          "type": "structure",
 83          "required": [
 84            "Name",
 85            "ResourceArn"
 86          ],
 87          "members": {
 88            "Name": {},
 89            "ResourceArn": {},
 90            "Tags": {
 91              "shape": "Sl"
 92            }
 93          }
 94        },
 95        "output": {
 96          "type": "structure",
 97          "members": {
 98            "ProtectionId": {}
 99          }
100        }
101      },
102      "CreateProtectionGroup": {
103        "input": {
104          "type": "structure",
105          "required": [
106            "ProtectionGroupId",
107            "Aggregation",
108            "Pattern"
109          ],
110          "members": {
111            "ProtectionGroupId": {},
112            "Aggregation": {},
113            "Pattern": {},
114            "ResourceType": {},
115            "Members": {
116              "shape": "Sv"
117            },
118            "Tags": {
119              "shape": "Sl"
120            }
121          }
122        },
123        "output": {
124          "type": "structure",
125          "members": {}
126        }
127      },
128      "CreateSubscription": {
129        "input": {
130          "type": "structure",
131          "members": {}
132        },
133        "output": {
134          "type": "structure",
135          "members": {}
136        }
137      },
138      "DeleteProtection": {
139        "input": {
140          "type": "structure",
141          "required": [
142            "ProtectionId"
143          ],
144          "members": {
145            "ProtectionId": {}
146          }
147        },
148        "output": {
149          "type": "structure",
150          "members": {}
151        }
152      },
153      "DeleteProtectionGroup": {
154        "input": {
155          "type": "structure",
156          "required": [
157            "ProtectionGroupId"
158          ],
159          "members": {
160            "ProtectionGroupId": {}
161          }
162        },
163        "output": {
164          "type": "structure",
165          "members": {}
166        }
167      },
168      "DeleteSubscription": {
169        "input": {
170          "type": "structure",
171          "members": {},
172          "deprecated": true
173        },
174        "output": {
175          "type": "structure",
176          "members": {},
177          "deprecated": true
178        },
179        "deprecated": true
180      },
181      "DescribeAttack": {
182        "input": {
183          "type": "structure",
184          "required": [
185            "AttackId"
186          ],
187          "members": {
188            "AttackId": {}
189          }
190        },
191        "output": {
192          "type": "structure",
193          "members": {
194            "Attack": {
195              "type": "structure",
196              "members": {
197                "AttackId": {},
198                "ResourceArn": {},
199                "SubResources": {
200                  "type": "list",
201                  "member": {
202                    "type": "structure",
203                    "members": {
204                      "Type": {},
205                      "Id": {},
206                      "AttackVectors": {
207                        "type": "list",
208                        "member": {
209                          "type": "structure",
210                          "required": [
211                            "VectorType"
212                          ],
213                          "members": {
214                            "VectorType": {},
215                            "VectorCounters": {
216                              "shape": "S1f"
217                            }
218                          }
219                        }
220                      },
221                      "Counters": {
222                        "shape": "S1f"
223                      }
224                    }
225                  }
226                },
227                "StartTime": {
228                  "type": "timestamp"
229                },
230                "EndTime": {
231                  "type": "timestamp"
232                },
233                "AttackCounters": {
234                  "shape": "S1f"
235                },
236                "AttackProperties": {
237                  "type": "list",
238                  "member": {
239                    "type": "structure",
240                    "members": {
241                      "AttackLayer": {},
242                      "AttackPropertyIdentifier": {},
243                      "TopContributors": {
244                        "type": "list",
245                        "member": {
246                          "type": "structure",
247                          "members": {
248                            "Name": {},
249                            "Value": {
250                              "type": "long"
251                            }
252                          }
253                        }
254                      },
255                      "Unit": {},
256                      "Total": {
257                        "type": "long"
258                      }
259                    }
260                  }
261                },
262                "Mitigations": {
263                  "type": "list",
264                  "member": {
265                    "type": "structure",
266                    "members": {
267                      "MitigationName": {}
268                    }
269                  }
270                }
271              }
272            }
273          }
274        }
275      },
276      "DescribeAttackStatistics": {
277        "input": {
278          "type": "structure",
279          "members": {}
280        },
281        "output": {
282          "type": "structure",
283          "required": [
284            "TimeRange",
285            "DataItems"
286          ],
287          "members": {
288            "TimeRange": {
289              "shape": "S1w"
290            },
291            "DataItems": {
292              "type": "list",
293              "member": {
294                "type": "structure",
295                "required": [
296                  "AttackCount"
297                ],
298                "members": {
299                  "AttackVolume": {
300                    "type": "structure",
301                    "members": {
302                      "BitsPerSecond": {
303                        "shape": "S20"
304                      },
305                      "PacketsPerSecond": {
306                        "shape": "S20"
307                      },
308                      "RequestsPerSecond": {
309                        "shape": "S20"
310                      }
311                    }
312                  },
313                  "AttackCount": {
314                    "type": "long"
315                  }
316                }
317              }
318            }
319          }
320        }
321      },
322      "DescribeDRTAccess": {
323        "input": {
324          "type": "structure",
325          "members": {}
326        },
327        "output": {
328          "type": "structure",
329          "members": {
330            "RoleArn": {},
331            "LogBucketList": {
332              "type": "list",
333              "member": {}
334            }
335          }
336        }
337      },
338      "DescribeEmergencyContactSettings": {
339        "input": {
340          "type": "structure",
341          "members": {}
342        },
343        "output": {
344          "type": "structure",
345          "members": {
346            "EmergencyContactList": {
347              "shape": "Sc"
348            }
349          }
350        }
351      },
352      "DescribeProtection": {
353        "input": {
354          "type": "structure",
355          "members": {
356            "ProtectionId": {},
357            "ResourceArn": {}
358          }
359        },
360        "output": {
361          "type": "structure",
362          "members": {
363            "Protection": {
364              "shape": "S28"
365            }
366          }
367        }
368      },
369      "DescribeProtectionGroup": {
370        "input": {
371          "type": "structure",
372          "required": [
373            "ProtectionGroupId"
374          ],
375          "members": {
376            "ProtectionGroupId": {}
377          }
378        },
379        "output": {
380          "type": "structure",
381          "required": [
382            "ProtectionGroup"
383          ],
384          "members": {
385            "ProtectionGroup": {
386              "shape": "S2d"
387            }
388          }
389        }
390      },
391      "DescribeSubscription": {
392        "input": {
393          "type": "structure",
394          "members": {}
395        },
396        "output": {
397          "type": "structure",
398          "members": {
399            "Subscription": {
400              "type": "structure",
401              "required": [
402                "SubscriptionLimits"
403              ],
404              "members": {
405                "StartTime": {
406                  "type": "timestamp"
407                },
408                "EndTime": {
409                  "type": "timestamp"
410                },
411                "TimeCommitmentInSeconds": {
412                  "type": "long"
413                },
414                "AutoRenew": {},
415                "Limits": {
416                  "shape": "S2k"
417                },
418                "ProactiveEngagementStatus": {},
419                "SubscriptionLimits": {
420                  "type": "structure",
421                  "required": [
422                    "ProtectionLimits",
423                    "ProtectionGroupLimits"
424                  ],
425                  "members": {
426                    "ProtectionLimits": {
427                      "type": "structure",
428                      "required": [
429                        "ProtectedResourceTypeLimits"
430                      ],
431                      "members": {
432                        "ProtectedResourceTypeLimits": {
433                          "shape": "S2k"
434                        }
435                      }
436                    },
437                    "ProtectionGroupLimits": {
438                      "type": "structure",
439                      "required": [
440                        "MaxProtectionGroups",
441                        "PatternTypeLimits"
442                      ],
443                      "members": {
444                        "MaxProtectionGroups": {
445                          "type": "long"
446                        },
447                        "PatternTypeLimits": {
448                          "type": "structure",
449                          "required": [
450                            "ArbitraryPatternLimits"
451                          ],
452                          "members": {
453                            "ArbitraryPatternLimits": {
454                              "type": "structure",
455                              "required": [
456                                "MaxMembers"
457                              ],
458                              "members": {
459                                "MaxMembers": {
460                                  "type": "long"
461                                }
462                              }
463                            }
464                          }
465                        }
466                      }
467                    }
468                  }
469                },
470                "SubscriptionArn": {}
471              }
472            }
473          }
474        }
475      },
476      "DisableProactiveEngagement": {
477        "input": {
478          "type": "structure",
479          "members": {}
480        },
481        "output": {
482          "type": "structure",
483          "members": {}
484        }
485      },
486      "DisassociateDRTLogBucket": {
487        "input": {
488          "type": "structure",
489          "required": [
490            "LogBucket"
491          ],
492          "members": {
493            "LogBucket": {}
494          }
495        },
496        "output": {
497          "type": "structure",
498          "members": {}
499        }
500      },
501      "DisassociateDRTRole": {
502        "input": {
503          "type": "structure",
504          "members": {}
505        },
506        "output": {
507          "type": "structure",
508          "members": {}
509        }
510      },
511      "DisassociateHealthCheck": {
512        "input": {
513          "type": "structure",
514          "required": [
515            "ProtectionId",
516            "HealthCheckArn"
517          ],
518          "members": {
519            "ProtectionId": {},
520            "HealthCheckArn": {}
521          }
522        },
523        "output": {
524          "type": "structure",
525          "members": {}
526        }
527      },
528      "EnableProactiveEngagement": {
529        "input": {
530          "type": "structure",
531          "members": {}
532        },
533        "output": {
534          "type": "structure",
535          "members": {}
536        }
537      },
538      "GetSubscriptionState": {
539        "input": {
540          "type": "structure",
541          "members": {}
542        },
543        "output": {
544          "type": "structure",
545          "required": [
546            "SubscriptionState"
547          ],
548          "members": {
549            "SubscriptionState": {}
550          }
551        }
552      },
553      "ListAttacks": {
554        "input": {
555          "type": "structure",
556          "members": {
557            "ResourceArns": {
558              "type": "list",
559              "member": {}
560            },
561            "StartTime": {
562              "shape": "S1w"
563            },
564            "EndTime": {
565              "shape": "S1w"
566            },
567            "NextToken": {},
568            "MaxResults": {
569              "type": "integer"
570            }
571          }
572        },
573        "output": {
574          "type": "structure",
575          "members": {
576            "AttackSummaries": {
577              "type": "list",
578              "member": {
579                "type": "structure",
580                "members": {
581                  "AttackId": {},
582                  "ResourceArn": {},
583                  "StartTime": {
584                    "type": "timestamp"
585                  },
586                  "EndTime": {
587                    "type": "timestamp"
588                  },
589                  "AttackVectors": {
590                    "type": "list",
591                    "member": {
592                      "type": "structure",
593                      "required": [
594                        "VectorType"
595                      ],
596                      "members": {
597                        "VectorType": {}
598                      }
599                    }
600                  }
601                }
602              }
603            },
604            "NextToken": {}
605          }
606        }
607      },
608      "ListProtectionGroups": {
609        "input": {
610          "type": "structure",
611          "members": {
612            "NextToken": {},
613            "MaxResults": {
614              "type": "integer"
615            }
616          }
617        },
618        "output": {
619          "type": "structure",
620          "required": [
621            "ProtectionGroups"
622          ],
623          "members": {
624            "ProtectionGroups": {
625              "type": "list",
626              "member": {
627                "shape": "S2d"
628              }
629            },
630            "NextToken": {}
631          }
632        }
633      },
634      "ListProtections": {
635        "input": {
636          "type": "structure",
637          "members": {
638            "NextToken": {},
639            "MaxResults": {
640              "type": "integer"
641            }
642          }
643        },
644        "output": {
645          "type": "structure",
646          "members": {
647            "Protections": {
648              "type": "list",
649              "member": {
650                "shape": "S28"
651              }
652            },
653            "NextToken": {}
654          }
655        }
656      },
657      "ListResourcesInProtectionGroup": {
658        "input": {
659          "type": "structure",
660          "required": [
661            "ProtectionGroupId"
662          ],
663          "members": {
664            "ProtectionGroupId": {},
665            "NextToken": {},
666            "MaxResults": {
667              "type": "integer"
668            }
669          }
670        },
671        "output": {
672          "type": "structure",
673          "required": [
674            "ResourceArns"
675          ],
676          "members": {
677            "ResourceArns": {
678              "type": "list",
679              "member": {}
680            },
681            "NextToken": {}
682          }
683        }
684      },
685      "ListTagsForResource": {
686        "input": {
687          "type": "structure",
688          "required": [
689            "ResourceARN"
690          ],
691          "members": {
692            "ResourceARN": {}
693          }
694        },
695        "output": {
696          "type": "structure",
697          "members": {
698            "Tags": {
699              "shape": "Sl"
700            }
701          }
702        }
703      },
704      "TagResource": {
705        "input": {
706          "type": "structure",
707          "required": [
708            "ResourceARN",
709            "Tags"
710          ],
711          "members": {
712            "ResourceARN": {},
713            "Tags": {
714              "shape": "Sl"
715            }
716          }
717        },
718        "output": {
719          "type": "structure",
720          "members": {}
721        }
722      },
723      "UntagResource": {
724        "input": {
725          "type": "structure",
726          "required": [
727            "ResourceARN",
728            "TagKeys"
729          ],
730          "members": {
731            "ResourceARN": {},
732            "TagKeys": {
733              "type": "list",
734              "member": {}
735            }
736          }
737        },
738        "output": {
739          "type": "structure",
740          "members": {}
741        }
742      },
743      "UpdateEmergencyContactSettings": {
744        "input": {
745          "type": "structure",
746          "members": {
747            "EmergencyContactList": {
748              "shape": "Sc"
749            }
750          }
751        },
752        "output": {
753          "type": "structure",
754          "members": {}
755        }
756      },
757      "UpdateProtectionGroup": {
758        "input": {
759          "type": "structure",
760          "required": [
761            "ProtectionGroupId",
762            "Aggregation",
763            "Pattern"
764          ],
765          "members": {
766            "ProtectionGroupId": {},
767            "Aggregation": {},
768            "Pattern": {},
769            "ResourceType": {},
770            "Members": {
771              "shape": "Sv"
772            }
773          }
774        },
775        "output": {
776          "type": "structure",
777          "members": {}
778        }
779      },
780      "UpdateSubscription": {
781        "input": {
782          "type": "structure",
783          "members": {
784            "AutoRenew": {}
785          }
786        },
787        "output": {
788          "type": "structure",
789          "members": {}
790        }
791      }
792    },
793    "shapes": {
794      "Sc": {
795        "type": "list",
796        "member": {
797          "type": "structure",
798          "required": [
799            "EmailAddress"
800          ],
801          "members": {
802            "EmailAddress": {},
803            "PhoneNumber": {},
804            "ContactNotes": {}
805          }
806        }
807      },
808      "Sl": {
809        "type": "list",
810        "member": {
811          "type": "structure",
812          "members": {
813            "Key": {},
814            "Value": {}
815          }
816        }
817      },
818      "Sv": {
819        "type": "list",
820        "member": {}
821      },
822      "S1f": {
823        "type": "list",
824        "member": {
825          "type": "structure",
826          "members": {
827            "Name": {},
828            "Max": {
829              "type": "double"
830            },
831            "Average": {
832              "type": "double"
833            },
834            "Sum": {
835              "type": "double"
836            },
837            "N": {
838              "type": "integer"
839            },
840            "Unit": {}
841          }
842        }
843      },
844      "S1w": {
845        "type": "structure",
846        "members": {
847          "FromInclusive": {
848            "type": "timestamp"
849          },
850          "ToExclusive": {
851            "type": "timestamp"
852          }
853        }
854      },
855      "S20": {
856        "type": "structure",
857        "required": [
858          "Max"
859        ],
860        "members": {
861          "Max": {
862            "type": "double"
863          }
864        }
865      },
866      "S28": {
867        "type": "structure",
868        "members": {
869          "Id": {},
870          "Name": {},
871          "ResourceArn": {},
872          "HealthCheckIds": {
873            "type": "list",
874            "member": {}
875          },
876          "ProtectionArn": {}
877        }
878      },
879      "S2d": {
880        "type": "structure",
881        "required": [
882          "ProtectionGroupId",
883          "Aggregation",
884          "Pattern",
885          "Members"
886        ],
887        "members": {
888          "ProtectionGroupId": {},
889          "Aggregation": {},
890          "Pattern": {},
891          "ResourceType": {},
892          "Members": {
893            "shape": "Sv"
894          },
895          "ProtectionGroupArn": {}
896        }
897      },
898      "S2k": {
899        "type": "list",
900        "member": {
901          "type": "structure",
902          "members": {
903            "Type": {},
904            "Max": {
905              "type": "long"
906            }
907          }
908        }
909      }
910    }
911  }