ListQueries - NeptuneAnalyticsAPI

ListQueries

Lists active openCypher queries.

Request Syntax

GET /queries?maxResults=maxResults&state=state HTTP/1.1 graphIdentifier: graphIdentifier

URI Request Parameters

The request uses the following URI parameters.

graphIdentifier

The unique identifier of the Neptune Analytics graph.

Pattern: g-[a-z0-9]{10}

Required: Yes

maxResults

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

Required: Yes

state

Filtered list of queries based on state.

Valid Values: ALL | RUNNING | WAITING | CANCELLING

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "queries": [ { "elapsed": number, "id": "string", "queryString": "string", "state": "string", "waited": number } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

queries

A list of current openCypher queries.

Type: Array of QuerySummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Raised in case of an authentication or authorization failure.

HTTP Status Code: 403

InternalServerException

A failure occurred on the server.

HTTP Status Code: 500

ThrottlingException

The exception was interrupted by throttling.

HTTP Status Code: 429

ValidationException

A resource could not be validated.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: