Amazon Neptune · JSON Structure

Gremlin Gremlin Query Request Structure

GremlinQueryRequest schema from Neptune

Type: object Properties: 1 Required: 1
DatabaseGraph DatabaseGremlinNeptuneProperty GraphRDFSPARQL

GremlinQueryRequest is a JSON Structure definition published by Amazon Neptune, describing 1 property, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

gremlin

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/gremlin-gremlin-query-request-structure.json",
  "name": "GremlinQueryRequest",
  "description": "GremlinQueryRequest schema from Neptune",
  "type": "object",
  "properties": {
    "gremlin": {
      "type": "string",
      "description": "The Gremlin traversal query string. Must be a valid Gremlin traversal starting with g. The bindings property is not supported by Neptune.",
      "examples": [
        "g.V().count()",
        "g.V().has('name','John').out('knows')"
      ]
    }
  },
  "required": [
    "gremlin"
  ]
}