Class StopQueryCommandProtected

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.

Example

Use a bare-bones client and the command you need to make an API call.

import { CloudWatchLogsClient, StopQueryCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import
// const { CloudWatchLogsClient, StopQueryCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import
const client = new CloudWatchLogsClient(config);
const input = { // StopQueryRequest
  queryId: "STRING_VALUE", // required
};
const command = new StopQueryCommand(input);
const response = await client.send(command);
// { // StopQueryResponse
//   success: true || false,
// };

Param

StopQueryCommandInput

Returns

StopQueryCommandOutput

See

• StopQueryCommandInput for command's input shape.
• StopQueryCommandOutput for command's response shape.
• config for CloudWatchLogsClient's config shape.

Throws

InvalidParameterException (client fault)

A parameter is specified incorrectly.

Throws

ResourceNotFoundException (client fault)

The specified resource does not exist.

Throws

ServiceUnavailableException (server fault)

The service cannot complete the request.

Throws

CloudWatchLogsServiceException

Base exception class for all service exceptions from CloudWatchLogs service.