- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CancelQueryCommand
Cancels a specified query.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { NeptuneGraphClient, CancelQueryCommand } from "@aws-sdk/client-neptune-graph"; // ES Modules import
// const { NeptuneGraphClient, CancelQueryCommand } = require("@aws-sdk/client-neptune-graph"); // CommonJS import
const client = new NeptuneGraphClient(config);
const input = { // CancelQueryInput
graphIdentifier: "STRING_VALUE", // required
queryId: "STRING_VALUE", // required
};
const command = new CancelQueryCommand(input);
const response = await client.send(command);
// {};
CancelQueryCommand Input
See CancelQueryCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
graphIdentifier Required | string | undefined | The unique identifier of the Neptune Analytics graph. |
queryId Required | string | undefined | The unique identifier of the query to cancel. |
CancelQueryCommand Output
See CancelQueryCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | Raised in case of an authentication or authorization failure. |
InternalServerException | server | A failure occurred on the server. |
ResourceNotFoundException | client | A specified resource could not be located. |
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. |