@aws-sdk/client-shield 3.295.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (46) hide show
  1. package/dist-types/Shield.d.ts +37 -0
  2. package/dist-types/ShieldClient.d.ts +24 -4
  3. package/dist-types/commands/AssociateDRTLogBucketCommand.d.ts +16 -0
  4. package/dist-types/commands/AssociateDRTRoleCommand.d.ts +16 -0
  5. package/dist-types/commands/AssociateHealthCheckCommand.d.ts +16 -0
  6. package/dist-types/commands/AssociateProactiveEngagementDetailsCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateProtectionCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateProtectionGroupCommand.d.ts +16 -0
  9. package/dist-types/commands/CreateSubscriptionCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteProtectionCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteProtectionGroupCommand.d.ts +16 -0
  12. package/dist-types/commands/DeleteSubscriptionCommand.d.ts +16 -0
  13. package/dist-types/commands/DescribeAttackCommand.d.ts +16 -0
  14. package/dist-types/commands/DescribeAttackStatisticsCommand.d.ts +16 -0
  15. package/dist-types/commands/DescribeDRTAccessCommand.d.ts +16 -0
  16. package/dist-types/commands/DescribeEmergencyContactSettingsCommand.d.ts +16 -0
  17. package/dist-types/commands/DescribeProtectionCommand.d.ts +16 -0
  18. package/dist-types/commands/DescribeProtectionGroupCommand.d.ts +16 -0
  19. package/dist-types/commands/DescribeSubscriptionCommand.d.ts +16 -0
  20. package/dist-types/commands/DisableApplicationLayerAutomaticResponseCommand.d.ts +16 -0
  21. package/dist-types/commands/DisableProactiveEngagementCommand.d.ts +16 -0
  22. package/dist-types/commands/DisassociateDRTLogBucketCommand.d.ts +16 -0
  23. package/dist-types/commands/DisassociateDRTRoleCommand.d.ts +16 -0
  24. package/dist-types/commands/DisassociateHealthCheckCommand.d.ts +16 -0
  25. package/dist-types/commands/EnableApplicationLayerAutomaticResponseCommand.d.ts +16 -0
  26. package/dist-types/commands/EnableProactiveEngagementCommand.d.ts +16 -0
  27. package/dist-types/commands/GetSubscriptionStateCommand.d.ts +16 -0
  28. package/dist-types/commands/ListAttacksCommand.d.ts +16 -0
  29. package/dist-types/commands/ListProtectionGroupsCommand.d.ts +16 -0
  30. package/dist-types/commands/ListProtectionsCommand.d.ts +16 -0
  31. package/dist-types/commands/ListResourcesInProtectionGroupCommand.d.ts +16 -0
  32. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  33. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  34. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  35. package/dist-types/commands/UpdateApplicationLayerAutomaticResponseCommand.d.ts +16 -0
  36. package/dist-types/commands/UpdateEmergencyContactSettingsCommand.d.ts +16 -0
  37. package/dist-types/commands/UpdateProtectionGroupCommand.d.ts +16 -0
  38. package/dist-types/commands/UpdateSubscriptionCommand.d.ts +16 -0
  39. package/dist-types/models/ShieldServiceException.d.ts +2 -0
  40. package/dist-types/models/models_0.d.ts +298 -2
  41. package/dist-types/pagination/Interfaces.d.ts +3 -0
  42. package/dist-types/pagination/ListAttacksPaginator.d.ts +3 -0
  43. package/dist-types/pagination/ListProtectionGroupsPaginator.d.ts +3 -0
  44. package/dist-types/pagination/ListProtectionsPaginator.d.ts +3 -0
  45. package/dist-types/pagination/ListResourcesInProtectionGroupPaginator.d.ts +3 -0
  46. package/package.json +29 -29
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { ShieldServiceException as __BaseException } from "./ShieldServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>Exception that indicates the specified <code>AttackId</code> does not exist, or the requester does not have the appropriate permissions to access the <code>AttackId</code>.</p>
5
6
  */
6
7
  export declare class AccessDeniedException extends __BaseException {
@@ -12,6 +13,7 @@ export declare class AccessDeniedException extends __BaseException {
12
13
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
13
14
  }
14
15
  /**
16
+ * @public
15
17
  * <p>In order to grant the necessary access to the Shield Response Team (SRT) the user submitting the request must have the <code>iam:PassRole</code> permission. This error indicates the user did not have the appropriate permissions. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html">Granting a User Permissions to Pass a Role to an Amazon Web Services Service</a>. </p>
16
18
  */
17
19
  export declare class AccessDeniedForDependencyException extends __BaseException {
@@ -23,22 +25,25 @@ export declare class AccessDeniedForDependencyException extends __BaseException
23
25
  constructor(opts: __ExceptionOptionType<AccessDeniedForDependencyException, __BaseException>);
24
26
  }
25
27
  /**
28
+ * @public
26
29
  * <p>Specifies that Shield Advanced should configure its WAF rules with the WAF <code>Block</code> action. </p>
27
30
  * <p>This is only used in the context of the <code>ResponseAction</code> setting. </p>
28
- * <p>JSON specification: <code>"Block": {}</code>
31
+ * <p>JSON specification: <code>"Block": \{\}</code>
29
32
  * </p>
30
33
  */
31
34
  export interface BlockAction {
32
35
  }
33
36
  /**
37
+ * @public
34
38
  * <p>Specifies that Shield Advanced should configure its WAF rules with the WAF <code>Count</code> action. </p>
35
39
  * <p>This is only used in the context of the <code>ResponseAction</code> setting. </p>
36
- * <p>JSON specification: <code>"Count": {}</code>
40
+ * <p>JSON specification: <code>"Count": \{\}</code>
37
41
  * </p>
38
42
  */
39
43
  export interface CountAction {
40
44
  }
41
45
  /**
46
+ * @public
42
47
  * <p>Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the
43
48
  * protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature,
44
49
  * when you enable or update automatic mitigation. Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have associated with the resource. </p>
@@ -55,11 +60,15 @@ export interface ResponseAction {
55
60
  */
56
61
  Count?: CountAction;
57
62
  }
