Skip to content
AWS for Query.Farm

aws.neptunedata.list_gremlin_queries

Example SQL Queries

SELECT * FROM
aws.neptunedata.list_gremlin_queries;

Description

Lists active Gremlin queries. See Gremlin query status API for details about the output.

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).

Table Definition

Column NameColumn Data Type
include_waiting Input Column

If set to TRUE, the list returned includes waiting queries. The default is FALSE;

BOOLEAN
_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.

accepted_query_count

The number of queries that have been accepted but not yet completed, including queries in the queue.

BIGINT
queries

A list of the current queries.

STRUCT(
    "query_id" VARCHAR,
    "query_string" VARCHAR,
    "query_eval_stats" STRUCT(
        "waited" BIGINT,
        "elapsed" BIGINT,
        "cancelled" BOOLEAN,
        "subqueries" VARCHAR
    )
)[]
Show child fields
queries[]
Show child fields
queries[].query_eval_stats

The query statistics of the Gremlin query.

Show child fields
queries[].query_eval_stats.cancelled

Set to TRUE if the query was cancelled, or FALSE otherwise.

queries[].query_eval_stats.elapsed

The number of milliseconds the query has been running so far.

queries[].query_eval_stats.subqueries

The number of subqueries in this query.

queries[].query_eval_stats.waited

Indicates how long the query waited, in milliseconds.

queries[].query_id

The ID of the Gremlin query.

queries[].query_string

The query string of the Gremlin query.

running_query_count

The number of Gremlin queries currently running.

BIGINT