aws-sdk-shield 1.44.0 → 1.45.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -46,6 +46,37 @@ module Aws::Shield
46
46
  include Aws::Structure
47
47
  end
48
48
 
49
+ # The automatic application layer DDoS mitigation settings for a
50
+ # Protection. This configuration determines whether Shield Advanced
51
+ # automatically manages rules in the web ACL in order to respond to
52
+ # application layer events that Shield Advanced determines to be DDoS
53
+ # attacks.
54
+ #
55
+ # @!attribute [rw] status
56
+ # Indicates whether automatic application layer DDoS mitigation is
57
+ # enabled for the protection.
58
+ # @return [String]
59
+ #
60
+ # @!attribute [rw] action
61
+ # Specifies the action setting that Shield Advanced should use in the
62
+ # WAF rules that it creates on behalf of the protected resource in
63
+ # response to DDoS attacks. You specify this as part of the
64
+ # configuration for the automatic application layer DDoS mitigation
65
+ # feature, when you enable or update automatic mitigation. Shield
66
+ # Advanced creates the WAF rules in a Shield Advanced-managed rule
67
+ # group, inside the web ACL that you have associated with the
68
+ # resource.
69
+ # @return [Types::ResponseAction]
70
+ #
71
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ApplicationLayerAutomaticResponseConfiguration AWS API Documentation
72
+ #
73
+ class ApplicationLayerAutomaticResponseConfiguration < Struct.new(
74
+ :status,
75
+ :action)
76
+ SENSITIVE = []
77
+ include Aws::Structure
78
+ end
79
+
49
80
  # @note When making an API call, you may pass AssociateDRTLogBucketRequest
50
81
  # data as a hash:
51
82
  #
@@ -190,21 +221,11 @@ module Aws::Shield
190
221
  # @return [Array<Types::SubResourceSummary>]
191
222
  #
192
223
  # @!attribute [rw] start_time
193
- # The time the attack started, in Unix time in seconds. For more
194
- # information see [timestamp][1].
195
- #
196
- #
197
- #
198
- # [1]: http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types
224
+ # The time the attack started, in Unix time in seconds.
199
225
  # @return [Time]
200
226
  #
201
227
  # @!attribute [rw] end_time
202
- # The time the attack ended, in Unix time in seconds. For more
203
- # information see [timestamp][1].
204
- #
205
- #
206
- #
207
- # [1]: http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types
228
+ # The time the attack ended, in Unix time in seconds.
208
229
  # @return [Time]
209
230
  #
210
231
  # @!attribute [rw] attack_counters
@@ -215,10 +236,10 @@ module Aws::Shield
215
236
  # @!attribute [rw] attack_properties
216
237
  # The array of objects that provide details of the Shield event.
217
238
  #
218
- # For infrastructure layer events (L3 and L4 events) after January 25,
219
- # 2021, you can view metrics for top contributors in Amazon CloudWatch
220
- # metrics. For more information, see [Shield metrics and alarms][1] in
221
- # the *WAF Developer Guide*.
239
+ # For infrastructure layer events (L3 and L4 events), you can view
240
+ # metrics for top contributors in Amazon CloudWatch metrics. For more
241
+ # information, see [Shield metrics and alarms][1] in the *WAF
242
+ # Developer Guide*.
222
243
  #
223
244
  #
224
245
  #
@@ -252,10 +273,10 @@ module Aws::Shield
252
273
  # layer 3 and layer 4 events and `APPLICATION` indicates layer 7
253
274
  # events.
254
275
  #
255
- # For infrastructure layer events (L3 and L4 events) after January 25,
256
- # 2021, you can view metrics for top contributors in Amazon CloudWatch
257
- # metrics. For more information, see [Shield metrics and alarms][1] in
258
- # the *WAF Developer Guide*.
276
+ # For infrastructure layer events (L3 and L4 events), you can view
277
+ # metrics for top contributors in Amazon CloudWatch metrics. For more
278
+ # information, see [Shield metrics and alarms][1] in the *WAF
279
+ # Developer Guide*.
259
280
  #
260
281
  #
261
282
  #
@@ -270,6 +291,8 @@ module Aws::Shield
270
291
  #
271
292
  # @!attribute [rw] top_contributors
272
293
  # Contributor objects for the top five contributors to a Shield event.
294
+ # A contributor is a source of traffic that Shield Advanced identifies
295
+ # as responsible for some or all of an event.
273
296
  # @return [Array<Types::Contributor>]
274
297
  #
275
298
  # @!attribute [rw] unit