63
+ /**
64
+ * @public
65
+ */
58
66
  export declare enum ApplicationLayerAutomaticResponseStatus {
59
67
  DISABLED = "DISABLED",
60
68
  ENABLED = "ENABLED"
61
69
  }
62
70
  /**
71
+ * @public
63
72
  * <p>The automatic application layer DDoS mitigation settings for a <a>Protection</a>.
64
73
  * This configuration determines whether Shield Advanced automatically
65
74
  * manages rules in the web ACL in order to respond to application layer events that Shield Advanced determines to be DDoS attacks. </p>
@@ -76,15 +85,22 @@ export interface ApplicationLayerAutomaticResponseConfiguration {
76
85
  */
77
86
  Action: ResponseAction | undefined;
78
87
  }
88
+ /**
89
+ * @public
90
+ */
79
91
  export interface AssociateDRTLogBucketRequest {
80
92
  /**
81
93
  * <p>The Amazon S3 bucket that contains the logs that you want to share.</p>
82
94
  */
83
95
  LogBucket: string | undefined;
84
96
  }
97
+ /**
98
+ * @public
99
+ */
85
100
  export interface AssociateDRTLogBucketResponse {
86
101
  }
87
102
  /**
103
+ * @public
88
104
  * <p>Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.</p>
89
105
  */
