Amazon IoT Device Management · JSON Structure

Iot Device Management Describe Audit Task Response Structure

DescribeAuditTaskResponse schema

Type: object Properties: 6
Device ManagementFleet ManagementIoTOTA Updates

DescribeAuditTaskResponse is a JSON Structure definition published by Amazon IoT Device Management, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

taskStatus taskType taskStartTime taskStatistics scheduledAuditName auditDetails

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-device-management/refs/heads/main/json-structure/iot-device-management-describe-audit-task-response-structure.json",
  "name": "DescribeAuditTaskResponse",
  "description": "DescribeAuditTaskResponse schema",
  "type": "object",
  "properties": {
    "taskStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AuditTaskStatus"
        },
        {
          "description": "The status of the audit: one of \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\", or \"CANCELED\"."
        }
      ]
    },
    "taskType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AuditTaskType"
        },
        {
          "description": "The type of audit: \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED_AUDIT_TASK\"."
        }
      ]
    },
    "taskStartTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The time the audit started."
        }
      ]
    },
    "taskStatistics": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TaskStatistics"
        },
        {
          "description": "Statistical information about the audit."
        }
      ]
    },
    "scheduledAuditName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ScheduledAuditName"
        },
        {
          "description": "The name of the scheduled audit (only if the audit was a scheduled audit)."
        }
      ]
    },
    "auditDetails": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AuditDetails"
        },
        {
          "description": "Detailed information about each check performed during this audit."
        }
      ]
    }
  }
}