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.

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.

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 BeginCancelQuery and EndCancelQuery.

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

Syntax

C#
public virtual Task<CancelQueryResponse> CancelQueryAsync(
         CancelQueryRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CloudTrail.Model.CancelQueryRequest

Container for the necessary parameters to execute the CancelQuery 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 CancelQuery service method, as returned by CloudTrail.

Exceptions

ExceptionCondition
ConflictException This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.
EventDataStoreARNInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
EventDataStoreNotFoundException The specified event data store was not found.
InactiveEventDataStoreException The event data store is inactive.
InactiveQueryException The specified query cannot be canceled because it is in the FINISHED, FAILED, TIMED_OUT, or CANCELLED state.
InvalidParameterException The request includes a parameter that is not valid.
NoManagementAccountSLRExistsException This exception is thrown when the management account does not have a service-linked role.
OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
QueryIdNotFoundException The query ID does not exist or does not map to a query.
UnsupportedOperationException This exception is thrown when the requested operation is not supported.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also