Get Propertygraph Summary

neptunedata_get_propertygraph_summary

R Documentation

Gets a graph summary for a property graph

Description

Gets a graph summary for a property graph.

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:GetGraphSummary IAM action in that cluster.

Usage

neptunedata_get_propertygraph_summary(mode)

Arguments

mode

Mode can take one of two values: BASIC (the default), and DETAILED.

Value

A list with the following syntax:

list(
  statusCode = 123,
  payload = list(
    version = "string",
    lastStatisticsComputationTime = as.POSIXct(
      "2015-01-01"
    ),
    graphSummary = list(
      numNodes = 123,
      numEdges = 123,
      numNodeLabels = 123,
      numEdgeLabels = 123,
      nodeLabels = list(
        "string"
      ),
      edgeLabels = list(
        "string"
      ),
      numNodeProperties = 123,
      numEdgeProperties = 123,
      nodeProperties = list(
        list(
          123
        )
      ),
      edgeProperties = list(
        list(
          123
        )
      ),
      totalNodePropertyValues = 123,
      totalEdgePropertyValues = 123,
      nodeStructures = list(
        list(
          count = 123,
          nodeProperties = list(
            "string"
          ),
          distinctOutgoingEdgeLabels = list(
            "string"
          )
        )
      ),
      edgeStructures = list(
        list(
          count = 123,
          edgeProperties = list(
            "string"
          )
        )
      )
    )
  )
)

Request syntax

svc$get_propertygraph_summary(
  mode = "basic"|"detailed"
)