ListAuditMitigationActionsExecutionsCommand

Suggest an Edit

Gets the status of audit mitigation action tasks that were executed.

Requires permission to access the ListAuditMitigationActionsExecutions  action.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { IoTClient, ListAuditMitigationActionsExecutionsCommand } from "@aws-sdk/client-iot"; // ES Modules import
// const { IoTClient, ListAuditMitigationActionsExecutionsCommand } = require("@aws-sdk/client-iot"); // CommonJS import
const client = new IoTClient(config);
const input = { // ListAuditMitigationActionsExecutionsRequest
  taskId: "STRING_VALUE", // required
  actionStatus: "IN_PROGRESS" || "COMPLETED" || "FAILED" || "CANCELED" || "SKIPPED" || "PENDING",
  findingId: "STRING_VALUE", // required
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
};
const command = new ListAuditMitigationActionsExecutionsCommand(input);
const response = await client.send(command);
// { // ListAuditMitigationActionsExecutionsResponse
//   actionsExecutions: [ // AuditMitigationActionExecutionMetadataList
//     { // AuditMitigationActionExecutionMetadata
//       taskId: "STRING_VALUE",
//       findingId: "STRING_VALUE",
//       actionName: "STRING_VALUE",
//       actionId: "STRING_VALUE",
//       status: "IN_PROGRESS" || "COMPLETED" || "FAILED" || "CANCELED" || "SKIPPED" || "PENDING",
//       startTime: new Date("TIMESTAMP"),
//       endTime: new Date("TIMESTAMP"),
//       errorCode: "STRING_VALUE",
//       message: "STRING_VALUE",
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListAuditMitigationActionsExecutionsCommand Input

See ListAuditMitigationActionsExecutionsCommandInput for more details

Parameter
Type
Description
findingId
Required
string | undefined

Specify this filter to limit results to those that were applied to a specific audit finding.

taskId
Required
string | undefined

Specify this filter to limit results to actions for a specific audit mitigation actions task.

actionStatus
AuditMitigationActionsExecutionStatus | undefined

Specify this filter to limit results to those with a specific status.

maxResults
number | undefined

The maximum number of results to return at one time. The default is 25.

nextToken
string | undefined

The token for the next set of results.

ListAuditMitigationActionsExecutionsCommand Output

See ListAuditMitigationActionsExecutionsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
actionsExecutions
AuditMitigationActionExecutionMetadata[] | undefined

A set of task execution results based on the input parameters. Details include the mitigation action applied, start time, and task status.

nextToken
string | undefined

The token for the next set of results.

Throws

Name
Fault
Details
InternalFailureException
server

An unexpected error has occurred.

InvalidRequestException
client

The request is not valid.

ThrottlingException
client

The rate exceeds the limit.

IoTServiceException
Base exception class for all service exceptions from IoT service.