Amazon IoT Greengrass · JSON Structure

Iot Greengrass Component Candidate Structure

Contains information about a component that is a candidate to deploy to a Greengrass core device.

Type: object Properties: 3
Edge ComputingIoTLambdaMachine LearningReal-Time Processing

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

Properties

componentName componentVersion versionRequirements

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-greengrass/refs/heads/main/json-structure/iot-greengrass-component-candidate-structure.json",
  "name": "ComponentCandidate",
  "description": "Contains information about a component that is a candidate to deploy to a Greengrass core device.",
  "type": "object",
  "properties": {
    "componentName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComponentNameString"
        },
        {
          "description": "The name of the component."
        }
      ]
    },
    "componentVersion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComponentVersionString"
        },
        {
          "description": "The version of the component."
        }
      ]
    },
    "versionRequirements": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComponentVersionRequirementMap"
        },
        {
          "description": "<p>The version requirements for the component's dependencies. Greengrass core devices get the version requirements from component recipes.</p> <p>IoT Greengrass V2 uses semantic version constraints. For more information, see <a href=\"https://semver.org/\">Semantic Versioning</a>.</p>"
        }
      ]
    }
  }
}