Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListAttacks

Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.

Request Syntax


{
   "EndTime": { 
      "FromInclusive": number,
      "ToExclusive": number
   },
   "MaxResults": number,
   "NextToken": "string",
   "ResourceArns": [ "string" ],
   "StartTime": { 
      "FromInclusive": number,
      "ToExclusive": number
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

EndTime

The end of the time period for the attacks. This is a timestamp type. The request syntax listing for this call indicates a number type, but you can provide the time in any valid timestamp format setting.

Type: TimeRange object

Required: No

MaxResults

The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects 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 NextToken value in the response.

The default setting is 20.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 10000.

Required: No

NextToken

When you request a list of objects from AWS Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.

You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.

Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.

On your first call to a list operation, leave this setting empty.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

Pattern: ^.*$

Required: No

ResourceArns

The ARNs (Amazon Resource Names) of the resources that were attacked. If you leave this blank, all applicable resources for this account will be included.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^arn:aws.*

Required: No

StartTime

The start of the time period for the attacks. This is a timestamp type. The request syntax listing for this call indicates a number type, but you can provide the time in any valid timestamp format setting.

Type: TimeRange object

Required: No

Response Syntax


{
   "AttackSummaries": [ 
      { 
         "AttackId": "string",
         "AttackVectors": [ 
            { 
               "VectorType": "string"
            }
         ],
         "EndTime": number,
         "ResourceArn": "string",
         "StartTime": number
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AttackSummaries

The attack information for the specified time range.

Type: Array of AttackSummary objects

NextToken

Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

Pattern: ^.*$

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalErrorException

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

HTTP Status Code: 500

InvalidOperationException

Exception that indicates that the operation would not cause any change to occur.

HTTP Status Code: 400

InvalidParameterException

Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

HTTP Status Code: 400