CloudWatchLogs / Client / stop_query

stop_query

CloudWatchLogs.Client.stop_query(**kwargs)

Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running.

This operation can be used to cancel both interactive queries and individual scheduled query executions. When used with scheduled queries, StopQuery cancels only the specific execution identified by the query ID, not the scheduled query configuration itself.

See also: AWS API Documentation

Request Syntax

response = client.stop_query(
    queryId='string'
)
Parameters:

queryId (string) –

[REQUIRED]

The ID number of the query to stop. To find this ID number, use DescribeQueries.

Return type:

dict

Returns:

Response Syntax

{
    'success': True|False
}

Response Structure

  • (dict) –

    • success (boolean) –

      This is true if the query was stopped by the StopQuery operation.

Exceptions