logo
Expand description

AWS Shield Advanced

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

The details of a DDoS attack.

Details of the described attack.

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.

Summarizes all DDoS attacks for a specified time period.

Describes the attack.

Information about the volume of attacks during the time period, included in an AttackStatisticsDataItem. If the accompanying AttackCount in the statistics object is zero, this setting might be empty.

Statistics objects for the various data types in AttackVolume.

A contributor to the attack and their contribution.

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.

Specifies how many protections of a given type you can create.

The mitigation applied to a DDoS attack.

An object that represents a resource that is under DDoS protection.

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.

Limits settings on protection groups with arbitrary pattern type.

Limits settings on protection groups for your subscription.

Limits settings by pattern type in the protection groups for your subscription.

Limits settings on protections for your subscription.

A client for the AWS Shield API.

The attack information for the specified SubResource.

Information about the AWS Shield Advanced subscription for an account.

Limits settings for your subscription.

A summary of information about the attack.

The counter that describes a DDoS attack.

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.

The time range.

Provides information about a particular parameter passed inside a request that resulted in an exception.

Enums

Errors returned by AssociateDRTLogBucket

Errors returned by AssociateDRTRole

Errors returned by AssociateHealthCheck

Errors returned by AssociateProactiveEngagementDetails

Errors returned by CreateProtection

Errors returned by CreateProtectionGroup

Errors returned by CreateSubscription

Errors returned by DeleteProtection

Errors returned by DeleteProtectionGroup

Errors returned by DeleteSubscription

Errors returned by DescribeAttack

Errors returned by DescribeAttackStatistics

Errors returned by DescribeDRTAccess

Errors returned by DescribeEmergencyContactSettings

Errors returned by DescribeProtection

Errors returned by DescribeProtectionGroup

Errors returned by DescribeSubscription

Errors returned by DisableProactiveEngagement

Errors returned by DisassociateDRTLogBucket

Errors returned by DisassociateDRTRole

Errors returned by DisassociateHealthCheck

Errors returned by EnableProactiveEngagement

Errors returned by GetSubscriptionState

Errors returned by ListAttacks

Errors returned by ListProtectionGroups

Errors returned by ListProtections

Errors returned by ListResourcesInProtectionGroup

Errors returned by ListTagsForResource

Errors returned by TagResource

Errors returned by UntagResource

Errors returned by UpdateEmergencyContactSettings

Errors returned by UpdateProtectionGroup

Errors returned by UpdateSubscription

Traits

Trait representing the capabilities of the AWS Shield API. AWS Shield clients implement this trait.