gremlin_query_status

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

Overview

Name	gremlin_query_status
Type	Resource
Id	aws.neptunedata.gremlin_query_status

Fields

The following fields are returned by SELECT queries:

get_gremlin_query_status

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_gremlin_query_status	select	query_id, region		Gets the status of a specified Gremlin 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:Gremlin IAM condition key can be used in the policy document to restrict the use of Gremlin 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 identifier that identifies the Gremlin query.
region	string	AWS region (default: us-east-1)

SELECT examples

get_gremlin_query_status

Gets the status of a specified Gremlin 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:Gremlin IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see Condition keys available in Neptune IAM data-access policy statements).

SELECT
query_eval_stats,
query_id,
query_string
FROM aws.neptunedata.gremlin_query_status
WHERE query_id = '{{ query_id }}' -- required
AND region = '{{ region }}' -- required
;