NeptuneGraph / Client / get_graph_summary

get_graph_summary#

NeptuneGraph.Client.get_graph_summary(**kwargs)#

Gets a graph summary for a property graph.

See also: AWS API Documentation

Request Syntax

response = client.get_graph_summary(
    graphIdentifier='string',
    mode='BASIC'|'DETAILED'
)
Parameters:

  • graphIdentifier (string) –

    [REQUIRED]

    The unique identifier of the Neptune Analytics graph.

  • mode (string) – The summary mode can take one of two values: basic (the default), and detailed.

Return type:

dict

Returns:

Response Syntax

{
    'version': 'string',
    'lastStatisticsComputationTime': datetime(2015, 1, 1),
    'graphSummary': {
        'numNodes': 123,
        'numEdges': 123,
        'numNodeLabels': 123,
        'numEdgeLabels': 123,
        'nodeLabels': [
            'string',
        ],
        'edgeLabels': [
            'string',
        ],
        'numNodeProperties': 123,
        'numEdgeProperties': 123,
        'nodeProperties': [
            {
                'string': 123
            },
        ],
        'edgeProperties': [
            {
                'string': 123
            },
        ],
        'totalNodePropertyValues': 123,
        'totalEdgePropertyValues': 123,
        'nodeStructures': [
            {
                'count': 123,
                'nodeProperties': [
                    'string',
                ],
                'distinctOutgoingEdgeLabels': [
                    'string',
                ]
            },
        ],
        'edgeStructures': [
            {
                'count': 123,
                'edgeProperties': [
                    'string',
                ]
            },
        ]
    }
}

Response Structure

  • (dict) –

    • version (string) –

      Display the version of this tool.

    • lastStatisticsComputationTime (datetime) –

      The timestamp, in ISO 8601 format, of the time at which Neptune Analytics last computed statistics.

    • graphSummary (dict) –

      The graph summary.

      • numNodes (integer) –

        The number of nodes in the graph.

      • numEdges (integer) –

        The number of edges in the graph.

      • numNodeLabels (integer) –

        The number of distinct node labels in the graph.

      • numEdgeLabels (integer) –

        The number of unique edge labels in the graph.

      • nodeLabels (list) –

        A list of distinct node labels in the graph.

        • (string) –

      • edgeLabels (list) –

        A list of the edge labels in the graph.

        • (string) –

      • numNodeProperties (integer) –

        The number of distinct node properties in the graph.

      • numEdgeProperties (integer) –

        The number of edge properties in the graph.

      • nodeProperties (list) –

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

        • (dict) –

          • (string) –

            • (integer) –

      • edgeProperties (list) –

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

        • (dict) –

          • (string) –

            • (integer) –

      • totalNodePropertyValues (integer) –

        The total number of usages of all node properties.

      • totalEdgePropertyValues (integer) –

        The total number of usages of all edge properties.

      • nodeStructures (list) –

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

        • (dict) –

          Information about a node.

          • count (integer) –

            The number of instances of this node.

          • nodeProperties (list) –

            Properties associated with this node.

            • (string) –

          • distinctOutgoingEdgeLabels (list) –

            The outgoing edge labels associated with this node.

            • (string) –

      • edgeStructures (list) –

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

        • (dict) –

          Contains information about an edge in a Neptune Analytics graph.

          • count (integer) –

            The number of instances of the edge in the graph.

          • edgeProperties (list) –

            A list of the properties associated with the edge.

            • (string) –

Exceptions