View a markdown version of this page

ApiSecurityEventDetail - AWS WAFV2

ApiSecurityEventDetail

The API security details of an event.

Contents

ApiPatterns

The API patterns that the event involves. The list contains up to 20 API patterns.

Type: Array of ApiPattern objects

Array Members: Maximum number of 20 items.

Required: No

Category

The API security threat category of the event. For example, API2:2023.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: No

Confidence

The confidence level of the event detection: LOW, MEDIUM, or HIGH.

Type: String

Valid Values: LOW | MEDIUM | HIGH

Required: No

EventActors

The event actors that are associated with the event. The list contains up to 20 event actors. To retrieve the details of an event actor, provide its EventActorId to GetEventActor.

Type: Array of EventActorReference objects

Array Members: Maximum number of 20 items.

Required: No

Label

The fully qualified name of the label that AWS WAF assigned to the event. For example, awswaf:managed:aws:api-security:credential-stuffing-high.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^[0-9A-Za-z_\-:]+$

Required: No

Timeline

The changes to the event's label, confidence, and API patterns over time, ordered from oldest to newest. The list contains up to 32 entries.

For ListEvents and ListEventsByWebACL, this is returned only if you specify TIMELINE in the request Include setting.

Type: Array of EventTimelineEntry objects

Array Members: Maximum number of 32 items.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: