Class: Aws::WAFV2::Types::ApiSecurityEventDetail

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb

Overview

The API security details of an event.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#api_patterns ⇒ Array<Types::ApiPattern>

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

Returns:



614
615
616
617
618
619
620
621
622
623
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 614

class ApiSecurityEventDetail < Struct.new(
  :label,
  :category,
  :confidence,
  :api_patterns,
  :event_actors,
  :timeline)
  SENSITIVE = []
  include Aws::Structure
end

#category ⇒ String

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

Returns:

  • (String)


614
615
616
617
618
619
620
621
622
623
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 614

class ApiSecurityEventDetail < Struct.new(
  :label,
  :category,
  :confidence,
  :api_patterns,
  :event_actors,
  :timeline)
  SENSITIVE = []
  include Aws::Structure
end

#confidence ⇒ String

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

Returns:

  • (String)


614
615
616
617
618
619
620
621
622
623
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 614

class ApiSecurityEventDetail < Struct.new(
  :label,
  :category,
  :confidence,
  :api_patterns,
  :event_actors,
  :timeline)
  SENSITIVE = []
  include Aws::Structure
end

#event_actors ⇒ Array<Types::EventActorReference>

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.

Returns:



614
615
616
617
618
619
620
621
622
623
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 614

class ApiSecurityEventDetail < Struct.new(
  :label,
  :category,
  :confidence,
  :api_patterns,
  :event_actors,
  :timeline)
  SENSITIVE = []
  include Aws::Structure
end

#label ⇒ String

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

Returns:

  • (String)


614
615
616
617
618
619
620
621
622
623
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 614

class ApiSecurityEventDetail < Struct.new(
  :label,
  :category,
  :confidence,
  :api_patterns,
  :event_actors,
  :timeline)
  SENSITIVE = []
  include Aws::Structure
end

#timeline ⇒ Array<Types::EventTimelineEntry>

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.

Returns:



614
615
616
617
618
619
620
621
622
623
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 614

class ApiSecurityEventDetail < Struct.new(
  :label,
  :category,
  :confidence,
  :api_patterns,
  :event_actors,
  :timeline)
  SENSITIVE = []
  include Aws::Structure
end