IoT / Client / cancel_audit_task

cancel_audit_task#

IoT.Client.cancel_audit_task(**kwargs)#

Cancels an audit that is in progress. The audit can be either scheduled or on demand. If the audit isn’t in progress, an “InvalidRequestException” occurs.

Requires permission to access the CancelAuditTask action.

See also: AWS API Documentation

Request Syntax

response = client.cancel_audit_task(
    taskId='string'
)
Parameters:

taskId (string) –

[REQUIRED]

The ID of the audit you want to cancel. You can only cancel an audit that is “IN_PROGRESS”.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • IoT.Client.exceptions.ResourceNotFoundException

  • IoT.Client.exceptions.InvalidRequestException

  • IoT.Client.exceptions.ThrottlingException

  • IoT.Client.exceptions.InternalFailureException