[ aws . iot ]



Gets information about a Device Defender audit.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--task-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]


--task-id (string)

The ID of the audit whose information you want to get.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.


To get information about an audit instance

The following describe-audit-task example gets information about an instance of an AWS IoT Device Defender audit. If the audit is complete, summary statistics for the run are included in the results.

aws iot describe-audit-task \
    --task-id a3aea009955e501a31b764abe1bebd3d


    "taskStatus": "COMPLETED",
    "taskType": "ON_DEMAND_AUDIT_TASK",
    "taskStartTime": 1560356923.434,
    "taskStatistics": {
        "totalChecks": 3,
        "inProgressChecks": 0,
        "waitingForDataCollectionChecks": 0,
        "compliantChecks": 3,
        "nonCompliantChecks": 0,
        "failedChecks": 0,
        "canceledChecks": 0
    "auditDetails": {
            "checkRunStatus": "COMPLETED_COMPLIANT",
            "checkCompliant": true,
            "totalResourcesCount": 0,
            "nonCompliantResourcesCount": 0
            "checkRunStatus": "COMPLETED_COMPLIANT",
            "checkCompliant": true,
            "totalResourcesCount": 6,
            "nonCompliantResourcesCount": 0
            "checkRunStatus": "COMPLETED_COMPLIANT",
            "checkCompliant": true,
            "totalResourcesCount": 0,
            "nonCompliantResourcesCount": 0

For more information, see Audit Commands in the AWS IoT Developer Guide.


taskStatus -> (string)

The status of the audit: one of “IN_PROGRESS”, “COMPLETED”, “FAILED”, or “CANCELED”.

taskType -> (string)


taskStartTime -> (timestamp)

The time the audit started.

taskStatistics -> (structure)

Statistical information about the audit.

totalChecks -> (integer)

The number of checks in this audit.

inProgressChecks -> (integer)

The number of checks in progress.

waitingForDataCollectionChecks -> (integer)

The number of checks waiting for data collection.

compliantChecks -> (integer)

The number of checks that found compliant resources.

nonCompliantChecks -> (integer)

The number of checks that found noncompliant resources.

failedChecks -> (integer)

The number of checks.

canceledChecks -> (integer)

The number of checks that did not run because the audit was canceled.

scheduledAuditName -> (string)

The name of the scheduled audit (only if the audit was a scheduled audit).

auditDetails -> (map)

Detailed information about each check performed during this audit.

key -> (string)

An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

value -> (structure)

Information about the audit check.

checkRunStatus -> (string)


checkCompliant -> (boolean)

True if the check is complete and found all resources compliant.

totalResourcesCount -> (long)

The number of resources on which the check was performed.

nonCompliantResourcesCount -> (long)

The number of resources that were found noncompliant during the check.

errorCode -> (string)

The code of any error encountered when this check is performed during this audit. One of “INSUFFICIENT_PERMISSIONS” or “AUDIT_CHECK_DISABLED”.

message -> (string)

The message associated with any error encountered when this check is performed during this audit.