shield.d.ts
44.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class Shield extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Shield.Types.ClientConfiguration)
config: Config & Shield.Types.ClientConfiguration;
/**
* Authorizes the DDoS Response Team (DRT) to access the specified Amazon S3 bucket containing your AWS WAF logs. You can associate up to 10 Amazon S3 buckets with your subscription. To use the services of the DRT and make an AssociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan.
*/
associateDRTLogBucket(params: Shield.Types.AssociateDRTLogBucketRequest, callback?: (err: AWSError, data: Shield.Types.AssociateDRTLogBucketResponse) => void): Request<Shield.Types.AssociateDRTLogBucketResponse, AWSError>;
/**
* Authorizes the DDoS Response Team (DRT) to access the specified Amazon S3 bucket containing your AWS WAF logs. You can associate up to 10 Amazon S3 buckets with your subscription. To use the services of the DRT and make an AssociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan.
*/
associateDRTLogBucket(callback?: (err: AWSError, data: Shield.Types.AssociateDRTLogBucketResponse) => void): Request<Shield.Types.AssociateDRTLogBucketResponse, AWSError>;
/**
* Authorizes the DDoS Response Team (DRT), using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks. This enables the DRT to inspect your AWS WAF configuration and create or update AWS WAF rules and web ACLs. You can associate only one RoleArn with your subscription. If you submit an AssociateDRTRole request for an account that already has an associated role, the new RoleArn will replace the existing RoleArn. Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to the role you will specify in the request. For more information see Attaching and Detaching IAM Policies. The role must also trust the service principal drt.shield.amazonaws.com. For more information, see IAM JSON Policy Elements: Principal. The DRT will have access only to your AWS WAF and Shield resources. By submitting this request, you authorize the DRT to inspect your AWS WAF and Shield configuration and create and update AWS WAF rules and web ACLs on your behalf. The DRT takes these actions only if explicitly authorized by you. You must have the iam:PassRole permission to make an AssociateDRTRole request. For more information, see Granting a User Permissions to Pass a Role to an AWS Service. To use the services of the DRT and make an AssociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan.
*/
associateDRTRole(params: Shield.Types.AssociateDRTRoleRequest, callback?: (err: AWSError, data: Shield.Types.AssociateDRTRoleResponse) => void): Request<Shield.Types.AssociateDRTRoleResponse, AWSError>;
/**
* Authorizes the DDoS Response Team (DRT), using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks. This enables the DRT to inspect your AWS WAF configuration and create or update AWS WAF rules and web ACLs. You can associate only one RoleArn with your subscription. If you submit an AssociateDRTRole request for an account that already has an associated role, the new RoleArn will replace the existing RoleArn. Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to the role you will specify in the request. For more information see Attaching and Detaching IAM Policies. The role must also trust the service principal drt.shield.amazonaws.com. For more information, see IAM JSON Policy Elements: Principal. The DRT will have access only to your AWS WAF and Shield resources. By submitting this request, you authorize the DRT to inspect your AWS WAF and Shield configuration and create and update AWS WAF rules and web ACLs on your behalf. The DRT takes these actions only if explicitly authorized by you. You must have the iam:PassRole permission to make an AssociateDRTRole request. For more information, see Granting a User Permissions to Pass a Role to an AWS Service. To use the services of the DRT and make an AssociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan.
*/
associateDRTRole(callback?: (err: AWSError, data: Shield.Types.AssociateDRTRoleResponse) => void): Request<Shield.Types.AssociateDRTRoleResponse, AWSError>;
/**
* Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your AWS resource to improve responsiveness and accuracy in attack detection and mitigation. You define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the AWS WAF and AWS Shield Developer Guide.
*/
associateHealthCheck(params: Shield.Types.AssociateHealthCheckRequest, callback?: (err: AWSError, data: Shield.Types.AssociateHealthCheckResponse) => void): Request<Shield.Types.AssociateHealthCheckResponse, AWSError>;
/**
* Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your AWS resource to improve responsiveness and accuracy in attack detection and mitigation. You define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the AWS WAF and AWS Shield Developer Guide.
*/
associateHealthCheck(callback?: (err: AWSError, data: Shield.Types.AssociateHealthCheckResponse) => void): Request<Shield.Types.AssociateHealthCheckResponse, AWSError>;
/**
* Initializes proactive engagement and sets the list of contacts for the DDoS Response Team (DRT) to use. You must provide at least one phone number in the emergency contact list. After you have initialized proactive engagement using this call, to disable or enable proactive engagement, use the calls DisableProactiveEngagement and EnableProactiveEngagement. This call defines the list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you for escalations to the DRT and to initiate proactive customer support. The contacts that you provide in the request replace any contacts that were already defined. If you already have contacts defined and want to use them, retrieve the list using DescribeEmergencyContactSettings and then provide it to this call.
*/
associateProactiveEngagementDetails(params: Shield.Types.AssociateProactiveEngagementDetailsRequest, callback?: (err: AWSError, data: Shield.Types.AssociateProactiveEngagementDetailsResponse) => void): Request<Shield.Types.AssociateProactiveEngagementDetailsResponse, AWSError>;
/**
* Initializes proactive engagement and sets the list of contacts for the DDoS Response Team (DRT) to use. You must provide at least one phone number in the emergency contact list. After you have initialized proactive engagement using this call, to disable or enable proactive engagement, use the calls DisableProactiveEngagement and EnableProactiveEngagement. This call defines the list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you for escalations to the DRT and to initiate proactive customer support. The contacts that you provide in the request replace any contacts that were already defined. If you already have contacts defined and want to use them, retrieve the list using DescribeEmergencyContactSettings and then provide it to this call.
*/
associateProactiveEngagementDetails(callback?: (err: AWSError, data: Shield.Types.AssociateProactiveEngagementDetailsResponse) => void): Request<Shield.Types.AssociateProactiveEngagementDetailsResponse, AWSError>;
/**
* Enables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Elastic Load Balancing load balancer, AWS Global Accelerator accelerator, Elastic IP Address, or an Amazon Route 53 hosted zone. You can add protection to only a single resource with each CreateProtection request. If you want to add protection to multiple resources at once, use the AWS WAF console. For more information see Getting Started with AWS Shield Advanced and Add AWS Shield Advanced Protection to more AWS Resources.
*/
createProtection(params: Shield.Types.CreateProtectionRequest, callback?: (err: AWSError, data: Shield.Types.CreateProtectionResponse) => void): Request<Shield.Types.CreateProtectionResponse, AWSError>;
/**
* Enables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Elastic Load Balancing load balancer, AWS Global Accelerator accelerator, Elastic IP Address, or an Amazon Route 53 hosted zone. You can add protection to only a single resource with each CreateProtection request. If you want to add protection to multiple resources at once, use the AWS WAF console. For more information see Getting Started with AWS Shield Advanced and Add AWS Shield Advanced Protection to more AWS Resources.
*/
createProtection(callback?: (err: AWSError, data: Shield.Types.CreateProtectionResponse) => void): Request<Shield.Types.CreateProtectionResponse, AWSError>;
/**
* Activates AWS Shield Advanced for an account. When you initally create a subscription, your subscription is set to be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request.
*/
createSubscription(params: Shield.Types.CreateSubscriptionRequest, callback?: (err: AWSError, data: Shield.Types.CreateSubscriptionResponse) => void): Request<Shield.Types.CreateSubscriptionResponse, AWSError>;
/**
* Activates AWS Shield Advanced for an account. When you initally create a subscription, your subscription is set to be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request.
*/
createSubscription(callback?: (err: AWSError, data: Shield.Types.CreateSubscriptionResponse) => void): Request<Shield.Types.CreateSubscriptionResponse, AWSError>;
/**
* Deletes an AWS Shield Advanced Protection.
*/
deleteProtection(params: Shield.Types.DeleteProtectionRequest, callback?: (err: AWSError, data: Shield.Types.DeleteProtectionResponse) => void): Request<Shield.Types.DeleteProtectionResponse, AWSError>;
/**
* Deletes an AWS Shield Advanced Protection.
*/
deleteProtection(callback?: (err: AWSError, data: Shield.Types.DeleteProtectionResponse) => void): Request<Shield.Types.DeleteProtectionResponse, AWSError>;
/**
* Removes AWS Shield Advanced from an account. AWS Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment.
*/
deleteSubscription(params: Shield.Types.DeleteSubscriptionRequest, callback?: (err: AWSError, data: Shield.Types.DeleteSubscriptionResponse) => void): Request<Shield.Types.DeleteSubscriptionResponse, AWSError>;
/**
* Removes AWS Shield Advanced from an account. AWS Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment.
*/
deleteSubscription(callback?: (err: AWSError, data: Shield.Types.DeleteSubscriptionResponse) => void): Request<Shield.Types.DeleteSubscriptionResponse, AWSError>;
/**
* Describes the details of a DDoS attack.
*/
describeAttack(params: Shield.Types.DescribeAttackRequest, callback?: (err: AWSError, data: Shield.Types.DescribeAttackResponse) => void): Request<Shield.Types.DescribeAttackResponse, AWSError>;
/**
* Describes the details of a DDoS attack.
*/
describeAttack(callback?: (err: AWSError, data: Shield.Types.DescribeAttackResponse) => void): Request<Shield.Types.DescribeAttackResponse, AWSError>;
/**
* Returns the current role and list of Amazon S3 log buckets used by the DDoS Response Team (DRT) to access your AWS account while assisting with attack mitigation.
*/
describeDRTAccess(params: Shield.Types.DescribeDRTAccessRequest, callback?: (err: AWSError, data: Shield.Types.DescribeDRTAccessResponse) => void): Request<Shield.Types.DescribeDRTAccessResponse, AWSError>;
/**
* Returns the current role and list of Amazon S3 log buckets used by the DDoS Response Team (DRT) to access your AWS account while assisting with attack mitigation.
*/
describeDRTAccess(callback?: (err: AWSError, data: Shield.Types.DescribeDRTAccessResponse) => void): Request<Shield.Types.DescribeDRTAccessResponse, AWSError>;
/**
* A list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.
*/
describeEmergencyContactSettings(params: Shield.Types.DescribeEmergencyContactSettingsRequest, callback?: (err: AWSError, data: Shield.Types.DescribeEmergencyContactSettingsResponse) => void): Request<Shield.Types.DescribeEmergencyContactSettingsResponse, AWSError>;
/**
* A list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.
*/
describeEmergencyContactSettings(callback?: (err: AWSError, data: Shield.Types.DescribeEmergencyContactSettingsResponse) => void): Request<Shield.Types.DescribeEmergencyContactSettingsResponse, AWSError>;
/**
* Lists the details of a Protection object.
*/
describeProtection(params: Shield.Types.DescribeProtectionRequest, callback?: (err: AWSError, data: Shield.Types.DescribeProtectionResponse) => void): Request<Shield.Types.DescribeProtectionResponse, AWSError>;
/**
* Lists the details of a Protection object.
*/
describeProtection(callback?: (err: AWSError, data: Shield.Types.DescribeProtectionResponse) => void): Request<Shield.Types.DescribeProtectionResponse, AWSError>;
/**
* Provides details about the AWS Shield Advanced subscription for an account.
*/
describeSubscription(params: Shield.Types.DescribeSubscriptionRequest, callback?: (err: AWSError, data: Shield.Types.DescribeSubscriptionResponse) => void): Request<Shield.Types.DescribeSubscriptionResponse, AWSError>;
/**
* Provides details about the AWS Shield Advanced subscription for an account.
*/
describeSubscription(callback?: (err: AWSError, data: Shield.Types.DescribeSubscriptionResponse) => void): Request<Shield.Types.DescribeSubscriptionResponse, AWSError>;
/**
* Removes authorization from the DDoS Response Team (DRT) to notify contacts about escalations to the DRT and to initiate proactive customer support.
*/
disableProactiveEngagement(params: Shield.Types.DisableProactiveEngagementRequest, callback?: (err: AWSError, data: Shield.Types.DisableProactiveEngagementResponse) => void): Request<Shield.Types.DisableProactiveEngagementResponse, AWSError>;
/**
* Removes authorization from the DDoS Response Team (DRT) to notify contacts about escalations to the DRT and to initiate proactive customer support.
*/
disableProactiveEngagement(callback?: (err: AWSError, data: Shield.Types.DisableProactiveEngagementResponse) => void): Request<Shield.Types.DisableProactiveEngagementResponse, AWSError>;
/**
* Removes the DDoS Response Team's (DRT) access to the specified Amazon S3 bucket containing your AWS WAF logs. To make a DisassociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTLogBucket request to remove this access.
*/
disassociateDRTLogBucket(params: Shield.Types.DisassociateDRTLogBucketRequest, callback?: (err: AWSError, data: Shield.Types.DisassociateDRTLogBucketResponse) => void): Request<Shield.Types.DisassociateDRTLogBucketResponse, AWSError>;
/**
* Removes the DDoS Response Team's (DRT) access to the specified Amazon S3 bucket containing your AWS WAF logs. To make a DisassociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTLogBucket request to remove this access.
*/
disassociateDRTLogBucket(callback?: (err: AWSError, data: Shield.Types.DisassociateDRTLogBucketResponse) => void): Request<Shield.Types.DisassociateDRTLogBucketResponse, AWSError>;
/**
* Removes the DDoS Response Team's (DRT) access to your AWS account. To make a DisassociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTRole request to remove this access.
*/
disassociateDRTRole(params: Shield.Types.DisassociateDRTRoleRequest, callback?: (err: AWSError, data: Shield.Types.DisassociateDRTRoleResponse) => void): Request<Shield.Types.DisassociateDRTRoleResponse, AWSError>;
/**
* Removes the DDoS Response Team's (DRT) access to your AWS account. To make a DisassociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTRole request to remove this access.
*/
disassociateDRTRole(callback?: (err: AWSError, data: Shield.Types.DisassociateDRTRoleResponse) => void): Request<Shield.Types.DisassociateDRTRoleResponse, AWSError>;
/**
* Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your AWS resource to improve responsiveness and accuracy in attack detection and mitigation. You define the health check in Route 53 and then associate or disassociate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the AWS WAF and AWS Shield Developer Guide.
*/
disassociateHealthCheck(params: Shield.Types.DisassociateHealthCheckRequest, callback?: (err: AWSError, data: Shield.Types.DisassociateHealthCheckResponse) => void): Request<Shield.Types.DisassociateHealthCheckResponse, AWSError>;
/**
* Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your AWS resource to improve responsiveness and accuracy in attack detection and mitigation. You define the health check in Route 53 and then associate or disassociate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the AWS WAF and AWS Shield Developer Guide.
*/
disassociateHealthCheck(callback?: (err: AWSError, data: Shield.Types.DisassociateHealthCheckResponse) => void): Request<Shield.Types.DisassociateHealthCheckResponse, AWSError>;
/**
* Authorizes the DDoS Response Team (DRT) to use email and phone to notify contacts about escalations to the DRT and to initiate proactive customer support.
*/
enableProactiveEngagement(params: Shield.Types.EnableProactiveEngagementRequest, callback?: (err: AWSError, data: Shield.Types.EnableProactiveEngagementResponse) => void): Request<Shield.Types.EnableProactiveEngagementResponse, AWSError>;
/**
* Authorizes the DDoS Response Team (DRT) to use email and phone to notify contacts about escalations to the DRT and to initiate proactive customer support.
*/
enableProactiveEngagement(callback?: (err: AWSError, data: Shield.Types.EnableProactiveEngagementResponse) => void): Request<Shield.Types.EnableProactiveEngagementResponse, AWSError>;
/**
* Returns the SubscriptionState, either Active or Inactive.
*/
getSubscriptionState(params: Shield.Types.GetSubscriptionStateRequest, callback?: (err: AWSError, data: Shield.Types.GetSubscriptionStateResponse) => void): Request<Shield.Types.GetSubscriptionStateResponse, AWSError>;
/**
* Returns the SubscriptionState, either Active or Inactive.
*/
getSubscriptionState(callback?: (err: AWSError, data: Shield.Types.GetSubscriptionStateResponse) => void): Request<Shield.Types.GetSubscriptionStateResponse, AWSError>;
/**
* Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
*/
listAttacks(params: Shield.Types.ListAttacksRequest, callback?: (err: AWSError, data: Shield.Types.ListAttacksResponse) => void): Request<Shield.Types.ListAttacksResponse, AWSError>;
/**
* Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
*/
listAttacks(callback?: (err: AWSError, data: Shield.Types.ListAttacksResponse) => void): Request<Shield.Types.ListAttacksResponse, AWSError>;
/**
* Lists all Protection objects for the account.
*/
listProtections(params: Shield.Types.ListProtectionsRequest, callback?: (err: AWSError, data: Shield.Types.ListProtectionsResponse) => void): Request<Shield.Types.ListProtectionsResponse, AWSError>;
/**
* Lists all Protection objects for the account.
*/
listProtections(callback?: (err: AWSError, data: Shield.Types.ListProtectionsResponse) => void): Request<Shield.Types.ListProtectionsResponse, AWSError>;
/**
* Updates the details of the list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.
*/
updateEmergencyContactSettings(params: Shield.Types.UpdateEmergencyContactSettingsRequest, callback?: (err: AWSError, data: Shield.Types.UpdateEmergencyContactSettingsResponse) => void): Request<Shield.Types.UpdateEmergencyContactSettingsResponse, AWSError>;
/**
* Updates the details of the list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.
*/
updateEmergencyContactSettings(callback?: (err: AWSError, data: Shield.Types.UpdateEmergencyContactSettingsResponse) => void): Request<Shield.Types.UpdateEmergencyContactSettingsResponse, AWSError>;
/**
* Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.
*/
updateSubscription(params: Shield.Types.UpdateSubscriptionRequest, callback?: (err: AWSError, data: Shield.Types.UpdateSubscriptionResponse) => void): Request<Shield.Types.UpdateSubscriptionResponse, AWSError>;
/**
* Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.
*/
updateSubscription(callback?: (err: AWSError, data: Shield.Types.UpdateSubscriptionResponse) => void): Request<Shield.Types.UpdateSubscriptionResponse, AWSError>;
}
declare namespace Shield {
export interface AssociateDRTLogBucketRequest {
/**
* The Amazon S3 bucket that contains your AWS WAF logs.
*/
LogBucket: LogBucket;
}
export interface AssociateDRTLogBucketResponse {
}
export interface AssociateDRTRoleRequest {
/**
* The Amazon Resource Name (ARN) of the role the DRT will use to access your AWS account. Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to this role. For more information see Attaching and Detaching IAM Policies.
*/
RoleArn: RoleArn;
}
export interface AssociateDRTRoleResponse {
}
export interface AssociateHealthCheckRequest {
/**
* The unique identifier (ID) for the Protection object to add the health check association to.
*/
ProtectionId: ProtectionId;
/**
* The Amazon Resource Name (ARN) of the health check to associate with the protection.
*/
HealthCheckArn: HealthCheckArn;
}
export interface AssociateHealthCheckResponse {
}
export interface AssociateProactiveEngagementDetailsRequest {
/**
* A list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you for escalations to the DRT and to initiate proactive customer support. To enable proactive engagement, the contact list must include at least one phone number. The contacts that you provide here replace any contacts that were already defined. If you already have contacts defined and want to use them, retrieve the list using DescribeEmergencyContactSettings and then provide it here.
*/
EmergencyContactList: EmergencyContactList;
}
export interface AssociateProactiveEngagementDetailsResponse {
}
export interface AttackDetail {
/**
* The unique identifier (ID) of the attack.
*/
AttackId?: AttackId;
/**
* The ARN (Amazon Resource Name) of the resource that was attacked.
*/
ResourceArn?: ResourceArn;
/**
* If applicable, additional detail about the resource being attacked, for example, IP address or URL.
*/
SubResources?: SubResourceSummaryList;
/**
* The time the attack started, in Unix time in seconds. For more information see timestamp.
*/
StartTime?: AttackTimestamp;
/**
* The time the attack ended, in Unix time in seconds. For more information see timestamp.
*/
EndTime?: AttackTimestamp;
/**
* List of counters that describe the attack for the specified time period.
*/
AttackCounters?: SummarizedCounterList;
/**
* The array of AttackProperty objects.
*/
AttackProperties?: AttackProperties;
/**
* List of mitigation actions taken for the attack.
*/
Mitigations?: MitigationList;
}
export type AttackId = string;
export type AttackLayer = "NETWORK"|"APPLICATION"|string;
export type AttackProperties = AttackProperty[];
export interface AttackProperty {
/**
* The type of distributed denial of service (DDoS) event that was observed. NETWORK indicates layer 3 and layer 4 events and APPLICATION indicates layer 7 events.
*/
AttackLayer?: AttackLayer;
/**
* Defines the DDoS attack property information that is provided. The WORDPRESS_PINGBACK_REFLECTOR and WORDPRESS_PINGBACK_SOURCE values are valid only for WordPress reflective pingback DDoS attacks.
*/
AttackPropertyIdentifier?: AttackPropertyIdentifier;
/**
* The array of Contributor objects that includes the top five contributors to an attack.
*/
TopContributors?: TopContributors;
/**
* The unit of the Value of the contributions.
*/
Unit?: Unit;
/**
* The total contributions made to this attack by all contributors, not just the five listed in the TopContributors list.
*/
Total?: Long;
}
export type AttackPropertyIdentifier = "DESTINATION_URL"|"REFERRER"|"SOURCE_ASN"|"SOURCE_COUNTRY"|"SOURCE_IP_ADDRESS"|"SOURCE_USER_AGENT"|"WORDPRESS_PINGBACK_REFLECTOR"|"WORDPRESS_PINGBACK_SOURCE"|string;
export type AttackSummaries = AttackSummary[];
export interface AttackSummary {
/**
* The unique identifier (ID) of the attack.
*/
AttackId?: String;
/**
* The ARN (Amazon Resource Name) of the resource that was attacked.
*/
ResourceArn?: String;
/**
* The start time of the attack, in Unix time in seconds. For more information see timestamp.
*/
StartTime?: AttackTimestamp;
/**
* The end time of the attack, in Unix time in seconds. For more information see timestamp.
*/
EndTime?: AttackTimestamp;
/**
* The list of attacks for a specified time period.
*/
AttackVectors?: AttackVectorDescriptionList;
}
export type AttackTimestamp = Date;
export interface AttackVectorDescription {
/**
* The attack type. Valid values: UDP_TRAFFIC UDP_FRAGMENT GENERIC_UDP_REFLECTION DNS_REFLECTION NTP_REFLECTION CHARGEN_REFLECTION SSDP_REFLECTION PORT_MAPPER RIP_REFLECTION SNMP_REFLECTION MSSQL_REFLECTION NET_BIOS_REFLECTION SYN_FLOOD ACK_FLOOD REQUEST_FLOOD HTTP_REFLECTION UDS_REFLECTION MEMCACHED_REFLECTION
*/
VectorType: String;
}
export type AttackVectorDescriptionList = AttackVectorDescription[];
export type AutoRenew = "ENABLED"|"DISABLED"|string;
export type ContactNotes = string;
export interface Contributor {
/**
* The name of the contributor. This is dependent on the AttackPropertyIdentifier. For example, if the AttackPropertyIdentifier is SOURCE_COUNTRY, the Name could be United States.
*/
Name?: String;
/**
* The contribution of this contributor expressed in Protection units. For example 10,000.
*/
Value?: Long;
}
export interface CreateProtectionRequest {
/**
* Friendly name for the Protection you are creating.
*/
Name: ProtectionName;
/**
* The ARN (Amazon Resource Name) of the resource to be protected. The ARN should be in one of the following formats: For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id For an Elastic Load Balancer (Classic Load Balancer): arn:aws:elasticloadbalancing:region:account-id:loadbalancer/load-balancer-name For an AWS CloudFront distribution: arn:aws:cloudfront::account-id:distribution/distribution-id For an AWS Global Accelerator accelerator: arn:aws:globalaccelerator::account-id:accelerator/accelerator-id For Amazon Route 53: arn:aws:route53:::hostedzone/hosted-zone-id For an Elastic IP address: arn:aws:ec2:region:account-id:eip-allocation/allocation-id
*/
ResourceArn: ResourceArn;
}
export interface CreateProtectionResponse {
/**
* The unique identifier (ID) for the Protection object that is created.
*/
ProtectionId?: ProtectionId;
}
export interface CreateSubscriptionRequest {
}
export interface CreateSubscriptionResponse {
}
export interface DeleteProtectionRequest {
/**
* The unique identifier (ID) for the Protection object to be deleted.
*/
ProtectionId: ProtectionId;
}
export interface DeleteProtectionResponse {
}
export interface DeleteSubscriptionRequest {
}
export interface DeleteSubscriptionResponse {
}
export interface DescribeAttackRequest {
/**
* The unique identifier (ID) for the attack that to be described.
*/
AttackId: AttackId;
}
export interface DescribeAttackResponse {
/**
* The attack that is described.
*/
Attack?: AttackDetail;
}
export interface DescribeDRTAccessRequest {
}
export interface DescribeDRTAccessResponse {
/**
* The Amazon Resource Name (ARN) of the role the DRT used to access your AWS account.
*/
RoleArn?: RoleArn;
/**
* The list of Amazon S3 buckets accessed by the DRT.
*/
LogBucketList?: LogBucketList;
}
export interface DescribeEmergencyContactSettingsRequest {
}
export interface DescribeEmergencyContactSettingsResponse {
/**
* A list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.
*/
EmergencyContactList?: EmergencyContactList;
}
export interface DescribeProtectionRequest {
/**
* The unique identifier (ID) for the Protection object that is described. When submitting the DescribeProtection request you must provide either the ResourceArn or the ProtectionID, but not both.
*/
ProtectionId?: ProtectionId;
/**
* The ARN (Amazon Resource Name) of the AWS resource for the Protection object that is described. When submitting the DescribeProtection request you must provide either the ResourceArn or the ProtectionID, but not both.
*/
ResourceArn?: ResourceArn;
}
export interface DescribeProtectionResponse {
/**
* The Protection object that is described.
*/
Protection?: Protection;
}
export interface DescribeSubscriptionRequest {
}
export interface DescribeSubscriptionResponse {
/**
* The AWS Shield Advanced subscription details for an account.
*/
Subscription?: Subscription;
}
export interface DisableProactiveEngagementRequest {
}
export interface DisableProactiveEngagementResponse {
}
export interface DisassociateDRTLogBucketRequest {
/**
* The Amazon S3 bucket that contains your AWS WAF logs.
*/
LogBucket: LogBucket;
}
export interface DisassociateDRTLogBucketResponse {
}
export interface DisassociateDRTRoleRequest {
}
export interface DisassociateDRTRoleResponse {
}
export interface DisassociateHealthCheckRequest {
/**
* The unique identifier (ID) for the Protection object to remove the health check association from.
*/
ProtectionId: ProtectionId;
/**
* The Amazon Resource Name (ARN) of the health check that is associated with the protection.
*/
HealthCheckArn: HealthCheckArn;
}
export interface DisassociateHealthCheckResponse {
}
export type Double = number;
export type DurationInSeconds = number;
export type EmailAddress = string;
export interface EmergencyContact {
/**
* The email address for the contact.
*/
EmailAddress: EmailAddress;
/**
* The phone number for the contact.
*/
PhoneNumber?: PhoneNumber;
/**
* Additional notes regarding the contact.
*/
ContactNotes?: ContactNotes;
}
export type EmergencyContactList = EmergencyContact[];
export interface EnableProactiveEngagementRequest {
}
export interface EnableProactiveEngagementResponse {
}
export interface GetSubscriptionStateRequest {
}
export interface GetSubscriptionStateResponse {
/**
* The status of the subscription.
*/
SubscriptionState: SubscriptionState;
}
export type HealthCheckArn = string;
export type HealthCheckId = string;
export type HealthCheckIds = HealthCheckId[];
export type Integer = number;
export interface Limit {
/**
* The type of protection.
*/
Type?: String;
/**
* The maximum number of protections that can be created for the specified Type.
*/
Max?: Long;
}
export type Limits = Limit[];
export interface ListAttacksRequest {
/**
* The ARN (Amazon Resource Name) of the resource that was attacked. If this is left blank, all applicable resources for this account will be included.
*/
ResourceArns?: ResourceArnFilterList;
/**
* The start of the time period for the attacks. This is a timestamp type. The sample request above indicates a number type because the default used by WAF is Unix time in seconds. However any valid timestamp format is allowed.
*/
StartTime?: TimeRange;
/**
* The end of the time period for the attacks. This is a timestamp type. The sample request above indicates a number type because the default used by WAF is Unix time in seconds. However any valid timestamp format is allowed.
*/
EndTime?: TimeRange;
/**
* The ListAttacksRequest.NextMarker value from a previous call to ListAttacksRequest. Pass null if this is the first call.
*/
NextToken?: Token;
/**
* The maximum number of AttackSummary objects to be returned. If this is left blank, the first 20 results will be returned. This is a maximum value; it is possible that AWS WAF will return the results in smaller batches. That is, the number of AttackSummary objects returned could be less than MaxResults, even if there are still more AttackSummary objects yet to return. If there are more AttackSummary objects to return, AWS WAF will always also return a NextToken.
*/
MaxResults?: MaxResults;
}
export interface ListAttacksResponse {
/**
* The attack information for the specified time range.
*/
AttackSummaries?: AttackSummaries;
/**
* The token returned by a previous call to indicate that there is more data available. If not null, more results are available. Pass this value for the NextMarker parameter in a subsequent call to ListAttacks to retrieve the next set of items. AWS WAF might return the list of AttackSummary objects in batches smaller than the number specified by MaxResults. If there are more AttackSummary objects to return, AWS WAF will always also return a NextToken.
*/
NextToken?: Token;
}
export interface ListProtectionsRequest {
/**
* The ListProtectionsRequest.NextToken value from a previous call to ListProtections. Pass null if this is the first call.
*/
NextToken?: Token;
/**
* The maximum number of Protection objects to be returned. If this is left blank the first 20 results will be returned. This is a maximum value; it is possible that AWS WAF will return the results in smaller batches. That is, the number of Protection objects returned could be less than MaxResults, even if there are still more Protection objects yet to return. If there are more Protection objects to return, AWS WAF will always also return a NextToken.
*/
MaxResults?: MaxResults;
}
export interface ListProtectionsResponse {
/**
* The array of enabled Protection objects.
*/
Protections?: Protections;
/**
* If you specify a value for MaxResults and you have more Protections than the value of MaxResults, AWS Shield Advanced returns a NextToken value in the response that allows you to list another group of Protections. For the second and subsequent ListProtections requests, specify the value of NextToken from the previous response to get information about another batch of Protections. AWS WAF might return the list of Protection objects in batches smaller than the number specified by MaxResults. If there are more Protection objects to return, AWS WAF will always also return a NextToken.
*/
NextToken?: Token;
}
export type LogBucket = string;
export type LogBucketList = LogBucket[];
export type Long = number;
export type MaxResults = number;
export interface Mitigation {
/**
* The name of the mitigation taken for this attack.
*/
MitigationName?: String;
}
export type MitigationList = Mitigation[];
export type PhoneNumber = string;
export type ProactiveEngagementStatus = "ENABLED"|"DISABLED"|"PENDING"|string;
export interface Protection {
/**
* The unique identifier (ID) of the protection.
*/
Id?: ProtectionId;
/**
* The friendly name of the protection. For example, My CloudFront distributions.
*/
Name?: ProtectionName;
/**
* The ARN (Amazon Resource Name) of the AWS resource that is protected.
*/
ResourceArn?: ResourceArn;
/**
* The unique identifier (ID) for the Route 53 health check that's associated with the protection.
*/
HealthCheckIds?: HealthCheckIds;
}
export type ProtectionId = string;
export type ProtectionName = string;
export type Protections = Protection[];
export type ResourceArn = string;
export type ResourceArnFilterList = ResourceArn[];
export type RoleArn = string;
export type String = string;
export interface SubResourceSummary {
/**
* The SubResource type.
*/
Type?: SubResourceType;
/**
* The unique identifier (ID) of the SubResource.
*/
Id?: String;
/**
* The list of attack types and associated counters.
*/
AttackVectors?: SummarizedAttackVectorList;
/**
* The counters that describe the details of the attack.
*/
Counters?: SummarizedCounterList;
}
export type SubResourceSummaryList = SubResourceSummary[];
export type SubResourceType = "IP"|"URL"|string;
export interface Subscription {
/**
* The start time of the subscription, in Unix time in seconds. For more information see timestamp.
*/
StartTime?: Timestamp;
/**
* The date and time your subscription will end.
*/
EndTime?: Timestamp;
/**
* The length, in seconds, of the AWS Shield Advanced subscription for the account.
*/
TimeCommitmentInSeconds?: DurationInSeconds;
/**
* If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period. When you initally create a subscription, AutoRenew is set to ENABLED. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.
*/
AutoRenew?: AutoRenew;
/**
* Specifies how many protections of a given type you can create.
*/
Limits?: Limits;
/**
* If ENABLED, the DDoS Response Team (DRT) will use email and phone to notify contacts about escalations to the DRT and to initiate proactive customer support. If PENDING, you have requested proactive engagement and the request is pending. The status changes to ENABLED when your request is fully processed. If DISABLED, the DRT will not proactively notify contacts about escalations or to initiate proactive customer support.
*/
ProactiveEngagementStatus?: ProactiveEngagementStatus;
}
export type SubscriptionState = "ACTIVE"|"INACTIVE"|string;
export interface SummarizedAttackVector {
/**
* The attack type, for example, SNMP reflection or SYN flood.
*/
VectorType: String;
/**
* The list of counters that describe the details of the attack.
*/
VectorCounters?: SummarizedCounterList;
}
export type SummarizedAttackVectorList = SummarizedAttackVector[];
export interface SummarizedCounter {
/**
* The counter name.
*/
Name?: String;
/**
* The maximum value of the counter for a specified time period.
*/
Max?: Double;
/**
* The average value of the counter for a specified time period.
*/
Average?: Double;
/**
* The total of counter values for a specified time period.
*/
Sum?: Double;
/**
* The number of counters for a specified time period.
*/
N?: Integer;
/**
* The unit of the counters.
*/
Unit?: String;
}
export type SummarizedCounterList = SummarizedCounter[];
export interface TimeRange {
/**
* The start time, in Unix time in seconds. For more information see timestamp.
*/
FromInclusive?: AttackTimestamp;
/**
* The end time, in Unix time in seconds. For more information see timestamp.
*/
ToExclusive?: AttackTimestamp;
}
export type Timestamp = Date;
export type Token = string;
export type TopContributors = Contributor[];
export type Unit = "BITS"|"BYTES"|"PACKETS"|"REQUESTS"|string;
export interface UpdateEmergencyContactSettingsRequest {
/**
* A list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support. If you have proactive engagement enabled, the contact list must include at least one phone number.
*/
EmergencyContactList?: EmergencyContactList;
}
export interface UpdateEmergencyContactSettingsResponse {
}
export interface UpdateSubscriptionRequest {
/**
* When you initally create a subscription, AutoRenew is set to ENABLED. If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.
*/
AutoRenew?: AutoRenew;
}
export interface UpdateSubscriptionResponse {
}
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2016-06-02"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the Shield client.
*/
export import Types = Shield;
}
export = Shield;