PropertygraphSummary - Neptune Data API
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

PropertygraphSummary

The graph summary API returns a read-only list of node and edge labels and property keys, along with counts of nodes, edges, and properties. See Graph summary response for a property graph (PG).

Contents

edgeLabels

A list of the distinct edge labels in the graph.

Type: Array of strings

Required: No

edgeProperties

A list of the distinct edge properties in the graph, along with the count of edges where each property is used.

Type: Array of string to long maps

Required: No

edgeStructures

This field is only present when the requested mode is DETAILED. It contains a list of edge structures.

Type: Array of EdgeStructure objects

Required: No

nodeLabels

A list of the distinct node labels in the graph.

Type: Array of strings

Required: No

nodeProperties

The number of distinct node properties in the graph.

Type: Array of string to long maps

Required: No

nodeStructures

This field is only present when the requested mode is DETAILED. It contains a list of node structures.

Type: Array of NodeStructure objects

Required: No

numEdgeLabels

The number of distinct edge labels in the graph.

Type: Long

Required: No

numEdgeProperties

The number of distinct edge properties in the graph.

Type: Long

Required: No

numEdges

The number of edges in the graph.

Type: Long

Required: No

numNodeLabels

The number of distinct node labels in the graph.

Type: Long

Required: No

numNodeProperties

A list of the distinct node properties in the graph, along with the count of nodes where each property is used.

Type: Long

Required: No

numNodes

The number of nodes in the graph.

Type: Long

Required: No

totalEdgePropertyValues

The total number of usages of all edge properties.

Type: Long

Required: No

totalNodePropertyValues

The total number of usages of all node properties.

Type: Long

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: