/audit/tasks/{taskId}

The AWS IoT Wireless multi-region endpoint

https://api.iotwireless.{region}.amazonaws.com

GET

Gets information about a Device Defender audit.

Requires permission to access the DescribeAuditTask action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.iotwireless.{region}.amazonaws.com/audit/tasks/'

Response Example

200 - Example 1

{
    "taskStatus": "IN_PROGRESS",
    "taskType": "ON_DEMAND_AUDIT_TASK",
    "taskStartTime": "string",
    "taskStatistics": {
        "totalChecks": 0,
        "inProgressChecks": 0,
        "waitingForDataCollectionChecks": 0,
        "compliantChecks": 0,
        "nonCompliantChecks": 0,
        "failedChecks": 0,
        "canceledChecks": 0
    },
    "scheduledAuditName": "string",
    "auditDetails": {
        "property1": {
            "checkRunStatus": "IN_PROGRESS",
            "checkCompliant": true,
            "totalResourcesCount": 0,
            "nonCompliantResourcesCount": 0,
            "suppressedNonCompliantResourcesCount": 0,
            "errorCode": "string",
            "message": "string"
        }
    }
}

Request

Path Params

taskId

string

required

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

Responses

🟢200Success

application/json

Body

taskStatus

enum<string>

optional

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

Allowed values:

IN_PROGRESSCOMPLETEDFAILEDCANCELED

taskType

enum<string>

optional

The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".

Allowed values:

ON_DEMAND_AUDIT_TASKSCHEDULED_AUDIT_TASK

taskStartTime

string <date-time>

optional

The time the audit started.

taskStatistics

object

optional

Statistical information about the audit.

totalChecks

integer

optional

The number of checks in this audit.

inProgressChecks

integer

optional

The number of checks in progress.

waitingForDataCollectionChecks

integer

optional

The number of checks waiting for data collection.

compliantChecks

integer

optional

The number of checks that found compliant resources.

nonCompliantChecks

integer

optional

The number of checks that found noncompliant resources.

failedChecks

integer

optional

The number of checks.

canceledChecks

integer

optional

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

scheduledAuditName

string

optional

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

>= 1 characters<= 128 characters

Match pattern:

[a-zA-Z0-9_-]+

auditDetails

object

optional

Detailed information about each check performed during this audit.

🟠480InvalidRequestException

🟠481ResourceNotFoundException

🟠482ThrottlingException

🟠483InternalFailureException

Modified at 2022-09-10 23:12:16

/audit/suppressions/describe

/detect/mitigationactions/tasks/{taskId}