Class: Aws::IoT::Types::StartDetectMitigationActionsTaskRequest

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 StartDetectMitigationActionsTaskRequest data as a hash:

{
  task_id: "MitigationActionsTaskId", # required
  target: { # required
    violation_ids: ["ViolationId"],
    security_profile_name: "SecurityProfileName",
    behavior_name: "BehaviorName",
  },
  actions: ["MitigationActionName"], # required
  violation_event_occurrence_range: {
    start_time: Time.now, # required
    end_time: Time.now, # required
  },
  include_only_active_violations: false,
  include_suppressed_alerts: false,
  client_request_token: "ClientRequestToken", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actionsArray<String>

The actions to be performed when a device has unexpected behavior.

Returns:

  • (Array<String>)


16338
16339
16340
16341
16342
16343
16344
16345
16346
16347
16348
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 16338

class StartDetectMitigationActionsTaskRequest < Struct.new(
  :task_id,
  :target,
  :actions,
  :violation_event_occurrence_range,
  :include_only_active_violations,
  :include_suppressed_alerts,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#client_request_tokenString

Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


16338
16339
16340
16341
16342
16343
16344
16345
16346
16347
16348
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 16338

class StartDetectMitigationActionsTaskRequest < Struct.new(
  :task_id,
  :target,
  :actions,
  :violation_event_occurrence_range,
  :include_only_active_violations,
  :include_suppressed_alerts,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#include_only_active_violationsBoolean

Specifies to list only active violations.

Returns:

  • (Boolean)


16338
16339
16340
16341
16342
16343
16344
16345
16346
16347
16348
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 16338

class StartDetectMitigationActionsTaskRequest < Struct.new(
  :task_id,
  :target,
  :actions,
  :violation_event_occurrence_range,
  :include_only_active_violations,
  :include_suppressed_alerts,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#include_suppressed_alertsBoolean

Specifies to include suppressed alerts.

Returns:

  • (Boolean)


16338
16339
16340
16341
16342
16343
16344
16345
16346
16347
16348
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 16338

class StartDetectMitigationActionsTaskRequest < Struct.new(
  :task_id,
  :target,
  :actions,
  :violation_event_occurrence_range,
  :include_only_active_violations,
  :include_suppressed_alerts,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#targetTypes::DetectMitigationActionsTaskTarget

Specifies the ML Detect findings to which the mitigation actions are applied.



16338
16339
16340
16341
16342
16343
16344
16345
16346
16347
16348
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 16338

class StartDetectMitigationActionsTaskRequest < Struct.new(
  :task_id,
  :target,
  :actions,
  :violation_event_occurrence_range,
  :include_only_active_violations,
  :include_suppressed_alerts,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#task_idString

The unique identifier of the task.

Returns:

  • (String)


16338
16339
16340
16341
16342
16343
16344
16345
16346
16347
16348
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 16338

class StartDetectMitigationActionsTaskRequest < Struct.new(
  :task_id,
  :target,
  :actions,
  :violation_event_occurrence_range,
  :include_only_active_violations,
  :include_suppressed_alerts,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#violation_event_occurrence_rangeTypes::ViolationEventOccurrenceRange

Specifies the time period of which violation events occurred between.



16338
16339
16340
16341
16342
16343
16344
16345
16346
16347
16348
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 16338

class StartDetectMitigationActionsTaskRequest < Struct.new(
  :task_id,
  :target,
  :actions,
  :violation_event_occurrence_range,
  :include_only_active_violations,
  :include_suppressed_alerts,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end