@@ -327,21 +350,11 @@ module Aws::Shield
327
350
  # @return [String]
328
351
  #
329
352
  # @!attribute [rw] start_time
330
- # The start time of the attack, in Unix time in seconds. For more
331
- # information see [timestamp][1].
332
- #
333
- #
334
- #
335
- # [1]: http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types
353
+ # The start time of the attack, in Unix time in seconds.
336
354
  # @return [Time]
337
355
  #
338
356
  # @!attribute [rw] end_time
339
- # The end time of the attack, in Unix time in seconds. For more
340
- # information see [timestamp][1].
341
- #
342
- #
343
- #
344
- # [1]: http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types
357
+ # The end time of the attack, in Unix time in seconds.
345
358
  # @return [Time]
346
359
  #
347
360
  # @!attribute [rw] attack_vectors
@@ -455,13 +468,27 @@ module Aws::Shield
455
468
  include Aws::Structure
456
469
  end
457
470
 
471
+ # Specifies that Shield Advanced should configure its WAF rules with the
472
+ # WAF `Block` action.
473
+ #
474
+ # This is only used in the context of the `ResponseAction` setting.
475
+ #
476
+ # JSON specification: `"Block": \{\}`
477
+ #
478
+ # @api private
479
+ #
480
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/BlockAction AWS API Documentation
481
+ #
482
+ class BlockAction < Aws::EmptyStructure; end
483
+
458
484
  # A contributor to the attack and their contribution.
459
485
  #
460
486
  # @!attribute [rw] name
461
- # The name of the contributor. This is dependent on the
462
- # `AttackPropertyIdentifier`. For example, if the
463
- # `AttackPropertyIdentifier` is `SOURCE_COUNTRY`, the `Name` could be
464
- # `United States`.
487
+ # The name of the contributor. The type of name that you'll find here
488
+ # depends on the `AttackPropertyIdentifier` setting in the
489
+ # `AttackProperty` where this contributor is defined. For example, if
490
+ # the `AttackPropertyIdentifier` is `SOURCE_COUNTRY`, the `Name` could
491
+ # be `United States`.
465
492
  # @return [String]
466
493
  #
467
494
  # @!attribute [rw] value
@@ -478,6 +505,19 @@ module Aws::Shield
478
505
  include Aws::Structure
479
506
  end
480
507
 
508
+ # Specifies that Shield Advanced should configure its WAF rules with the
509
+ # WAF `Count` action.
510
+ #
511
+ # This is only used in the context of the `ResponseAction` setting.
512
+ #
513
+ # JSON specification: `"Count": \{\}`
514
+ #
515
+ # @api private
516
+ #
517
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/CountAction AWS API Documentation
518
+ #
519
+ class CountAction < Aws::EmptyStructure; end
520
+
481
521
  # @note When making an API call, you may pass CreateProtectionGroupRequest
482
522
  # data as a hash:
483
523
  #
@@ -600,7 +640,7 @@ module Aws::Shield
600
640
  # `arn:aws:globalaccelerator::account-id:accelerator/accelerator-id
601
641
  # `
602
642
  #
603
- # * For Amazon Route 53: `arn:aws:route53:::hostedzone/hosted-zone-id
643
+ # * For Amazon Route 53: `arn:aws:route53:::hostedzone/hosted-zone-id
604
644
  # `
605
645
  #
606
646
  # * For an Elastic IP address:
@@ -711,7 +751,7 @@ module Aws::Shield
711
751
  # }
712
752
  #
713
753
  # @!attribute [rw] attack_id
714
- # The unique identifier (ID) for the attack that to be described.
754
+ # The unique identifier (ID) for the attack.
715
755
  # @return [String]
716
756
  #
717
757
  # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DescribeAttackRequest AWS API Documentation
@@ -898,6 +938,29 @@ module Aws::Shield
898
938
  include Aws::Structure
899
939
  end
900
940
 
941
+ # @note When making an API call, you may pass DisableApplicationLayerAutomaticResponseRequest
942
+ # data as a hash:
943
+ #
944
+ # {
945
+ # resource_arn: "ResourceArn", # required
946
+ # }
947
+ #
948
+ # @!attribute [rw] resource_arn
949
+ # The ARN (Amazon Resource Name) of the resource.
950
+ # @return [String]
951
+ #
952
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DisableApplicationLayerAutomaticResponseRequest AWS API Documentation
953
+ #
954
+ class DisableApplicationLayerAutomaticResponseRequest < Struct.new(
955
+ :resource_arn)
956
+ SENSITIVE = []
957
+ include Aws::Structure
958
+ end
959
+
960
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DisableApplicationLayerAutomaticResponseResponse AWS API Documentation
961
+ #
962
+ class DisableApplicationLayerAutomaticResponseResponse < Aws::EmptyStructure; end
963
+
901
964
  # @api private
