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.
Parameters:
-
task_id
(AuditTaskId)
–
The ID of the audit you want to cancel. You can only cancel an audit that is "IN_PROGRESS".
Raises:
Source code in docs_src/capo_iot/_services/io_t.py
| def cancel_audit_task(
self,
task_id: "capo_iot.types.audit_task_id.AuditTaskId",
*,
config_overrides: Optional[IoTClientConfig] = None,
) -> "capo_iot.types.cancel_audit_task_response.CancelAuditTaskResponse":
"""<p>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.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CancelAuditTask</a> action.</p>
Args:
task_id: <p>The ID of the audit you want to cancel. You can only cancel an audit that is "IN_PROGRESS".</p>
Raises:
capo_iot.errors.internal_failure_exception.InternalFailureException: <p>An unexpected error has occurred.</p>
capo_iot.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
capo_iot.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
capo_iot.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
capo_iot.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_iot.types.cancel_audit_task_request.CancelAuditTaskRequest]",
) -> OperationResponse[
"capo_iot.types.cancel_audit_task_response.CancelAuditTaskResponse"
]:
import capo_iot._operations.aws_iot_service.cancel_audit_task
output, http_response = (
capo_iot._operations.aws_iot_service.cancel_audit_task.cancel_audit_task(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("CancelAuditTask")
)
input_: capo_iot.types.cancel_audit_task_request.CancelAuditTaskRequest = {
"task_id": task_id
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|