Expand description
This is the AWS Shield Advanced API Reference. This guide is for developers who need detailed information about the AWS Shield Advanced API actions, data types, and errors. For detailed information about AWS WAF and AWS Shield Advanced features and an overview of how to use the AWS WAF and AWS Shield Advanced APIs, see the AWS WAF and AWS Shield Developer Guide.
If you’re using the service, you’re probably looking for ShieldClient and Shield.
Structs§
- AssociateDRT
LogBucket Request - AssociateDRT
LogBucket Response - AssociateDRT
Role Request - AssociateDRT
Role Response - Associate
Health Check Request - Associate
Health Check Response - Associate
Proactive Engagement Details Request - Associate
Proactive Engagement Details Response - Attack
Detail The details of a DDoS attack.
- Attack
Property Details of the described attack.
- Attack
Summary Summarizes all DDoS attacks for a specified time period.
- Attack
Vector Description Describes the attack.
- Contributor
A contributor to the attack and their contribution.
- Create
Protection Request - Create
Protection Response - Create
Subscription Request - Create
Subscription Response - Delete
Protection Request - Delete
Protection Response - Delete
Subscription Request - Delete
Subscription Response - Describe
Attack Request - Describe
Attack Response - DescribeDRT
Access Request - DescribeDRT
Access Response - Describe
Emergency Contact Settings Request - Describe
Emergency Contact Settings Response - Describe
Protection Request - Describe
Protection Response - Describe
Subscription Request - Describe
Subscription Response - Disable
Proactive Engagement Request - Disable
Proactive Engagement Response - DisassociateDRT
LogBucket Request - DisassociateDRT
LogBucket Response - DisassociateDRT
Role Request - DisassociateDRT
Role Response - Disassociate
Health Check Request - Disassociate
Health Check Response - Emergency
Contact Contact information that the DRT can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.
- Enable
Proactive Engagement Request - Enable
Proactive Engagement Response - GetSubscription
State Request - GetSubscription
State Response - Limit
Specifies how many protections of a given type you can create.
- List
Attacks Request - List
Attacks Response - List
Protections Request - List
Protections Response - Mitigation
The mitigation applied to a DDoS attack.
- Protection
An object that represents a resource that is under DDoS protection.
- Shield
Client - A client for the AWS Shield API.
- SubResource
Summary The attack information for the specified SubResource.
- Subscription
Information about the AWS Shield Advanced subscription for an account.
- Summarized
Attack Vector A summary of information about the attack.
- Summarized
Counter The counter that describes a DDoS attack.
- Time
Range The time range.
- Update
Emergency Contact Settings Request - Update
Emergency Contact Settings Response - Update
Subscription Request - Update
Subscription Response
Enums§
- AssociateDRT
LogBucket Error - Errors returned by AssociateDRTLogBucket
- AssociateDRT
Role Error - Errors returned by AssociateDRTRole
- Associate
Health Check Error - Errors returned by AssociateHealthCheck
- Associate
Proactive Engagement Details Error - Errors returned by AssociateProactiveEngagementDetails
- Create
Protection Error - Errors returned by CreateProtection
- Create
Subscription Error - Errors returned by CreateSubscription
- Delete
Protection Error - Errors returned by DeleteProtection
- Delete
Subscription Error - Errors returned by DeleteSubscription
- Describe
Attack Error - Errors returned by DescribeAttack
- DescribeDRT
Access Error - Errors returned by DescribeDRTAccess
- Describe
Emergency Contact Settings Error - Errors returned by DescribeEmergencyContactSettings
- Describe
Protection Error - Errors returned by DescribeProtection
- Describe
Subscription Error - Errors returned by DescribeSubscription
- Disable
Proactive Engagement Error - Errors returned by DisableProactiveEngagement
- DisassociateDRT
LogBucket Error - Errors returned by DisassociateDRTLogBucket
- DisassociateDRT
Role Error - Errors returned by DisassociateDRTRole
- Disassociate
Health Check Error - Errors returned by DisassociateHealthCheck
- Enable
Proactive Engagement Error - Errors returned by EnableProactiveEngagement
- GetSubscription
State Error - Errors returned by GetSubscriptionState
- List
Attacks Error - Errors returned by ListAttacks
- List
Protections Error - Errors returned by ListProtections
- Update
Emergency Contact Settings Error - Errors returned by UpdateEmergencyContactSettings
- Update
Subscription Error - Errors returned by UpdateSubscription
Traits§
- Shield
- Trait representing the capabilities of the AWS Shield API. AWS Shield clients implement this trait.