DescribeAuditTaskResponse

DescribeAuditTaskResponse schema

Device ManagementFleet ManagementIoTOTA Updates

Properties

Name Type Description
taskStatus object
taskType object
taskStartTime object
taskStatistics object
scheduledAuditName object
auditDetails object
View JSON Schema on GitHub

JSON Schema

iot-device-management-describe-audit-task-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-device-management/refs/heads/main/json-schema/iot-device-management-describe-audit-task-response-schema.json",
  "title": "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."
        }
      ]
    }
  }
}