View a markdown version of this page

EventDetailSummary - AWS WAFV2

EventDetailSummary

Information about an API security event, returned by ListEvents, ListEventsByWebACL, and GetEvent.

Contents

EventId

The unique identifier of the event. You provide this to GetEvent to retrieve the details of the event.

Type: String

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

Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$

Required: Yes

ApiSecurityEventDetail

The API security details of the event, such as the label, category, confidence, API patterns, and event actors.

Type: ApiSecurityEventDetail object

Required: No

EndTime

The time when the event ended. This is not populated while the event is ongoing.

Type: Timestamp

Required: No

EventCategory

The category of the event. The only supported value is API_SECURITY.

Type: String

Valid Values: API_SECURITY

Required: No

EventStatus

The current status of the event.

Type: String

Valid Values: EVENT_STARTED | EVENT_IN_PROGRESS | EVENT_COMPLETED | EVENT_ENDED

Required: No

LastUpdatedTime

The time when the event was last updated.

Type: Timestamp

Required: No

ResourceArn

The Amazon Resource Name (ARN) of the protected resource that the event is associated with.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: .*\S.*

Required: No

StartTime

The time when the event started.

Type: Timestamp

Required: No

WebAclArn

The Amazon Resource Name (ARN) of the web ACL that the event is associated with.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: .*\S.*

Required: No

See Also

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