Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iot ]

list-audit-mitigation-actions-tasks

Description

Gets a list of audit mitigation action tasks that match the specified filters.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-audit-mitigation-actions-tasks
[--audit-task-id <value>]
[--finding-id <value>]
[--task-status <value>]
[--max-results <value>]
[--next-token <value>]
--start-time <value>
--end-time <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--audit-task-id (string)

Specify this filter to limit results to tasks that were applied to results for a specific audit.

--finding-id (string)

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

--task-status (string)

Specify this filter to limit results to tasks that are in a specific state.

Possible values:

  • IN_PROGRESS
  • COMPLETED
  • FAILED
  • CANCELED

--max-results (integer)

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

--next-token (string)

The token for the next set of results.

--start-time (timestamp)

Specify this filter to limit results to tasks that began on or after a specific date and time.

--end-time (timestamp)

Specify this filter to limit results to tasks that were completed or canceled on or before a specific date and time.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To list audit mitigation action tasks

The following list-audit-mitigation-actions-tasks example lists the mitigation actions that were applied to findings within the specified time period.

aws iot create-mitigation-action --cli-input-json file://params.json

Contents of params.json:

{
    "actionName": "AddThingsToQuarantineGroup1Action",
    "actionParams": {
        "addThingsToThingGroupParams": {
            "thingGroupNames": [
                "QuarantineGroup1"
            ],
            "overrideDynamicGroups": true
        }
    },
    "roleArn": "arn:aws:iam::123456789012:role/service-role/MoveThingsToQuarantineGroupRole"
}

Output:

{
    "tasks": [
        {
            "taskId": "ResetPolicyTask01",
            "startTime": "2019-12-10T15:13:19.457000-08:00",
            "taskStatus": "COMPLETED"
        }
    ]
}

For more information, see ListAuditMitigationActionsTasks (Mitigation Action Commands) in the AWS IoT Developer Guide.

Output

tasks -> (list)

The collection of audit mitigation tasks that matched the filter criteria.

(structure)

Information about an audit mitigation actions task that is returned by ListAuditMitigationActionsTasks .

taskId -> (string)

The unique identifier for the task.

startTime -> (timestamp)

The time at which the audit mitigation actions task was started.

taskStatus -> (string)

The current state of the audit mitigation actions task.

nextToken -> (string)

The token for the next set of results.