Data retrieval APIs for AWS Shield
AWS Shield provides the following APIs for data retrieval.
| Actions | Description | Access level |
|---|---|---|
| DescribeAttack | Get attack details. For getting attack details protected by AWS WAF anti-DDoS managed rule group, this action additionally calls wafv2:DescribeTopContributorsByEvent to retrieve application layer attack contributors, which requires to have wafv2:DescribeTopContributorsByEvent permission in IAM policy | Read |
| DescribeAttackContributors | Get detailed information about the contributors to a specific DDoS attack | Read |
| DescribeAttackStatistics | Describe information about the number and type of attacks AWS Shield has detected in the last year | Read |
| DescribeDRTAccess | Describe the current role and list of Amazon S3 log buckets used by the DDoS Response team to access your AWS account while assisting with attack mitigation | Read |
| DescribeEmergencyContactSettings | List the email addresses that the DRT can use to contact you during a suspected attack | Read |
| DescribeProtection | Get protection details | Read |
| DescribeProtectionGroup | Describe the specification for the specified protection group | Read |
| DescribeSubscription | Get subscription details, such as start time | Read |
| GetGlobalThreatData | Retrieve global threat intelligence data and trends from AWS Shield's threat monitoring systems | Read |
| GetSubscriptionState | Get subscription state | Read |
| ListAttacks | List all existing attacks | List |
| ListMitigations | Retrieve a list of mitigation actions that have been applied during DDoS attacks | List |
| ListProtectionGroups | Retrieve the protection groups for the account | List |
| ListProtections | List all existing protections | List |
| ListResourcesInProtectionGroup | Retrieve the resources that are included in the protection group | List |
| ListTagsForResource | Get information about AWS tags for a specified Amazon Resource Name (ARN) in AWS Shield | Read |