902
965
  #
903
966
  # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/DisableProactiveEngagementRequest AWS API Documentation
@@ -1007,6 +1070,47 @@ module Aws::Shield
1007
1070
  include Aws::Structure
1008
1071
  end
1009
1072
 
1073
+ # @note When making an API call, you may pass EnableApplicationLayerAutomaticResponseRequest
1074
+ # data as a hash:
1075
+ #
1076
+ # {
1077
+ # resource_arn: "ResourceArn", # required
1078
+ # action: { # required
1079
+ # block: {
1080
+ # },
1081
+ # count: {
1082
+ # },
1083
+ # },
1084
+ # }
1085
+ #
1086
+ # @!attribute [rw] resource_arn
1087
+ # The ARN (Amazon Resource Name) of the resource.
1088
+ # @return [String]
1089
+ #
1090
+ # @!attribute [rw] action
1091
+ # Specifies the action setting that Shield Advanced should use in the
1092
+ # WAF rules that it creates on behalf of the protected resource in
1093
+ # response to DDoS attacks. You specify this as part of the
1094
+ # configuration for the automatic application layer DDoS mitigation
1095
+ # feature, when you enable or update automatic mitigation. Shield
1096
+ # Advanced creates the WAF rules in a Shield Advanced-managed rule
1097
+ # group, inside the web ACL that you have associated with the
1098
+ # resource.
1099
+ # @return [Types::ResponseAction]
1100
+ #
1101
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/EnableApplicationLayerAutomaticResponseRequest AWS API Documentation
1102
+ #
1103
+ class EnableApplicationLayerAutomaticResponseRequest < Struct.new(
1104
+ :resource_arn,
1105
+ :action)
1106
+ SENSITIVE = []
1107
+ include Aws::Structure
1108
+ end
1109
+
1110
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/EnableApplicationLayerAutomaticResponseResponse AWS API Documentation
1111
+ #
1112
+ class EnableApplicationLayerAutomaticResponseResponse < Aws::EmptyStructure; end
1113
+
1010
1114
  # @api private
1011
1115
  #
1012
1116
  # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/EnableProactiveEngagementRequest AWS API Documentation
@@ -1063,9 +1167,9 @@ module Aws::Shield
1063
1167
  include Aws::Structure
1064
1168
  end
1065
1169
 
1066
- # Exception that indicates that the NextToken specified in the request
1067
- # is invalid. Submit the request using the NextToken value that was
1068
- # returned in the response.
1170
+ # Exception that indicates that the `NextToken` specified in the request
1171
+ # is invalid. Submit the request using the `NextToken` value that was
1172
+ # returned in the prior response.
1069
1173
  #
1070
1174
  # @!attribute [rw] message
1071
1175
  # @return [String]
@@ -1178,48 +1282,60 @@ module Aws::Shield
1178
1282
  # }
1179
1283
  #
1180
1284
  # @!attribute [rw] resource_arns
1181
- # The ARN (Amazon Resource Name) of the resource that was attacked. If
1182
- # this is left blank, all applicable resources for this account will
1183
- # be included.
1285
+ # The ARNs (Amazon Resource Names) of the resources that were
1286
+ # attacked. If you leave this blank, all applicable resources for this
1287
+ # account will be included.
1184
1288
  # @return [Array<String>]
1185
1289
  #
1186
1290
  # @!attribute [rw] start_time
1187
1291
  # The start of the time period for the attacks. This is a `timestamp`
1188
- # type. The sample request above indicates a `number` type because the
1189
- # default used by WAF is Unix time in seconds. However any valid
1190
- # [timestamp format][1] is allowed.
1292
+ # type. The request syntax listing for this call indicates a `number`
1293
+ # type, but you can provide the time in any valid [timestamp
1294
+ # format][1] setting.
1191
1295
  #
1192
1296
  #
1193
1297
  #
1194
- # [1]: http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types
1298
+ # [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp
1195
1299
  # @return [Types::TimeRange]
1196
1300
  #
1197
1301
  # @!attribute [rw] end_time
1198
1302
  # The end of the time period for the attacks. This is a `timestamp`
