[ aws . cloudtrail ]
cancel-query¶
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 CancelQuery , the query status might show as CANCELLED even if the operation is not yet finished.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
cancel-query
--event-data-store <value>
--query-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--event-data-store (string)
The ARN (or the ID suffix of the ARN) of an event data store on which the specified query is running.
--query-id (string)
The ID of the query that you want to cancel. The
QueryIdcomes from the response of aStartQueryoperation.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Output¶
QueryId -> (string)
The ID of the canceled query.
QueryStatus -> (string)
Shows the status of a query after a
CancelQueryrequest. Typically, the values shown are eitherRUNNINGorCANCELLED.