open_cypher_queries

Creates, updates, deletes, gets or lists an open_cypher_queries resource.

Overview

Name	open_cypher_queries
Type	Resource
Id	aws.neptunedata.open_cypher_queries

Fields

The following fields are returned by SELECT queries:

list_open_cypher_queries

Name	Datatype	Description
accepted_query_count	integer	The number of queries that have been accepted but not yet completed, including queries in the queue.
queries	array	A list of current openCypher queries.
running_query_count	integer	The number of currently running openCypher queries.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_open_cypher_queries	select	region	includeWaiting	Lists active openCypher queries. See Neptune openCypher status endpoint for more information. 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:GetQueryStatus IAM action in that cluster. Note that the neptune-db:QueryLanguage:OpenCypher IAM condition key can be used in the policy document to restrict the use of openCypher queries (see Condition keys available in Neptune IAM data-access policy statements).

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)
includeWaiting	boolean	When set to TRUE and other parameters are not present, causes status information to be returned for waiting queries as well as for running queries.

SELECT examples

list_open_cypher_queries

Lists active openCypher queries. See Neptune openCypher status endpoint for more information. 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:GetQueryStatus IAM action in that cluster. Note that the neptune-db:QueryLanguage:OpenCypher IAM condition key can be used in the policy document to restrict the use of openCypher queries (see Condition keys available in Neptune IAM data-access policy statements).

SELECT
accepted_query_count,
queries,
running_query_count
FROM aws.neptunedata.open_cypher_queries
WHERE region = '{{ region }}' -- required
AND includeWaiting = '{{ includeWaiting }}'
;