@aws-sdk/client-shield 3.533.0 → 3.536.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (77) hide show
  1. package/dist-types/Shield.d.ts +17 -1
  2. package/dist-types/ShieldClient.d.ts +1 -1
  3. package/dist-types/commands/AssociateDRTLogBucketCommand.d.ts +2 -1
  4. package/dist-types/commands/AssociateDRTRoleCommand.d.ts +2 -1
  5. package/dist-types/commands/AssociateHealthCheckCommand.d.ts +2 -1
  6. package/dist-types/commands/AssociateProactiveEngagementDetailsCommand.d.ts +2 -1
  7. package/dist-types/commands/CreateProtectionCommand.d.ts +2 -1
  8. package/dist-types/commands/CreateProtectionGroupCommand.d.ts +2 -1
  9. package/dist-types/commands/CreateSubscriptionCommand.d.ts +2 -1
  10. package/dist-types/commands/DeleteProtectionCommand.d.ts +2 -1
  11. package/dist-types/commands/DeleteProtectionGroupCommand.d.ts +2 -1
  12. package/dist-types/commands/DeleteSubscriptionCommand.d.ts +4 -3
  13. package/dist-types/commands/DescribeAttackCommand.d.ts +2 -1
  14. package/dist-types/commands/DescribeAttackStatisticsCommand.d.ts +2 -1
  15. package/dist-types/commands/DescribeDRTAccessCommand.d.ts +2 -1
  16. package/dist-types/commands/DescribeEmergencyContactSettingsCommand.d.ts +2 -1
  17. package/dist-types/commands/DescribeProtectionCommand.d.ts +2 -1
  18. package/dist-types/commands/DescribeProtectionGroupCommand.d.ts +2 -1
  19. package/dist-types/commands/DescribeSubscriptionCommand.d.ts +2 -1
  20. package/dist-types/commands/DisableApplicationLayerAutomaticResponseCommand.d.ts +2 -1
  21. package/dist-types/commands/DisableProactiveEngagementCommand.d.ts +2 -1
  22. package/dist-types/commands/DisassociateDRTLogBucketCommand.d.ts +2 -1
  23. package/dist-types/commands/DisassociateDRTRoleCommand.d.ts +2 -1
  24. package/dist-types/commands/DisassociateHealthCheckCommand.d.ts +2 -1
  25. package/dist-types/commands/EnableApplicationLayerAutomaticResponseCommand.d.ts +2 -1
  26. package/dist-types/commands/EnableProactiveEngagementCommand.d.ts +2 -1
  27. package/dist-types/commands/GetSubscriptionStateCommand.d.ts +2 -1
  28. package/dist-types/commands/ListAttacksCommand.d.ts +2 -1
  29. package/dist-types/commands/ListProtectionGroupsCommand.d.ts +2 -1
  30. package/dist-types/commands/ListProtectionsCommand.d.ts +2 -1
  31. package/dist-types/commands/ListResourcesInProtectionGroupCommand.d.ts +2 -1
  32. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  33. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  34. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  35. package/dist-types/commands/UpdateApplicationLayerAutomaticResponseCommand.d.ts +2 -1
  36. package/dist-types/commands/UpdateEmergencyContactSettingsCommand.d.ts +2 -1
  37. package/dist-types/commands/UpdateProtectionGroupCommand.d.ts +2 -1
  38. package/dist-types/commands/UpdateSubscriptionCommand.d.ts +2 -1
  39. package/dist-types/models/models_0.d.ts +213 -213
  40. package/dist-types/ts3.4/Shield.d.ts +16 -0
  41. package/dist-types/ts3.4/commands/AssociateDRTLogBucketCommand.d.ts +9 -0
  42. package/dist-types/ts3.4/commands/AssociateDRTRoleCommand.d.ts +9 -0
  43. package/dist-types/ts3.4/commands/AssociateHealthCheckCommand.d.ts +9 -0
  44. package/dist-types/ts3.4/commands/AssociateProactiveEngagementDetailsCommand.d.ts +9 -0
  45. package/dist-types/ts3.4/commands/CreateProtectionCommand.d.ts +9 -0
  46. package/dist-types/ts3.4/commands/CreateProtectionGroupCommand.d.ts +9 -0
  47. package/dist-types/ts3.4/commands/CreateSubscriptionCommand.d.ts +9 -0
  48. package/dist-types/ts3.4/commands/DeleteProtectionCommand.d.ts +9 -0
  49. package/dist-types/ts3.4/commands/DeleteProtectionGroupCommand.d.ts +9 -0
  50. package/dist-types/ts3.4/commands/DeleteSubscriptionCommand.d.ts +9 -0
  51. package/dist-types/ts3.4/commands/DescribeAttackCommand.d.ts +9 -0
  52. package/dist-types/ts3.4/commands/DescribeAttackStatisticsCommand.d.ts +9 -0
  53. package/dist-types/ts3.4/commands/DescribeDRTAccessCommand.d.ts +9 -0
  54. package/dist-types/ts3.4/commands/DescribeEmergencyContactSettingsCommand.d.ts +9 -0
  55. package/dist-types/ts3.4/commands/DescribeProtectionCommand.d.ts +9 -0
  56. package/dist-types/ts3.4/commands/DescribeProtectionGroupCommand.d.ts +9 -0
  57. package/dist-types/ts3.4/commands/DescribeSubscriptionCommand.d.ts +9 -0
  58. package/dist-types/ts3.4/commands/DisableApplicationLayerAutomaticResponseCommand.d.ts +9 -0
  59. package/dist-types/ts3.4/commands/DisableProactiveEngagementCommand.d.ts +9 -0
  60. package/dist-types/ts3.4/commands/DisassociateDRTLogBucketCommand.d.ts +9 -0
  61. package/dist-types/ts3.4/commands/DisassociateDRTRoleCommand.d.ts +9 -0
  62. package/dist-types/ts3.4/commands/DisassociateHealthCheckCommand.d.ts +9 -0
  63. package/dist-types/ts3.4/commands/EnableApplicationLayerAutomaticResponseCommand.d.ts +9 -0
  64. package/dist-types/ts3.4/commands/EnableProactiveEngagementCommand.d.ts +9 -0
  65. package/dist-types/ts3.4/commands/GetSubscriptionStateCommand.d.ts +9 -0
  66. package/dist-types/ts3.4/commands/ListAttacksCommand.d.ts +9 -0
  67. package/dist-types/ts3.4/commands/ListProtectionGroupsCommand.d.ts +9 -0
  68. package/dist-types/ts3.4/commands/ListProtectionsCommand.d.ts +9 -0
  69. package/dist-types/ts3.4/commands/ListResourcesInProtectionGroupCommand.d.ts +9 -0
  70. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  71. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  72. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  73. package/dist-types/ts3.4/commands/UpdateApplicationLayerAutomaticResponseCommand.d.ts +9 -0
  74. package/dist-types/ts3.4/commands/UpdateEmergencyContactSettingsCommand.d.ts +9 -0
  75. package/dist-types/ts3.4/commands/UpdateProtectionGroupCommand.d.ts +9 -0
  76. package/dist-types/ts3.4/commands/UpdateSubscriptionCommand.d.ts +9 -0
  77. package/package.json +40 -40
@@ -1,8 +1,8 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { ShieldServiceException as __BaseException } from "./ShieldServiceException";
3
3
  /**
4
- * @public
5
4
  * <p>Exception that indicates the specified <code>AttackId</code> does not exist, or the requester does not have the appropriate permissions to access the <code>AttackId</code>.</p>
5
+ * @public
6
6
  */
