Class: Aws::IoT::Types::ListViolationEventsRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::ListViolationEventsRequest

Defined in:

gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Overview

Note:

When making an API call, you may pass ListViolationEventsRequest data as a hash:

{
  start_time: Time.now, # required
  end_time: Time.now, # required
  thing_name: "DeviceDefenderThingName",
  security_profile_name: "SecurityProfileName",
  behavior_criteria_type: "STATIC", # accepts STATIC, STATISTICAL, MACHINE_LEARNING
  list_suppressed_alerts: false,
  verification_state: "FALSE_POSITIVE", # accepts FALSE_POSITIVE, BENIGN_POSITIVE, TRUE_POSITIVE, UNKNOWN
  next_token: "NextToken",
  max_results: 1,
}

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #behavior_criteria_type ⇒ String

  The criteria for a behavior.

• #end_time ⇒ Time

  The end time for the alerts to be listed.

• #list_suppressed_alerts ⇒ Boolean

  A list of all suppressed alerts.

• #max_results ⇒ Integer

  The maximum number of results to return at one time.

• #next_token ⇒ String

  The token for the next set of results.

• #security_profile_name ⇒ String

  A filter to limit results to those alerts generated by the specified security profile.

• #start_time ⇒ Time

  The start time for the alerts to be listed.

• #thing_name ⇒ String

  A filter to limit results to those alerts caused by the specified thing.

• #verification_state ⇒ String

  The verification state of the violation (detect alarm).

Instance Attribute Details

#behavior_criteria_type ⇒ String

The criteria for a behavior.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 13881

class ListViolationEventsRequest < Struct.new(
  :start_time,
  :end_time,
  :thing_name,
  :security_profile_name,
  :behavior_criteria_type,
  :list_suppressed_alerts,
  :verification_state,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

The end time for the alerts to be listed.

Returns:

• (Time)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 13881

class ListViolationEventsRequest < Struct.new(
  :start_time,
  :end_time,
  :thing_name,
  :security_profile_name,
  :behavior_criteria_type,
  :list_suppressed_alerts,
  :verification_state,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#list_suppressed_alerts ⇒ Boolean

A list of all suppressed alerts.

Returns:

• (Boolean)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 13881

class ListViolationEventsRequest < Struct.new(
  :start_time,
  :end_time,
  :thing_name,
  :security_profile_name,
  :behavior_criteria_type,
  :list_suppressed_alerts,
  :verification_state,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return at one time.

Returns:

• (Integer)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 13881

class ListViolationEventsRequest < Struct.new(
  :start_time,
  :end_time,
  :thing_name,
  :security_profile_name,
  :behavior_criteria_type,
  :list_suppressed_alerts,
  :verification_state,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token for the next set of results.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 13881

class ListViolationEventsRequest < Struct.new(
  :start_time,
  :end_time,
  :thing_name,
  :security_profile_name,
  :behavior_criteria_type,
  :list_suppressed_alerts,
  :verification_state,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#security_profile_name ⇒ String

A filter to limit results to those alerts generated by the specified security profile.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 13881

class ListViolationEventsRequest < Struct.new(
  :start_time,
  :end_time,
  :thing_name,
  :security_profile_name,
  :behavior_criteria_type,
  :list_suppressed_alerts,
  :verification_state,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The start time for the alerts to be listed.

Returns:

• (Time)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 13881

class ListViolationEventsRequest < Struct.new(
  :start_time,
  :end_time,
  :thing_name,
  :security_profile_name,
  :behavior_criteria_type,
  :list_suppressed_alerts,
  :verification_state,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#thing_name ⇒ String

A filter to limit results to those alerts caused by the specified thing.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 13881

class ListViolationEventsRequest < Struct.new(
  :start_time,
  :end_time,
  :thing_name,
  :security_profile_name,
  :behavior_criteria_type,
  :list_suppressed_alerts,
  :verification_state,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#verification_state ⇒ String

The verification state of the violation (detect alarm).

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 13881

class ListViolationEventsRequest < Struct.new(
  :start_time,
  :end_time,
  :thing_name,
  :security_profile_name,
  :behavior_criteria_type,
  :list_suppressed_alerts,
  :verification_state,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end