Neptune streams dataplane API

• GetPropertygraphStream (action)

• PropertygraphRecord (structure)

• PropertygraphData (structure)

• neptune-db:QueryLanguage:Gremlin

• neptune-db:QueryLanguage:OpenCypher

• commitNum  (in the CLI: --commit-num) –  a Long, of type: long (a signed 64-bit integer).

  The commit number of the starting record to read from the change-log stream. This parameter is required when iteratorType isAT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER, and ignored when iteratorType is TRIM_HORIZON or LATEST.

• encoding  (in the CLI: --encoding) –  an Encoding, of type: string (a UTF-8 encoded string).

  If set to TRUE, Neptune compresses the response using gzip encoding.

• iteratorType  (in the CLI: --iterator-type) –  an IteratorType, of type: string (a UTF-8 encoded string).

  Can be one of:

  • AT_SEQUENCE_NUMBER   –   Indicates that reading should start from the event sequence number specified jointly by the commitNum and opNum parameters.

  • AFTER_SEQUENCE_NUMBER   –   Indicates that reading should start right after the event sequence number specified jointly by the commitNum and opNum parameters.

  • TRIM_HORIZON   –   Indicates that reading should start at the last untrimmed record in the system, which is the oldest unexpired (not yet deleted) record in the change-log stream.

  • LATEST   –   Indicates that reading should start at the most recent record in the system, which is the latest unexpired (not yet deleted) record in the change-log stream.

• limit  (in the CLI: --limit) –  a GetPropertygraphStreamInputLimitLong, of type: long (a signed 64-bit integer), not less than 1 or more than 100000 ?st?s.

  Specifies the maximum number of records to return. There is also a size limit of 10 MB on the response that can't be modified and that takes precedence over the number of records specified in the limit parameter. The response does include a threshold-breaching record if the 10 MB limit was reached.

  The range for limit is 1 to 100,000, with a default of 10.

• opNum  (in the CLI: --op-num) –  a Long, of type: long (a signed 64-bit integer).

  The operation sequence number within the specified commit to start reading from in the change-log stream data. The default is 1.

• format   – Required: a String, of type: string (a UTF-8 encoded string).

  Serialization format for the change records being returned. Currently, the only supported value is PG_JSON.

• lastEventId   – Required: It is a map array of key-value pairs where:

      Each key is a a String, of type: string (a UTF-8 encoded string).

      Each value is a a String, of type: string (a UTF-8 encoded string).

  Sequence identifier of the last change in the stream response.

  An event ID is composed of two fields: a commitNum, which identifies a transaction that changed the graph, and an opNum, which identifies a specific operation within that transaction:

  "eventId": {
            "commitNum": 12,
            "opNum": 1
          }

• lastTrxTimestampInMillis   – Required: a Long, of type: long (a signed 64-bit integer).

  The time at which the commit for the transaction was requested, in milliseconds from the Unix epoch.

• records   – Required: An array of PropertygraphRecord objects.

  An array of serialized change-log stream records included in the response.

• totalRecords   – Required: an Integer, of type: integer (a signed 32-bit integer).

  The total number of records in the response.

Errors

• UnsupportedOperationException

• ExpiredStreamException

• InvalidParameterException

• MemoryLimitExceededException

• StreamRecordsNotFoundException

• ClientTimeoutException

• PreconditionsFailedException

• ThrottlingException

• ConstraintViolationException

• InvalidArgumentException

• IllegalArgumentException

• TooManyRequestsException

Fields

• commitTimestampInMillis – This is Required: a Long, of type: long (a signed 64-bit integer).

  The time at which the commit for the transaction was requested, in milliseconds from the Unix epoch.

• data – This is Required: A PropertygraphData object.

  The serialized Gremlin or openCypher change record.

• eventId – This is Required: It is a map array of key-value pairs where:

      Each key is a a String, of type: string (a UTF-8 encoded string).

      Each value is a a String, of type: string (a UTF-8 encoded string).

  The sequence identifier of the stream change record.

• isLastOp – This is a Boolean, of type: boolean (a Boolean (true or false) value).

  Only present if this operation is the last one in its transaction. If present, it is set to true. It is useful for ensuring that an entire transaction is consumed.

• op – This is Required: a String, of type: string (a UTF-8 encoded string).

  The operation that created the change.

Fields

• from – This is a String, of type: string (a UTF-8 encoded string).

  If this is an edge (type = e), the ID of the corresponding from vertex or source node.

• id – This is Required: a String, of type: string (a UTF-8 encoded string).

  The ID of the Gremlin or openCypher element.

• key – This is Required: a String, of type: string (a UTF-8 encoded string).

  The property name. For element labels, this is label.

• to – This is a String, of type: string (a UTF-8 encoded string).

  If this is an edge (type = e), the ID of the corresponding to vertex or target node.

• type – This is Required: a String, of type: string (a UTF-8 encoded string).

  The type of this Gremlin or openCypher element. Must be one of:

  • v1   -   Vertex label for Gremlin, or node label for openCypher.

  • vp   -   Vertex properties for Gremlin, or node properties for openCypher.

  • e   -   Edge and edge label for Gremlin, or relationship and relationship type for openCypher.

  • ep   -   Edge properties for Gremlin, or relationship properties for openCypher.

• value – This is Required: a Document, of type: document (a protocol-agnostic open content represented by a JSON-like data model).

  This is a JSON object that contains a value field for the value itself, and a datatype field for the JSON data type of that value:

  "value": {
            "value": "(the new value"),
            "dataType": "(the JSON datatypenew value")
          }