Amazon Neptune · Schema

GremlinQueryResponse

GremlinQueryResponse schema from Neptune

DatabaseGraph DatabaseGremlinNeptuneProperty GraphRDFSPARQL

Properties

Name Type Description
requestId string The unique request identifier.
status object
result object
View JSON Schema on GitHub

JSON Schema

gremlin-gremlin-query-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-neptune/refs/heads/main/json-schema/gremlin-gremlin-query-response-schema.json",
  "title": "GremlinQueryResponse",
  "description": "GremlinQueryResponse schema from Neptune",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "format": "uuid",
      "description": "The unique request identifier."
    },
    "status": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string"
        },
        "code": {
          "type": "integer",
          "description": "The response status code (200 for success)."
        },
        "attributes": {
          "type": "object",
          "description": "Additional response attributes."
        }
      }
    },
    "result": {
      "type": "object",
      "properties": {
        "data": {
          "description": "The query result data. The shape depends on the traversal's terminal step (e.g., count, valueMap, path)."
        },
        "meta": {
          "type": "object"
        }
      }
    }
  }
}