1199
- # type. The sample request above indicates a `number` type because the
1200
- # default used by WAF is Unix time in seconds. However any valid
1201
- # [timestamp format][1] is allowed.
1303
+ # type. The request syntax listing for this call indicates a `number`
1304
+ # type, but you can provide the time in any valid [timestamp
1305
+ # format][1] setting.
1202
1306
  #
1203
1307
  #
1204
1308
  #
1205
- # [1]: http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types
1309
+ # [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp
1206
1310
  # @return [Types::TimeRange]
1207
1311
  #
1208
1312
  # @!attribute [rw] next_token
1209
- # The `ListAttacksRequest.NextMarker` value from a previous call to
1210
- # `ListAttacksRequest`. Pass null if this is the first call.
1313
+ # When you request a list of objects from Shield Advanced, if the
1314
+ # response does not include all of the remaining available objects,
1315
+ # Shield Advanced includes a `NextToken` value in the response. You
1316
+ # can retrieve the next batch of objects by requesting the list again
1317
+ # and providing the token that was returned by the prior call in your
1318
+ # request.
1319
+ #
1320
+ # You can indicate the maximum number of objects that you want Shield
1321
+ # Advanced to return for a single call with the `MaxResults` setting.
1322
+ # Shield Advanced will not return more than `MaxResults` objects, but
1323
+ # may return fewer, even if more objects are still available.
1324
+ #
1325
+ # Whenever more objects remain that Shield Advanced has not yet
1326
+ # returned to you, the response will include a `NextToken` value.
1327
+ #
1328
+ # On your first call to a list operation, leave this setting empty.
1211
1329
  # @return [String]
1212
1330
  #
1213
1331
  # @!attribute [rw] max_results
1214
- # The maximum number of AttackSummary objects to return. If you leave
1215
- # this blank, Shield Advanced returns the first 20 results.
1216
- #
1217
- # This is a maximum value. Shield Advanced might return the results in
1218
- # smaller batches. That is, the number of objects returned could be
1219
- # less than `MaxResults`, even if there are still more objects yet to
1220
- # return. If there are more objects to return, Shield Advanced returns
1221
- # a value in `NextToken` that you can use in your next request, to get
1222
- # the next batch of objects.
1332
+ # The greatest number of objects that you want Shield Advanced to
1333
+ # return to the list request. Shield Advanced might return fewer
1334
+ # objects than you indicate in this setting, even if more objects are
1335
+ # available. If there are more objects remaining, Shield Advanced will
1336
+ # always also return a `NextToken` value in the response.
1337
+ #
1338
+ # The default setting is 20.
1223
1339
  # @return [Integer]
1224
1340
  #
1225
1341
  # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListAttacksRequest AWS API Documentation
@@ -1239,15 +1355,20 @@ module Aws::Shield
1239
1355
  # @return [Array<Types::AttackSummary>]
1240
1356
  #
1241
1357
  # @!attribute [rw] next_token
1242
- # The token returned by a previous call to indicate that there is more
1243
- # data available. If not null, more results are available. Pass this
1244
- # value for the `NextMarker` parameter in a subsequent call to
1245
- # `ListAttacks` to retrieve the next set of items.
1358
+ # When you request a list of objects from Shield Advanced, if the
1359
+ # response does not include all of the remaining available objects,
1360
+ # Shield Advanced includes a `NextToken` value in the response. You
1361
+ # can retrieve the next batch of objects by requesting the list again
1362
+ # and providing the token that was returned by the prior call in your
1363
+ # request.
1364
+ #
1365
+ # You can indicate the maximum number of objects that you want Shield
1366
+ # Advanced to return for a single call with the `MaxResults` setting.
1367
+ # Shield Advanced will not return more than `MaxResults` objects, but
1368
+ # may return fewer, even if more objects are still available.
1246
1369
  #
1247
- # Shield Advanced might return the list of AttackSummary objects in
1248
- # batches smaller than the number specified by MaxResults. If there
1249
- # are more attack summary objects to return, Shield Advanced will
1250
- # always also return a `NextToken`.
1370
+ # Whenever more objects remain that Shield Advanced has not yet
1371
+ # returned to you, the response will include a `NextToken` value.
1251
1372
  # @return [String]
1252
1373
  #
1253
1374
  # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListAttacksResponse AWS API Documentation
@@ -1268,20 +1389,32 @@ module Aws::Shield
1268
1389
  # }
1269
1390
  #
1270
1391
  # @!attribute [rw] next_token
