@aws-sdk/client-shield 3.379.1 → 3.385.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.
- package/dist-types/models/models_0.d.ts +169 -0
- package/package.json +5 -5
|
@@ -50,11 +50,13 @@ export interface CountAction {
|
|
|
50
50
|
*/
|
|
51
51
|
export interface ResponseAction {
|
|
52
52
|
/**
|
|
53
|
+
* @public
|
|
53
54
|
* <p>Specifies that Shield Advanced should configure its WAF rules with the WAF <code>Block</code> action. </p>
|
|
54
55
|
* <p>You must specify exactly one action, either <code>Block</code> or <code>Count</code>.</p>
|
|
55
56
|
*/
|
|
56
57
|
Block?: BlockAction;
|
|
57
58
|
/**
|
|
59
|
+
* @public
|
|
58
60
|
* <p>Specifies that Shield Advanced should configure its WAF rules with the WAF <code>Count</code> action. </p>
|
|
59
61
|
* <p>You must specify exactly one action, either <code>Block</code> or <code>Count</code>.</p>
|
|
60
62
|
*/
|
|
@@ -80,10 +82,12 @@ export type ApplicationLayerAutomaticResponseStatus = (typeof ApplicationLayerAu
|
|
|
80
82
|
*/
|
|
81
83
|
export interface ApplicationLayerAutomaticResponseConfiguration {
|
|
82
84
|
/**
|
|
85
|
+
* @public
|
|
83
86
|
* <p>Indicates whether automatic application layer DDoS mitigation is enabled for the protection. </p>
|
|
84
87
|
*/
|
|
85
88
|
Status: ApplicationLayerAutomaticResponseStatus | string | undefined;
|
|
86
89
|
/**
|
|
90
|
+
* @public
|
|
87
91
|
* <p>Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the
|
|
88
92
|
* protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature,
|
|
89
93
|
* 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>
|
|
@@ -95,6 +99,7 @@ export interface ApplicationLayerAutomaticResponseConfiguration {
|
|
|
95
99
|
*/
|
|
96
100
|
export interface AssociateDRTLogBucketRequest {
|
|
97
101
|
/**
|
|
102
|
+
* @public
|
|
98
103
|
* <p>The Amazon S3 bucket that contains the logs that you want to share.</p>
|
|
99
104
|
*/
|
|
100
105
|
LogBucket: string | undefined;
|
|
@@ -134,10 +139,12 @@ export declare class InvalidOperationException extends __BaseException {
|
|
|
134
139
|
*/
|
|
135
140
|
export interface ValidationExceptionField {
|
|
136
141
|
/**
|
|
142
|
+
* @public
|
|
137
143
|
* <p>The name of the parameter that failed validation.</p>
|
|
138
144
|
*/
|
|
139
145
|
name: string | undefined;
|
|
140
146
|
/**
|
|
147
|
+
* @public
|
|
141
148
|
* <p>The message describing why the parameter failed validation.</p>
|
|
142
149
|
*/
|
|
143
150
|
message: string | undefined;
|
|
@@ -162,10 +169,12 @@ export declare class InvalidParameterException extends __BaseException {
|
|
|
162
169
|
readonly name: "InvalidParameterException";
|
|
163
170
|
readonly $fault: "client";
|
|
164
171
|
/**
|
|
172
|
+
* @public
|
|
165
173
|
* <p>Additional information about the exception.</p>
|
|
166
174
|
*/
|
|
167
175
|
reason?: ValidationExceptionReason | string;
|
|
168
176
|
/**
|
|
177
|
+
* @public
|
|
169
178
|
* <p>Fields that caused the exception.</p>
|
|
170
179
|
*/
|
|
171
180
|
fields?: ValidationExceptionField[];
|
|
@@ -182,10 +191,12 @@ export declare class LimitsExceededException extends __BaseException {
|
|
|
182
191
|
readonly name: "LimitsExceededException";
|
|
183
192
|
readonly $fault: "client";
|
|
184
193
|
/**
|
|
194
|
+
* @public
|
|
185
195
|
* <p>The type of limit that would be exceeded.</p>
|
|
186
196
|
*/
|
|
187
197
|
Type?: string;
|
|
188
198
|
/**
|
|
199
|
+
* @public
|
|
189
200
|
* <p>The threshold that would be exceeded.</p>
|
|
190
201
|
*/
|
|
191
202
|
Limit?: number;
|
|
@@ -227,6 +238,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
227
238
|
readonly name: "ResourceNotFoundException";
|
|
228
239
|
readonly $fault: "client";
|
|
229
240
|
/**
|
|
241
|
+
* @public
|
|
230
242
|
* <p>Type of resource.</p>
|
|
231
243
|
*/
|
|
232
244
|
resourceType?: string;
|
|
@@ -240,6 +252,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
240
252
|
*/
|
|
241
253
|
export interface AssociateDRTRoleRequest {
|
|
242
254
|
/**
|
|
255
|
+
* @public
|
|
243
256
|
* <p>The Amazon Resource Name (ARN) of the role the SRT will use to access your Amazon Web Services account.</p>
|
|
244
257
|
* <p>Prior to making the <code>AssociateDRTRole</code> request, you must attach the <a href="https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSShieldDRTAccessPolicy">AWSShieldDRTAccessPolicy</a> managed policy to this role. For more information see <a href=" https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage-attach-detach.html">Attaching and Detaching IAM Policies</a>.</p>
|
|
245
258
|
*/
|
|
@@ -255,10 +268,12 @@ export interface AssociateDRTRoleResponse {
|
|
|
255
268
|
*/
|
|
256
269
|
export interface AssociateHealthCheckRequest {
|
|
257
270
|
/**
|
|
271
|
+
* @public
|
|
258
272
|
* <p>The unique identifier (ID) for the <a>Protection</a> object to add the health check association to. </p>
|
|
259
273
|
*/
|
|
260
274
|
ProtectionId: string | undefined;
|
|
261
275
|
/**
|
|
276
|
+
* @public
|
|
262
277
|
* <p>The Amazon Resource Name (ARN) of the health check to associate with the protection.</p>
|
|
263
278
|
*/
|
|
264
279
|
HealthCheckArn: string | undefined;
|
|
@@ -286,14 +301,17 @@ export declare class InvalidResourceException extends __BaseException {
|
|
|
286
301
|
*/
|
|
287
302
|
export interface EmergencyContact {
|
|
288
303
|
/**
|
|
304
|
+
* @public
|
|
289
305
|
* <p>The email address for the contact.</p>
|
|
290
306
|
*/
|
|
291
307
|
EmailAddress: string | undefined;
|
|
292
308
|
/**
|
|
309
|
+
* @public
|
|
293
310
|
* <p>The phone number for the contact.</p>
|
|
294
311
|
*/
|
|
295
312
|
PhoneNumber?: string;
|
|
296
313
|
/**
|
|
314
|
+
* @public
|
|
297
315
|
* <p>Additional notes regarding the contact. </p>
|
|
298
316
|
*/
|
|
299
317
|
ContactNotes?: string;
|
|
@@ -303,6 +321,7 @@ export interface EmergencyContact {
|
|
|
303
321
|
*/
|
|
304
322
|
export interface AssociateProactiveEngagementDetailsRequest {
|
|
305
323
|
/**
|
|
324
|
+
* @public
|
|
306
325
|
* <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>
|
|
307
326
|
* <p>To enable proactive engagement, the contact list must include at least one phone number.</p>
|
|
308
327
|
* <note>
|
|
@@ -322,26 +341,32 @@ export interface AssociateProactiveEngagementDetailsResponse {
|
|
|
322
341
|
*/
|
|
323
342
|
export interface SummarizedCounter {
|
|
324
343
|
/**
|
|
344
|
+
* @public
|
|
325
345
|
* <p>The counter name.</p>
|
|
326
346
|
*/
|
|
327
347
|
Name?: string;
|
|
328
348
|
/**
|
|
349
|
+
* @public
|
|
329
350
|
* <p>The maximum value of the counter for a specified time period.</p>
|
|
330
351
|
*/
|
|
331
352
|
Max?: number;
|
|
332
353
|
/**
|
|
354
|
+
* @public
|
|
333
355
|
* <p>The average value of the counter for a specified time period.</p>
|
|
334
356
|
*/
|
|
335
357
|
Average?: number;
|
|
336
358
|
/**
|
|
359
|
+
* @public
|
|
337
360
|
* <p>The total of counter values for a specified time period.</p>
|
|
338
361
|
*/
|
|
339
362
|
Sum?: number;
|
|
340
363
|
/**
|
|
364
|
+
* @public
|
|
341
365
|
* <p>The number of counters for a specified time period.</p>
|
|
342
366
|
*/
|
|
343
367
|
N?: number;
|
|
344
368
|
/**
|
|
369
|
+
* @public
|
|
345
370
|
* <p>The unit of the counters.</p>
|
|
346
371
|
*/
|
|
347
372
|
Unit?: string;
|
|
@@ -382,10 +407,12 @@ export type AttackPropertyIdentifier = (typeof AttackPropertyIdentifier)[keyof t
|
|
|
382
407
|
*/
|
|
383
408
|
export interface Contributor {
|
|
384
409
|
/**
|
|
410
|
+
* @public
|
|
385
411
|
* <p>The name of the contributor. The type of name that you'll find here depends on the <code>AttackPropertyIdentifier</code> setting in the <code>AttackProperty</code> where this contributor is defined. For example, if the <code>AttackPropertyIdentifier</code> is <code>SOURCE_COUNTRY</code>, the <code>Name</code> could be <code>United States</code>.</p>
|
|
386
412
|
*/
|
|
387
413
|
Name?: string;
|
|
388
414
|
/**
|
|
415
|
+
* @public
|
|
389
416
|
* <p>The contribution of this contributor expressed in <a>Protection</a> units. For example <code>10,000</code>.</p>
|
|
390
417
|
*/
|
|
391
418
|
Value?: number;
|
|
@@ -410,6 +437,7 @@ export type Unit = (typeof Unit)[keyof typeof Unit];
|
|
|
410
437
|
*/
|
|
411
438
|
export interface AttackProperty {
|
|
412
439
|
/**
|
|
440
|
+
* @public
|
|
413
441
|
* <p>The type of Shield event that was observed. <code>NETWORK</code> indicates layer 3 and layer 4 events and <code>APPLICATION</code>
|
|
414
442
|
* indicates layer 7 events.</p>
|
|
415
443
|
* <p>For infrastructure
|
|
@@ -419,21 +447,25 @@ export interface AttackProperty {
|
|
|
419
447
|
*/
|
|
420
448
|
AttackLayer?: AttackLayer | string;
|
|
421
449
|
/**
|
|
450
|
+
* @public
|
|
422
451
|
* <p>Defines the Shield event property information that is provided. The
|
|
423
452
|
* <code>WORDPRESS_PINGBACK_REFLECTOR</code> and <code>WORDPRESS_PINGBACK_SOURCE</code>
|
|
424
453
|
* values are valid only for WordPress reflective pingback events.</p>
|
|
425
454
|
*/
|
|
426
455
|
AttackPropertyIdentifier?: AttackPropertyIdentifier | string;
|
|
427
456
|
/**
|
|
457
|
+
* @public
|
|
428
458
|
* <p>Contributor objects for the top five contributors to a Shield event. A contributor is a source of traffic that Shield Advanced identifies as responsible for some or all of an event.</p>
|
|
429
459
|
*/
|
|
430
460
|
TopContributors?: Contributor[];
|
|
431
461
|
/**
|
|
462
|
+
* @public
|
|
432
463
|
* <p>The unit used for the <code>Contributor</code>
|
|
433
464
|
* <code>Value</code> property. </p>
|
|
434
465
|
*/
|
|
435
466
|
Unit?: Unit | string;
|
|
436
467
|
/**
|
|
468
|
+
* @public
|
|
437
469
|
* <p>The total contributions made to this Shield event by all contributors.</p>
|
|
438
470
|
*/
|
|
439
471
|
Total?: number;
|
|
@@ -444,6 +476,7 @@ export interface AttackProperty {
|
|
|
444
476
|
*/
|
|
445
477
|
export interface Mitigation {
|
|
446
478
|
/**
|
|
479
|
+
* @public
|
|
447
480
|
* <p>The name of the mitigation taken for this attack.</p>
|
|
448
481
|
*/
|
|
449
482
|
MitigationName?: string;
|
|
@@ -454,10 +487,12 @@ export interface Mitigation {
|
|
|
454
487
|
*/
|
|
455
488
|
export interface SummarizedAttackVector {
|
|
456
489
|
/**
|
|
490
|
+
* @public
|
|
457
491
|
* <p>The attack type, for example, SNMP reflection or SYN flood.</p>
|
|
458
492
|
*/
|
|
459
493
|
VectorType: string | undefined;
|
|
460
494
|
/**
|
|
495
|
+
* @public
|
|
461
496
|
* <p>The list of counters that describe the details of the attack.</p>
|
|
462
497
|
*/
|
|
463
498
|
VectorCounters?: SummarizedCounter[];
|
|
@@ -480,18 +515,22 @@ export type SubResourceType = (typeof SubResourceType)[keyof typeof SubResourceT
|
|
|
480
515
|
*/
|
|
481
516
|
export interface SubResourceSummary {
|
|
482
517
|
/**
|
|
518
|
+
* @public
|
|
483
519
|
* <p>The <code>SubResource</code> type.</p>
|
|
484
520
|
*/
|
|
485
521
|
Type?: SubResourceType | string;
|
|
486
522
|
/**
|
|
523
|
+
* @public
|
|
487
524
|
* <p>The unique identifier (ID) of the <code>SubResource</code>.</p>
|
|
488
525
|
*/
|
|
489
526
|
Id?: string;
|
|
490
527
|
/**
|
|
528
|
+
* @public
|
|
491
529
|
* <p>The list of attack types and associated counters.</p>
|
|
492
530
|
*/
|
|
493
531
|
AttackVectors?: SummarizedAttackVector[];
|
|
494
532
|
/**
|
|
533
|
+
* @public
|
|
495
534
|
* <p>The counters that describe the details of the attack.</p>
|
|
496
535
|
*/
|
|
497
536
|
Counters?: SummarizedCounter[];
|
|
@@ -502,30 +541,37 @@ export interface SubResourceSummary {
|
|
|
502
541
|
*/
|
|
503
542
|
export interface AttackDetail {
|
|
504
543
|
/**
|
|
544
|
+
* @public
|
|
505
545
|
* <p>The unique identifier (ID) of the attack.</p>
|
|
506
546
|
*/
|
|
507
547
|
AttackId?: string;
|
|
508
548
|
/**
|
|
549
|
+
* @public
|
|
509
550
|
* <p>The ARN (Amazon Resource Name) of the resource that was attacked.</p>
|
|
510
551
|
*/
|
|
511
552
|
ResourceArn?: string;
|
|
512
553
|
/**
|
|
554
|
+
* @public
|
|
513
555
|
* <p>If applicable, additional detail about the resource being attacked, for example, IP address or URL.</p>
|
|
514
556
|
*/
|
|
515
557
|
SubResources?: SubResourceSummary[];
|
|
516
558
|
/**
|
|
559
|
+
* @public
|
|
517
560
|
* <p>The time the attack started, in Unix time in seconds. </p>
|
|
518
561
|
*/
|
|
519
562
|
StartTime?: Date;
|
|
520
563
|
/**
|
|
564
|
+
* @public
|
|
521
565
|
* <p>The time the attack ended, in Unix time in seconds. </p>
|
|
522
566
|
*/
|
|
523
567
|
EndTime?: Date;
|
|
524
568
|
/**
|
|
569
|
+
* @public
|
|
525
570
|
* <p>List of counters that describe the attack for the specified time period.</p>
|
|
526
571
|
*/
|
|
527
572
|
AttackCounters?: SummarizedCounter[];
|
|
528
573
|
/**
|
|
574
|
+
* @public
|
|
529
575
|
* <p>The array of objects that provide details of the Shield event. </p>
|
|
530
576
|
* <p>For infrastructure
|
|
531
577
|
* layer events (L3 and L4 events), you can view metrics for top contributors in Amazon CloudWatch metrics.
|
|
@@ -534,6 +580,7 @@ export interface AttackDetail {
|
|
|
534
580
|
*/
|
|
535
581
|
AttackProperties?: AttackProperty[];
|
|
536
582
|
/**
|
|
583
|
+
* @public
|
|
537
584
|
* <p>List of mitigation actions taken for the attack.</p>
|
|
538
585
|
*/
|
|
539
586
|
Mitigations?: Mitigation[];
|
|
@@ -544,6 +591,7 @@ export interface AttackDetail {
|
|
|
544
591
|
*/
|
|
545
592
|
export interface AttackVolumeStatistics {
|
|
546
593
|
/**
|
|
594
|
+
* @public
|
|
547
595
|
* <p>The maximum attack volume observed for the given unit.</p>
|
|
548
596
|
*/
|
|
549
597
|
Max: number | undefined;
|
|
@@ -554,14 +602,17 @@ export interface AttackVolumeStatistics {
|
|
|
554
602
|
*/
|
|
555
603
|
export interface AttackVolume {
|
|
556
604
|
/**
|
|
605
|
+
* @public
|
|
557
606
|
* <p>A statistics object that uses bits per second as the unit. This is included for network level attacks. </p>
|
|
558
607
|
*/
|
|
559
608
|
BitsPerSecond?: AttackVolumeStatistics;
|
|
560
609
|
/**
|
|
610
|
+
* @public
|
|
561
611
|
* <p>A statistics object that uses packets per second as the unit. This is included for network level attacks. </p>
|
|
562
612
|
*/
|
|
563
613
|
PacketsPerSecond?: AttackVolumeStatistics;
|
|
564
614
|
/**
|
|
615
|
+
* @public
|
|
565
616
|
* <p>A statistics object that uses requests per second as the unit. This is included for application level attacks, and is only available for accounts that are subscribed to Shield Advanced.</p>
|
|
566
617
|
*/
|
|
567
618
|
RequestsPerSecond?: AttackVolumeStatistics;
|
|
@@ -572,10 +623,12 @@ export interface AttackVolume {
|
|
|
572
623
|
*/
|
|
573
624
|
export interface AttackStatisticsDataItem {
|
|
574
625
|
/**
|
|
626
|
+
* @public
|
|
575
627
|
* <p>Information about the volume of attacks during the time period. If the accompanying <code>AttackCount</code> is zero, this setting might be empty.</p>
|
|
576
628
|
*/
|
|
577
629
|
AttackVolume?: AttackVolume;
|
|
578
630
|
/**
|
|
631
|
+
* @public
|
|
579
632
|
* <p>The number of attacks detected during the time period. This is always present, but might be zero. </p>
|
|
580
633
|
*/
|
|
581
634
|
AttackCount: number | undefined;
|
|
@@ -586,6 +639,7 @@ export interface AttackStatisticsDataItem {
|
|
|
586
639
|
*/
|
|
587
640
|
export interface AttackVectorDescription {
|
|
588
641
|
/**
|
|
642
|
+
* @public
|
|
589
643
|
* <p>The attack type. Valid values:</p>
|
|
590
644
|
* <ul>
|
|
591
645
|
* <li>
|
|
@@ -652,22 +706,27 @@ export interface AttackVectorDescription {
|
|
|
652
706
|
*/
|
|
653
707
|
export interface AttackSummary {
|
|
654
708
|
/**
|
|
709
|
+
* @public
|
|
655
710
|
* <p>The unique identifier (ID) of the attack.</p>
|
|
656
711
|
*/
|
|
657
712
|
AttackId?: string;
|
|
658
713
|
/**
|
|
714
|
+
* @public
|
|
659
715
|
* <p>The ARN (Amazon Resource Name) of the resource that was attacked.</p>
|
|
660
716
|
*/
|
|
661
717
|
ResourceArn?: string;
|
|
662
718
|
/**
|
|
719
|
+
* @public
|
|
663
720
|
* <p>The start time of the attack, in Unix time in seconds. </p>
|
|
664
721
|
*/
|
|
665
722
|
StartTime?: Date;
|
|
666
723
|
/**
|
|
724
|
+
* @public
|
|
667
725
|
* <p>The end time of the attack, in Unix time in seconds. </p>
|
|
668
726
|
*/
|
|
669
727
|
EndTime?: Date;
|
|
670
728
|
/**
|
|
729
|
+
* @public
|
|
671
730
|
* <p>The list of attacks for a specified time period.</p>
|
|
672
731
|
*/
|
|
673
732
|
AttackVectors?: AttackVectorDescription[];
|
|
@@ -690,10 +749,12 @@ export type AutoRenew = (typeof AutoRenew)[keyof typeof AutoRenew];
|
|
|
690
749
|
*/
|
|
691
750
|
export interface Tag {
|
|
692
751
|
/**
|
|
752
|
+
* @public
|
|
693
753
|
* <p>Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.</p>
|
|
694
754
|
*/
|
|
695
755
|
Key?: string;
|
|
696
756
|
/**
|
|
757
|
+
* @public
|
|
697
758
|
* <p>Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.</p>
|
|
698
759
|
*/
|
|
699
760
|
Value?: string;
|
|
@@ -703,10 +764,12 @@ export interface Tag {
|
|
|
703
764
|
*/
|
|
704
765
|
export interface CreateProtectionRequest {
|
|
705
766
|
/**
|
|
767
|
+
* @public
|
|
706
768
|
* <p>Friendly name for the <code>Protection</code> you are creating.</p>
|
|
707
769
|
*/
|
|
708
770
|
Name: string | undefined;
|
|
709
771
|
/**
|
|
772
|
+
* @public
|
|
710
773
|
* <p>The ARN (Amazon Resource Name) of the resource to be protected.</p>
|
|
711
774
|
* <p>The ARN should be in one of the following formats:</p>
|
|
712
775
|
* <ul>
|
|
@@ -744,6 +807,7 @@ export interface CreateProtectionRequest {
|
|
|
744
807
|
*/
|
|
745
808
|
ResourceArn: string | undefined;
|
|
746
809
|
/**
|
|
810
|
+
* @public
|
|
747
811
|
* <p>One or more tag key-value pairs for the <a>Protection</a> object that is created.</p>
|
|
748
812
|
*/
|
|
749
813
|
Tags?: Tag[];
|
|
@@ -753,6 +817,7 @@ export interface CreateProtectionRequest {
|
|
|
753
817
|
*/
|
|
754
818
|
export interface CreateProtectionResponse {
|
|
755
819
|
/**
|
|
820
|
+
* @public
|
|
756
821
|
* <p>The unique identifier (ID) for the <a>Protection</a> object that is created.</p>
|
|
757
822
|
*/
|
|
758
823
|
ProtectionId?: string;
|
|
@@ -765,6 +830,7 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
|
|
|
765
830
|
readonly name: "ResourceAlreadyExistsException";
|
|
766
831
|
readonly $fault: "client";
|
|
767
832
|
/**
|
|
833
|
+
* @public
|
|
768
834
|
* <p>The type of resource that already exists.</p>
|
|
769
835
|
*/
|
|
770
836
|
resourceType?: string;
|
|
@@ -820,10 +886,12 @@ export type ProtectedResourceType = (typeof ProtectedResourceType)[keyof typeof
|
|
|
820
886
|
*/
|
|
821
887
|
export interface CreateProtectionGroupRequest {
|
|
822
888
|
/**
|
|
889
|
+
* @public
|
|
823
890
|
* <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>
|
|
824
891
|
*/
|
|
825
892
|
ProtectionGroupId: string | undefined;
|
|
826
893
|
/**
|
|
894
|
+
* @public
|
|
827
895
|
* <p>Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.</p>
|
|
828
896
|
* <ul>
|
|
829
897
|
* <li>
|
|
@@ -839,19 +907,23 @@ export interface CreateProtectionGroupRequest {
|
|
|
839
907
|
*/
|
|
840
908
|
Aggregation: ProtectionGroupAggregation | string | undefined;
|
|
841
909
|
/**
|
|
910
|
+
* @public
|
|
842
911
|
* <p>The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type. </p>
|
|
843
912
|
*/
|
|
844
913
|
Pattern: ProtectionGroupPattern | string | undefined;
|
|
845
914
|
/**
|
|
915
|
+
* @public
|
|
846
916
|
* <p>The resource type to include in the protection group. All protected resources of this type are included in the protection group. Newly protected resources of this type are automatically added to the group.
|
|
847
917
|
* You must set this when you set <code>Pattern</code> to <code>BY_RESOURCE_TYPE</code> and you must not set it for any other <code>Pattern</code> setting. </p>
|
|
848
918
|
*/
|
|
849
919
|
ResourceType?: ProtectedResourceType | string;
|
|
850
920
|
/**
|
|
921
|
+
* @public
|
|
851
922
|
* <p>The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set <code>Pattern</code> to <code>ARBITRARY</code> and you must not set it for any other <code>Pattern</code> setting. </p>
|
|
852
923
|
*/
|
|
853
924
|
Members?: string[];
|
|
854
925
|
/**
|
|
926
|
+
* @public
|
|
855
927
|
* <p>One or more tag key-value pairs for the protection group.</p>
|
|
856
928
|
*/
|
|
857
929
|
Tags?: Tag[];
|
|
@@ -876,6 +948,7 @@ export interface CreateSubscriptionResponse {
|
|
|
876
948
|
*/
|
|
877
949
|
export interface DeleteProtectionRequest {
|
|
878
950
|
/**
|
|
951
|
+
* @public
|
|
879
952
|
* <p>The unique identifier (ID) for the <a>Protection</a> object to be
|
|
880
953
|
* deleted.</p>
|
|
881
954
|
*/
|
|
@@ -891,6 +964,7 @@ export interface DeleteProtectionResponse {
|
|
|
891
964
|
*/
|
|
892
965
|
export interface DeleteProtectionGroupRequest {
|
|
893
966
|
/**
|
|
967
|
+
* @public
|
|
894
968
|
* <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>
|
|
895
969
|
*/
|
|
896
970
|
ProtectionGroupId: string | undefined;
|
|
@@ -927,6 +1001,7 @@ export declare class LockedSubscriptionException extends __BaseException {
|
|
|
927
1001
|
*/
|
|
928
1002
|
export interface DescribeAttackRequest {
|
|
929
1003
|
/**
|
|
1004
|
+
* @public
|
|
930
1005
|
* <p>The unique identifier (ID) for the attack.</p>
|
|
931
1006
|
*/
|
|
932
1007
|
AttackId: string | undefined;
|
|
@@ -936,6 +1011,7 @@ export interface DescribeAttackRequest {
|
|
|
936
1011
|
*/
|
|
937
1012
|
export interface DescribeAttackResponse {
|
|
938
1013
|
/**
|
|
1014
|
+
* @public
|
|
939
1015
|
* <p>The attack that you requested. </p>
|
|
940
1016
|
*/
|
|
941
1017
|
Attack?: AttackDetail;
|
|
@@ -951,10 +1027,12 @@ export interface DescribeAttackStatisticsRequest {
|
|
|
951
1027
|
*/
|
|
952
1028
|
export interface TimeRange {
|
|
953
1029
|
/**
|
|
1030
|
+
* @public
|
|
954
1031
|
* <p>The start time, in Unix time in seconds. </p>
|
|
955
1032
|
*/
|
|
956
1033
|
FromInclusive?: Date;
|
|
957
1034
|
/**
|
|
1035
|
+
* @public
|
|
958
1036
|
* <p>The end time, in Unix time in seconds. </p>
|
|
959
1037
|
*/
|
|
960
1038
|
ToExclusive?: Date;
|
|
@@ -964,10 +1042,12 @@ export interface TimeRange {
|
|
|
964
1042
|
*/
|
|
965
1043
|
export interface DescribeAttackStatisticsResponse {
|
|
966
1044
|
/**
|
|
1045
|
+
* @public
|
|
967
1046
|
* <p>The time range of the attack.</p>
|
|
968
1047
|
*/
|
|
969
1048
|
TimeRange: TimeRange | undefined;
|
|
970
1049
|
/**
|
|
1050
|
+
* @public
|
|
971
1051
|
* <p>The data that describes the attacks detected during the time period.</p>
|
|
972
1052
|
*/
|
|
973
1053
|
DataItems: AttackStatisticsDataItem[] | undefined;
|
|
@@ -982,10 +1062,12 @@ export interface DescribeDRTAccessRequest {
|
|
|
982
1062
|
*/
|
|
983
1063
|
export interface DescribeDRTAccessResponse {
|
|
984
1064
|
/**
|
|
1065
|
+
* @public
|
|
985
1066
|
* <p>The Amazon Resource Name (ARN) of the role the SRT used to access your Amazon Web Services account.</p>
|
|
986
1067
|
*/
|
|
987
1068
|
RoleArn?: string;
|
|
988
1069
|
/**
|
|
1070
|
+
* @public
|
|
989
1071
|
* <p>The list of Amazon S3 buckets accessed by the SRT.</p>
|
|
990
1072
|
*/
|
|
991
1073
|
LogBucketList?: string[];
|
|
@@ -1000,6 +1082,7 @@ export interface DescribeEmergencyContactSettingsRequest {
|
|
|
1000
1082
|
*/
|
|
1001
1083
|
export interface DescribeEmergencyContactSettingsResponse {
|
|
1002
1084
|
/**
|
|
1085
|
+
* @public
|
|
1003
1086
|
* <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>
|
|
1004
1087
|
*/
|
|
1005
1088
|
EmergencyContactList?: EmergencyContact[];
|
|
@@ -1009,11 +1092,13 @@ export interface DescribeEmergencyContactSettingsResponse {
|
|
|
1009
1092
|
*/
|
|
1010
1093
|
export interface DescribeProtectionRequest {
|
|
1011
1094
|
/**
|
|
1095
|
+
* @public
|
|
1012
1096
|
* <p>The unique identifier (ID) for the <a>Protection</a> object to describe.
|
|
1013
1097
|
* You must provide either the <code>ResourceArn</code> of the protected resource or the <code>ProtectionID</code> of the protection, but not both.</p>
|
|
1014
1098
|
*/
|
|
1015
1099
|
ProtectionId?: string;
|
|
1016
1100
|
/**
|
|
1101
|
+
* @public
|
|
1017
1102
|
* <p>The ARN (Amazon Resource Name) of the protected Amazon Web Services resource.
|
|
1018
1103
|
* You must provide either the <code>ResourceArn</code> of the protected resource or the <code>ProtectionID</code> of the protection, but not both.</p>
|
|
1019
1104
|
*/
|
|
@@ -1025,26 +1110,32 @@ export interface DescribeProtectionRequest {
|
|
|
1025
1110
|
*/
|
|
1026
1111
|
export interface Protection {
|
|
1027
1112
|
/**
|
|
1113
|
+
* @public
|
|
1028
1114
|
* <p>The unique identifier (ID) of the protection.</p>
|
|
1029
1115
|
*/
|
|
1030
1116
|
Id?: string;
|
|
1031
1117
|
/**
|
|
1118
|
+
* @public
|
|
1032
1119
|
* <p>The name of the protection. For example, <code>My CloudFront distributions</code>.</p>
|
|
1033
1120
|
*/
|
|
1034
1121
|
Name?: string;
|
|
1035
1122
|
/**
|
|
1123
|
+
* @public
|
|
1036
1124
|
* <p>The ARN (Amazon Resource Name) of the Amazon Web Services resource that is protected.</p>
|
|
1037
1125
|
*/
|
|
1038
1126
|
ResourceArn?: string;
|
|
1039
1127
|
/**
|
|
1128
|
+
* @public
|
|
1040
1129
|
* <p>The unique identifier (ID) for the Route 53 health check that's associated with the protection. </p>
|
|
1041
1130
|
*/
|
|
1042
1131
|
HealthCheckIds?: string[];
|
|
1043
1132
|
/**
|
|
1133
|
+
* @public
|
|
1044
1134
|
* <p>The ARN (Amazon Resource Name) of the protection.</p>
|
|
1045
1135
|
*/
|
|
1046
1136
|
ProtectionArn?: string;
|
|
1047
1137
|
/**
|
|
1138
|
+
* @public
|
|
1048
1139
|
* <p>The automatic application layer DDoS mitigation settings for the protection.
|
|
1049
1140
|
* This configuration determines whether Shield Advanced automatically
|
|
1050
1141
|
* manages rules in the web ACL in order to respond to application layer events that Shield Advanced determines to be DDoS attacks. </p>
|
|
@@ -1056,6 +1147,7 @@ export interface Protection {
|
|
|
1056
1147
|
*/
|
|
1057
1148
|
export interface DescribeProtectionResponse {
|
|
1058
1149
|
/**
|
|
1150
|
+
* @public
|
|
1059
1151
|
* <p>The <a>Protection</a> that you requested. </p>
|
|
1060
1152
|
*/
|
|
1061
1153
|
Protection?: Protection;
|
|
@@ -1065,6 +1157,7 @@ export interface DescribeProtectionResponse {
|
|
|
1065
1157
|
*/
|
|
1066
1158
|
export interface DescribeProtectionGroupRequest {
|
|
1067
1159
|
/**
|
|
1160
|
+
* @public
|
|
1068
1161
|
* <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>
|
|
1069
1162
|
*/
|
|
1070
1163
|
ProtectionGroupId: string | undefined;
|
|
@@ -1075,10 +1168,12 @@ export interface DescribeProtectionGroupRequest {
|
|
|
1075
1168
|
*/
|
|
1076
1169
|
export interface ProtectionGroup {
|
|
1077
1170
|
/**
|
|
1171
|
+
* @public
|
|
1078
1172
|
* <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>
|
|
1079
1173
|
*/
|
|
1080
1174
|
ProtectionGroupId: string | undefined;
|
|
1081
1175
|
/**
|
|
1176
|
+
* @public
|
|
1082
1177
|
* <p>Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.</p>
|
|
1083
1178
|
* <ul>
|
|
1084
1179
|
* <li>
|
|
@@ -1094,19 +1189,23 @@ export interface ProtectionGroup {
|
|
|
1094
1189
|
*/
|
|
1095
1190
|
Aggregation: ProtectionGroupAggregation | string | undefined;
|
|
1096
1191
|
/**
|
|
1192
|
+
* @public
|
|
1097
1193
|
* <p>The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource ARNs (Amazon Resource Names), or include all resources of a specified resource type.</p>
|
|
1098
1194
|
*/
|
|
1099
1195
|
Pattern: ProtectionGroupPattern | string | undefined;
|
|
1100
1196
|
/**
|
|
1197
|
+
* @public
|
|
1101
1198
|
* <p>The resource type to include in the protection group. All protected resources of this type are included in the protection group.
|
|
1102
1199
|
* You must set this when you set <code>Pattern</code> to <code>BY_RESOURCE_TYPE</code> and you must not set it for any other <code>Pattern</code> setting. </p>
|
|
1103
1200
|
*/
|
|
1104
1201
|
ResourceType?: ProtectedResourceType | string;
|
|
1105
1202
|
/**
|
|
1203
|
+
* @public
|
|
1106
1204
|
* <p>The ARNs (Amazon Resource Names) of the resources to include in the protection group. You must set this when you set <code>Pattern</code> to <code>ARBITRARY</code> and you must not set it for any other <code>Pattern</code> setting. </p>
|
|
1107
1205
|
*/
|
|
1108
1206
|
Members: string[] | undefined;
|
|
1109
1207
|
/**
|
|
1208
|
+
* @public
|
|
1110
1209
|
* <p>The ARN (Amazon Resource Name) of the protection group.</p>
|
|
1111
1210
|
*/
|
|
1112
1211
|
ProtectionGroupArn?: string;
|
|
@@ -1116,6 +1215,7 @@ export interface ProtectionGroup {
|
|
|
1116
1215
|
*/
|
|
1117
1216
|
export interface DescribeProtectionGroupResponse {
|
|
1118
1217
|
/**
|
|
1218
|
+
* @public
|
|
1119
1219
|
* <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>
|
|
1120
1220
|
*/
|
|
1121
1221
|
ProtectionGroup: ProtectionGroup | undefined;
|
|
@@ -1131,10 +1231,12 @@ export interface DescribeSubscriptionRequest {
|
|
|
1131
1231
|
*/
|
|
1132
1232
|
export interface Limit {
|
|
1133
1233
|
/**
|
|
1234
|
+
* @public
|
|
1134
1235
|
* <p>The type of protection.</p>
|
|
1135
1236
|
*/
|
|
1136
1237
|
Type?: string;
|
|
1137
1238
|
/**
|
|
1239
|
+
* @public
|
|
1138
1240
|
* <p>The maximum number of protections that can be created for the specified <code>Type</code>.</p>
|
|
1139
1241
|
*/
|
|
1140
1242
|
Max?: number;
|
|
@@ -1158,6 +1260,7 @@ export type ProactiveEngagementStatus = (typeof ProactiveEngagementStatus)[keyof
|
|
|
1158
1260
|
*/
|
|
1159
1261
|
export interface ProtectionGroupArbitraryPatternLimits {
|
|
1160
1262
|
/**
|
|
1263
|
+
* @public
|
|
1161
1264
|
* <p>The maximum number of resources you can specify for a single arbitrary pattern in a protection group.</p>
|
|
1162
1265
|
*/
|
|
1163
1266
|
MaxMembers: number | undefined;
|
|
@@ -1168,6 +1271,7 @@ export interface ProtectionGroupArbitraryPatternLimits {
|
|
|
1168
1271
|
*/
|
|
1169
1272
|
export interface ProtectionGroupPatternTypeLimits {
|
|
1170
1273
|
/**
|
|
1274
|
+
* @public
|
|
1171
1275
|
* <p>Limits settings on protection groups with arbitrary pattern type. </p>
|
|
1172
1276
|
*/
|
|
1173
1277
|
ArbitraryPatternLimits: ProtectionGroupArbitraryPatternLimits | undefined;
|
|
@@ -1178,10 +1282,12 @@ export interface ProtectionGroupPatternTypeLimits {
|
|
|
1178
1282
|
*/
|
|
1179
1283
|
export interface ProtectionGroupLimits {
|
|
1180
1284
|
/**
|
|
1285
|
+
* @public
|
|
1181
1286
|
* <p>The maximum number of protection groups that you can have at one time. </p>
|
|
1182
1287
|
*/
|
|
1183
1288
|
MaxProtectionGroups: number | undefined;
|
|
1184
1289
|
/**
|
|
1290
|
+
* @public
|
|
1185
1291
|
* <p>Limits settings by pattern type in the protection groups for your subscription. </p>
|
|
1186
1292
|
*/
|
|
1187
1293
|
PatternTypeLimits: ProtectionGroupPatternTypeLimits | undefined;
|
|
@@ -1192,6 +1298,7 @@ export interface ProtectionGroupLimits {
|
|
|
1192
1298
|
*/
|
|
1193
1299
|
export interface ProtectionLimits {
|
|
1194
1300
|
/**
|
|
1301
|
+
* @public
|
|
1195
1302
|
* <p>The maximum number of resource types that you can specify in a protection.</p>
|
|
1196
1303
|
*/
|
|
1197
1304
|
ProtectedResourceTypeLimits: Limit[] | undefined;
|
|
@@ -1202,10 +1309,12 @@ export interface ProtectionLimits {
|
|
|
1202
1309
|
*/
|
|
1203
1310
|
export interface SubscriptionLimits {
|
|
1204
1311
|
/**
|
|
1312
|
+
* @public
|
|
1205
1313
|
* <p>Limits settings on protections for your subscription. </p>
|
|
1206
1314
|
*/
|
|
1207
1315
|
ProtectionLimits: ProtectionLimits | undefined;
|
|
1208
1316
|
/**
|
|
1317
|
+
* @public
|
|
1209
1318
|
* <p>Limits settings on protection groups for your subscription. </p>
|
|
1210
1319
|
*/
|
|
1211
1320
|
ProtectionGroupLimits: ProtectionGroupLimits | undefined;
|
|
@@ -1216,37 +1325,45 @@ export interface SubscriptionLimits {
|
|
|
1216
1325
|
*/
|
|
1217
1326
|
export interface Subscription {
|
|
1218
1327
|
/**
|
|
1328
|
+
* @public
|
|
1219
1329
|
* <p>The start time of the subscription, in Unix time in seconds. </p>
|
|
1220
1330
|
*/
|
|
1221
1331
|
StartTime?: Date;
|
|
1222
1332
|
/**
|
|
1333
|
+
* @public
|
|
1223
1334
|
* <p>The date and time your subscription will end.</p>
|
|
1224
1335
|
*/
|
|
1225
1336
|
EndTime?: Date;
|
|
1226
1337
|
/**
|
|
1338
|
+
* @public
|
|
1227
1339
|
* <p>The length, in seconds, of the Shield Advanced subscription for the account.</p>
|
|
1228
1340
|
*/
|
|
1229
1341
|
TimeCommitmentInSeconds?: number;
|
|
1230
1342
|
/**
|
|
1343
|
+
* @public
|
|
1231
1344
|
* <p>If <code>ENABLED</code>, the subscription will be automatically renewed at the end of the existing subscription period.</p>
|
|
1232
1345
|
* <p>When you initally create a subscription, <code>AutoRenew</code> is set to <code>ENABLED</code>. 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>
|
|
1233
1346
|
*/
|
|
1234
1347
|
AutoRenew?: AutoRenew | string;
|
|
1235
1348
|
/**
|
|
1349
|
+
* @public
|
|
1236
1350
|
* <p>Specifies how many protections of a given type you can create.</p>
|
|
1237
1351
|
*/
|
|
1238
1352
|
Limits?: Limit[];
|
|
1239
1353
|
/**
|
|
1354
|
+
* @public
|
|
1240
1355
|
* <p>If <code>ENABLED</code>, the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.</p>
|
|
1241
1356
|
* <p>If <code>PENDING</code>, you have requested proactive engagement and the request is pending. The status changes to <code>ENABLED</code> when your request is fully processed.</p>
|
|
1242
1357
|
* <p>If <code>DISABLED</code>, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support. </p>
|
|
1243
1358
|
*/
|
|
1244
1359
|
ProactiveEngagementStatus?: ProactiveEngagementStatus | string;
|
|
1245
1360
|
/**
|
|
1361
|
+
* @public
|
|
1246
1362
|
* <p>Limits settings for your subscription. </p>
|
|
1247
1363
|
*/
|
|
1248
1364
|
SubscriptionLimits: SubscriptionLimits | undefined;
|
|
1249
1365
|
/**
|
|
1366
|
+
* @public
|
|
1250
1367
|
* <p>The ARN (Amazon Resource Name) of the subscription.</p>
|
|
1251
1368
|
*/
|
|
1252
1369
|
SubscriptionArn?: string;
|
|
@@ -1256,6 +1373,7 @@ export interface Subscription {
|
|
|
1256
1373
|
*/
|
|
1257
1374
|
export interface DescribeSubscriptionResponse {
|
|
1258
1375
|
/**
|
|
1376
|
+
* @public
|
|
1259
1377
|
* <p>The Shield Advanced subscription details for an account.</p>
|
|
1260
1378
|
*/
|
|
1261
1379
|
Subscription?: Subscription;
|
|
@@ -1265,6 +1383,7 @@ export interface DescribeSubscriptionResponse {
|
|
|
1265
1383
|
*/
|
|
1266
1384
|
export interface DisableApplicationLayerAutomaticResponseRequest {
|
|
1267
1385
|
/**
|
|
1386
|
+
* @public
|
|
1268
1387
|
* <p>The ARN (Amazon Resource Name) of the protected resource.</p>
|
|
1269
1388
|
*/
|
|
1270
1389
|
ResourceArn: string | undefined;
|
|
@@ -1289,6 +1408,7 @@ export interface DisableProactiveEngagementResponse {
|
|
|
1289
1408
|
*/
|
|
1290
1409
|
export interface DisassociateDRTLogBucketRequest {
|
|
1291
1410
|
/**
|
|
1411
|
+
* @public
|
|
1292
1412
|
* <p>The Amazon S3 bucket that contains the logs that you want to share.</p>
|
|
1293
1413
|
*/
|
|
1294
1414
|
LogBucket: string | undefined;
|
|
@@ -1313,10 +1433,12 @@ export interface DisassociateDRTRoleResponse {
|
|
|
1313
1433
|
*/
|
|
1314
1434
|
export interface DisassociateHealthCheckRequest {
|
|
1315
1435
|
/**
|
|
1436
|
+
* @public
|
|
1316
1437
|
* <p>The unique identifier (ID) for the <a>Protection</a> object to remove the health check association from. </p>
|
|
1317
1438
|
*/
|
|
1318
1439
|
ProtectionId: string | undefined;
|
|
1319
1440
|
/**
|
|
1441
|
+
* @public
|
|
1320
1442
|
* <p>The Amazon Resource Name (ARN) of the health check that is associated with the protection.</p>
|
|
1321
1443
|
*/
|
|
1322
1444
|
HealthCheckArn: string | undefined;
|
|
@@ -1331,10 +1453,12 @@ export interface DisassociateHealthCheckResponse {
|
|
|
1331
1453
|
*/
|
|
1332
1454
|
export interface EnableApplicationLayerAutomaticResponseRequest {
|
|
1333
1455
|
/**
|
|
1456
|
+
* @public
|
|
1334
1457
|
* <p>The ARN (Amazon Resource Name) of the protected resource.</p>
|
|
1335
1458
|
*/
|
|
1336
1459
|
ResourceArn: string | undefined;
|
|
1337
1460
|
/**
|
|
1461
|
+
* @public
|
|
1338
1462
|
* <p>Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the
|
|
1339
1463
|
* protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature,
|
|
1340
1464
|
* 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>
|
|
@@ -1378,6 +1502,7 @@ export type SubscriptionState = (typeof SubscriptionState)[keyof typeof Subscrip
|
|
|
1378
1502
|
*/
|
|
1379
1503
|
export interface GetSubscriptionStateResponse {
|
|
1380
1504
|
/**
|
|
1505
|
+
* @public
|
|
1381
1506
|
* <p>The status of the subscription.</p>
|
|
1382
1507
|
*/
|
|
1383
1508
|
SubscriptionState: SubscriptionState | string | undefined;
|
|
@@ -1387,21 +1512,25 @@ export interface GetSubscriptionStateResponse {
|
|
|
1387
1512
|
*/
|
|
1388
1513
|
export interface ListAttacksRequest {
|
|
1389
1514
|
/**
|
|
1515
|
+
* @public
|
|
1390
1516
|
* <p>The ARNs (Amazon Resource Names) of the resources that were attacked. If you leave this
|
|
1391
1517
|
* blank, all applicable resources for this account will be included.</p>
|
|
1392
1518
|
*/
|
|
1393
1519
|
ResourceArns?: string[];
|
|
1394
1520
|
/**
|
|
1521
|
+
* @public
|
|
1395
1522
|
* <p>The start of the time period for the attacks. This is a <code>timestamp</code> type. The request syntax listing for this call indicates a <code>number</code> type,
|
|
1396
1523
|
* but you can provide the time in any valid <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">timestamp format</a> setting. </p>
|
|
1397
1524
|
*/
|
|
1398
1525
|
StartTime?: TimeRange;
|
|
1399
1526
|
/**
|
|
1527
|
+
* @public
|
|
1400
1528
|
* <p>The end of the time period for the attacks. This is a <code>timestamp</code> type. The request syntax listing for this call indicates a <code>number</code> type,
|
|
1401
1529
|
* but you can provide the time in any valid <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp">timestamp format</a> setting. </p>
|
|
1402
1530
|
*/
|
|
1403
1531
|
EndTime?: TimeRange;
|
|
1404
1532
|
/**
|
|
1533
|
+
* @public
|
|
1405
1534
|
* <p>When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects,
|
|
1406
1535
|
* Shield Advanced includes a <code>NextToken</code> value in the response. You can retrieve the next batch of objects by requesting the list again and
|
|
1407
1536
|
* providing the token that was returned by the prior call in your request. </p>
|
|
@@ -1412,6 +1541,7 @@ export interface ListAttacksRequest {
|
|
|
1412
1541
|
*/
|
|
1413
1542
|
NextToken?: string;
|
|
1414
1543
|
/**
|
|
1544
|
+
* @public
|
|
1415
1545
|
* <p>The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects
|
|
1416
1546
|
* than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a <code>NextToken</code> value
|
|
1417
1547
|
* in the response.</p>
|
|
@@ -1424,10 +1554,12 @@ export interface ListAttacksRequest {
|
|
|
1424
1554
|
*/
|
|
1425
1555
|
export interface ListAttacksResponse {
|
|
1426
1556
|
/**
|
|
1557
|
+
* @public
|
|
1427
1558
|
* <p>The attack information for the specified time range.</p>
|
|
1428
1559
|
*/
|
|
1429
1560
|
AttackSummaries?: AttackSummary[];
|
|
1430
1561
|
/**
|
|
1562
|
+
* @public
|
|
1431
1563
|
* <p>When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects,
|
|
1432
1564
|
* Shield Advanced includes a <code>NextToken</code> value in the response. You can retrieve the next batch of objects by requesting the list again and
|
|
1433
1565
|
* providing the token that was returned by the prior call in your request. </p>
|
|
@@ -1455,18 +1587,22 @@ export declare class InvalidPaginationTokenException extends __BaseException {
|
|
|
1455
1587
|
*/
|
|
1456
1588
|
export interface InclusionProtectionGroupFilters {
|
|
1457
1589
|
/**
|
|
1590
|
+
* @public
|
|
1458
1591
|
* <p>The ID of the protection group that you want to retrieve. </p>
|
|
1459
1592
|
*/
|
|
1460
1593
|
ProtectionGroupIds?: string[];
|
|
1461
1594
|
/**
|
|
1595
|
+
* @public
|
|
1462
1596
|
* <p>The pattern specification of the protection groups that you want to retrieve. </p>
|
|
1463
1597
|
*/
|
|
1464
1598
|
Patterns?: (ProtectionGroupPattern | string)[];
|
|
1465
1599
|
/**
|
|
1600
|
+
* @public
|
|
1466
1601
|
* <p>The resource type configuration of the protection groups that you want to retrieve. In the protection group configuration, you specify the resource type when you set the group's <code>Pattern</code> to <code>BY_RESOURCE_TYPE</code>. </p>
|
|
1467
1602
|
*/
|
|
1468
1603
|
ResourceTypes?: (ProtectedResourceType | string)[];
|
|
1469
1604
|
/**
|
|
1605
|
+
* @public
|
|
1470
1606
|
* <p>The aggregation setting of the protection groups that you want to retrieve. </p>
|
|
1471
1607
|
*/
|
|
1472
1608
|
Aggregations?: (ProtectionGroupAggregation | string)[];
|
|
@@ -1476,6 +1612,7 @@ export interface InclusionProtectionGroupFilters {
|
|
|
1476
1612
|
*/
|
|
1477
1613
|
export interface ListProtectionGroupsRequest {
|
|
1478
1614
|
/**
|
|
1615
|
+
* @public
|
|
1479
1616
|
* <p>When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects,
|
|
1480
1617
|
* Shield Advanced includes a <code>NextToken</code> value in the response. You can retrieve the next batch of objects by requesting the list again and
|
|
1481
1618
|
* providing the token that was returned by the prior call in your request. </p>
|
|
@@ -1486,6 +1623,7 @@ export interface ListProtectionGroupsRequest {
|
|
|
1486
1623
|
*/
|
|
1487
1624
|
NextToken?: string;
|
|
1488
1625
|
/**
|
|
1626
|
+
* @public
|
|
1489
1627
|
* <p>The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects
|
|
1490
1628
|
* than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a <code>NextToken</code> value
|
|
1491
1629
|
* in the response.</p>
|
|
@@ -1493,6 +1631,7 @@ export interface ListProtectionGroupsRequest {
|
|
|
1493
1631
|
*/
|
|
1494
1632
|
MaxResults?: number;
|
|
1495
1633
|
/**
|
|
1634
|
+
* @public
|
|
1496
1635
|
* <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 specific pattern or aggregation settings. 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>
|
|
1497
1636
|
*/
|
|
1498
1637
|
InclusionFilters?: InclusionProtectionGroupFilters;
|
|
@@ -1502,10 +1641,12 @@ export interface ListProtectionGroupsRequest {
|
|
|
1502
1641
|
*/
|
|
1503
1642
|
export interface ListProtectionGroupsResponse {
|
|
1504
1643
|
/**
|
|
1644
|
+
* @public
|
|
1505
1645
|
* <p></p>
|
|
1506
1646
|
*/
|
|
1507
1647
|
ProtectionGroups: ProtectionGroup[] | undefined;
|
|
1508
1648
|
/**
|
|
1649
|
+
* @public
|
|
1509
1650
|
* <p>When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects,
|
|
1510
1651
|
* Shield Advanced includes a <code>NextToken</code> value in the response. You can retrieve the next batch of objects by requesting the list again and
|
|
1511
1652
|
* providing the token that was returned by the prior call in your request. </p>
|
|
@@ -1521,14 +1662,17 @@ export interface ListProtectionGroupsResponse {
|
|
|
1521
1662
|
*/
|
|
1522
1663
|
export interface InclusionProtectionFilters {
|
|
1523
1664
|
/**
|
|
1665
|
+
* @public
|
|
1524
1666
|
* <p>The ARN (Amazon Resource Name) of the resource whose protection you want to retrieve. </p>
|
|
1525
1667
|
*/
|
|
1526
1668
|
ResourceArns?: string[];
|
|
1527
1669
|
/**
|
|
1670
|
+
* @public
|
|
1528
1671
|
* <p>The name of the protection that you want to retrieve. </p>
|
|
1529
1672
|
*/
|
|
1530
1673
|
ProtectionNames?: string[];
|
|
1531
1674
|
/**
|
|
1675
|
+
* @public
|
|
1532
1676
|
* <p>The type of protected resource whose protections you want to retrieve. </p>
|
|
1533
1677
|
*/
|
|
1534
1678
|
ResourceTypes?: (ProtectedResourceType | string)[];
|
|
@@ -1538,6 +1682,7 @@ export interface InclusionProtectionFilters {
|
|
|
1538
1682
|
*/
|
|
1539
1683
|
export interface ListProtectionsRequest {
|
|
1540
1684
|
/**
|
|
1685
|
+
* @public
|
|
1541
1686
|
* <p>When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects,
|
|
1542
1687
|
* Shield Advanced includes a <code>NextToken</code> value in the response. You can retrieve the next batch of objects by requesting the list again and
|
|
1543
1688
|
* providing the token that was returned by the prior call in your request. </p>
|
|
@@ -1548,6 +1693,7 @@ export interface ListProtectionsRequest {
|
|
|
1548
1693
|
*/
|
|
1549
1694
|
NextToken?: string;
|
|
1550
1695
|
/**
|
|
1696
|
+
* @public
|
|
1551
1697
|
* <p>The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects
|
|
1552
1698
|
* than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a <code>NextToken</code> value
|
|
1553
1699
|
* in the response.</p>
|
|
@@ -1555,6 +1701,7 @@ export interface ListProtectionsRequest {
|
|
|
1555
1701
|
*/
|
|
1556
1702
|
MaxResults?: number;
|
|
1557
1703
|
/**
|
|
1704
|
+
* @public
|
|
1558
1705
|
* <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>
|
|
1559
1706
|
*/
|
|
1560
1707
|
InclusionFilters?: InclusionProtectionFilters;
|
|
@@ -1564,10 +1711,12 @@ export interface ListProtectionsRequest {
|
|
|
1564
1711
|
*/
|
|
1565
1712
|
export interface ListProtectionsResponse {
|
|
1566
1713
|
/**
|
|
1714
|
+
* @public
|
|
1567
1715
|
* <p>The array of enabled <a>Protection</a> objects.</p>
|
|
1568
1716
|
*/
|
|
1569
1717
|
Protections?: Protection[];
|
|
1570
1718
|
/**
|
|
1719
|
+
* @public
|
|
1571
1720
|
* <p>When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects,
|
|
1572
1721
|
* Shield Advanced includes a <code>NextToken</code> value in the response. You can retrieve the next batch of objects by requesting the list again and
|
|
1573
1722
|
* providing the token that was returned by the prior call in your request. </p>
|
|
@@ -1582,10 +1731,12 @@ export interface ListProtectionsResponse {
|
|
|
1582
1731
|
*/
|
|
1583
1732
|
export interface ListResourcesInProtectionGroupRequest {
|
|
1584
1733
|
/**
|
|
1734
|
+
* @public
|
|
1585
1735
|
* <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>
|
|
1586
1736
|
*/
|
|
1587
1737
|
ProtectionGroupId: string | undefined;
|
|
1588
1738
|
/**
|
|
1739
|
+
* @public
|
|
1589
1740
|
* <p>When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects,
|
|
1590
1741
|
* Shield Advanced includes a <code>NextToken</code> value in the response. You can retrieve the next batch of objects by requesting the list again and
|
|
1591
1742
|
* providing the token that was returned by the prior call in your request. </p>
|
|
@@ -1596,6 +1747,7 @@ export interface ListResourcesInProtectionGroupRequest {
|
|
|
1596
1747
|
*/
|
|
1597
1748
|
NextToken?: string;
|
|
1598
1749
|
/**
|
|
1750
|
+
* @public
|
|
1599
1751
|
* <p>The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects
|
|
1600
1752
|
* than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a <code>NextToken</code> value
|
|
1601
1753
|
* in the response.</p>
|
|
@@ -1608,10 +1760,12 @@ export interface ListResourcesInProtectionGroupRequest {
|
|
|
1608
1760
|
*/
|
|
1609
1761
|
export interface ListResourcesInProtectionGroupResponse {
|
|
1610
1762
|
/**
|
|
1763
|
+
* @public
|
|
1611
1764
|
* <p>The Amazon Resource Names (ARNs) of the resources that are included in the protection group.</p>
|
|
1612
1765
|
*/
|
|
1613
1766
|
ResourceArns: string[] | undefined;
|
|
1614
1767
|
/**
|
|
1768
|
+
* @public
|
|
1615
1769
|
* <p>When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects,
|
|
1616
1770
|
* Shield Advanced includes a <code>NextToken</code> value in the response. You can retrieve the next batch of objects by requesting the list again and
|
|
1617
1771
|
* providing the token that was returned by the prior call in your request. </p>
|
|
@@ -1626,6 +1780,7 @@ export interface ListResourcesInProtectionGroupResponse {
|
|
|
1626
1780
|
*/
|
|
1627
1781
|
export interface ListTagsForResourceRequest {
|
|
1628
1782
|
/**
|
|
1783
|
+
* @public
|
|
1629
1784
|
* <p>The Amazon Resource Name (ARN) of the resource to get tags for.</p>
|
|
1630
1785
|
*/
|
|
1631
1786
|
ResourceARN: string | undefined;
|
|
@@ -1635,6 +1790,7 @@ export interface ListTagsForResourceRequest {
|
|
|
1635
1790
|
*/
|
|
1636
1791
|
export interface ListTagsForResourceResponse {
|
|
1637
1792
|
/**
|
|
1793
|
+
* @public
|
|
1638
1794
|
* <p>A list of tag key and value pairs associated with the specified resource.</p>
|
|
1639
1795
|
*/
|
|
1640
1796
|
Tags?: Tag[];
|
|
@@ -1644,10 +1800,12 @@ export interface ListTagsForResourceResponse {
|
|
|
1644
1800
|
*/
|
|
1645
1801
|
export interface TagResourceRequest {
|
|
1646
1802
|
/**
|
|
1803
|
+
* @public
|
|
1647
1804
|
* <p>The Amazon Resource Name (ARN) of the resource that you want to add or update tags for.</p>
|
|
1648
1805
|
*/
|
|
1649
1806
|
ResourceARN: string | undefined;
|
|
1650
1807
|
/**
|
|
1808
|
+
* @public
|
|
1651
1809
|
* <p>The tags that you want to modify or add to the resource.</p>
|
|
1652
1810
|
*/
|
|
1653
1811
|
Tags: Tag[] | undefined;
|
|
@@ -1662,10 +1820,12 @@ export interface TagResourceResponse {
|
|
|
1662
1820
|
*/
|
|
1663
1821
|
export interface UntagResourceRequest {
|
|
1664
1822
|
/**
|
|
1823
|
+
* @public
|
|
1665
1824
|
* <p>The Amazon Resource Name (ARN) of the resource that you want to remove tags from.</p>
|
|
1666
1825
|
*/
|
|
1667
1826
|
ResourceARN: string | undefined;
|
|
1668
1827
|
/**
|
|
1828
|
+
* @public
|
|
1669
1829
|
* <p>The tag key for each tag that you want to remove from the resource.</p>
|
|
1670
1830
|
*/
|
|
1671
1831
|
TagKeys: string[] | undefined;
|
|
@@ -1680,10 +1840,12 @@ export interface UntagResourceResponse {
|
|
|
1680
1840
|
*/
|
|
1681
1841
|
export interface UpdateApplicationLayerAutomaticResponseRequest {
|
|
1682
1842
|
/**
|
|
1843
|
+
* @public
|
|
1683
1844
|
* <p>The ARN (Amazon Resource Name) of the resource.</p>
|
|
1684
1845
|
*/
|
|
1685
1846
|
ResourceArn: string | undefined;
|
|
1686
1847
|
/**
|
|
1848
|
+
* @public
|
|
1687
1849
|
* <p>Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the
|
|
1688
1850
|
* protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature,
|
|
1689
1851
|
* 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>
|
|
@@ -1700,6 +1862,7 @@ export interface UpdateApplicationLayerAutomaticResponseResponse {
|
|
|
1700
1862
|
*/
|
|
1701
1863
|
export interface UpdateEmergencyContactSettingsRequest {
|
|
1702
1864
|
/**
|
|
1865
|
+
* @public
|
|
1703
1866
|
* <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>
|
|
1704
1867
|
* <p>If you have proactive engagement enabled, the contact list must include at least one phone number.</p>
|
|
1705
1868
|
*/
|
|
@@ -1715,10 +1878,12 @@ export interface UpdateEmergencyContactSettingsResponse {
|
|
|
1715
1878
|
*/
|
|
1716
1879
|
export interface UpdateProtectionGroupRequest {
|
|
1717
1880
|
/**
|
|
1881
|
+
* @public
|
|
1718
1882
|
* <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>
|
|
1719
1883
|
*/
|
|
1720
1884
|
ProtectionGroupId: string | undefined;
|
|
1721
1885
|
/**
|
|
1886
|
+
* @public
|
|
1722
1887
|
* <p>Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.</p>
|
|
1723
1888
|
* <ul>
|
|
1724
1889
|
* <li>
|
|
@@ -1734,15 +1899,18 @@ export interface UpdateProtectionGroupRequest {
|
|
|
1734
1899
|
*/
|
|
1735
1900
|
Aggregation: ProtectionGroupAggregation | string | undefined;
|
|
1736
1901
|
/**
|
|
1902
|
+
* @public
|
|
1737
1903
|
* <p>The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.</p>
|
|
1738
1904
|
*/
|
|
1739
1905
|
Pattern: ProtectionGroupPattern | string | undefined;
|
|
1740
1906
|
/**
|
|
1907
|
+
* @public
|
|
1741
1908
|
* <p>The resource type to include in the protection group. All protected resources of this type are included in the protection group.
|
|
1742
1909
|
* You must set this when you set <code>Pattern</code> to <code>BY_RESOURCE_TYPE</code> and you must not set it for any other <code>Pattern</code> setting. </p>
|
|
1743
1910
|
*/
|
|
1744
1911
|
ResourceType?: ProtectedResourceType | string;
|
|
1745
1912
|
/**
|
|
1913
|
+
* @public
|
|
1746
1914
|
* <p>The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set <code>Pattern</code> to <code>ARBITRARY</code> and you must not set it for any other <code>Pattern</code> setting. </p>
|
|
1747
1915
|
*/
|
|
1748
1916
|
Members?: string[];
|
|
@@ -1757,6 +1925,7 @@ export interface UpdateProtectionGroupResponse {
|
|
|
1757
1925
|
*/
|
|
1758
1926
|
export interface UpdateSubscriptionRequest {
|
|
1759
1927
|
/**
|
|
1928
|
+
* @public
|
|
1760
1929
|
* <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>
|
|
1761
1930
|
*/
|
|
1762
1931
|
AutoRenew?: AutoRenew | string;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-shield",
|
|
3
3
|
"description": "AWS SDK for JavaScript Shield Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.385.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,15 +21,15 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.385.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.385.0",
|
|
26
26
|
"@aws-sdk/middleware-host-header": "3.379.1",
|
|
27
27
|
"@aws-sdk/middleware-logger": "3.378.0",
|
|
28
28
|
"@aws-sdk/middleware-recursion-detection": "3.378.0",
|
|
29
29
|
"@aws-sdk/middleware-signing": "3.379.1",
|
|
30
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
30
|
+
"@aws-sdk/middleware-user-agent": "3.382.0",
|
|
31
31
|
"@aws-sdk/types": "3.378.0",
|
|
32
|
-
"@aws-sdk/util-endpoints": "3.
|
|
32
|
+
"@aws-sdk/util-endpoints": "3.382.0",
|
|
33
33
|
"@aws-sdk/util-user-agent-browser": "3.378.0",
|
|
34
34
|
"@aws-sdk/util-user-agent-node": "3.378.0",
|
|
35
35
|
"@smithy/config-resolver": "^2.0.1",
|