You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing StartAuditMitigationActionsTaskRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  task_id: "AuditMitigationActionsTaskId", # 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
}

Instance Attribute Summary collapse

Instance Attribute Details

#audit_check_to_actions_mapping ⇒ Hash<String,Array<String>>

For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your AWS account.

Returns:

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

    For an audit check, specifies which mitigation actions to apply.

#client_request_token ⇒ String

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.

Returns:

  • (String) —

    Each audit mitigation task must have a unique client request token.

#target ⇒ Types::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 speecific set of findings.

Returns:

#task_id ⇒ String

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

Returns:

  • (String) —

    A unique identifier for the task.