7
7
  export declare class AccessDeniedException extends __BaseException {
8
8
  readonly name: "AccessDeniedException";
@@ -13,8 +13,8 @@ export declare class AccessDeniedException extends __BaseException {
13
13
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
14
14
  }
15
15
  /**
16
- * @public
17
16
  * <p>In order to grant the necessary access to the Shield Response Team (SRT) the user submitting the request must have the <code>iam:PassRole</code> permission. This error indicates the user did not have the appropriate permissions. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html">Granting a User Permissions to Pass a Role to an Amazon Web Services Service</a>. </p>
17
+ * @public
18
18
  */
19
19
  export declare class AccessDeniedForDependencyException extends __BaseException {
20
20
  readonly name: "AccessDeniedForDependencyException";
@@ -25,40 +25,40 @@ export declare class AccessDeniedForDependencyException extends __BaseException
25
25
  constructor(opts: __ExceptionOptionType<AccessDeniedForDependencyException, __BaseException>);
26
26
  }
27
27
  /**
28
- * @public
29
28
  * <p>Specifies that Shield Advanced should configure its WAF rules with the WAF <code>Block</code> action. </p>
30
29
  * <p>This is only used in the context of the <code>ResponseAction</code> setting. </p>
31
30
  * <p>JSON specification: <code>"Block": \{\}</code>
32
31
  * </p>
32
+ * @public
33
33
  */
34
34
  export interface BlockAction {
35
35
  }
36
36
  /**
37
- * @public
38
37
  * <p>Specifies that Shield Advanced should configure its WAF rules with the WAF <code>Count</code> action. </p>
39
38
  * <p>This is only used in the context of the <code>ResponseAction</code> setting. </p>
40
39
  * <p>JSON specification: <code>"Count": \{\}</code>
41
40
  * </p>
41
+ * @public
42
42
  */
43
43
  export interface CountAction {
44
44
  }
45
45
  /**
46
- * @public
47
46
  * <p>Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the
48
47
  * protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature,
49
48
  * 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>
49
+ * @public
50
50
  */
51
51
  export interface ResponseAction {
52
52
  /**
53
- * @public
54
53
  * <p>Specifies that Shield Advanced should configure its WAF rules with the WAF <code>Block</code> action. </p>
55
54
  * <p>You must specify exactly one action, either <code>Block</code> or <code>Count</code>.</p>
55
+ * @public
56
56
  */
57
57
  Block?: BlockAction;
58
58
  /**
59
- * @public
60
59
  * <p>Specifies that Shield Advanced should configure its WAF rules with the WAF <code>Count</code> action. </p>
61
60
  * <p>You must specify exactly one action, either <code>Block</code> or <code>Count</code>.</p>
61
+ * @public
62
62
  */
63
63
  Count?: CountAction;
64
64
  }
@@ -75,22 +75,22 @@ export declare const ApplicationLayerAutomaticResponseStatus: {
75
75
  */
76
76
  export type ApplicationLayerAutomaticResponseStatus = (typeof ApplicationLayerAutomaticResponseStatus)[keyof typeof ApplicationLayerAutomaticResponseStatus];
77
77
  /**
78
- * @public
79
78
  * <p>The automatic application layer DDoS mitigation settings for a <a>Protection</a>.
80
79
  * This configuration determines whether Shield Advanced automatically
81
80
  * manages rules in the web ACL in order to respond to application layer events that Shield Advanced determines to be DDoS attacks. </p>
81
+ * @public
82
82
  */
83
83
  export interface ApplicationLayerAutomaticResponseConfiguration {
84
84
  /**
85
- * @public
86
85
  * <p>Indicates whether automatic application layer DDoS mitigation is enabled for the protection. </p>
86
+ * @public
87
87
  */
88
88
  Status: ApplicationLayerAutomaticResponseStatus | undefined;
89
89
  /**
90
- * @public
91
90
  * <p>Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the
92
91
  * protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature,
93
92
  * 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>
93
+ * @public
94
94
  */
95
95
  Action: ResponseAction | undefined;
96
96
  }
@@ -99,8 +99,8 @@ export interface ApplicationLayerAutomaticResponseConfiguration {
99
99
  */
100
100
  export interface AssociateDRTLogBucketRequest {
101
101
  /**
102
- * @public
103
102
  * <p>The Amazon S3 bucket that contains the logs that you want to share.</p>
103
+ * @public
104
104
  */
105
105
  LogBucket: string | undefined;
106
106
  }
@@ -110,8 +110,8 @@ export interface AssociateDRTLogBucketRequest {
110
110
  export interface AssociateDRTLogBucketResponse {
111
111
  }
112
112
  /**
113
- * @public
114
113
  * <p>Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.</p>
114
+ * @public
115
115
  */
116
116
  export declare class InternalErrorException extends __BaseException {
117
117
  readonly name: "InternalErrorException";
@@ -122,8 +122,8 @@ export declare class InternalErrorException extends __BaseException {
122
122
  constructor(opts: __ExceptionOptionType<InternalErrorException, __BaseException>);
123
123
  }
124
124
  /**
125
- * @public
126
125
  * <p>Exception that indicates that the operation would not cause any change to occur.</p>
126
+ * @public
127
127
  */
128
128
  export declare class InvalidOperationException extends __BaseException {
129
129
  readonly name: "InvalidOperationException";
@@ -134,18 +134,18 @@ export declare class InvalidOperationException extends __BaseException {
134
134
  constructor(opts: __ExceptionOptionType<InvalidOperationException, __BaseException>);
135
135
  }
136
136
  /**
137
- * @public
138
137
  * <p>Provides information about a particular parameter passed inside a request that resulted in an exception.</p>
138
+ * @public
139
139
  */
140
140
  export interface ValidationExceptionField {
141
141
  /**
142
- * @public
143
142
  * <p>The name of the parameter that failed validation.</p>
143
+ * @public
144
144
  */
145
145
  name: string | undefined;
146
146
  /**
147
- * @public
148
147
  * <p>The message describing why the parameter failed validation.</p>
148
+ * @public
149
149
  */
150
150
  message: string | undefined;
151
151
  }
@@ -162,20 +162,20 @@ export declare const ValidationExceptionReason: {
162
162
  */
163
163
  export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
164
164
  /**
165
- * @public
166
165
  * <p>Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties. </p>
166
+ * @public
167
167
  */
168
168
  export declare class InvalidParameterException extends __BaseException {
169
169
  readonly name: "InvalidParameterException";
170
170
  readonly $fault: "client";
171
171
  /**
172
- * @public
173
172
  * <p>Additional information about the exception.</p>
173
+ * @public
174
174
  */
175
175
  reason?: ValidationExceptionReason;
176
176
  /**
177
- * @public
178
177
  * <p>Fields that caused the exception.</p>
178
+ * @public
179
179
  */
180
180
  fields?: ValidationExceptionField[];
181
181
  /**
@@ -184,20 +184,20 @@ export declare class InvalidParameterException extends __BaseException {
184
184
  constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
185
185
  }
186
186
  /**
187
- * @public
188
187
  * <p>Exception that indicates that the operation would exceed a limit.</p>
188
+ * @public
189
189
  */
190
190
  export declare class LimitsExceededException extends __BaseException {
191
191
  readonly name: "LimitsExceededException";
192
192
  readonly $fault: "client";
193
193
  /**
194
- * @public
195
194
  * <p>The type of limit that would be exceeded.</p>
195
+ * @public
196
196
  */
197
197
  Type?: string;
198
198
  /**
199
- * @public
200
199
  * <p>The threshold that would be exceeded.</p>
200
+ * @public
201
201
  */
202
202
  Limit?: number;
203
203
  /**
@@ -206,8 +206,8 @@ export declare class LimitsExceededException extends __BaseException {
206
206
  constructor(opts: __ExceptionOptionType<LimitsExceededException, __BaseException>);
207
207
  }
208
208
  /**
209
- * @public
210
209
  * <p>The ARN of the role that you specified does not exist.</p>
210
+ * @public
211
211
  */
212
212
  export declare class NoAssociatedRoleException extends __BaseException {
213
213
  readonly name: "NoAssociatedRoleException";
@@ -218,9 +218,9 @@ export declare class NoAssociatedRoleException extends __BaseException {
218
218
  constructor(opts: __ExceptionOptionType<NoAssociatedRoleException, __BaseException>);
219
219
  }
220
220
  /**
221
- * @public
222
221
  * <p>Exception that indicates that the resource state has been modified by another
223
222
  * client. Retrieve the resource and then retry your request.</p>
223
+ * @public
224
224
  */
225
225
  export declare class OptimisticLockException extends __BaseException {
226
226
  readonly name: "OptimisticLockException";
@@ -231,15 +231,15 @@ export declare class OptimisticLockException extends __BaseException {
231
231
  constructor(opts: __ExceptionOptionType<OptimisticLockException, __BaseException>);
232
232
  }
233
233
  /**
234
- * @public
235
234
  * <p>Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties. </p>
235
+ * @public
236
236
  */
237
237
  export declare class ResourceNotFoundException extends __BaseException {
238
238
  readonly name: "ResourceNotFoundException";
239
239
  readonly $fault: "client";
240
240
  /**
241
- * @public
242
241
  * <p>Type of resource.</p>
242
+ * @public
243
243
  */
244
244
  resourceType?: string;
245
245
  /**
@@ -252,9 +252,9 @@ export declare class ResourceNotFoundException extends __BaseException {
252
252
  */
253
253
  export interface AssociateDRTRoleRequest {
254
254
  /**
255
- * @public
256
255
  * <p>The Amazon Resource Name (ARN) of the role the SRT will use to access your Amazon Web Services account.</p>
257
256
  * <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>
257
+ * @public
258
258
  */
259
259
  RoleArn: string | undefined;
260
260
  }
@@ -268,13 +268,13 @@ export interface AssociateDRTRoleResponse {
268
268
  */
269
269
  export interface AssociateHealthCheckRequest {
270
270
  /**
271
- * @public
272
271
  * <p>The unique identifier (ID) for the <a>Protection</a> object to add the health check association to. </p>
272
+ * @public
273
273
  */
274
274
  ProtectionId: string | undefined;
275
275
  /**
276
- * @public
277
276
  * <p>The Amazon Resource Name (ARN) of the health check to associate with the protection.</p>
277
+ * @public
278
278
  */
279
279
  HealthCheckArn: string | undefined;
280
280
  }
@@ -284,8 +284,8 @@ export interface AssociateHealthCheckRequest {
284
284
  export interface AssociateHealthCheckResponse {
285
285
  }
286
286
  /**
287
- * @public
288
287
  * <p>Exception that indicates that the resource is invalid. You might not have access to the resource, or the resource might not exist.</p>
288
+ * @public
289
289
  */
290
290
  export declare class InvalidResourceException extends __BaseException {
291
291
  readonly name: "InvalidResourceException";
@@ -296,23 +296,23 @@ export declare class InvalidResourceException extends __BaseException {
296
296
  constructor(opts: __ExceptionOptionType<InvalidResourceException, __BaseException>);
297
297
  }
298
298
  /**
299
- * @public
300
299
  * <p>Contact information that the SRT can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.</p>
300
+ * @public
301
301
  */
302
302
  export interface EmergencyContact {
303
303
  /**
304
- * @public
305
304
  * <p>The email address for the contact.</p>
305
+ * @public
306
306
  */
307
307
  EmailAddress: string | undefined;
308
308
  /**
309
- * @public
310
309
  * <p>The phone number for the contact.</p>
310
+ * @public
311
311
  */
312
312
  PhoneNumber?: string;
313
313
  /**
314
- * @public
315
314
  * <p>Additional notes regarding the contact. </p>
315
+ * @public
316
316
  */
317
317
  ContactNotes?: string;
318
318
  }
@@ -321,12 +321,12 @@ export interface EmergencyContact {
321
321
  */
322
322
  export interface AssociateProactiveEngagementDetailsRequest {
323
323
  /**
324
- * @public
325
324
  * <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>
326
325
  * <p>To enable proactive engagement, the contact list must include at least one phone number.</p>
327
326
  * <note>
328
327
  * <p>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 <code>DescribeEmergencyContactSettings</code> and then provide it here. </p>
329
328
  * </note>
329
+ * @public
330
330
  */
331
331
  EmergencyContactList: EmergencyContact[] | undefined;
332
332
  }
@@ -336,38 +336,38 @@ export interface AssociateProactiveEngagementDetailsRequest {
336
336
  export interface AssociateProactiveEngagementDetailsResponse {
337
337
  }
338
338
  /**
339
- * @public
340
339
  * <p>The counter that describes a DDoS attack.</p>
340
+ * @public
341
341
  */
342
342
  export interface SummarizedCounter {
343
343
  /**
344
- * @public
345
344
  * <p>The counter name.</p>
345
+ * @public
346
346
  */
347
347
  Name?: string;
348
348
  /**
349
- * @public
350
349
  * <p>The maximum value of the counter for a specified time period.</p>
350
+ * @public
351
351
  */
352
352
  Max?: number;
353
353
  /**
354
- * @public
355
354
  * <p>The average value of the counter for a specified time period.</p>
355
+ * @public
356
356
  */
357
357
  Average?: number;
358
358
  /**
359
- * @public
360
359
  * <p>The total of counter values for a specified time period.</p>
360
+ * @public
361
361
  */
362
362
  Sum?: number;
363
363
  /**
364
- * @public
365
364
  * <p>The number of counters for a specified time period.</p>
365
+ * @public
366
366
  */
367
367
  N?: number;
368
368
  /**
369
- * @public
370
369
  * <p>The unit of the counters.</p>
370
+ * @public
371
371
  */
372
372
  Unit?: string;
373
373
  }
@@ -402,18 +402,18 @@ export declare const AttackPropertyIdentifier: {
402
402
  */
403
403
  export type AttackPropertyIdentifier = (typeof AttackPropertyIdentifier)[keyof typeof AttackPropertyIdentifier];
404
404
  /**
405
- * @public
406
405
  * <p>A contributor to the attack and their contribution. </p>
406
+ * @public
407
407
  */
408
408
  export interface Contributor {
409
409
  /**
410
- * @public
411
410
  * <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>
411
+ * @public
412
412
  */
413
413
  Name?: string;
414
414
  /**
415
- * @public
416
415
  * <p>The contribution of this contributor expressed in <a>Protection</a> units. For example <code>10,000</code>.</p>
416
+ * @public
417
417
  */
418
418
  Value?: number;
419
419
  }
@@ -432,68 +432,68 @@ export declare const Unit: {
432
432
  */
433
433
  export type Unit = (typeof Unit)[keyof typeof Unit];
434
434
  /**
435
- * @public
436
435
  * <p>Details of a Shield event. This is provided as part of an <a>AttackDetail</a>.</p>
436
+ * @public
437
437
  */
438
438
  export interface AttackProperty {
439
439
  /**
440
- * @public
441
440
  * <p>The type of Shield event that was observed. <code>NETWORK</code> indicates layer 3 and layer 4 events and <code>APPLICATION</code>
442
441
  * indicates layer 7 events.</p>
443
442
  * <p>For infrastructure
444
443
  * layer events (L3 and L4 events), you can view metrics for top contributors in Amazon CloudWatch metrics.
445
444
  * For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#set-ddos-alarms">Shield metrics and alarms</a>
446
445
  * in the <i>WAF Developer Guide</i>. </p>
446
+ * @public
447
447
  */
448
448
  AttackLayer?: AttackLayer;
449
449
  /**
450
- * @public
451
450
  * <p>Defines the Shield event property information that is provided. The
452
451
  * <code>WORDPRESS_PINGBACK_REFLECTOR</code> and <code>WORDPRESS_PINGBACK_SOURCE</code>
453
452
  * values are valid only for WordPress reflective pingback events.</p>
453
+ * @public
454
454
  */
455
455
  AttackPropertyIdentifier?: AttackPropertyIdentifier;
456
456
  /**
457
- * @public
458
457
  * <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>
458
+ * @public
459
459
  */
460
460
  TopContributors?: Contributor[];
461
461
  /**
462
- * @public
463
462
  * <p>The unit used for the <code>Contributor</code>
464
463
  * <code>Value</code> property. </p>
464
+ * @public
465
465
  */
466
466
  Unit?: Unit;
467
467
  /**
468
- * @public
469
468
  * <p>The total contributions made to this Shield event by all contributors.</p>
469
+ * @public
470
470
  */
471
471
  Total?: number;
472
472
  }
473
473
  /**
474
- * @public
475
474
  * <p>The mitigation applied to a DDoS attack.</p>
475
+ * @public
476
476
  */
477
477
  export interface Mitigation {
478
478
  /**
479
- * @public
480
479
  * <p>The name of the mitigation taken for this attack.</p>
480
+ * @public
481
481
  */
482
482
  MitigationName?: string;
483
483
  }
484
484
  /**
485
- * @public
486
485
  * <p>A summary of information about the attack.</p>
486
+ * @public
487
487
  */
488
488
  export interface SummarizedAttackVector {
489
489
  /**
490
- * @public
491
490
  * <p>The attack type, for example, SNMP reflection or SYN flood.</p>
491
+ * @public
492
492
  */
493
493
  VectorType: string | undefined;
494
494
  /**
495
- * @public
496
495
  * <p>The list of counters that describe the details of the attack.</p>
496
+ * @public
497
497
  */
498
498
  VectorCounters?: SummarizedCounter[];
499
499
  }
@@ -510,136 +510,135 @@ export declare const SubResourceType: {
510
510
  */
511
511
  export type SubResourceType = (typeof SubResourceType)[keyof typeof SubResourceType];
512
512
  /**
513
- * @public
514
513
  * <p>The attack information for the specified SubResource.</p>
514
+ * @public
515
515
  */
516
516
  export interface SubResourceSummary {
517
517
  /**
518
- * @public
519
518
  * <p>The <code>SubResource</code> type.</p>
519
+ * @public
520
520
  */
521
521
  Type?: SubResourceType;
522
522
  /**
523
- * @public
524
523
  * <p>The unique identifier (ID) of the <code>SubResource</code>.</p>
524
+ * @public
525
525
  */
526
526
  Id?: string;
527
527
  /**
528
- * @public
529
528
  * <p>The list of attack types and associated counters.</p>
529
+ * @public
530
530
  */
531
531
  AttackVectors?: SummarizedAttackVector[];
532
532
  /**
533
- * @public
534
533
  * <p>The counters that describe the details of the attack.</p>
534
+ * @public
535
535
  */
536
536
  Counters?: SummarizedCounter[];
537
537
  }
538
538
  /**
539
- * @public
540
539
  * <p>The details of a DDoS attack.</p>
540
+ * @public
541
541
  */
542
542
  export interface AttackDetail {
543
543
  /**
544
- * @public
545
544
  * <p>The unique identifier (ID) of the attack.</p>
545
+ * @public
546
546
  */
547
547
  AttackId?: string;
548
548
  /**
549
- * @public
550
549
  * <p>The ARN (Amazon Resource Name) of the resource that was attacked.</p>
550
+ * @public
551
551
  */
552
552
  ResourceArn?: string;
553
553
  /**
554
- * @public
555
554
  * <p>If applicable, additional detail about the resource being attacked, for example, IP address or URL.</p>
555
+ * @public
556
556
  */
557
557
  SubResources?: SubResourceSummary[];
558
558
  /**
559
- * @public
560
559
  * <p>The time the attack started, in Unix time in seconds. </p>
560
+ * @public
561
561
  */
562
562
  StartTime?: Date;
563
563
  /**
564
- * @public
565
564
  * <p>The time the attack ended, in Unix time in seconds. </p>
565
+ * @public
566
566
  */
567
567
  EndTime?: Date;
568
568
  /**
569
- * @public
570
569
  * <p>List of counters that describe the attack for the specified time period.</p>
570
+ * @public
571
571
  */
572
572
  AttackCounters?: SummarizedCounter[];
573
573
  /**
574
- * @public
575
574
  * <p>The array of objects that provide details of the Shield event. </p>
576
575
  * <p>For infrastructure
577
576
  * layer events (L3 and L4 events), you can view metrics for top contributors in Amazon CloudWatch metrics.
578
577
  * For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#set-ddos-alarms">Shield metrics and alarms</a>
579
578
  * in the <i>WAF Developer Guide</i>. </p>
579
+ * @public
580
580
  */
581
581
  AttackProperties?: AttackProperty[];
582
582
  /**
583
- * @public
584
583
  * <p>List of mitigation actions taken for the attack.</p>
584
+ * @public
585
585
  */
586
586
  Mitigations?: Mitigation[];
587
587
  }
588
588
  /**
589
- * @public
590
589
  * <p>Statistics objects for the various data types in <a>AttackVolume</a>. </p>
590
+ * @public
591
591
  */
592
592
  export interface AttackVolumeStatistics {
593
593
  /**
594
- * @public
595
594
  * <p>The maximum attack volume observed for the given unit.</p>
595
+ * @public
596
596
  */
597
597
  Max: number | undefined;
598
598
  }
599
599
  /**
600
- * @public
601
600
  * <p>Information about the volume of attacks during the time period, included in an <a>AttackStatisticsDataItem</a>. If the accompanying <code>AttackCount</code> in the statistics object is zero, this setting might be empty.</p>
601
+ * @public
602
602
  */
603
603
  export interface AttackVolume {
604
604
  /**
605
- * @public
606
605
  * <p>A statistics object that uses bits per second as the unit. This is included for network level attacks. </p>
606
+ * @public
607
607
  */
608
608
  BitsPerSecond?: AttackVolumeStatistics;
609
609
  /**
610
- * @public
611
610
  * <p>A statistics object that uses packets per second as the unit. This is included for network level attacks. </p>
611
+ * @public
612
612
  */
613
613
  PacketsPerSecond?: AttackVolumeStatistics;
614
614
  /**
615
- * @public
616
615
  * <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>
616
+ * @public
617
617
  */
618
618
  RequestsPerSecond?: AttackVolumeStatistics;
619
619
  }
620
620
  /**
621
- * @public
622
621
  * <p>A single attack statistics data record. This is returned by <a>DescribeAttackStatistics</a> along with a time range indicating the time period that the attack statistics apply to. </p>
622
+ * @public
623
623
  */
624
624
  export interface AttackStatisticsDataItem {
625
625
  /**
626
- * @public
627
626
  * <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>
627
+ * @public
628
628
  */
629
629
  AttackVolume?: AttackVolume;
630
630
  /**
631
- * @public
632
631
  * <p>The number of attacks detected during the time period. This is always present, but might be zero. </p>
632
+ * @public
633
633
  */
634
634
  AttackCount: number | undefined;
635
635
  }
636
636
  /**
637
- * @public
638
637
  * <p>Describes the attack.</p>
638
+ * @public
639
639
  */
640
640
  export interface AttackVectorDescription {
641
641
  /**
642
- * @public
643
642
  * <p>The attack type. Valid values:</p>
644
643
  * <ul>
645
644
  * <li>
@@ -697,37 +696,38 @@ export interface AttackVectorDescription {
697
696
  * <p>MEMCACHED_REFLECTION</p>
698
697
  * </li>
699
698
  * </ul>
699
+ * @public
700
700
  */
701
701
  VectorType: string | undefined;
702
702
  }
703
703
  /**
704
- * @public
705
704
  * <p>Summarizes all DDoS attacks for a specified time period.</p>
705
+ * @public
706
706
  */
707
707
  export interface AttackSummary {
708
708
  /**
709
- * @public
710
709
  * <p>The unique identifier (ID) of the attack.</p>
710
+ * @public
711
711
  */
712
712
  AttackId?: string;
713
713
  /**
714
- * @public
715
714
  * <p>The ARN (Amazon Resource Name) of the resource that was attacked.</p>
715
+ * @public
716
716
  */
717
717
  ResourceArn?: string;
718
718
  /**
719
- * @public
720
719
  * <p>The start time of the attack, in Unix time in seconds. </p>
720
+ * @public
721
721
  */
722
722
  StartTime?: Date;
723
723
  /**
724
- * @public
725
724
  * <p>The end time of the attack, in Unix time in seconds. </p>
725
+ * @public
726
726
  */
727
727
  EndTime?: Date;
728
728
  /**
729
- * @public
730
729
  * <p>The list of attacks for a specified time period.</p>
730
+ * @public
731
731
  */
732
732
  AttackVectors?: AttackVectorDescription[];
733
733
  }
@@ -744,18 +744,18 @@ export declare const AutoRenew: {
744
744
  */
745
745
  export type AutoRenew = (typeof AutoRenew)[keyof typeof AutoRenew];
746
746
  /**
747
- * @public
748
747
  * <p>A tag associated with an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as "environment", and the tag value represents a specific value within that category, such as "test," "development," or "production". Or you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.</p>
748
+ * @public
749
749
  */
750
750
  export interface Tag {
751
751
  /**
752
- * @public
753
752
  * <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>
753
+ * @public
754
754
  */
755
755
  Key?: string;
756
756
  /**
757
- * @public
758
757
  * <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>
758
+ * @public
759
759
  */
760
760
  Value?: string;
761
761
  }
@@ -764,12 +764,11 @@ export interface Tag {
764
764
  */
765
765
  export interface CreateProtectionRequest {
766
766
  /**
767
- * @public
768
767
  * <p>Friendly name for the <code>Protection</code> you are creating.</p>
768
+ * @public
769
769
  */
770
770
  Name: string | undefined;
771
771
  /**
772
- * @public
773
772
  * <p>The ARN (Amazon Resource Name) of the resource to be protected.</p>
774
773
  * <p>The ARN should be in one of the following formats:</p>
775
774
  * <ul>
@@ -804,11 +803,12 @@ export interface CreateProtectionRequest {
804
803
  * </p>
805
804
  * </li>
806
805
  * </ul>
806
+ * @public
807
807
  */
808
808
  ResourceArn: string | undefined;
809
809
  /**
810
- * @public
811
810
  * <p>One or more tag key-value pairs for the <a>Protection</a> object that is created.</p>
811
+ * @public
812
812
  */
813
813
  Tags?: Tag[];
814
814
  }
@@ -817,21 +817,21 @@ export interface CreateProtectionRequest {
817
817
  */
818
818
  export interface CreateProtectionResponse {
819
819
  /**
820
- * @public
821
820
  * <p>The unique identifier (ID) for the <a>Protection</a> object that is created.</p>
821
+ * @public
822
822
  */
823
823
  ProtectionId?: string;
824
824
  }
825
825
  /**
826
- * @public
827
826
  * <p>Exception indicating the specified resource already exists. If available, this exception includes details in additional properties. </p>
827
+ * @public
828
828
  */
829
829
  export declare class ResourceAlreadyExistsException extends __BaseException {
830
830
  readonly name: "ResourceAlreadyExistsException";
831
831
  readonly $fault: "client";
832
832
  /**
833
- * @public
834
833
  * <p>The type of resource that already exists.</p>
834
+ * @public
835
835
  */
836
836
  resourceType?: string;
837
837
  /**
@@ -886,12 +886,11 @@ export type ProtectedResourceType = (typeof ProtectedResourceType)[keyof typeof
886
886
  */
887
887
  export interface CreateProtectionGroupRequest {
888
888
  /**
889
- * @public
890
889
  * <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>
890
+ * @public
891
891
  */
892
892
  ProtectionGroupId: string | undefined;
893
893
  /**
894
- * @public
895
894
  * <p>Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.</p>
896
895
  * <ul>
897
896
  * <li>
@@ -904,27 +903,28 @@ export interface CreateProtectionGroupRequest {
904
903
  * <p>Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront and origin resources for CloudFront distributions.</p>
905
904
  * </li>
906
905
  * </ul>
906
+ * @public
907
907
  */
908
908
  Aggregation: ProtectionGroupAggregation | undefined;
909
909
  /**
910
- * @public
911
910
  * <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>
911
+ * @public
912
912
  */
913
913
  Pattern: ProtectionGroupPattern | undefined;
914
914
  /**
915
- * @public
916
915
  * <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.
917
916
  * 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>
917
+ * @public
918
918
  */
919
919
  ResourceType?: ProtectedResourceType;
920
920
  /**
921
- * @public
922
921
  * <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>
922
+ * @public
923
923
  */
924
924
  Members?: string[];
925
925
  /**
926
- * @public
927
926
  * <p>One or more tag key-value pairs for the protection group.</p>
927
+ * @public
928
928
  */
929
929
  Tags?: Tag[];
930
930
  }
@@ -948,9 +948,9 @@ export interface CreateSubscriptionResponse {
948
948
  */
949
949
  export interface DeleteProtectionRequest {
950
950
  /**
951
- * @public
952
951
  * <p>The unique identifier (ID) for the <a>Protection</a> object to be
953
952
  * deleted.</p>
953
+ * @public
954
954
  */
955
955
  ProtectionId: string | undefined;
956
956
  }
@@ -964,8 +964,8 @@ export interface DeleteProtectionResponse {
964
964
  */
965
965
  export interface DeleteProtectionGroupRequest {
966
966
  /**
967
- * @public
968
967
  * <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>
968
+ * @public
969
969
  */
970
970
  ProtectionGroupId: string | undefined;
971
971
  }
@@ -985,8 +985,8 @@ export interface DeleteSubscriptionRequest {
985
985
  export interface DeleteSubscriptionResponse {
986
986
  }
987
987
  /**
988
- * @public
989
988
  * <p>You are trying to update a subscription that has not yet completed the 1-year commitment. You can change the <code>AutoRenew</code> parameter during the last 30 days of your subscription. This exception indicates that you are attempting to change <code>AutoRenew</code> prior to that period.</p>
989
+ * @public
990
990
  */
991
991
  export declare class LockedSubscriptionException extends __BaseException {
992
992
  readonly name: "LockedSubscriptionException";
@@ -1001,8 +1001,8 @@ export declare class LockedSubscriptionException extends __BaseException {
1001
1001
  */
1002
1002
  export interface DescribeAttackRequest {
1003
1003
  /**
1004
- * @public
1005
1004
  * <p>The unique identifier (ID) for the attack.</p>
1005
+ * @public
1006
1006
  */
1007
1007
  AttackId: string | undefined;
1008
1008
  }
@@ -1011,8 +1011,8 @@ export interface DescribeAttackRequest {
1011
1011
  */
1012
1012
  export interface DescribeAttackResponse {
1013
1013
  /**
1014
- * @public
1015
1014
  * <p>The attack that you requested. </p>
1015
+ * @public
1016
1016
  */
1017
1017
  Attack?: AttackDetail;
1018
1018
  }
@@ -1022,18 +1022,18 @@ export interface DescribeAttackResponse {
1022
1022
  export interface DescribeAttackStatisticsRequest {
1023
1023
  }
1024
1024
  /**
1025
- * @public
1026
1025
  * <p>The time range. </p>
1026
+ * @public
1027
1027
  */
1028
1028
  export interface TimeRange {
1029
1029
  /**
1030
- * @public
1031
1030
  * <p>The start time, in Unix time in seconds. </p>
1031
+ * @public
1032
1032
  */
1033
1033
  FromInclusive?: Date;
1034
1034
  /**
1035
- * @public
1036
1035
  * <p>The end time, in Unix time in seconds. </p>
1036
+ * @public
1037
1037
  */
1038
1038
  ToExclusive?: Date;
1039
1039
  }
@@ -1042,13 +1042,13 @@ export interface TimeRange {
1042
1042
  */
1043
1043
  export interface DescribeAttackStatisticsResponse {
1044
1044
  /**
1045
- * @public
1046
1045
  * <p>The time range of the attack.</p>
1046
+ * @public
1047
1047
  */
1048
1048
  TimeRange: TimeRange | undefined;
1049
1049
  /**
1050
- * @public
1051
1050
  * <p>The data that describes the attacks detected during the time period.</p>
1051
+ * @public
1052
1052
  */
1053
1053
  DataItems: AttackStatisticsDataItem[] | undefined;
1054
1054
  }
@@ -1062,13 +1062,13 @@ export interface DescribeDRTAccessRequest {
1062
1062
  */
1063
1063
  export interface DescribeDRTAccessResponse {
1064
1064
  /**
1065
- * @public
1066
1065
  * <p>The Amazon Resource Name (ARN) of the role the SRT used to access your Amazon Web Services account.</p>
1066
+ * @public
1067
1067
  */
1068
1068
  RoleArn?: string;
1069
1069
  /**
1070
- * @public
1071
1070
  * <p>The list of Amazon S3 buckets accessed by the SRT.</p>
1071
+ * @public
1072
1072
  */
1073
1073
  LogBucketList?: string[];
1074
1074
  }
@@ -1082,8 +1082,8 @@ export interface DescribeEmergencyContactSettingsRequest {
1082
1082
  */
1083
1083
  export interface DescribeEmergencyContactSettingsResponse {
1084
1084
  /**
1085
- * @public
1086
1085
  * <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>
1086
+ * @public
1087
1087
  */
1088
1088
  EmergencyContactList?: EmergencyContact[];
1089
1089
  }
@@ -1092,53 +1092,53 @@ export interface DescribeEmergencyContactSettingsResponse {
1092
1092
  */
1093
1093
  export interface DescribeProtectionRequest {
1094
1094
  /**
1095
- * @public
1096
1095
  * <p>The unique identifier (ID) for the <a>Protection</a> object to describe.
1097
1096
  * You must provide either the <code>ResourceArn</code> of the protected resource or the <code>ProtectionID</code> of the protection, but not both.</p>
1097
+ * @public
1098
1098
  */
1099
1099
  ProtectionId?: string;
1100
1100
  /**
1101
- * @public
1102
1101
  * <p>The ARN (Amazon Resource Name) of the protected Amazon Web Services resource.
1103
1102
  * You must provide either the <code>ResourceArn</code> of the protected resource or the <code>ProtectionID</code> of the protection, but not both.</p>
1103
+ * @public
1104
1104
  */
1105
1105
  ResourceArn?: string;
1106
1106
  }
1107
1107
  /**
1108
- * @public
1109
1108
  * <p>An object that represents a resource that is under DDoS protection.</p>
1109
+ * @public
1110
1110
  */
1111
1111
  export interface Protection {
1112
1112
  /**
1113
- * @public
1114
1113
  * <p>The unique identifier (ID) of the protection.</p>
1114
+ * @public
1115
1115
  */
1116
1116
  Id?: string;
1117
1117
  /**
1118
- * @public
1119
1118
  * <p>The name of the protection. For example, <code>My CloudFront distributions</code>.</p>
1119
+ * @public
1120
1120
  */
1121
1121
  Name?: string;
1122
1122
  /**
1123
- * @public
1124
1123
  * <p>The ARN (Amazon Resource Name) of the Amazon Web Services resource that is protected.</p>
1124
+ * @public
1125
1125
  */
1126
1126
  ResourceArn?: string;
1127
1127
  /**
1128
- * @public
1129
1128
  * <p>The unique identifier (ID) for the Route 53 health check that's associated with the protection. </p>
1129
+ * @public
1130
1130
  */
1131
1131
  HealthCheckIds?: string[];
1132
1132
  /**
1133
- * @public
1134
1133
  * <p>The ARN (Amazon Resource Name) of the protection.</p>
1134
+ * @public
1135
1135
  */
1136
1136
  ProtectionArn?: string;
1137
1137
  /**
1138
- * @public
1139
1138
  * <p>The automatic application layer DDoS mitigation settings for the protection.
1140
1139
  * This configuration determines whether Shield Advanced automatically
1141
1140
  * manages rules in the web ACL in order to respond to application layer events that Shield Advanced determines to be DDoS attacks. </p>
1141
+ * @public
1142
1142
  */
1143
1143
  ApplicationLayerAutomaticResponseConfiguration?: ApplicationLayerAutomaticResponseConfiguration;
1144
1144
  }
@@ -1147,8 +1147,8 @@ export interface Protection {
1147
1147
  */
1148
1148
  export interface DescribeProtectionResponse {
1149
1149
  /**
1150
- * @public
1151
1150
  * <p>The <a>Protection</a> that you requested. </p>
1151
+ * @public
1152
1152
  */
1153
1153
  Protection?: Protection;
1154
1154
  }
@@ -1157,23 +1157,22 @@ export interface DescribeProtectionResponse {
1157
1157
  */
1158
1158
  export interface DescribeProtectionGroupRequest {
1159
1159
  /**
1160
- * @public
1161
1160
  * <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>
1161
+ * @public
1162
1162
  */
1163
1163
  ProtectionGroupId: string | undefined;
1164
1164
  }
1165
1165
  /**
1166
- * @public
1167
1166
  * <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>
1167
+ * @public
1168
1168
  */
1169
1169
  export interface ProtectionGroup {
1170
1170
  /**
1171
- * @public
1172
1171
  * <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>
1172
+ * @public
1173
1173
  */
1174
1174
  ProtectionGroupId: string | undefined;
1175
1175
  /**
1176
- * @public
1177
1176
  * <p>Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.</p>
1178
1177
  * <ul>
1179
1178
  * <li>
@@ -1186,27 +1185,28 @@ export interface ProtectionGroup {
1186
1185
  * <p>Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront distributions and origin resources for CloudFront distributions.</p>
1187
1186
  * </li>
1188
1187
  * </ul>
1188
+ * @public
1189
1189
  */
1190
1190
  Aggregation: ProtectionGroupAggregation | undefined;
1191
1191
  /**
1192
- * @public
1193
1192
  * <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>
1193
+ * @public
1194
1194
  */
1195
1195
  Pattern: ProtectionGroupPattern | undefined;
1196
1196
  /**
1197
- * @public
1198
1197
  * <p>The resource type to include in the protection group. All protected resources of this type are included in the protection group.
1199
1198
  * 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>
1199
+ * @public
1200
1200
  */
1201
1201
  ResourceType?: ProtectedResourceType;
1202
1202
  /**
1203
- * @public
1204
1203
  * <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>
1204
+ * @public
1205
1205
  */
1206
1206
  Members: string[] | undefined;
1207
1207
  /**
1208
- * @public
1209
1208
  * <p>The ARN (Amazon Resource Name) of the protection group.</p>
1209
+ * @public
1210
1210
  */
1211
1211
  ProtectionGroupArn?: string;
1212
1212
  }
@@ -1215,8 +1215,8 @@ export interface ProtectionGroup {
1215
1215
  */
1216
1216
  export interface DescribeProtectionGroupResponse {
1217
1217
  /**
1218
- * @public
1219
1218
  * <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>
1219
+ * @public
1220
1220
  */
1221
1221
  ProtectionGroup: ProtectionGroup | undefined;
1222
1222
  }
@@ -1226,18 +1226,18 @@ export interface DescribeProtectionGroupResponse {
1226
1226
  export interface DescribeSubscriptionRequest {
1227
1227
  }
1228
1228
  /**
1229
- * @public
1230
1229
  * <p>Specifies how many protections of a given type you can create.</p>
1230
+ * @public
1231
1231
  */
1232
1232
  export interface Limit {
1233
1233
  /**
1234
- * @public
1235
1234
  * <p>The type of protection.</p>
1235
+ * @public
1236
1236
  */
1237
1237
  Type?: string;
1238
1238
  /**
1239
- * @public
1240
1239
  * <p>The maximum number of protections that can be created for the specified <code>Type</code>.</p>
1240
+ * @public
1241
1241
  */
1242
1242
  Max?: number;
1243
1243
  }
@@ -1255,116 +1255,116 @@ export declare const ProactiveEngagementStatus: {
1255
1255
  */
1256
1256
  export type ProactiveEngagementStatus = (typeof ProactiveEngagementStatus)[keyof typeof ProactiveEngagementStatus];
1257
1257
  /**
1258
- * @public
1259
1258
  * <p>Limits settings on protection groups with arbitrary pattern type. </p>
1259
+ * @public
1260
1260
  */
1261
1261
  export interface ProtectionGroupArbitraryPatternLimits {
1262
1262
  /**
1263
- * @public
1264
1263
  * <p>The maximum number of resources you can specify for a single arbitrary pattern in a protection group.</p>
1264
+ * @public
1265
1265
  */
1266
1266
  MaxMembers: number | undefined;
1267
1267
  }
1268
1268
  /**
1269
- * @public
1270
1269
  * <p>Limits settings by pattern type in the protection groups for your subscription. </p>
1270
+ * @public
1271
1271
  */
1272
1272
  export interface ProtectionGroupPatternTypeLimits {
1273
1273
  /**
1274
- * @public
1275
1274
  * <p>Limits settings on protection groups with arbitrary pattern type. </p>
1275
+ * @public
1276
1276
  */
1277
1277
  ArbitraryPatternLimits: ProtectionGroupArbitraryPatternLimits | undefined;
1278
1278
  }
1279
1279
  /**
1280
- * @public
1281
1280
  * <p>Limits settings on protection groups for your subscription. </p>
1281
+ * @public
1282
1282
  */
1283
1283
  export interface ProtectionGroupLimits {
1284
1284
  /**
1285
- * @public
1286
1285
  * <p>The maximum number of protection groups that you can have at one time. </p>
1286
+ * @public
1287
1287
  */
1288
1288
  MaxProtectionGroups: number | undefined;
1289
1289
  /**
1290
- * @public
1291
1290
  * <p>Limits settings by pattern type in the protection groups for your subscription. </p>
1291
+ * @public
1292
1292
  */
1293
1293
  PatternTypeLimits: ProtectionGroupPatternTypeLimits | undefined;
1294
1294
  }
1295
1295
  /**
1296
- * @public
1297
1296
  * <p>Limits settings on protections for your subscription. </p>
1297
+ * @public
1298
1298
  */
1299
1299
  export interface ProtectionLimits {
1300
1300
  /**
1301
- * @public
1302
1301
  * <p>The maximum number of resource types that you can specify in a protection.</p>
1302
+ * @public
1303
1303
  */
1304
1304
  ProtectedResourceTypeLimits: Limit[] | undefined;
1305
1305
  }
1306
1306
  /**
1307
- * @public
1308
1307
  * <p>Limits settings for your subscription. </p>
1308
+ * @public
1309
1309
  */
1310
1310
  export interface SubscriptionLimits {
1311
1311
  /**
1312
- * @public
1313
1312
  * <p>Limits settings on protections for your subscription. </p>
1313
+ * @public
1314
1314
  */
1315
1315
  ProtectionLimits: ProtectionLimits | undefined;
1316
1316
  /**
1317
- * @public
1318
1317
  * <p>Limits settings on protection groups for your subscription. </p>
1318
+ * @public
1319
1319
  */
1320
1320
  ProtectionGroupLimits: ProtectionGroupLimits | undefined;
1321
1321
  }
1322
1322
  /**
1323
- * @public
1324
1323
  * <p>Information about the Shield Advanced subscription for an account.</p>
1324
+ * @public
1325
1325
  */
1326
1326
  export interface Subscription {
1327
1327
  /**
1328
- * @public
1329
1328
  * <p>The start time of the subscription, in Unix time in seconds. </p>
1329
+ * @public
1330
1330
  */
1331
1331
  StartTime?: Date;
1332
1332
  /**
1333
- * @public
1334
1333
  * <p>The date and time your subscription will end.</p>
1334
+ * @public
1335
1335
  */
1336
1336
  EndTime?: Date;
1337
1337
  /**
1338
- * @public
1339
1338
  * <p>The length, in seconds, of the Shield Advanced subscription for the account.</p>
1339
+ * @public
1340
1340
  */
1341
1341
  TimeCommitmentInSeconds?: number;
1342
1342
  /**
1343
- * @public
1344
1343
  * <p>If <code>ENABLED</code>, the subscription will be automatically renewed at the end of the existing subscription period.</p>
1345
1344
  * <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>
1345
+ * @public
1346
1346
  */
1347
1347
  AutoRenew?: AutoRenew;
1348
1348
  /**
1349
- * @public
1350
1349
  * <p>Specifies how many protections of a given type you can create.</p>
1350
+ * @public
1351
1351
  */
1352
1352
  Limits?: Limit[];
1353
1353
  /**
1354
- * @public
1355
1354
  * <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>
1356
1355
  * <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>
1357
1356
  * <p>If <code>DISABLED</code>, the SRT will not proactively notify contacts about escalations or to initiate proactive customer support. </p>
1357
+ * @public
1358
1358
  */
1359
1359
  ProactiveEngagementStatus?: ProactiveEngagementStatus;
1360
1360
  /**
1361
- * @public
1362
1361
  * <p>Limits settings for your subscription. </p>
1362
+ * @public
1363
1363
  */
1364
1364
  SubscriptionLimits: SubscriptionLimits | undefined;
1365
1365
  /**
1366
- * @public
1367
1366
  * <p>The ARN (Amazon Resource Name) of the subscription.</p>
1367
+ * @public
1368
1368
  */
1369
1369
  SubscriptionArn?: string;
1370
1370
  }
@@ -1373,8 +1373,8 @@ export interface Subscription {
1373
1373
  */
1374
1374
  export interface DescribeSubscriptionResponse {
1375
1375
  /**
1376
- * @public
1377
1376
  * <p>The Shield Advanced subscription details for an account.</p>
1377
+ * @public
1378
1378
  */
1379
1379
  Subscription?: Subscription;
1380
1380
  }
@@ -1383,8 +1383,8 @@ export interface DescribeSubscriptionResponse {
1383
1383
  */
1384
1384
  export interface DisableApplicationLayerAutomaticResponseRequest {
1385
1385
  /**
1386
- * @public
1387
1386
  * <p>The ARN (Amazon Resource Name) of the protected resource.</p>
1387
+ * @public
1388
1388
  */
1389
1389
  ResourceArn: string | undefined;
1390
1390
  }
@@ -1408,8 +1408,8 @@ export interface DisableProactiveEngagementResponse {
1408
1408
  */
1409
1409
  export interface DisassociateDRTLogBucketRequest {
1410
1410
  /**
1411
- * @public
1412
1411
  * <p>The Amazon S3 bucket that contains the logs that you want to share.</p>
1412
+ * @public
1413
1413
  */
1414
1414
  LogBucket: string | undefined;
1415
1415
  }
@@ -1433,13 +1433,13 @@ export interface DisassociateDRTRoleResponse {
1433
1433
  */
1434
1434
  export interface DisassociateHealthCheckRequest {
1435
1435
  /**
1436
- * @public
1437
1436
  * <p>The unique identifier (ID) for the <a>Protection</a> object to remove the health check association from. </p>
1437
+ * @public
1438
1438
  */
1439
1439
  ProtectionId: string | undefined;
1440
1440
  /**
1441
- * @public
1442
1441
  * <p>The Amazon Resource Name (ARN) of the health check that is associated with the protection.</p>
1442
+ * @public
1443
1443
  */
1444
1444
  HealthCheckArn: string | undefined;
1445
1445
  }
@@ -1453,15 +1453,15 @@ export interface DisassociateHealthCheckResponse {
1453
1453
  */
1454
1454
  export interface EnableApplicationLayerAutomaticResponseRequest {
1455
1455
  /**
1456
- * @public
1457
1456
  * <p>The ARN (Amazon Resource Name) of the protected resource.</p>
1457
+ * @public
1458
1458
  */
1459
1459
  ResourceArn: string | undefined;
1460
1460
  /**
1461
- * @public
1462
1461
  * <p>Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the
1463
1462
  * protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature,
1464
1463
  * 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>
1464
+ * @public
1465
1465
  */
1466
1466
  Action: ResponseAction | undefined;
1467
1467
  }
@@ -1502,8 +1502,8 @@ export type SubscriptionState = (typeof SubscriptionState)[keyof typeof Subscrip
1502
1502
  */
1503
1503
  export interface GetSubscriptionStateResponse {
1504
1504
  /**
1505
- * @public
1506
1505
  * <p>The status of the subscription.</p>
1506
+ * @public
1507
1507
  */
1508
1508
  SubscriptionState: SubscriptionState | undefined;
1509
1509
  }
@@ -1512,25 +1512,24 @@ export interface GetSubscriptionStateResponse {
1512
1512
  */
1513
1513
  export interface ListAttacksRequest {
1514
1514
  /**
1515
- * @public
1516
1515
  * <p>The ARNs (Amazon Resource Names) of the resources that were attacked. If you leave this
1517
1516
  * blank, all applicable resources for this account will be included.</p>
1517
+ * @public
1518
1518
  */
1519
1519
  ResourceArns?: string[];
1520
1520
  /**
1521
- * @public
1522
1521
  * <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,
1523
1522
  * 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>
1523
+ * @public
1524
1524
  */
1525
1525
  StartTime?: TimeRange;
1526
1526
  /**
1527
- * @public
1528
1527
  * <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,
1529
1528
  * 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>
1529
+ * @public
1530
1530
  */
1531
1531
  EndTime?: TimeRange;
1532
1532
  /**
1533
- * @public
1534
1533
  * <p>When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects,
1535
1534
  * 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
1536
1535
  * providing the token that was returned by the prior call in your request. </p>
@@ -1538,14 +1537,15 @@ export interface ListAttacksRequest {
1538
1537
  * setting. Shield Advanced will not return more than <code>MaxResults</code> objects, but may return fewer, even if more objects are still available.</p>
1539
1538
  * <p>Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a <code>NextToken</code> value.</p>
1540
1539
  * <p>On your first call to a list operation, leave this setting empty.</p>
1540
+ * @public
1541
1541
  */
1542
1542
  NextToken?: string;
1543
1543
  /**
1544
- * @public
1545
1544
  * <p>The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects
1546
1545
  * 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
1547
1546
  * in the response.</p>
1548
1547
  * <p>The default setting is 20.</p>
1548
+ * @public
1549
1549
  */
1550
1550
  MaxResults?: number;
1551
1551
  }
@@ -1554,24 +1554,24 @@ export interface ListAttacksRequest {
1554
1554
  */
1555
1555
  export interface ListAttacksResponse {
1556
1556
  /**
1557
- * @public
1558
1557
  * <p>The attack information for the specified time range.</p>
1558
+ * @public
1559
1559
  */
1560
1560
  AttackSummaries?: AttackSummary[];
1561
1561
  /**
1562
- * @public
1563
1562
  * <p>When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects,
1564
1563
  * 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
1565
1564
  * providing the token that was returned by the prior call in your request. </p>
1566
1565
  * <p>You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the <code>MaxResults</code>
1567
1566
  * setting. Shield Advanced will not return more than <code>MaxResults</code> objects, but may return fewer, even if more objects are still available.</p>
1568
1567
  * <p>Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a <code>NextToken</code> value.</p>
1568
+ * @public
1569
1569
  */
1570
1570
  NextToken?: string;
1571
1571
  }
1572
1572
  /**
1573
- * @public
1574
1573
  * <p>Exception that indicates that the <code>NextToken</code> specified in the request is invalid. Submit the request using the <code>NextToken</code> value that was returned in the prior response.</p>
1574
+ * @public
1575
1575
  */
1576
1576
  export declare class InvalidPaginationTokenException extends __BaseException {
1577
1577
  readonly name: "InvalidPaginationTokenException";
@@ -1582,28 +1582,28 @@ export declare class InvalidPaginationTokenException extends __BaseException {
1582
1582
  constructor(opts: __ExceptionOptionType<InvalidPaginationTokenException, __BaseException>);
1583
1583
  }
1584
1584
  /**
1585
- * @public
1586
1585
  * <p>Narrows the set of protection groups that the call retrieves. You can retrieve a single protection group by its name and you can retrieve all protection groups that are configured with a specific pattern, aggregation, or resource type. You can provide up to one criteria per filter type. Shield Advanced returns the protection groups that exactly match all of the search criteria that you provide.</p>
1586
+ * @public
1587
1587
  */
1588
1588
  export interface InclusionProtectionGroupFilters {
1589
1589
  /**
1590
- * @public
1591
1590
  * <p>The ID of the protection group that you want to retrieve. </p>
1591
+ * @public
1592
1592
  */
1593
1593
  ProtectionGroupIds?: string[];
1594
1594
  /**
1595
- * @public
1596
1595
  * <p>The pattern specification of the protection groups that you want to retrieve. </p>
1596
+ * @public
1597
1597
  */
1598
1598
  Patterns?: ProtectionGroupPattern[];
1599
1599
  /**
1600
- * @public
1601
1600
  * <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>
1601
+ * @public
1602
1602
  */
1603
1603
  ResourceTypes?: ProtectedResourceType[];
1604
1604
  /**
1605
- * @public
1606
1605
  * <p>The aggregation setting of the protection groups that you want to retrieve. </p>
1606
+ * @public
1607
1607
  */
1608
1608
  Aggregations?: ProtectionGroupAggregation[];
1609
1609
  }
@@ -1612,7 +1612,6 @@ export interface InclusionProtectionGroupFilters {
1612
1612
  */
1613
1613
  export interface ListProtectionGroupsRequest {
1614
1614
  /**
1615
- * @public
1616
1615
  * <p>When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects,
1617
1616
  * 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
1618
1617
  * providing the token that was returned by the prior call in your request. </p>
@@ -1620,19 +1619,20 @@ export interface ListProtectionGroupsRequest {
1620
1619
  * setting. Shield Advanced will not return more than <code>MaxResults</code> objects, but may return fewer, even if more objects are still available.</p>
1621
1620
  * <p>Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a <code>NextToken</code> value.</p>
1622
1621
  * <p>On your first call to a list operation, leave this setting empty.</p>
1622
+ * @public
1623
1623
  */
1624
1624
  NextToken?: string;
1625
1625
  /**
1626
- * @public
1627
1626
  * <p>The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects
1628
1627
  * 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
1629
1628
  * in the response.</p>
1630
1629
  * <p>The default setting is 20.</p>
1630
+ * @public
1631
1631
  */
1632
1632
  MaxResults?: number;
1633
1633
  /**
1634
- * @public
1635
1634
  * <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>
1635
+ * @public
1636
1636
  */
1637
1637
  InclusionFilters?: InclusionProtectionGroupFilters;
1638
1638
  }
@@ -1641,39 +1641,39 @@ export interface ListProtectionGroupsRequest {
1641
1641
  */
1642
1642
  export interface ListProtectionGroupsResponse {
1643
1643
  /**
1644
- * @public
1645
1644
  * <p></p>
1645
+ * @public
1646
1646
  */
1647
1647
  ProtectionGroups: ProtectionGroup[] | undefined;
1648
1648
  /**
1649
- * @public
1650
1649
  * <p>When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects,
1651
1650
  * 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
1652
1651
  * providing the token that was returned by the prior call in your request. </p>
1653
1652
  * <p>You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the <code>MaxResults</code>
1654
1653
  * setting. Shield Advanced will not return more than <code>MaxResults</code> objects, but may return fewer, even if more objects are still available.</p>
1655
1654
  * <p>Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a <code>NextToken</code> value.</p>
1655
+ * @public
1656
1656
  */
1657
1657
  NextToken?: string;
1658
1658
  }
1659
1659
  /**
1660
- * @public
1661
1660
  * <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>
1661
+ * @public
1662
1662
  */
1663
1663
  export interface InclusionProtectionFilters {
1664
1664
  /**
1665
- * @public
1666
1665
  * <p>The ARN (Amazon Resource Name) of the resource whose protection you want to retrieve. </p>
1666
+ * @public
1667
1667
  */
1668
1668
  ResourceArns?: string[];
1669
1669
  /**
1670
- * @public
1671
1670
  * <p>The name of the protection that you want to retrieve. </p>
1671
+ * @public
1672
1672
  */
1673
1673
  ProtectionNames?: string[];
1674
1674
  /**
1675
- * @public
1676
1675
  * <p>The type of protected resource whose protections you want to retrieve. </p>
1676
+ * @public
1677
1677
  */
1678
1678
  ResourceTypes?: ProtectedResourceType[];
1679
1679
  }
@@ -1682,7 +1682,6 @@ export interface InclusionProtectionFilters {
1682
1682
  */
1683
1683
  export interface ListProtectionsRequest {
1684
1684
  /**
1685
- * @public
1686
1685
  * <p>When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects,
1687
1686
  * 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
1688
1687
  * providing the token that was returned by the prior call in your request. </p>
@@ -1690,19 +1689,20 @@ export interface ListProtectionsRequest {
1690
1689
  * setting. Shield Advanced will not return more than <code>MaxResults</code> objects, but may return fewer, even if more objects are still available.</p>
1691
1690
  * <p>Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a <code>NextToken</code> value.</p>
1692
1691
  * <p>On your first call to a list operation, leave this setting empty.</p>
1692
+ * @public
1693
1693
  */
1694
1694
  NextToken?: string;
1695
1695
  /**
1696
- * @public
1697
1696
  * <p>The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects
1698
1697
  * 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
1699
1698
  * in the response.</p>
1700
1699
  * <p>The default setting is 20.</p>
1700
+ * @public
1701
1701
  */
1702
1702
  MaxResults?: number;
1703
1703
  /**
1704
- * @public
1705
1704
  * <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>
1705
+ * @public
1706
1706
  */
1707
1707
  InclusionFilters?: InclusionProtectionFilters;
1708
1708
  }
@@ -1711,18 +1711,18 @@ export interface ListProtectionsRequest {
1711
1711
  */
1712
1712
  export interface ListProtectionsResponse {
1713
1713
  /**
1714
- * @public
1715
1714
  * <p>The array of enabled <a>Protection</a> objects.</p>
1715
+ * @public
1716
1716
  */
1717
1717
  Protections?: Protection[];
1718
1718
  /**
1719
- * @public
1720
1719
  * <p>When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects,
1721
1720
  * 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
1722
1721
  * providing the token that was returned by the prior call in your request. </p>
1723
1722
  * <p>You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the <code>MaxResults</code>
1724
1723
  * setting. Shield Advanced will not return more than <code>MaxResults</code> objects, but may return fewer, even if more objects are still available.</p>
1725
1724
  * <p>Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a <code>NextToken</code> value.</p>
1725
+ * @public
1726
1726
  */
1727
1727
  NextToken?: string;
1728
1728
  }
@@ -1731,12 +1731,11 @@ export interface ListProtectionsResponse {
1731
1731
  */
1732
1732
  export interface ListResourcesInProtectionGroupRequest {
1733
1733
  /**
1734
- * @public
1735
1734
  * <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>
1735
+ * @public
1736
1736
  */
1737
1737
  ProtectionGroupId: string | undefined;
1738
1738
  /**
1739
- * @public
1740
1739
  * <p>When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects,
1741
1740
  * 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
1742
1741
  * providing the token that was returned by the prior call in your request. </p>
@@ -1744,14 +1743,15 @@ export interface ListResourcesInProtectionGroupRequest {
1744
1743
  * setting. Shield Advanced will not return more than <code>MaxResults</code> objects, but may return fewer, even if more objects are still available.</p>
1745
1744
  * <p>Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a <code>NextToken</code> value.</p>
1746
1745
  * <p>On your first call to a list operation, leave this setting empty.</p>
1746
+ * @public
1747
1747
  */
1748
1748
  NextToken?: string;
1749
1749
  /**
1750
- * @public
1751
1750
  * <p>The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects
1752
1751
  * 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
1753
1752
  * in the response.</p>
1754
1753
  * <p>The default setting is 20.</p>
1754
+ * @public
1755
1755
  */
1756
1756
  MaxResults?: number;
1757
1757
  }
@@ -1760,18 +1760,18 @@ export interface ListResourcesInProtectionGroupRequest {
1760
1760
  */
1761
1761
  export interface ListResourcesInProtectionGroupResponse {
1762
1762
  /**
1763
- * @public
1764
1763
  * <p>The Amazon Resource Names (ARNs) of the resources that are included in the protection group.</p>
1764
+ * @public
1765
1765
  */
1766
1766
  ResourceArns: string[] | undefined;
1767
1767
  /**
1768
- * @public
1769
1768
  * <p>When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects,
1770
1769
  * 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
1771
1770
  * providing the token that was returned by the prior call in your request. </p>
1772
1771
  * <p>You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the <code>MaxResults</code>
1773
1772
  * setting. Shield Advanced will not return more than <code>MaxResults</code> objects, but may return fewer, even if more objects are still available.</p>
1774
1773
  * <p>Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a <code>NextToken</code> value.</p>
1774
+ * @public
1775
1775
  */
1776
1776
  NextToken?: string;
1777
1777
  }
@@ -1780,8 +1780,8 @@ export interface ListResourcesInProtectionGroupResponse {
1780
1780
  */
1781
1781
  export interface ListTagsForResourceRequest {
1782
1782
  /**
1783
- * @public
1784
1783
  * <p>The Amazon Resource Name (ARN) of the resource to get tags for.</p>
1784
+ * @public
1785
1785
  */
1786
1786
  ResourceARN: string | undefined;
1787
1787
  }
@@ -1790,8 +1790,8 @@ export interface ListTagsForResourceRequest {
1790
1790
  */
1791
1791
  export interface ListTagsForResourceResponse {
1792
1792
  /**
1793
- * @public
1794
1793
  * <p>A list of tag key and value pairs associated with the specified resource.</p>
1794
+ * @public
1795
1795
  */
1796
1796
  Tags?: Tag[];
1797
1797
  }
@@ -1800,13 +1800,13 @@ export interface ListTagsForResourceResponse {
1800
1800
  */
1801
1801
  export interface TagResourceRequest {
1802
1802
  /**
1803
- * @public
1804
1803
  * <p>The Amazon Resource Name (ARN) of the resource that you want to add or update tags for.</p>
1804
+ * @public
1805
1805
  */
1806
1806
  ResourceARN: string | undefined;
1807
1807
  /**
1808
- * @public
1809
1808
  * <p>The tags that you want to modify or add to the resource.</p>
1809
+ * @public
1810
1810
  */
1811
1811
  Tags: Tag[] | undefined;
1812
1812
  }
@@ -1820,13 +1820,13 @@ export interface TagResourceResponse {
1820
1820
  */
1821
1821
  export interface UntagResourceRequest {
1822
1822
  /**
1823
- * @public
1824
1823
  * <p>The Amazon Resource Name (ARN) of the resource that you want to remove tags from.</p>
1824
+ * @public
1825
1825
  */
1826
1826
  ResourceARN: string | undefined;
1827
1827
  /**
1828
- * @public
1829
1828
  * <p>The tag key for each tag that you want to remove from the resource.</p>
1829
+ * @public
1830
1830
  */
1831
1831
  TagKeys: string[] | undefined;
1832
1832
  }
@@ -1840,15 +1840,15 @@ export interface UntagResourceResponse {
1840
1840
  */
1841
1841
  export interface UpdateApplicationLayerAutomaticResponseRequest {
1842
1842
  /**
1843
- * @public
1844
1843
  * <p>The ARN (Amazon Resource Name) of the resource.</p>
1844
+ * @public
1845
1845
  */
1846
1846
  ResourceArn: string | undefined;
1847
1847
  /**
1848
- * @public
1849
1848
  * <p>Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the
1850
1849
  * protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature,
1851
1850
  * 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>
1851
+ * @public
1852
1852
  */
1853
1853
  Action: ResponseAction | undefined;
1854
1854
  }
@@ -1862,9 +1862,9 @@ export interface UpdateApplicationLayerAutomaticResponseResponse {
1862
1862
  */
1863
1863
  export interface UpdateEmergencyContactSettingsRequest {
1864
1864
  /**
1865
- * @public
1866
1865
  * <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>
1867
1866
  * <p>If you have proactive engagement enabled, the contact list must include at least one phone number.</p>
1867
+ * @public
1868
1868
  */
1869
1869
  EmergencyContactList?: EmergencyContact[];
1870
1870
  }
@@ -1878,12 +1878,11 @@ export interface UpdateEmergencyContactSettingsResponse {
1878
1878
  */
1879
1879
  export interface UpdateProtectionGroupRequest {
1880
1880
  /**
1881
- * @public
1882
1881
  * <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>
1882
+ * @public
1883
1883
  */
1884
1884
  ProtectionGroupId: string | undefined;
1885
1885
  /**
1886
- * @public
1887
1886
  * <p>Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.</p>
1888
1887
  * <ul>
1889
1888
  * <li>
@@ -1896,22 +1895,23 @@ export interface UpdateProtectionGroupRequest {
1896
1895
  * <p>Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront distributions and origin resources for CloudFront distributions.</p>
1897
1896
  * </li>
1898
1897
  * </ul>
1898
+ * @public
1899
1899
  */
1900
1900
  Aggregation: ProtectionGroupAggregation | undefined;
1901
1901
  /**
1902
- * @public
1903
1902
  * <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>
1903
+ * @public
1904
1904
  */
1905
1905
  Pattern: ProtectionGroupPattern | undefined;
1906
1906
  /**
1907
- * @public
1908
1907
  * <p>The resource type to include in the protection group. All protected resources of this type are included in the protection group.
1909
1908
  * 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>
1909
+ * @public
1910
1910
  */
1911
1911
  ResourceType?: ProtectedResourceType;
1912
1912
  /**
1913
- * @public
1914
1913
  * <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>
1914
+ * @public
1915
1915
  */
1916
1916
  Members?: string[];
1917
1917
  }
@@ -1925,8 +1925,8 @@ export interface UpdateProtectionGroupResponse {
1925
1925
  */
1926
1926
  export interface UpdateSubscriptionRequest {
1927
1927
  /**
1928
- * @public
1929
1928
  * <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>
1929
+ * @public
1930
1930
  */
1931
1931
  AutoRenew?: AutoRenew;
1932
1932
  }