Class: Aws::IoT::Types::StartAuditMitigationActionsTaskRequest

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

{
  task_id: "MitigationActionsTaskId", # required
  target: { # required
    audit_task_id: "AuditTaskId",
    finding_ids: ["FindingId"],
    audit_check_to_reason_code_filter: {
      "AuditCheckName" => ["ReasonForNonComplianceCode"],
    },
  },
  audit_check_to_actions_mapping: { # required
    "AuditCheckName" => ["MitigationActionName"],
  },
  client_request_token: "ClientRequestToken", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#audit_check_to_actions_mappingHash<String,Array<String>>

For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your Amazon Web Services accounts.

Returns:

  • (Hash<String,Array<String>>)


16381
16382
16383
16384
16385
16386
16387
16388
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 16381

class StartAuditMitigationActionsTaskRequest < Struct.new(
  :task_id,
  :target,
  :audit_check_to_actions_mapping,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#client_request_tokenString

Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.

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

Returns:

  • (String)


16381
16382
16383
16384
16385
16386
16387
16388
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 16381

class StartAuditMitigationActionsTaskRequest < Struct.new(
  :task_id,
  :target,
  :audit_check_to_actions_mapping,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#targetTypes::AuditMitigationActionsTaskTarget

Specifies the audit findings to which the mitigation actions are applied. You can apply them to a type of audit check, to all findings from an audit, or to a specific set of findings.



16381
16382
16383
16384
16385
16386
16387
16388
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 16381

class StartAuditMitigationActionsTaskRequest < Struct.new(
  :task_id,
  :target,
  :audit_check_to_actions_mapping,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#task_idString

A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.

Returns:

  • (String)


16381
16382
16383
16384
16385
16386
16387
16388
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 16381

class StartAuditMitigationActionsTaskRequest < Struct.new(
  :task_id,
  :target,
  :audit_check_to_actions_mapping,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end