Amazon Application Discovery Service · Schema

AgentInfo

AgentInfo schema from Amazon Application Discovery Service API

Amazon Application Discovery ServiceMigrationDiscoveryInfrastructure

Properties

Name	Type	Description
agentId	string	The agent or collector ID.
hostName	string	The name of the host where the agent or collector resides.
agentNetworkInfoList	array	Network details about the host where the agent or collector resides.
connectorId	string	The ID of the connector.
version	string	The agent or collector version.
health	string	The health of the agent or collector.
lastHealthPingTime	string	Time since agent or collector health was reported.
collectionStatus	string	Status of the collection process for the agent or collector.
agentType	string	Type of agent.
registeredTime	string	Agent's first registration timestamp in UTC.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-application-discovery-service/refs/heads/main/json-schema/application-discovery-service-agent-info-schema.json",
  "title": "AgentInfo",
  "description": "AgentInfo schema from Amazon Application Discovery Service API",
  "type": "object",
  "properties": {
    "agentId": {
      "type": "string",
      "example": "d-agent-500123",
      "description": "The agent or collector ID."
    },
    "hostName": {
      "type": "string",
      "example": "server-01.example.com",
      "description": "The name of the host where the agent or collector resides."
    },
    "agentNetworkInfoList": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ipAddress": {
            "type": "string",
            "example": "10.0.0.10",
            "description": "The IP address for the host where the agent or collector resides."
          },
          "macAddress": {
            "type": "string",
            "example": "aa:bb:cc:dd:ee:ff",
            "description": "The MAC address for the host where the agent or collector resides."
          }
        }
      },
      "description": "Network details about the host where the agent or collector resides."
    },
    "connectorId": {
      "type": "string",
      "example": "",
      "description": "The ID of the connector."
    },
    "version": {
      "type": "string",
      "example": "2.0.1",
      "description": "The agent or collector version."
    },
    "health": {
      "type": "string",
      "enum": [
        "HEALTHY",
        "UNHEALTHY",
        "RUNNING",
        "UNKNOWN",
        "BLACKLISTED",
        "SHUTDOWN"
      ],
      "example": "HEALTHY",
      "description": "The health of the agent or collector."
    },
    "lastHealthPingTime": {
      "type": "string",
      "example": "2026-04-19T10:00:00Z",
      "description": "Time since agent or collector health was reported."
    },
    "collectionStatus": {
      "type": "string",
      "example": "START_SCHEDULED",
      "description": "Status of the collection process for the agent or collector."
    },
    "agentType": {
      "type": "string",
      "example": "AWS_DISCOVERY_AGENT",
      "description": "Type of agent."
    },
    "registeredTime": {
      "type": "string",
      "example": "2026-01-01T00:00:00Z",
      "description": "Agent's first registration timestamp in UTC."
    }
  }
}