Skip to content
AWS for Query.Farm

aws.neptunedata.get_propertygraph_summary

Example SQL Queries

SELECT * FROM
aws.neptunedata.get_propertygraph_summary;

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.

Table Definition

Column NameColumn Data Type
mode Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

payload

Payload containing the property graph summary response.

STRUCT(
    "version" VARCHAR,
    "last_statistics_computation_time" TIMESTAMP_S,
    "graph_summary" STRUCT(
        "num_nodes" BIGINT,
        "num_edges" BIGINT,
        "num_node_labels" BIGINT,
        "num_edge_labels" BIGINT,
        "node_labels" VARCHAR[],
        "edge_labels" VARCHAR[],
        "num_node_properties" BIGINT,
        "num_edge_properties" BIGINT,
        "node_properties" MAP(VARCHAR, BIGINT)[],
        "edge_properties" MAP(VARCHAR, BIGINT)[],
        "total_node_property_values" BIGINT,
        "total_edge_property_values" BIGINT,
        "node_structures" STRUCT(
            "count" BIGINT,
            "node_properties" VARCHAR[],
            "distinct_outgoing_edge_labels" VARCHAR[]
        )[],
        "edge_structures" STRUCT(
            "count" BIGINT,
            "edge_properties" VARCHAR[]
        )[]
    )
)
Show child fields
payload.graph_summary

The graph summary.

Show child fields
payload.graph_summary.edge_labels[]
payload.graph_summary.edge_properties[]
payload.graph_summary.edge_structures[]
Show child fields
payload.graph_summary.edge_structures[].count

The number of edges that have this specific structure.

payload.graph_summary.edge_structures[].edge_properties[]
payload.graph_summary.node_labels[]
payload.graph_summary.node_properties[]
payload.graph_summary.node_structures[]
Show child fields
payload.graph_summary.node_structures[].count

Number of nodes that have this specific structure.

payload.graph_summary.node_structures[].distinct_outgoing_edge_labels[]
payload.graph_summary.node_structures[].node_properties[]
payload.graph_summary.num_edge_labels

The number of distinct edge labels in the graph.

payload.graph_summary.num_edge_properties

The number of distinct edge properties in the graph.

payload.graph_summary.num_edges

The number of edges in the graph.

payload.graph_summary.num_node_labels

The number of distinct node labels in the graph.

payload.graph_summary.num_node_properties

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

payload.graph_summary.num_nodes

The number of nodes in the graph.

payload.graph_summary.total_edge_property_values

The total number of usages of all edge properties.

payload.graph_summary.total_node_property_values

The total number of usages of all node properties.

payload.last_statistics_computation_time

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

payload.version

The version of this graph summary response.

status_code

The HTTP return code of the request. If the request succeeded, the code is 200.

BIGINT