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
Statistics Data Item A single attack statistics data record. This is returned by DescribeAttackStatistics along with a time range indicating the time period that the attack statistics apply to.
- Attack
Summary Summarizes all DDoS attacks for a specified time period.
- Attack
Vector Description Describes the attack.
- Attack
Volume Information about the volume of attacks during the time period, included in an AttackStatisticsDataItem. If the accompanying
AttackCountin the statistics object is zero, this setting might be empty.- Attack
Volume Statistics Statistics objects for the various data types in AttackVolume.
- Contributor
A contributor to the attack and their contribution.
- Create
Protection Group Request - Create
Protection Group Response - Create
Protection Request - Create
Protection Response - Create
Subscription Request - Create
Subscription Response - Delete
Protection Group Request - Delete
Protection Group Response - Delete
Protection Request - Delete
Protection Response - Delete
Subscription Request - Delete
Subscription Response - Describe
Attack Request - Describe
Attack Response - Describe
Attack Statistics Request - Describe
Attack Statistics Response - DescribeDRT
Access Request - DescribeDRT
Access Response - Describe
Emergency Contact Settings Request - Describe
Emergency Contact Settings Response - Describe
Protection Group Request - Describe
Protection Group 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
Protection Groups Request - List
Protection Groups Response - List
Protections Request - List
Protections Response - List
Resources InProtection Group Request - List
Resources InProtection Group Response - List
Tags ForResource Request - List
Tags ForResource Response - Mitigation
The mitigation applied to a DDoS attack.
- Protection
An object that represents a resource that is under DDoS protection.
- Protection
Group A grouping of protected resources that you and AWS Shield Advanced can monitor as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
- Protection
Group Arbitrary Pattern Limits Limits settings on protection groups with arbitrary pattern type.
- Protection
Group Limits Limits settings on protection groups for your subscription.
- Protection
Group Pattern Type Limits Limits settings by pattern type in the protection groups for your subscription.
- Protection
Limits Limits settings on protections for your subscription.
- 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.
- Subscription
Limits Limits settings for your subscription.
- Summarized
Attack Vector A summary of information about the attack.
- Summarized
Counter The counter that describes a DDoS attack.
- Tag
A tag associated with an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as "environment", and the tag value represents a specific value within that category, such as "test," "development," or "production". Or you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.
- TagResource
Request - TagResource
Response - Time
Range The time range.
- Untag
Resource Request - Untag
Resource Response - Update
Emergency Contact Settings Request - Update
Emergency Contact Settings Response - Update
Protection Group Request - Update
Protection Group Response - Update
Subscription Request - Update
Subscription Response - Validation
Exception Field Provides information about a particular parameter passed inside a request that resulted in an exception.
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
Protection Group Error - Errors returned by CreateProtectionGroup
- Create
Subscription Error - Errors returned by CreateSubscription
- Delete
Protection Error - Errors returned by DeleteProtection
- Delete
Protection Group Error - Errors returned by DeleteProtectionGroup
- Delete
Subscription Error - Errors returned by DeleteSubscription
- Describe
Attack Error - Errors returned by DescribeAttack
- Describe
Attack Statistics Error - Errors returned by DescribeAttackStatistics
- DescribeDRT
Access Error - Errors returned by DescribeDRTAccess
- Describe
Emergency Contact Settings Error - Errors returned by DescribeEmergencyContactSettings
- Describe
Protection Error - Errors returned by DescribeProtection
- Describe
Protection Group Error - Errors returned by DescribeProtectionGroup
- 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
Protection Groups Error - Errors returned by ListProtectionGroups
- List
Protections Error - Errors returned by ListProtections
- List
Resources InProtection Group Error - Errors returned by ListResourcesInProtectionGroup
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
Emergency Contact Settings Error - Errors returned by UpdateEmergencyContactSettings
- Update
Protection Group Error - Errors returned by UpdateProtectionGroup
- Update
Subscription Error - Errors returned by UpdateSubscription
Traits§
- Shield
- Trait representing the capabilities of the AWS Shield API. AWS Shield clients implement this trait.