AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query and the query string to use.

For more information, see CloudWatch Logs Insights Query Syntax.

Queries time out after 15 minutes of execution. If your queries are timing out, reduce the time range being searched or partition your query into a number of queries.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginStartQuery and EndStartQuery.

Namespace: Amazon.CloudWatchLogs
Assembly: AWSSDK.CloudWatchLogs.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<StartQueryResponse> StartQueryAsync(
         StartQueryRequest request,
         CancellationToken cancellationToken
)
Parameters
request
Type: Amazon.CloudWatchLogs.Model.StartQueryRequest

Container for the necessary parameters to execute the StartQuery service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value
The response from the StartQuery service method, as returned by CloudWatchLogs.

Exceptions

ExceptionCondition
InvalidParameterException A parameter is specified incorrectly.
LimitExceededException You have reached the maximum number of resources that can be created.
MalformedQueryException The query string is not valid. Details about this error are displayed in a QueryCompileError object. For more information, see QueryCompileError. For more information about valid query syntax, see CloudWatch Logs Insights Query Syntax.
ResourceNotFoundException The specified resource does not exist.
ServiceUnavailableException The service cannot complete the request.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0, 1.3

.NET Framework:
Supported in: 4.5

See Also