1271
- # The next token value from a previous call to `ListProtectionGroups`.
1272
- # Pass null if this is the first call.
1392
+ # When you request a list of objects from Shield Advanced, if the
1393
+ # response does not include all of the remaining available objects,
1394
+ # Shield Advanced includes a `NextToken` value in the response. You
1395
+ # can retrieve the next batch of objects by requesting the list again
1396
+ # and providing the token that was returned by the prior call in your
1397
+ # request.
1398
+ #
1399
+ # You can indicate the maximum number of objects that you want Shield
1400
+ # Advanced to return for a single call with the `MaxResults` setting.
1401
+ # Shield Advanced will not return more than `MaxResults` objects, but
1402
+ # may return fewer, even if more objects are still available.
1403
+ #
1404
+ # Whenever more objects remain that Shield Advanced has not yet
1405
+ # returned to you, the response will include a `NextToken` value.
1406
+ #
1407
+ # On your first call to a list operation, leave this setting empty.
1273
1408
  # @return [String]
1274
1409
  #
1275
1410
  # @!attribute [rw] max_results
1276
- # The maximum number of ProtectionGroup objects to return. If you
1277
- # leave this blank, Shield Advanced returns the first 20 results.
1278
- #
1279
- # This is a maximum value. Shield Advanced might return the results in
1280
- # smaller batches. That is, the number of objects returned could be
1281
- # less than `MaxResults`, even if there are still more objects yet to
1282
- # return. If there are more objects to return, Shield Advanced returns
1283
- # a value in `NextToken` that you can use in your next request, to get
1284
- # the next batch of objects.
1411
+ # The greatest number of objects that you want Shield Advanced to
1412
+ # return to the list request. Shield Advanced might return fewer
1413
+ # objects than you indicate in this setting, even if more objects are
1414
+ # available. If there are more objects remaining, Shield Advanced will
1415
+ # always also return a `NextToken` value in the response.
1416
+ #
1417
+ # The default setting is 20.
1285
1418
  # @return [Integer]
1286
1419
  #
1287
1420
  # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListProtectionGroupsRequest AWS API Documentation
@@ -1297,10 +1430,20 @@ module Aws::Shield
1297
1430
  # @return [Array<Types::ProtectionGroup>]
1298
1431
  #
1299
1432
  # @!attribute [rw] next_token
1300
- # If you specify a value for `MaxResults` and you have more protection
1301
- # groups than the value of MaxResults, Shield Advanced returns this
1302
- # token that you can use in your next request, to get the next batch
1303
- # of objects.
1433
+ # When you request a list of objects from Shield Advanced, if the
1434
+ # response does not include all of the remaining available objects,
1435
+ # Shield Advanced includes a `NextToken` value in the response. You
1436
+ # can retrieve the next batch of objects by requesting the list again
1437
+ # and providing the token that was returned by the prior call in your
1438
+ # request.
1439
+ #
1440
+ # You can indicate the maximum number of objects that you want Shield
1441
+ # Advanced to return for a single call with the `MaxResults` setting.
1442
+ # Shield Advanced will not return more than `MaxResults` objects, but
1443
+ # may return fewer, even if more objects are still available.
1444
+ #
1445
+ # Whenever more objects remain that Shield Advanced has not yet
1446
+ # returned to you, the response will include a `NextToken` value.
1304
1447
  # @return [String]
1305
1448
  #
1306
1449
  # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListProtectionGroupsResponse AWS API Documentation
@@ -1321,20 +1464,32 @@ module Aws::Shield
1321
1464
  # }
1322
1465
  #
1323
1466
  # @!attribute [rw] next_token
1324
- # The `ListProtectionsRequest.NextToken` value from a previous call to
1325
- # `ListProtections`. Pass null if this is the first call.
1467
+ # When you request a list of objects from Shield Advanced, if the
1468
+ # response does not include all of the remaining available objects,
1469
+ # Shield Advanced includes a `NextToken` value in the response. You
1470
+ # can retrieve the next batch of objects by requesting the list again
1471
+ # and providing the token that was returned by the prior call in your
1472
+ # request.
1473
+ #
1474
+ # You can indicate the maximum number of objects that you want Shield
1475
+ # Advanced to return for a single call with the `MaxResults` setting.
1476
+ # Shield Advanced will not return more than `MaxResults` objects, but
1477
+ # may return fewer, even if more objects are still available.
1478
+ #
1479
+ # Whenever more objects remain that Shield Advanced has not yet
1480
+ # returned to you, the response will include a `NextToken` value.
1481
+ #
1482
+ # On your first call to a list operation, leave this setting empty.
1326
1483
  # @return [String]
1327
1484
  #
1328
1485
  # @!attribute [rw] max_results
