IoT / Client / list_audit_mitigation_actions_executions

list_audit_mitigation_actions_executions#

IoT.Client.list_audit_mitigation_actions_executions(**kwargs)#

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

Requires permission to access the ListAuditMitigationActionsExecutions action.

See also: AWS API Documentation

Request Syntax

response = client.list_audit_mitigation_actions_executions(
    taskId='string',
    actionStatus='IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELED'|'SKIPPED'|'PENDING',
    findingId='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • taskId (string) –

    [REQUIRED]

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

  • actionStatus (string) – Specify this filter to limit results to those with a specific status.

  • findingId (string) –

    [REQUIRED]

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

  • maxResults (integer) – The maximum number of results to return at one time. The default is 25.

  • nextToken (string) – The token for the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'actionsExecutions': [
        {
            'taskId': 'string',
            'findingId': 'string',
            'actionName': 'string',
            'actionId': 'string',
            'status': 'IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELED'|'SKIPPED'|'PENDING',
            'startTime': datetime(2015, 1, 1),
            'endTime': datetime(2015, 1, 1),
            'errorCode': 'string',
            'message': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • actionsExecutions (list) –

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

      • (dict) –

        Returned by ListAuditMitigationActionsTask, this object contains information that describes a mitigation action that has been started.

        • taskId (string) –

          The unique identifier for the task that applies the mitigation action.

        • findingId (string) –

          The unique identifier for the findings to which the task and associated mitigation action are applied.

        • actionName (string) –

          The friendly name of the mitigation action being applied by the task.

        • actionId (string) –

          The unique identifier for the mitigation action being applied by the task.

        • status (string) –

          The current status of the task being executed.

        • startTime (datetime) –

          The date and time when the task was started.

        • endTime (datetime) –

          The date and time when the task was completed or canceled. Blank if the task is still running.

        • errorCode (string) –

          If an error occurred, the code that indicates which type of error occurred.

        • message (string) –

          If an error occurred, a message that describes the error.

    • nextToken (string) –

      The token for the next set of results.

Exceptions

  • IoT.Client.exceptions.InvalidRequestException

  • IoT.Client.exceptions.ThrottlingException

  • IoT.Client.exceptions.InternalFailureException