ListQueriesCommand

Suggest an Edit

Lists active openCypher queries.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { NeptuneGraphClient, ListQueriesCommand } from "@aws-sdk/client-neptune-graph"; // ES Modules import
// const { NeptuneGraphClient, ListQueriesCommand } = require("@aws-sdk/client-neptune-graph"); // CommonJS import
const client = new NeptuneGraphClient(config);
const input = { // ListQueriesInput
  graphIdentifier: "STRING_VALUE", // required
  maxResults: Number("int"), // required
  state: "ALL" || "RUNNING" || "WAITING" || "CANCELLING",
};
const command = new ListQueriesCommand(input);
const response = await client.send(command);
// { // ListQueriesOutput
//   queries: [ // QuerySummaryList // required
//     { // QuerySummary
//       id: "STRING_VALUE",
//       queryString: "STRING_VALUE",
//       waited: Number("int"),
//       elapsed: Number("int"),
//       state: "RUNNING" || "WAITING" || "CANCELLING",
//     },
//   ],
// };

ListQueriesCommand Input

See ListQueriesCommandInput for more details

Parameter
Type
Description
graphIdentifier
Required
string | undefined

The unique identifier of the Neptune Analytics graph.

maxResults
Required
number | undefined

The maximum number of results to be fetched by the API.

state
QueryStateInput | undefined

Filtered list of queries based on state.

ListQueriesCommand Output

See ListQueriesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
queries
Required
QuerySummary[] | undefined

A list of current openCypher queries.

Throws

Name
Fault
Details
AccessDeniedException
client

Raised in case of an authentication or authorization failure.

InternalServerException
server

A failure occurred on the server.

ThrottlingException
client

The exception was interrupted by throttling.

ValidationException
client

A resource could not be validated.

NeptuneGraphServiceException
Base exception class for all service exceptions from NeptuneGraph service.