ComponentPlatformList

ComponentPlatformList schema

Edge ComputingIoTLambdaMachine LearningReal-Time Processing
View JSON Schema on GitHub

JSON Schema

iot-greengrass-component-platform-list-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-greengrass/refs/heads/main/json-schema/iot-greengrass-component-platform-list-schema.json",
  "title": "ComponentPlatformList",
  "description": "ComponentPlatformList schema",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "name": {
        "allOf": [
          {
            "$ref": "#/components/schemas/NonEmptyString"
          },
          {
            "description": "<p>The friendly name of the platform. This name helps you identify the platform.</p> <p>If you omit this parameter, IoT Greengrass creates a friendly name from the <code>os</code> and <code>architecture</code> of the platform.</p>"
          }
        ]
      },
      "attributes": {
        "allOf": [
          {
            "$ref": "#/components/schemas/PlatformAttributesMap"
          },
          {
            "description": "A dictionary of attributes for the platform. The IoT Greengrass Core software defines the <code>os</code> and <code>architecture</code> by default. You can specify additional platform attributes for a core device when you deploy the Greengrass nucleus component. For more information, see the <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html\">Greengrass nucleus component</a> in the <i>IoT Greengrass V2 Developer Guide</i>."
          }
        ]
      }
    },
    "description": "Contains information about a platform that a component supports."
  }
}