Skip to content

Cancel Query

timestreamquery_cancel_query R Documentation

Cancels a query that has been issued

Description

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.

Usage

timestreamquery_cancel_query(QueryId)

Arguments

QueryId

[required] The ID of the query that needs to be cancelled. QueryID is returned as part of the query result.

Value

A list with the following syntax:

list(
  CancellationMessage = "string"
)

Request syntax

svc$cancel_query(
  QueryId = "string"
)