propertygraph_summaries

Creates, updates, deletes, gets or lists a propertygraph_summaries resource.

Overview

Name	propertygraph_summaries
Type	Resource
Id	aws.neptunedata.propertygraph_summaries

Fields

The following fields are returned by SELECT queries:

get_propertygraph_summary

Name	Datatype	Description
payload	object	Payload containing the property graph summary response.
status_code	integer	The HTTP return code of the request. If the request succeeded, the code is 200.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_propertygraph_summary	select	region	mode	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
mode	string	Mode can take one of two values: BASIC (the default), and DETAILED.

SELECT examples

get_propertygraph_summary

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.

SELECT
payload,
status_code
FROM aws.neptunedata.propertygraph_summaries
WHERE region = '{{ region }}' -- required
AND mode = '{{ mode }}'
;