1329
- # The maximum number of Protection objects to return. If you leave
1330
- # this blank, Shield Advanced returns the first 20 results.
1331
- #
1332
- # This is a maximum value. Shield Advanced might return the results in
1333
- # smaller batches. That is, the number of objects returned could be
1334
- # less than `MaxResults`, even if there are still more objects yet to
1335
- # return. If there are more objects to return, Shield Advanced returns
1336
- # a value in `NextToken` that you can use in your next request, to get
1337
- # the next batch of objects.
1486
+ # The greatest number of objects that you want Shield Advanced to
1487
+ # return to the list request. Shield Advanced might return fewer
1488
+ # objects than you indicate in this setting, even if more objects are
1489
+ # available. If there are more objects remaining, Shield Advanced will
1490
+ # always also return a `NextToken` value in the response.
1491
+ #
1492
+ # The default setting is 20.
1338
1493
  # @return [Integer]
1339
1494
  #
1340
1495
  # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListProtectionsRequest AWS API Documentation
@@ -1351,17 +1506,20 @@ module Aws::Shield
1351
1506
  # @return [Array<Types::Protection>]
1352
1507
  #
1353
1508
  # @!attribute [rw] next_token
1354
- # If you specify a value for `MaxResults` and you have more
1355
- # Protections than the value of MaxResults, Shield Advanced returns a
1356
- # NextToken value in the response that allows you to list another
1357
- # group of Protections. For the second and subsequent ListProtections
1358
- # requests, specify the value of NextToken from the previous response
1359
- # to get information about another batch of Protections.
1509
+ # When you request a list of objects from Shield Advanced, if the
1510
+ # response does not include all of the remaining available objects,
1511
+ # Shield Advanced includes a `NextToken` value in the response. You
1512
+ # can retrieve the next batch of objects by requesting the list again
1513
+ # and providing the token that was returned by the prior call in your
1514
+ # request.
1515
+ #
1516
+ # You can indicate the maximum number of objects that you want Shield
1517
+ # Advanced to return for a single call with the `MaxResults` setting.
1518
+ # Shield Advanced will not return more than `MaxResults` objects, but
1519
+ # may return fewer, even if more objects are still available.
1360
1520
  #
1361
- # Shield Advanced might return the list of Protection objects in
1362
- # batches smaller than the number specified by MaxResults. If there
1363
- # are more Protection objects to return, Shield Advanced will always
1364
- # also return a `NextToken`.
1521
+ # Whenever more objects remain that Shield Advanced has not yet
1522
+ # returned to you, the response will include a `NextToken` value.
1365
1523
  # @return [String]
1366
1524
  #
1367
1525
  # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListProtectionsResponse AWS API Documentation
@@ -1389,21 +1547,32 @@ module Aws::Shield
1389
1547
  # @return [String]
1390
1548
  #
1391
1549
  # @!attribute [rw] next_token
1392
- # The next token value from a previous call to
1393
- # `ListResourcesInProtectionGroup`. Pass null if this is the first
1394
- # call.
1550
+ # When you request a list of objects from Shield Advanced, if the
1551
+ # response does not include all of the remaining available objects,
1552
+ # Shield Advanced includes a `NextToken` value in the response. You
1553
+ # can retrieve the next batch of objects by requesting the list again
1554
+ # and providing the token that was returned by the prior call in your
1555
+ # request.
1556
+ #
1557
+ # You can indicate the maximum number of objects that you want Shield
1558
+ # Advanced to return for a single call with the `MaxResults` setting.
1559
+ # Shield Advanced will not return more than `MaxResults` objects, but
1560
+ # may return fewer, even if more objects are still available.
1561
+ #
1562
+ # Whenever more objects remain that Shield Advanced has not yet
1563
+ # returned to you, the response will include a `NextToken` value.
1564
+ #
1565
+ # On your first call to a list operation, leave this setting empty.
1395
1566
  # @return [String]
1396
1567
  #
1397
1568
  # @!attribute [rw] max_results
1398
- # The maximum number of resource ARN objects to return. If you leave
1399
- # this blank, Shield Advanced returns the first 20 results.
1400
- #
1401
- # This is a maximum value. Shield Advanced might return the results in
1402
- # smaller batches. That is, the number of objects returned could be
1403
- # less than `MaxResults`, even if there are still more objects yet to
1404
- # return. If there are more objects to return, Shield Advanced returns
1405
- # a value in `NextToken` that you can use in your next request, to get
1406
- # the next batch of objects.
1569
+ # The greatest number of objects that you want Shield Advanced to
1570
+ # return to the list request. Shield Advanced might return fewer
1571
+ # objects than you indicate in this setting, even if more objects are
1572
+ # available. If there are more objects remaining, Shield Advanced will
1573
+ # always also return a `NextToken` value in the response.
1574
+ #
1575
+ # The default setting is 20.
1407
1576
  # @return [Integer]
