Amazon Neptune · JSON Structure

Streams Property Graph Data Structure

The serialized property graph change data. The type field indicates the element kind.

Type: object Properties: 6
DatabaseGraph DatabaseGremlinNeptuneProperty GraphRDFSPARQL

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

Properties

id type key value from to

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-neptune/refs/heads/main/json-structure/streams-property-graph-data-structure.json",
  "name": "PropertyGraphData",
  "description": "The serialized property graph change data. The type field indicates the element kind.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the element."
    },
    "type": {
      "type": "string",
      "description": "The element type: v (vertex), vl (vertex label), vp (vertex property), e (edge), ep (edge property).",
      "enum": [
        "v",
        "vl",
        "vp",
        "e",
        "ep"
      ]
    },
    "key": {
      "type": "string",
      "description": "The property key name."
    },
    "value": {
      "type": "object",
      "description": "The property value with its data type.",
      "properties": {
        "value": {
          "description": "The actual property value."
        },
        "dataType": {
          "type": "string",
          "description": "The data type (String, Integer, Double, etc.)."
        }
      }
    },
    "from": {
      "type": "string",
      "description": "Source vertex ID (for edges only)."
    },
    "to": {
      "type": "string",
      "description": "Target vertex ID (for edges only)."
    }
  }
}