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

Inherits:
Struct
  • Object
show all
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 collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#behavior_criteria_typeString

The criteria for a behavior.

Returns:

  • (String)


13881
13882
13883
13884
13885
13886
13887
13888
13889
13890
13891
13892
13893
# 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_timeTime

The end time for the alerts to be listed.

Returns:

  • (Time)


13881
13882
13883
13884
13885
13886
13887
13888
13889
13890
13891
13892
13893
# 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_alertsBoolean

A list of all suppressed alerts.

Returns:

  • (Boolean)


13881
13882
13883
13884
13885
13886
13887
13888
13889
13890
13891
13892
13893
# 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_resultsInteger

The maximum number of results to return at one time.

Returns:

  • (Integer)


13881
13882
13883
13884
13885
13886
13887
13888
13889
13890
13891
13892
13893
# 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_tokenString

The token for the next set of results.

Returns:

  • (String)


13881
13882
13883
13884
13885
13886
13887
13888
13889
13890
13891
13892
13893
# 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_nameString

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

Returns:

  • (String)


13881
13882
13883
13884
13885
13886
13887
13888
13889
13890
13891
13892
13893
# 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_timeTime

The start time for the alerts to be listed.

Returns:

  • (Time)


13881
13882
13883
13884
13885
13886
13887
13888
13889
13890
13891
13892
13893
# 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_nameString

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

Returns:

  • (String)


13881
13882
13883
13884
13885
13886
13887
13888
13889
13890
13891
13892
13893
# 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_stateString

The verification state of the violation (detect alarm).

Returns:

  • (String)


13881
13882
13883
13884
13885
13886
13887
13888
13889
13890
13891
13892
13893
# 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