open_cypher_query_status

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

Overview

Name	open_cypher_query_status
Type	Resource
Id	aws.neptunedata.open_cypher_query_status

Fields

The following fields are returned by SELECT queries:

get_open_cypher_query_status

Name	Datatype	Description
query_eval_stats	object	The openCypher query evaluation status.
query_id	string	The unique ID of the query for which status is being returned.
query_string	string	The openCypher query string.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_open_cypher_query_status	select	query_id, region		Retrieves the status of a specified openCypher query. 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
query_id	string	The unique ID of the openCypher query for which to retrieve the query status.
region	string	AWS region (default: us-east-1)

SELECT examples

get_open_cypher_query_status

Retrieves the status of a specified openCypher query. 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
query_eval_stats,
query_id,
query_string
FROM aws.neptunedata.open_cypher_query_status
WHERE query_id = '{{ query_id }}' -- required
AND region = '{{ region }}' -- required
;