Module types

Data structures used by operation inputs/outputs.

Modules

• builders
  Builders
• error
  Error types that AWS Shield can respond with.

Structs

• ApplicationLayerAutomaticResponseConfiguration

  The automatic application layer DDoS mitigation settings for a Protection. This configuration determines whether Shield Advanced automatically manages rules in the web ACL in order to respond to application layer events that Shield Advanced determines to be DDoS attacks.

• AttackDetail

  The details of a DDoS attack.

• AttackProperty

  Details of a Shield event. This is provided as part of an AttackDetail.

• AttackStatisticsDataItem

  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.

• AttackSummary

  Summarizes all DDoS attacks for a specified time period.

• AttackVectorDescription

  Describes the attack.

• AttackVolume

  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.

• AttackVolumeStatistics

  Statistics objects for the various data types in AttackVolume.

• BlockAction

  Specifies that Shield Advanced should configure its WAF rules with the WAF Block action.

  This is only used in the context of the ResponseAction setting.

  JSON specification: "Block": {}

• Contributor

  A contributor to the attack and their contribution.

• CountAction

  Specifies that Shield Advanced should configure its WAF rules with the WAF Count action.

  This is only used in the context of the ResponseAction setting.

  JSON specification: "Count": {}

• EmergencyContact

  Contact information that the SRT can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.

• InclusionProtectionFilters

  Narrows the set of protections that the call retrieves. You can retrieve a single protection by providing its name or the ARN (Amazon Resource Name) of its protected resource. You can also retrieve all protections for a specific resource type. You can provide up to one criteria per filter type. Shield Advanced returns protections that exactly match all of the filter criteria that you provide.

• InclusionProtectionGroupFilters

  Narrows the set of protection groups that the call retrieves. You can retrieve a single protection group by its name and you can retrieve all protection groups that are configured with a specific pattern, aggregation, or resource type. You can provide up to one criteria per filter type. Shield Advanced returns the protection groups that exactly match all of the search criteria that you provide.

• Limit

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

• Mitigation

  The mitigation applied to a DDoS attack.

• Protection

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

• ProtectionGroup

  A grouping of protected resources that you and Shield Advanced can monitor as a collective. This resource grouping improves the accuracy of detection and reduces false positives.

• ProtectionGroupArbitraryPatternLimits

  Limits settings on protection groups with arbitrary pattern type.

• ProtectionGroupLimits

  Limits settings on protection groups for your subscription.

• ProtectionGroupPatternTypeLimits

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

• ProtectionLimits

  Limits settings on protections for your subscription.

• ResponseAction

  Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, when you enable or update automatic mitigation. Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have associated with the resource.

• SubResourceSummary

  The attack information for the specified SubResource.

• Subscription

  Information about the Shield Advanced subscription for an account.

• SubscriptionLimits

  Limits settings for your subscription.

• SummarizedAttackVector

  A summary of information about the attack.

• SummarizedCounter

  The counter that describes a DDoS attack.

• Tag

  A tag associated with an Amazon Web Services 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 Amazon Web Services resource, up to 50 tags for a resource.

• TimeRange

  The time range.

• ValidationExceptionField

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

Enums

• ApplicationLayerAutomaticResponseStatus
  When writing a match expression against ApplicationLayerAutomaticResponseStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• AttackLayer
  When writing a match expression against AttackLayer, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• AttackPropertyIdentifier
  When writing a match expression against AttackPropertyIdentifier, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• AutoRenew
  When writing a match expression against AutoRenew, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ProactiveEngagementStatus
  When writing a match expression against ProactiveEngagementStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ProtectedResourceType
  When writing a match expression against ProtectedResourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ProtectionGroupAggregation
  When writing a match expression against ProtectionGroupAggregation, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ProtectionGroupPattern
  When writing a match expression against ProtectionGroupPattern, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• SubResourceType
  When writing a match expression against SubResourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• SubscriptionState
  When writing a match expression against SubscriptionState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• Unit
  When writing a match expression against Unit, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ValidationExceptionReason
  When writing a match expression against ValidationExceptionReason, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.