1408
1577
  #
1409
1578
  # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListResourcesInProtectionGroupRequest AWS API Documentation
@@ -1422,10 +1591,20 @@ module Aws::Shield
1422
1591
  # @return [Array<String>]
1423
1592
  #
1424
1593
  # @!attribute [rw] next_token
1425
- # If you specify a value for `MaxResults` and you have more resources
1426
- # in the protection group than the value of MaxResults, Shield
1427
- # Advanced returns this token that you can use in your next request,
1428
- # to get the next batch of objects.
1594
+ # When you request a list of objects from Shield Advanced, if the
1595
+ # response does not include all of the remaining available objects,
1596
+ # Shield Advanced includes a `NextToken` value in the response. You
1597
+ # can retrieve the next batch of objects by requesting the list again
1598
+ # and providing the token that was returned by the prior call in your
1599
+ # request.
1600
+ #
1601
+ # You can indicate the maximum number of objects that you want Shield
1602
+ # Advanced to return for a single call with the `MaxResults` setting.
1603
+ # Shield Advanced will not return more than `MaxResults` objects, but
1604
+ # may return fewer, even if more objects are still available.
1605
+ #
1606
+ # Whenever more objects remain that Shield Advanced has not yet
1607
+ # returned to you, the response will include a `NextToken` value.
1429
1608
  # @return [String]
1430
1609
  #
1431
1610
  # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ListResourcesInProtectionGroupResponse AWS API Documentation
@@ -1543,7 +1722,7 @@ module Aws::Shield
1543
1722
  # @return [String]
1544
1723
  #
1545
1724
  # @!attribute [rw] health_check_ids
1546
- # The unique identifier (ID) for the Route 53 health check that's
1725
+ # The unique identifier (ID) for the Route 53 health check that's
1547
1726
  # associated with the protection.
1548
1727
  # @return [Array<String>]
1549
1728
  #
@@ -1551,6 +1730,14 @@ module Aws::Shield
1551
1730
  # The ARN (Amazon Resource Name) of the protection.
1552
1731
  # @return [String]
1553
1732
  #
1733
+ # @!attribute [rw] application_layer_automatic_response_configuration
1734
+ # The automatic application layer DDoS mitigation settings for the
1735
+ # protection. This configuration determines whether Shield Advanced
1736
+ # automatically manages rules in the web ACL in order to respond to
1737
+ # application layer events that Shield Advanced determines to be DDoS
1738
+ # attacks.
1739
+ # @return [Types::ApplicationLayerAutomaticResponseConfiguration]
1740
+ #
1554
1741
  # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/Protection AWS API Documentation
1555
1742
  #
1556
1743
  class Protection < Struct.new(
@@ -1558,7 +1745,8 @@ module Aws::Shield
1558
1745
  :name,
1559
1746
  :resource_arn,
1560
1747
  :health_check_ids,
1561
- :protection_arn)
1748
+ :protection_arn,
1749
+ :application_layer_automatic_response_configuration)
1562
1750
  SENSITIVE = []
1563
1751
  include Aws::Structure
1564
1752
  end
@@ -1733,6 +1921,47 @@ module Aws::Shield
1733
1921
  include Aws::Structure
1734
1922
  end
1735
1923
 
1924
+ # Specifies the action setting that Shield Advanced should use in the
1925
+ # WAF rules that it creates on behalf of the protected resource in
1926
+ # response to DDoS attacks. You specify this as part of the
1927
+ # configuration for the automatic application layer DDoS mitigation
1928
+ # feature, when you enable or update automatic mitigation. Shield
1929
+ # Advanced creates the WAF rules in a Shield Advanced-managed rule
1930
+ # group, inside the web ACL that you have associated with the resource.
1931
+ #
1932
+ # @note When making an API call, you may pass ResponseAction
1933
+ # data as a hash:
1934
+ #
1935
+ # {
1936
+ # block: {
1937
+ # },
1938
+ # count: {
1939
+ # },
1940
+ # }
1941
+ #
1942
+ # @!attribute [rw] block
1943
+ # Specifies that Shield Advanced should configure its WAF rules with
1944
+ # the WAF `Block` action.
1945
+ #
1946
+ # You must specify exactly one action, either `Block` or `Count`.
1947
+ # @return [Types::BlockAction]
1948
+ #
1949
+ # @!attribute [rw] count
1950
+ # Specifies that Shield Advanced should configure its WAF rules with
1951
+ # the WAF `Count` action.
1952
+ #
1953
+ # You must specify exactly one action, either `Block` or `Count`.
1954
+ # @return [Types::CountAction]
1955
+ #
1956
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/ResponseAction AWS API Documentation
1957
+ #
1958
+ class ResponseAction < Struct.new(
1959
+ :block,
1960
+ :count)
1961
+ SENSITIVE = []
1962
+ include Aws::Structure
1963
+ end
1964
+
1736
1965
  # The attack information for the specified SubResource.
