Module Values.ExecuteGremlinProfileQueryInputSource

Executes a Gremlin Profile query, which runs a specified traversal, collects various metrics about the run, and produces a profile report as output. See Gremlin profile API in Neptune for details. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ReadDataViaQuery IAM action in that cluster. Note that the neptune-db:QueryLanguage:Gremlin IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see Condition keys available in Neptune IAM data-access policy statements).

Sourcetype nonrec t = {
  1. gremlinQuery : String_.t;
    (*

    The Gremlin query string to profile.

    *)
  2. results : Boolean.t option;
    (*

    If this flag is set to TRUE, the query results are gathered and displayed as part of the profile report. If FALSE, only the result count is displayed.

    *)
  3. chop : Integer.t option;
    (*

    If non-zero, causes the results string to be truncated at that number of characters. If set to zero, the string contains all the results.

    *)
  4. serializer : String_.t option;
    (*

    If non-null, the gathered results are returned in a serialized response message in the format specified by this parameter. See Gremlin profile API in Neptune for more information.

    *)
  5. indexOps : Boolean.t option;
    (*

    If this flag is set to TRUE, the results include a detailed report of all index operations that took place during query execution and serialization.

    *)
}
Sourceval context_ : string
Sourceval make : ?results:??? -> ?chop:??? -> ?serializer:??? -> ?indexOps:??? -> gremlinQuery:String_.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of Boolean.t | `Integer of Integer.t | `String of String_.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t