90
106
  export declare class InternalErrorException extends __BaseException {
@@ -96,6 +112,7 @@ export declare class InternalErrorException extends __BaseException {
96
112
  constructor(opts: __ExceptionOptionType<InternalErrorException, __BaseException>);
97
113
  }
98
114
  /**
115
+ * @public
99
116
  * <p>Exception that indicates that the operation would not cause any change to occur.</p>
100
117
  */
101
118
  export declare class InvalidOperationException extends __BaseException {
@@ -107,6 +124,7 @@ export declare class InvalidOperationException extends __BaseException {
107
124
  constructor(opts: __ExceptionOptionType<InvalidOperationException, __BaseException>);
108
125
  }
109
126
  /**
127
+ * @public
110
128
  * <p>Provides information about a particular parameter passed inside a request that resulted in an exception.</p>
111
129
  */
112
130
  export interface ValidationExceptionField {
@@ -119,11 +137,15 @@ export interface ValidationExceptionField {
119
137
  */
120
138
  message: string | undefined;
121
139
  }
140
+ /**
141
+ * @public
142
+ */
122
143
  export declare enum ValidationExceptionReason {
123
144
  FIELD_VALIDATION_FAILED = "FIELD_VALIDATION_FAILED",
124
145
  OTHER = "OTHER"
125
146
  }
126
147
  /**
148
+ * @public
127
149
  * <p>Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties. </p>
128
150
  */
129
151
  export declare class InvalidParameterException extends __BaseException {
@@ -143,6 +165,7 @@ export declare class InvalidParameterException extends __BaseException {
143
165
  constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
144
166
  }
145
167
  /**
168
+ * @public
146
169
  * <p>Exception that indicates that the operation would exceed a limit.</p>
147
170
  */
148
171
  export declare class LimitsExceededException extends __BaseException {
@@ -162,6 +185,7 @@ export declare class LimitsExceededException extends __BaseException {
162
185
  constructor(opts: __ExceptionOptionType<LimitsExceededException, __BaseException>);
163
186
  }
164
187
  /**
188
+ * @public
165
189
  * <p>The ARN of the role that you specified does not exist.</p>
166
190
  */
167
191
  export declare class NoAssociatedRoleException extends __BaseException {
@@ -173,6 +197,7 @@ export declare class NoAssociatedRoleException extends __BaseException {
173
197
  constructor(opts: __ExceptionOptionType<NoAssociatedRoleException, __BaseException>);
174
198
  }
175
199
  /**
200
+ * @public
176
201
  * <p>Exception that indicates that the resource state has been modified by another
177
202
  * client. Retrieve the resource and then retry your request.</p>
178
203
  */
@@ -185,6 +210,7 @@ export declare class OptimisticLockException extends __BaseException {
185
210
  constructor(opts: __ExceptionOptionType<OptimisticLockException, __BaseException>);
186
211
  }
187
212
  /**
213
+ * @public
188
214
  * <p>Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties. </p>
189
215
  */
190
216
  export declare class ResourceNotFoundException extends __BaseException {
@@ -199,6 +225,9 @@ export declare class ResourceNotFoundException extends __BaseException {
199
225
  */
200
226
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
201
227
  }
228
+ /**
229
+ * @public
230
+ */
202
231
  export interface AssociateDRTRoleRequest {
203
232
  /**
204
233
  * <p>The Amazon Resource Name (ARN) of the role the SRT will use to access your Amazon Web Services account.</p>
@@ -206,8 +235,14 @@ export interface AssociateDRTRoleRequest {
206
235
  */
207
236
  RoleArn: string | undefined;
208
237
  }
238
+ /**
239
+ * @public
240
+ */
209
241
  export interface AssociateDRTRoleResponse {
210
242
  }
243
+ /**
244
+ * @public
245
+ */
211
246
  export interface AssociateHealthCheckRequest {
212
247
  /**
213
248
  * <p>The unique identifier (ID) for the <a>Protection</a> object to add the health check association to. </p>
@@ -218,9 +253,13 @@ export interface AssociateHealthCheckRequest {
218
253
  */
219
254
  HealthCheckArn: string | undefined;
220
255
  }
256
+ /**
257
+ * @public
258
+ */
221
259
  export interface AssociateHealthCheckResponse {
222
260
  }
223
261
  /**
262
+ * @public
224
263
  * <p>Exception that indicates that the resource is invalid. You might not have access to the resource, or the resource might not exist.</p>
225
264
  */
226
265
  export declare class InvalidResourceException extends __BaseException {
@@ -232,6 +271,7 @@ export declare class InvalidResourceException extends __BaseException {
232
271
  constructor(opts: __ExceptionOptionType<InvalidResourceException, __BaseException>);
233
272
  }
234
273
  /**
274
+ * @public
235
275
  * <p>Contact information that the SRT can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.</p>
236
276
  */
237
277
  export interface EmergencyContact {
@@ -248,6 +288,9 @@ export interface EmergencyContact {
248
288
  */
249
289
  ContactNotes?: string;
250
290
  }
291
+ /**
292
+ * @public
293
+ */
251
294
  export interface AssociateProactiveEngagementDetailsRequest {
252
295
  /**
253
296
  * <p>A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you for escalations to the SRT and to initiate proactive customer support. </p>
@@ -258,9 +301,13 @@ export interface AssociateProactiveEngagementDetailsRequest {
258
301
  */
259
302
  EmergencyContactList: EmergencyContact[] | undefined;
260
303
  }
304
+ /**
305
+ * @public
306
+ */
261
307
  export interface AssociateProactiveEngagementDetailsResponse {
262
308
  }
263
309
  /**
310
+ * @public
264
311
  * <p>The counter that describes a DDoS attack.</p>
265
312
  */
266
313
  export interface SummarizedCounter {
@@ -289,10 +336,16 @@ export interface SummarizedCounter {
289
336
  */
290
337
  Unit?: string;
291
338
  }
339
+ /**
340
+ * @public
341
+ */
292
342
  export declare enum AttackLayer {
293
343
  APPLICATION = "APPLICATION",
294
344
  NETWORK = "NETWORK"
295
345
  }
346
+ /**
347
+ * @public
348
+ */
296
349
  export declare enum AttackPropertyIdentifier {
297
350
  DESTINATION_URL = "DESTINATION_URL",
298
351
  REFERRER = "REFERRER",
@@ -304,6 +357,7 @@ export declare enum AttackPropertyIdentifier {
304
357
  WORDPRESS_PINGBACK_SOURCE = "WORDPRESS_PINGBACK_SOURCE"
305
358
  }
306
359
  /**
360
+ * @public
307
361
  * <p>A contributor to the attack and their contribution. </p>
308
362
  */
309
363
  export interface Contributor {
@@ -316,6 +370,9 @@ export interface Contributor {
316
370
  */
317
371
  Value?: number;
318
372
  }
373
+ /**
374
+ * @public
375
+ */
319
376
  export declare enum Unit {
320
377
  BITS = "BITS",
321
378
  BYTES = "BYTES",
@@ -323,6 +380,7 @@ export declare enum Unit {
323
380
  REQUESTS = "REQUESTS"
324
381
  }
325
382
  /**
383
+ * @public
326
384
  * <p>Details of a Shield event. This is provided as part of an <a>AttackDetail</a>.</p>
327
385
  */
328
386
  export interface AttackProperty {
@@ -356,6 +414,7 @@ export interface AttackProperty {
356
414
  Total?: number;
357
415
  }
358
416
  /**
417
+ * @public
359
418
  * <p>The mitigation applied to a DDoS attack.</p>
360
419
  */
361
420
  export interface Mitigation {
@@ -365,6 +424,7 @@ export interface Mitigation {
365
424
  MitigationName?: string;
366
425
  }
367
426
  /**
427
+ * @public
368
428
  * <p>A summary of information about the attack.</p>
369
429
  */
370
430
  export interface SummarizedAttackVector {
@@ -377,11 +437,15 @@ export interface SummarizedAttackVector {
377
437
  */
378
438
  VectorCounters?: SummarizedCounter[];
379
439
  }
440
+ /**
441
+ * @public
442
+ */
380
443
  export declare enum SubResourceType {
381
444
  IP = "IP",
382
445
  URL = "URL"
383
446
  }
384
447
  /**
448
+ * @public
385
449
  * <p>The attack information for the specified SubResource.</p>
386
450
  */
387
451
  export interface SubResourceSummary {
@@ -403,6 +467,7 @@ export interface SubResourceSummary {
403
467
  Counters?: SummarizedCounter[];
404
468
  }
405
469
  /**
470
+ * @public
406
471
  * <p>The details of a DDoS attack.</p>
407
472
  */
408
473
  export interface AttackDetail {
@@ -444,6 +509,7 @@ export interface AttackDetail {
444
509
  Mitigations?: Mitigation[];
445
510
  }
446
511
  /**
512
+ * @public
447
513
  * <p>Statistics objects for the various data types in <a>AttackVolume</a>. </p>
448
514
  */
449
515
  export interface AttackVolumeStatistics {
@@ -453,6 +519,7 @@ export interface AttackVolumeStatistics {
453
519
  Max: number | undefined;
454
520
  }
455
521
  /**
522
+ * @public
456
523
  * <p>Information about the volume of attacks during the time period, included in an <a>AttackStatisticsDataItem</a>. If the accompanying <code>AttackCount</code> in the statistics object is zero, this setting might be empty.</p>
457
524
  */
458
525
  export interface AttackVolume {
@@ -470,6 +537,7 @@ export interface AttackVolume {
470
537
  RequestsPerSecond?: AttackVolumeStatistics;
471
538
  }
472
539
  /**
540
+ * @public
473
541
  * <p>A single attack statistics data record. This is returned by <a>DescribeAttackStatistics</a> along with a time range indicating the time period that the attack statistics apply to. </p>
474
542
  */
475
543
  export interface AttackStatisticsDataItem {
@@ -483,6 +551,7 @@ export interface AttackStatisticsDataItem {
483
551
  AttackCount: number | undefined;
484
552
  }
485
553
  /**
554
+ * @public
486
555
  * <p>Describes the attack.</p>
487
556
  */
488
557
  export interface AttackVectorDescription {
@@ -548,6 +617,7 @@ export interface AttackVectorDescription {
548
617
  VectorType: string | undefined;
549
618
  }
550
619
  /**
620
+ * @public
551
621
  * <p>Summarizes all DDoS attacks for a specified time period.</p>
552
622
  */
553
623
  export interface AttackSummary {
@@ -572,11 +642,15 @@ export interface AttackSummary {
572
642
  */
573
643
  AttackVectors?: AttackVectorDescription[];
574
644
  }
645
+ /**
646
+ * @public
647
+ */
575
648
  export declare enum AutoRenew {
576
649
  DISABLED = "DISABLED",
577
650
  ENABLED = "ENABLED"
578
651
  }
579
652
  /**
653
+ * @public
580
654
  * <p>A tag associated with an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as "environment", and the tag value represents a specific value within that category, such as "test," "development," or "production". Or you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.</p>
581
655
  */
582
656
  export interface Tag {
@@ -589,6 +663,9 @@ export interface Tag {
589
663
  */
590
664
  Value?: string;
591
665
  }
666
+ /**
667
+ * @public
668
+ */
592
669
  export interface CreateProtectionRequest {
593
670
  /**
594
671
  * <p>Friendly name for the <code>Protection</code> you are creating.</p>
@@ -636,6 +713,9 @@ export interface CreateProtectionRequest {
636
713
  */
637
714
  Tags?: Tag[];
638
715
  }
716
+ /**
717
+ * @public
718
+ */
639
719
  export interface CreateProtectionResponse {
640
720
  /**
641
721
  * <p>The unique identifier (ID) for the <a>Protection</a> object that is created.</p>
@@ -643,6 +723,7 @@ export interface CreateProtectionResponse {
643
723
  ProtectionId?: string;
644
724
  }
645
725
  /**
726
+ * @public
646
727
  * <p>Exception indicating the specified resource already exists. If available, this exception includes details in additional properties. </p>
647
728
  */
648
729
  export declare class ResourceAlreadyExistsException extends __BaseException {
@@ -657,16 +738,25 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
657
738
  */
658
739
  constructor(opts: __ExceptionOptionType<ResourceAlreadyExistsException, __BaseException>);
659
740
  }
741
+ /**
742
+ * @public
743
+ */
660
744
  export declare enum ProtectionGroupAggregation {
661
745
  MAX = "MAX",
662
746
  MEAN = "MEAN",
663
747
  SUM = "SUM"
664
748
  }
749
+ /**
750
+ * @public
751
+ */
665
752
  export declare enum ProtectionGroupPattern {
666
753
  ALL = "ALL",
667
754
  ARBITRARY = "ARBITRARY",
668
755
  BY_RESOURCE_TYPE = "BY_RESOURCE_TYPE"
669
756
  }
757
+ /**
758
+ * @public
759
+ */
670
760
  export declare enum ProtectedResourceType {
671
761
  APPLICATION_LOAD_BALANCER = "APPLICATION_LOAD_BALANCER",
672
762
  CLASSIC_LOAD_BALANCER = "CLASSIC_LOAD_BALANCER",
@@ -675,6 +765,9 @@ export declare enum ProtectedResourceType {
675
765
  GLOBAL_ACCELERATOR = "GLOBAL_ACCELERATOR",
676
766
  ROUTE_53_HOSTED_ZONE = "ROUTE_53_HOSTED_ZONE"
677
767
  }
768
+ /**
769
+ * @public
770
+ */
678
771
  export interface CreateProtectionGroupRequest {
679
772
  /**
680
773
  * <p>The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it. </p>
@@ -713,12 +806,24 @@ export interface CreateProtectionGroupRequest {
713
806
  */
714
807
  Tags?: Tag[];
715
808
  }
809
+ /**
810
+ * @public
811
+ */
716
812
  export interface CreateProtectionGroupResponse {
717
813
  }
814
+ /**
815
+ * @public
816
+ */
718
817
  export interface CreateSubscriptionRequest {
719
818
  }
819
+ /**
820
+ * @public
821
+ */
720
822
  export interface CreateSubscriptionResponse {
721
823
  }
824
+ /**
825
+ * @public
826
+ */
722
827
  export interface DeleteProtectionRequest {
723
828
  /**
724
829
  * <p>The unique identifier (ID) for the <a>Protection</a> object to be
@@ -726,21 +831,37 @@ export interface DeleteProtectionRequest {
726
831
  */
727
832
  ProtectionId: string | undefined;
728
833
  }
834
+ /**
835
+ * @public
836
+ */
729
837
  export interface DeleteProtectionResponse {
730
838
  }
839
+ /**
840
+ * @public
841
+ */
731
842
  export interface DeleteProtectionGroupRequest {
732
843
  /**
733
844
  * <p>The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it. </p>
734
845
  */
735
846
  ProtectionGroupId: string | undefined;
736
847
  }
848
+ /**
849
+ * @public
850
+ */
737
851
  export interface DeleteProtectionGroupResponse {
738
852
  }
853
+ /**
854
+ * @public
855
+ */
739
856
  export interface DeleteSubscriptionRequest {
740
857
  }
858
+ /**
859
+ * @public
860
+ */
741
861
  export interface DeleteSubscriptionResponse {
742
862
  }
743
863
  /**
864
+ * @public
744
865
  * <p>You are trying to update a subscription that has not yet completed the 1-year commitment. You can change the <code>AutoRenew</code> parameter during the last 30 days of your subscription. This exception indicates that you are attempting to change <code>AutoRenew</code> prior to that period.</p>
745
866
  */
746
867
  export declare class LockedSubscriptionException extends __BaseException {
@@ -751,21 +872,31 @@ export declare class LockedSubscriptionException extends __BaseException {
751
872
  */
752
873
  constructor(opts: __ExceptionOptionType<LockedSubscriptionException, __BaseException>);
753
874
  }
875
+ /**
876
+ * @public
877
+ */
754
878
  export interface DescribeAttackRequest {
755
879
  /**
756
880
  * <p>The unique identifier (ID) for the attack.</p>
757
881
  */
758
882
  AttackId: string | undefined;
759
883
  }
884
+ /**
885
+ * @public
886
+ */
760
887
  export interface DescribeAttackResponse {
761
888
  /**
762
889
  * <p>The attack that you requested. </p>
763
890
  */
764
891
  Attack?: AttackDetail;
765
892
  }
893
+ /**
894
+ * @public
895
+ */
766
896
  export interface DescribeAttackStatisticsRequest {
767
897
  }
768
898
  /**
899
+ * @public
769
900
  * <p>The time range. </p>
770
901
  */
771
902
  export interface TimeRange {
@@ -778,6 +909,9 @@ export interface TimeRange {
778
909
  */
779
910
  ToExclusive?: Date;
780
911
  }
912
+ /**
913
+ * @public
914
+ */
781
915
  export interface DescribeAttackStatisticsResponse {
782
916
  /**
783
917
  * <p>The time range of the attack.</p>
@@ -788,8 +922,14 @@ export interface DescribeAttackStatisticsResponse {
788
922
  */
789
923
  DataItems: AttackStatisticsDataItem[] | undefined;
790
924
  }
925
+ /**
926
+ * @public
927
+ */
791
928
  export interface DescribeDRTAccessRequest {
792
929
  }
930
+ /**
931
+ * @public
932
+ */
793
933
  export interface DescribeDRTAccessResponse {
794
934
  /**
795
935
  * <p>The Amazon Resource Name (ARN) of the role the SRT used to access your Amazon Web Services account.</p>
@@ -800,14 +940,23 @@ export interface DescribeDRTAccessResponse {
800
940
  */
801
941
  LogBucketList?: string[];
802
942
  }
943
+ /**
944
+ * @public
945
+ */
803
946
  export interface DescribeEmergencyContactSettingsRequest {
804
947
  }
948
+ /**
949
+ * @public
950
+ */
805
951
  export interface DescribeEmergencyContactSettingsResponse {
806
952
  /**
807
953
  * <p>A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.</p>
808
954
  */
809
955
  EmergencyContactList?: EmergencyContact[];
810
956
  }
957
+ /**
958
+ * @public
959
+ */
811
960
  export interface DescribeProtectionRequest {
812
961
  /**
813
962
  * <p>The unique identifier (ID) for the <a>Protection</a> object to describe.
@@ -821,6 +970,7 @@ export interface DescribeProtectionRequest {
821
970
  ResourceArn?: string;
822
971
  }
823
972
  /**
973
+ * @public
824
974
  * <p>An object that represents a resource that is under DDoS protection.</p>
825
975
  */
826
976
  export interface Protection {
@@ -851,12 +1001,18 @@ export interface Protection {
851
1001
  */
852
1002
  ApplicationLayerAutomaticResponseConfiguration?: ApplicationLayerAutomaticResponseConfiguration;
853
1003
  }
1004
+ /**
1005
+ * @public
1006
+ */
854
1007
  export interface DescribeProtectionResponse {
855
1008
  /**
856
1009
  * <p>The <a>Protection</a> that you requested. </p>
857
1010
  */
858
1011
  Protection?: Protection;
859
1012
  }
1013
+ /**
1014
+ * @public
1015
+ */
860
1016
  export interface DescribeProtectionGroupRequest {
861
1017
  /**
862
1018
  * <p>The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it. </p>
@@ -864,6 +1020,7 @@ export interface DescribeProtectionGroupRequest {
864
1020
  ProtectionGroupId: string | undefined;
865
1021
  }
866
1022
  /**
1023
+ * @public
867
1024
  * <p>A grouping of protected resources that you and Shield Advanced can monitor as a collective. This resource grouping improves the accuracy of detection and reduces false positives. </p>
868
1025
  */
869
1026
  export interface ProtectionGroup {
@@ -904,15 +1061,22 @@ export interface ProtectionGroup {
904
1061
  */
905
1062
  ProtectionGroupArn?: string;
906
1063
  }
1064
+ /**
1065
+ * @public
1066
+ */
907
1067
  export interface DescribeProtectionGroupResponse {
908
1068
  /**
909
1069
  * <p>A grouping of protected resources that you and Shield Advanced can monitor as a collective. This resource grouping improves the accuracy of detection and reduces false positives. </p>
910
1070
  */
911
1071
  ProtectionGroup: ProtectionGroup | undefined;
912
1072
  }
1073
+ /**
1074
+ * @public
1075
+ */
913
1076
  export interface DescribeSubscriptionRequest {
914
1077
  }
915
1078
  /**
1079
+ * @public
916
1080
  * <p>Specifies how many protections of a given type you can create.</p>
917
1081
  */
918
1082
  export interface Limit {
@@ -925,12 +1089,16 @@ export interface Limit {
925
1089
  */
926
1090
  Max?: number;
927
1091
  }
1092
+ /**
1093
+ * @public
1094
+ */
928
1095
  export declare enum ProactiveEngagementStatus {
929
1096
  DISABLED = "DISABLED",
930
1097
  ENABLED = "ENABLED",
931
1098
  PENDING = "PENDING"
932
1099
  }
933
1100
  /**
1101
+ * @public
934
1102
  * <p>Limits settings on protection groups with arbitrary pattern type. </p>
935
1103
  */
936
1104
  export interface ProtectionGroupArbitraryPatternLimits {
@@ -940,6 +1108,7 @@ export interface ProtectionGroupArbitraryPatternLimits {
940
1108
  MaxMembers: number | undefined;
941
1109
  }
942
1110
  /**
1111
+ * @public
943
1112
  * <p>Limits settings by pattern type in the protection groups for your subscription. </p>
944
1113
  */
945
1114
  export interface ProtectionGroupPatternTypeLimits {
@@ -949,6 +1118,7 @@ export interface ProtectionGroupPatternTypeLimits {
949
1118
  ArbitraryPatternLimits: ProtectionGroupArbitraryPatternLimits | undefined;
950
1119
  }
951
1120
  /**
1121
+ * @public
952
1122
  * <p>Limits settings on protection groups for your subscription. </p>
953
1123
  */
954
1124
  export interface ProtectionGroupLimits {
@@ -962,6 +1132,7 @@ export interface ProtectionGroupLimits {
962
1132
  PatternTypeLimits: ProtectionGroupPatternTypeLimits | undefined;
963
1133
  }
964
1134
  /**
1135
+ * @public
965
1136
  * <p>Limits settings on protections for your subscription. </p>
966
1137
  */
967
1138
  export interface ProtectionLimits {
@@ -971,6 +1142,7 @@ export interface ProtectionLimits {
971
1142
  ProtectedResourceTypeLimits: Limit[] | undefined;
972
1143
  }
973
1144
  /**
1145
+ * @public
974
1146
  * <p>Limits settings for your subscription. </p>
975
1147
  */
976
1148
  export interface SubscriptionLimits {
@@ -984,6 +1156,7 @@ export interface SubscriptionLimits {
984
1156
  ProtectionGroupLimits: ProtectionGroupLimits | undefined;
985
1157
  }
986
1158
  /**
1159
+ * @public
987
1160
  * <p>Information about the Shield Advanced subscription for an account.</p>
988
1161
  */
989
1162
  export interface Subscription {
@@ -1023,36 +1196,66 @@ export interface Subscription {
1023
1196
  */
1024
1197
  SubscriptionArn?: string;
1025
1198
  }
1199
+ /**
1200
+ * @public
1201
+ */
1026
1202
  export interface DescribeSubscriptionResponse {
1027
1203
  /**
1028
1204
  * <p>The Shield Advanced subscription details for an account.</p>
1029
1205
  */
1030
1206
  Subscription?: Subscription;
1031
1207
  }
1208
+ /**
1209
+ * @public
1210
+ */
1032
1211
  export interface DisableApplicationLayerAutomaticResponseRequest {
1033
1212
  /**
1034
1213
  * <p>The ARN (Amazon Resource Name) of the protected resource.</p>
1035
1214
  */
1036
1215
  ResourceArn: string | undefined;
1037
1216
  }
1217
+ /**
1218
+ * @public
1219
+ */
1038
1220
  export interface DisableApplicationLayerAutomaticResponseResponse {
1039
1221
  }
1222
+ /**
1223
+ * @public
1224
+ */
1040
1225
  export interface DisableProactiveEngagementRequest {
1041
1226
  }
1227
+ /**
1228
+ * @public
1229
+ */
1042
1230
  export interface DisableProactiveEngagementResponse {
1043
1231
  }
1232
+ /**
1233
+ * @public
1234
+ */
1044
1235
  export interface DisassociateDRTLogBucketRequest {
1045
1236
  /**
1046
1237
  * <p>The Amazon S3 bucket that contains the logs that you want to share.</p>
1047
1238
  */
1048
1239
  LogBucket: string | undefined;
1049
1240
  }
1241
+ /**
1242
+ * @public
1243
+ */
1050
1244
  export interface DisassociateDRTLogBucketResponse {
1051
1245
  }
1246
+ /**
1247
+ * @public
1248
+ */
1052
1249
  export interface DisassociateDRTRoleRequest {
1053
1250
  }
1251
+ /**
1252
+ * @public
1253
+ */
1054
1254
  export interface DisassociateDRTRoleResponse {
1055
1255
  }
1256
+ /**
1257
+ * @public
1258
+ */
1056
1259
  export interface DisassociateHealthCheckRequest {
1057
1260
  /**
1058
1261
  * <p>The unique identifier (ID) for the <a>Protection</a> object to remove the health check association from. </p>
@@ -1063,8 +1266,14 @@ export interface DisassociateHealthCheckRequest {
1063
1266
  */
1064
1267
  HealthCheckArn: string | undefined;
1065
1268
  }
1269
+ /**
1270
+ * @public
1271
+ */
1066
1272
  export interface DisassociateHealthCheckResponse {
1067
1273
  }
1274
+ /**
1275
+ * @public
1276
+ */
1068
1277
  export interface EnableApplicationLayerAutomaticResponseRequest {
1069
1278
  /**
1070
1279
  * <p>The ARN (Amazon Resource Name) of the protected resource.</p>
@@ -1077,24 +1286,45 @@ export interface EnableApplicationLayerAutomaticResponseRequest {
1077
1286
  */
1078
1287
  Action: ResponseAction | undefined;
1079
1288
  }
1289
+ /**
1290
+ * @public
1291
+ */
1080
1292
  export interface EnableApplicationLayerAutomaticResponseResponse {
1081
1293
  }
1294
+ /**
1295
+ * @public
1296
+ */
1082
1297
  export interface EnableProactiveEngagementRequest {
1083
1298
  }
1299
+ /**
1300
+ * @public
1301
+ */
1084
1302
  export interface EnableProactiveEngagementResponse {
1085
1303
  }
1304
+ /**
1305
+ * @public
1306
+ */
1086
1307
  export interface GetSubscriptionStateRequest {
1087
1308
  }
1309
+ /**
1310
+ * @public
1311
+ */
1088
1312
  export declare enum SubscriptionState {
1089
1313
  ACTIVE = "ACTIVE",
1090
1314
  INACTIVE = "INACTIVE"
1091
1315
  }
1316
+ /**
1317
+ * @public
1318
+ */
1092
1319
  export interface GetSubscriptionStateResponse {
1093
1320
  /**
1094
1321
  * <p>The status of the subscription.</p>
1095
1322
  */
1096
1323
  SubscriptionState: SubscriptionState | string | undefined;
1097
1324
  }
1325
+ /**
1326
+ * @public
1327
+ */
1098
1328
  export interface ListAttacksRequest {
1099
1329
  /**
1100
1330
  * <p>The ARNs (Amazon Resource Names) of the resources that were attacked. If you leave this
@@ -1129,6 +1359,9 @@ export interface ListAttacksRequest {
1129
1359
  */
1130
1360
  MaxResults?: number;
1131
1361
  }
1362
+ /**
1363
+ * @public
1364
+ */
1132
1365
  export interface ListAttacksResponse {
1133
1366
  /**
1134
1367
  * <p>The attack information for the specified time range.</p>
@@ -1145,6 +1378,7 @@ export interface ListAttacksResponse {
1145
1378
  NextToken?: string;
1146
1379
  }
1147
1380
  /**
1381
+ * @public
1148
1382
  * <p>Exception that indicates that the <code>NextToken</code> specified in the request is invalid. Submit the request using the <code>NextToken</code> value that was returned in the prior response.</p>
1149
1383
  */
1150
1384
  export declare class InvalidPaginationTokenException extends __BaseException {
@@ -1156,6 +1390,7 @@ export declare class InvalidPaginationTokenException extends __BaseException {
1156
1390
  constructor(opts: __ExceptionOptionType<InvalidPaginationTokenException, __BaseException>);
1157
1391
  }
1158
1392
  /**
1393
+ * @public
1159
1394
  * <p>Narrows the set of protection groups that the call retrieves. You can retrieve a single protection group by its name and you can retrieve all protection groups that are configured with a specific pattern, aggregation, or resource type. You can provide up to one criteria per filter type. Shield Advanced returns the protection groups that exactly match all of the search criteria that you provide.</p>
1160
1395
  */
1161
1396
  export interface InclusionProtectionGroupFilters {
@@ -1176,6 +1411,9 @@ export interface InclusionProtectionGroupFilters {
1176
1411
  */
1177
1412
  Aggregations?: (ProtectionGroupAggregation | string)[];
1178
1413
  }
1414
+ /**
1415
+ * @public
1416
+ */
1179
1417
  export interface ListProtectionGroupsRequest {
1180
1418
  /**
1181
1419
  * <p>When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects,
@@ -1199,6 +1437,9 @@ export interface ListProtectionGroupsRequest {
1199
1437
  */
1200
1438
  InclusionFilters?: InclusionProtectionGroupFilters;
1201
1439
  }
1440
+ /**
1441
+ * @public
1442
+ */
1202
1443
  export interface ListProtectionGroupsResponse {
1203
1444
  /**
1204
1445
  * <p></p>
@@ -1215,6 +1456,7 @@ export interface ListProtectionGroupsResponse {
1215
1456
  NextToken?: string;
1216
1457
  }
1217
1458
  /**
1459
+ * @public
1218
1460
  * <p>Narrows the set of protections that the call retrieves. You can retrieve a single protection by providing its name or the ARN (Amazon Resource Name) of its protected resource. You can also retrieve all protections for a specific resource type. You can provide up to one criteria per filter type. Shield Advanced returns protections that exactly match all of the filter criteria that you provide.</p>
1219
1461
  */
1220
1462
  export interface InclusionProtectionFilters {
@@ -1231,6 +1473,9 @@ export interface InclusionProtectionFilters {
1231
1473
  */
1232
1474
  ResourceTypes?: (ProtectedResourceType | string)[];
1233
1475
  }
1476
+ /**
1477
+ * @public
1478
+ */
1234
1479
  export interface ListProtectionsRequest {
1235
1480
  /**
1236
1481
  * <p>When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects,
@@ -1254,6 +1499,9 @@ export interface ListProtectionsRequest {
1254
1499
  */
1255
1500
  InclusionFilters?: InclusionProtectionFilters;
1256
1501
  }
1502
+ /**
1503
+ * @public
1504
+ */
1257
1505
  export interface ListProtectionsResponse {
1258
1506
  /**
1259
1507
  * <p>The array of enabled <a>Protection</a> objects.</p>
@@ -1269,6 +1517,9 @@ export interface ListProtectionsResponse {
1269
1517
  */
1270
1518
  NextToken?: string;
1271
1519
  }
1520
+ /**
1521
+ * @public
1522
+ */
1272
1523
  export interface ListResourcesInProtectionGroupRequest {
1273
1524
  /**
1274
1525
  * <p>The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it. </p>
@@ -1292,6 +1543,9 @@ export interface ListResourcesInProtectionGroupRequest {
1292
1543
  */
1293
1544
  MaxResults?: number;
1294
1545
  }
1546
+ /**
1547
+ * @public
1548
+ */
1295
1549
  export interface ListResourcesInProtectionGroupResponse {
1296
1550
  /**
1297
1551
  * <p>The Amazon Resource Names (ARNs) of the resources that are included in the protection group.</p>
@@ -1307,18 +1561,27 @@ export interface ListResourcesInProtectionGroupResponse {
1307
1561
  */
1308
1562
  NextToken?: string;
1309
1563
  }
1564
+ /**
1565
+ * @public
1566
+ */
1310
1567
  export interface ListTagsForResourceRequest {
1311
1568
  /**
1312
1569
  * <p>The Amazon Resource Name (ARN) of the resource to get tags for.</p>
1313
1570
  */
1314
1571
  ResourceARN: string | undefined;
1315
1572
  }
1573
+ /**
1574
+ * @public
1575
+ */
1316
1576
  export interface ListTagsForResourceResponse {
1317
1577
  /**
1318
1578
  * <p>A list of tag key and value pairs associated with the specified resource.</p>
1319
1579
  */
1320
1580
  Tags?: Tag[];
1321
1581
  }
1582
+ /**
1583
+ * @public
1584
+ */
1322
1585
  export interface TagResourceRequest {
1323
1586
  /**
1324
1587
  * <p>The Amazon Resource Name (ARN) of the resource that you want to add or update tags for.</p>
@@ -1329,8 +1592,14 @@ export interface TagResourceRequest {
1329
1592
  */
1330
1593
  Tags: Tag[] | undefined;
1331
1594
  }
1595
+ /**
1596
+ * @public
1597
+ */
1332
1598
  export interface TagResourceResponse {
1333
1599
  }
1600
+ /**
1601
+ * @public
1602
+ */
1334
1603
  export interface UntagResourceRequest {
1335
1604
  /**
1336
1605
  * <p>The Amazon Resource Name (ARN) of the resource that you want to remove tags from.</p>
@@ -1341,8 +1610,14 @@ export interface UntagResourceRequest {
1341
1610
  */
1342
1611
  TagKeys: string[] | undefined;
1343
1612
  }
1613
+ /**
1614
+ * @public
1615
+ */
1344
1616
  export interface UntagResourceResponse {
1345
1617
  }
1618
+ /**
1619
+ * @public
1620
+ */
1346
1621
  export interface UpdateApplicationLayerAutomaticResponseRequest {
1347
1622
  /**
1348
1623
  * <p>The ARN (Amazon Resource Name) of the resource.</p>
@@ -1355,8 +1630,14 @@ export interface UpdateApplicationLayerAutomaticResponseRequest {
1355
1630
  */
1356
1631
  Action: ResponseAction | undefined;
1357
1632
  }
1633
+ /**
1634
+ * @public
1635
+ */
1358
1636
  export interface UpdateApplicationLayerAutomaticResponseResponse {
1359
1637
  }
1638
+ /**
1639
+ * @public
1640
+ */
1360
1641
  export interface UpdateEmergencyContactSettingsRequest {
1361
1642
  /**
1362
1643
  * <p>A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.</p>
@@ -1364,8 +1645,14 @@ export interface UpdateEmergencyContactSettingsRequest {
1364
1645
  */
1365
1646
  EmergencyContactList?: EmergencyContact[];
1366
1647
  }
1648
+ /**
1649
+ * @public
1650
+ */
1367
1651
  export interface UpdateEmergencyContactSettingsResponse {
1368
1652
  }
1653
+ /**
1654
+ * @public
1655
+ */
1369
1656
  export interface UpdateProtectionGroupRequest {
1370
1657
  /**
1371
1658
  * <p>The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it. </p>
@@ -1400,14 +1687,23 @@ export interface UpdateProtectionGroupRequest {
1400
1687
  */
1401
1688
  Members?: string[];
1402
1689
  }
1690
+ /**
1691
+ * @public
1692
+ */
1403
1693
  export interface UpdateProtectionGroupResponse {
1404
1694
  }
1695
+ /**
1696
+ * @public
1697
+ */
1405
1698
  export interface UpdateSubscriptionRequest {
1406
1699
  /**
1407
1700
  * <p>When you initally create a subscription, <code>AutoRenew</code> is set to <code>ENABLED</code>. If <code>ENABLED</code>, the subscription will be automatically renewed at the end of the existing subscription period. You can change this by submitting an <code>UpdateSubscription</code> request. If the <code>UpdateSubscription</code> request does not included a value for <code>AutoRenew</code>, the existing value for <code>AutoRenew</code> remains unchanged.</p>
1408
1701
  */
1409
1702
  AutoRenew?: AutoRenew | string;
1410
1703
  }
1704
+ /**
1705
+ * @public
1706
+ */
1411
1707
  export interface UpdateSubscriptionResponse {
1412
1708
  }
1413
1709
  /**