AWS IoT Over-the-air Update v2.0.0 (Release Candidate)
Client library for AWS IoT OTA
OTA_Shutdown

Signal to the OTA Agent to shut down.

OtaState_t OTA_Shutdown( uint32_t ticksToWait );
OtaState_t
OtaState_t
OTA Agent states.
Definition: ota.h:108
OTA_Shutdown
OtaState_t OTA_Shutdown(uint32_t ticksToWait)
Signal to the OTA Agent to shut down.
Definition: ota.c:3100

Signals the OTA agent task to shut down. The OTA agent will unsubscribe from all MQTT job notification topics, stop in progress OTA jobs, if any, and clear all resources.

Parameters
[in]ticksToWaitThe number of ticks to wait for the OTA Agent to complete the shutdown process. If this is set to zero, the function will return immediately without waiting. The actual state is returned to the caller.
Returns
One of the OTA agent states from the OtaState_t enum. A normal shutdown will return OtaAgentStateNotReady. Otherwise, refer to the OtaState_t enum for details.