Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CancelQueryCommand

Cancels a query that has been issued. Cancellation is provided only if the query has not completed running before the cancellation request was issued. Because cancellation is an idempotent operation, subsequent cancellation requests will return a CancellationMessage, indicating that the query has already been canceled. See code sample for details.

example

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

import { TimestreamQueryClient, CancelQueryCommand } from "@aws-sdk/client-timestream-query"; // ES Modules import
// const { TimestreamQueryClient, CancelQueryCommand } = require("@aws-sdk/client-timestream-query"); // CommonJS import
const client = new TimestreamQueryClient(config);
const command = new CancelQueryCommand(input);
const response = await client.send(command);
see

CancelQueryCommandInput for command's input shape.

see

CancelQueryCommandOutput for command's response shape.

see

config for TimestreamQueryClient's config shape.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly input

input: CancelQueryCommandInput

Readonly middlewareStack

middlewareStack: IMiddlewareStack<CancelQueryCommandInput, CancelQueryCommandOutput>

Methods

Static getEndpointParameterInstructions