Cancel Query

cloudtrail_cancel_query

R Documentation

Cancels a query if the query is not in a terminated state, such as CANCELLED, FAILED, TIMED_OUT, or FINISHED¶

Description¶

Cancels a query if the query is not in a terminated state, such as CANCELLED, FAILED, TIMED_OUT, or FINISHED. You must specify an ARN value for EventDataStore. The ID of the query that you want to cancel is also required. When you run cancel_query, the query status might show as CANCELLED even if the operation is not yet finished.

Usage¶

cloudtrail_cancel_query(EventDataStore, QueryId,
  EventDataStoreOwnerAccountId)

Arguments¶

EventDataStore

The ARN (or the ID suffix of the ARN) of an event data store on which the specified query is running.

QueryId

[required] The ID of the query that you want to cancel. The QueryId comes from the response of a start_query operation.

EventDataStoreOwnerAccountId

The account ID of the event data store owner.

Value¶

A list with the following syntax:

list(
  QueryId = "string",
  QueryStatus = "QUEUED"|"RUNNING"|"FINISHED"|"FAILED"|"CANCELLED"|"TIMED_OUT",
  EventDataStoreOwnerAccountId = "string"
)

Request syntax¶

svc$cancel_query(
  EventDataStore = "string",
  QueryId = "string",
  EventDataStoreOwnerAccountId = "string"
)