CancelQuery
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.
Request Syntax
{
"EventDataStore": "string
",
"EventDataStoreOwnerAccountId": "string
",
"QueryId": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- EventDataStore
-
This parameter has been deprecated.
The ARN (or the ID suffix of the ARN) of an event data store on which the specified query is running.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 256.
Pattern:
^[a-zA-Z0-9._/\-:]+$
Required: No
- EventDataStoreOwnerAccountId
-
The account ID of the event data store owner.
Type: String
Length Constraints: Minimum length of 12. Maximum length of 16.
Pattern:
\d+
Required: No
- QueryId
-
The ID of the query that you want to cancel. The
QueryId
comes from the response of aStartQuery
operation.Type: String
Length Constraints: Fixed length of 36.
Pattern:
^[a-f0-9\-]+$
Required: Yes
Response Syntax
{
"EventDataStoreOwnerAccountId": "string",
"QueryId": "string",
"QueryStatus": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- EventDataStoreOwnerAccountId
-
The account ID of the event data store owner.
Type: String
Length Constraints: Minimum length of 12. Maximum length of 16.
Pattern:
\d+
- QueryId
-
The ID of the canceled query.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
^[a-f0-9\-]+$
- QueryStatus
-
Shows the status of a query after a
CancelQuery
request. Typically, the values shown are eitherRUNNING
orCANCELLED
.Type: String
Valid Values:
QUEUED | RUNNING | FINISHED | FAILED | CANCELLED | TIMED_OUT
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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.
HTTP Status Code: 400
- EventDataStoreARNInvalidException
-
The specified event data store ARN is not valid or does not map to an event data store in your account.
HTTP Status Code: 400
- EventDataStoreNotFoundException
-
The specified event data store was not found.
HTTP Status Code: 400
- InactiveEventDataStoreException
-
The event data store is inactive.
HTTP Status Code: 400
- InactiveQueryException
-
The specified query cannot be canceled because it is in the
FINISHED
,FAILED
,TIMED_OUT
, orCANCELLED
state.HTTP Status Code: 400
- InvalidParameterException
-
The request includes a parameter that is not valid.
HTTP Status Code: 400
- NoManagementAccountSLRExistsException
-
This exception is thrown when the management account does not have a service-linked role.
HTTP Status Code: 400
- OperationNotPermittedException
-
This exception is thrown when the requested operation is not permitted.
HTTP Status Code: 400
- QueryIdNotFoundException
-
The query ID does not exist or does not map to a query.
HTTP Status Code: 400
- UnsupportedOperationException
-
This exception is thrown when the requested operation is not supported.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: