IoTSiteWise / Client / cancel_query

cancel_query

IoTSiteWise.Client.cancel_query(**kwargs)

Cancels a running query.

See also: AWS API Documentation

Request Syntax

response = client.cancel_query(
    workspaceName='string',
    queryId='string'
)

Parameters:

• workspaceName (string) –

  [REQUIRED]

  The name of the workspace associated with the query.

• queryId (string) –

  [REQUIRED]

  The unique identifier for the query execution to cancel.

Return type:

dict

Returns:

Response Syntax

{
    'queryId': 'string',
    'status': 'SUBMITTED'|'RUNNING'|'COMPLETED'|'FAILED'|'CANCELED'|'CANCELING'
}

Response Structure

• (dict) –

  Contains the response for the CancelQuery operation.

  • queryId (string) –

    The unique identifier for the cancelled query.

  • status (string) –

    The current query status.

Exceptions

• IoTSiteWise.Client.exceptions.InternalFailureException

• IoTSiteWise.Client.exceptions.AccessDeniedException

• IoTSiteWise.Client.exceptions.InvalidRequestException

• IoTSiteWise.Client.exceptions.ResourceNotFoundException

• IoTSiteWise.Client.exceptions.ThrottlingException

• IoTSiteWise.Client.exceptions.ConflictingOperationException