Skip to content

CloudTrail  >  Operations  >  cancel_query

cancel_query

Operation

cancel_query async 

cancel_query(input: CancelQueryInput, plugins: list[Plugin] | None = None) -> CancelQueryOutput

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 CancelQuery, the query status might show as CANCELLED even if the operation is not yet finished.

Parameters:

Name Type Description Default
input CancelQueryInput

An instance of CancelQueryInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
CancelQueryOutput

An instance of CancelQueryOutput.

Input

CancelQueryInput dataclass

Dataclass for CancelQueryInput structure.

Attributes

event_data_store class-attribute instance-attribute 
event_data_store: str | None = None

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

event_data_store_owner_account_id class-attribute instance-attribute 
event_data_store_owner_account_id: str | None = None

The account ID of the event data store owner.

query_id class-attribute instance-attribute 
query_id: str | None = None

The ID of the query that you want to cancel. The QueryId comes from the response of a StartQuery operation.

Output

CancelQueryOutput dataclass

Dataclass for CancelQueryOutput structure.

Attributes

event_data_store_owner_account_id class-attribute instance-attribute 
event_data_store_owner_account_id: str | None = None

The account ID of the event data store owner.

query_id instance-attribute 
query_id: str

The ID of the canceled query.

query_status instance-attribute 
query_status: QueryStatus

Shows the status of a query after a CancelQuery request. Typically, the values shown are either RUNNING or CANCELLED.