Menu
AWS Shield Advanced
AWS Shield Advanced API Reference (API Version 2016-06-02)

DescribeAttack

Describes the details of a DDoS attack.

Request Syntax

{
   "AttackId": "string"
}

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.

AttackId

The unique identifier (ID) for the attack that to be described.

Type: String

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

Pattern: [a-zA-Z0-9\\-]*

Required: Yes

Response Syntax

{
   "Attack": { 
      "AttackCounters": [ 
         { 
            "Average": number,
            "Max": number,
            "N": number,
            "Name": "string",
            "Sum": number,
            "Unit": "string"
         }
      ],
      "AttackId": "string",
      "AttackProperties": [ 
         { 
            "AttackLayer": "string",
            "AttackPropertyIdentifier": "string",
            "TopContributors": [ 
               { 
                  "Name": "string",
                  "Value": number
               }
            ],
            "Total": number,
            "Unit": "string"
         }
      ],
      "EndTime": number,
      "Mitigations": [ 
         { 
            "MitigationName": "string"
         }
      ],
      "ResourceArn": "string",
      "StartTime": number,
      "SubResources": [ 
         { 
            "AttackVectors": [ 
               { 
                  "VectorCounters": [ 
                     { 
                        "Average": number,
                        "Max": number,
                        "N": number,
                        "Name": "string",
                        "Sum": number,
                        "Unit": "string"
                     }
                  ],
                  "VectorType": "string"
               }
            ],
            "Counters": [ 
               { 
                  "Average": number,
                  "Max": number,
                  "N": number,
                  "Name": "string",
                  "Sum": number,
                  "Unit": "string"
               }
            ],
            "Id": "string",
            "Type": "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.

Attack

The attack that is described.

Type: AttackDetail object

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

InvalidParameterException

Exception that indicates that the parameters passed to the API are invalid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: