Amazon Ground Station · JSON Structure

Ground Station Agent Details Structure

Detailed information about the agent.

Type: object Properties: 6 Required: 4
Data ProcessingIoTSatellite CommunicationsSpace Technology

AgentDetails is a JSON Structure definition published by Amazon Ground Station, describing 6 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

agentCpuCores agentVersion componentVersions instanceId instanceType reservedCpuCores

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-ground-station/refs/heads/main/json-structure/ground-station-agent-details-structure.json",
  "name": "AgentDetails",
  "description": "Detailed information about the agent.",
  "type": "object",
  "properties": {
    "agentCpuCores": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AgentCpuCoresList"
        },
        {
          "description": "List of CPU cores reserved for the agent."
        }
      ]
    },
    "agentVersion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VersionString"
        },
        {
          "description": "Current agent version."
        }
      ]
    },
    "componentVersions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComponentVersionList"
        },
        {
          "description": "List of versions being used by agent components."
        }
      ]
    },
    "instanceId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InstanceId"
        },
        {
          "description": "ID of EC2 instance agent is running on."
        }
      ]
    },
    "instanceType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InstanceType"
        },
        {
          "description": "Type of EC2 instance agent is running on."
        }
      ]
    },
    "reservedCpuCores": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AgentCpuCoresList"
        },
        {
          "description": "<note> <p>This field should not be used. Use agentCpuCores instead.</p> </note> <p>List of CPU cores reserved for processes other than the agent running on the EC2 instance.</p>"
        }
      ]
    }
  },
  "required": [
    "agentVersion",
    "componentVersions",
    "instanceId",
    "instanceType"
  ]
}