1737
1966
  #
1738
1967
  # @!attribute [rw] type
@@ -1765,12 +1994,7 @@ module Aws::Shield
1765
1994
  # Information about the Shield Advanced subscription for an account.
1766
1995
  #
1767
1996
  # @!attribute [rw] start_time
1768
- # The start time of the subscription, in Unix time in seconds. For
1769
- # more information see [timestamp][1].
1770
- #
1771
- #
1772
- #
1773
- # [1]: http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types
1997
+ # The start time of the subscription, in Unix time in seconds.
1774
1998
  # @return [Time]
1775
1999
  #
1776
2000
  # @!attribute [rw] end_time
@@ -1995,21 +2219,11 @@ module Aws::Shield
1995
2219
  # }
1996
2220
  #
1997
2221
  # @!attribute [rw] from_inclusive
1998
- # The start time, in Unix time in seconds. For more information see
1999
- # [timestamp][1].
2000
- #
2001
- #
2002
- #
2003
- # [1]: http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types
2222
+ # The start time, in Unix time in seconds.
2004
2223
  # @return [Time]
2005
2224
  #
2006
2225
  # @!attribute [rw] to_exclusive
2007
- # The end time, in Unix time in seconds. For more information see
2008
- # [timestamp][1].
2009
- #
2010
- #
2011
- #
2012
- # [1]: http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#parameter-types
2226
+ # The end time, in Unix time in seconds.
2013
2227
  # @return [Time]
2014
2228
  #
2015
2229
  # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/TimeRange AWS API Documentation
@@ -2051,6 +2265,47 @@ module Aws::Shield
2051
2265
  #
2052
2266
  class UntagResourceResponse < Aws::EmptyStructure; end
2053
2267
 
2268
+ # @note When making an API call, you may pass UpdateApplicationLayerAutomaticResponseRequest
2269
+ # data as a hash:
2270
+ #
2271
+ # {
2272
+ # resource_arn: "ResourceArn", # required
2273
+ # action: { # required
2274
+ # block: {
2275
+ # },
2276
+ # count: {
2277
+ # },
2278
+ # },
2279
+ # }
2280
+ #
2281
+ # @!attribute [rw] resource_arn
2282
+ # The ARN (Amazon Resource Name) of the resource.
2283
+ # @return [String]
2284
+ #
2285
+ # @!attribute [rw] action
2286
+ # Specifies the action setting that Shield Advanced should use in the
2287
+ # WAF rules that it creates on behalf of the protected resource in
2288
+ # response to DDoS attacks. You specify this as part of the
2289
+ # configuration for the automatic application layer DDoS mitigation
2290
+ # feature, when you enable or update automatic mitigation. Shield
2291
+ # Advanced creates the WAF rules in a Shield Advanced-managed rule
2292
+ # group, inside the web ACL that you have associated with the
2293
+ # resource.
2294
+ # @return [Types::ResponseAction]
2295
+ #
2296
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/UpdateApplicationLayerAutomaticResponseRequest AWS API Documentation
2297
+ #
2298
+ class UpdateApplicationLayerAutomaticResponseRequest < Struct.new(
2299
+ :resource_arn,
2300
+ :action)
2301
+ SENSITIVE = []
2302
+ include Aws::Structure
2303
+ end
2304
+
2305
+ # @see http://docs.aws.amazon.com/goto/WebAPI/shield-2016-06-02/UpdateApplicationLayerAutomaticResponseResponse AWS API Documentation
2306
+ #
2307
+ class UpdateApplicationLayerAutomaticResponseResponse < Aws::EmptyStructure; end
2308
+
2054
2309
  # @note When making an API call, you may pass UpdateEmergencyContactSettingsRequest
2055
2310
  # data as a hash:
2056
2311
  #