stop_task

Stops the selected task.

Syntax

def stop_task(

self,

server,

task,

int timeout = 30

)

Parameters
Parameter	Type	Description
server	string	The name of the server.
task	string	Replicate: - The name of the task. Compose: - The name of the task or workflow appended with a double underscore and the project name. Example: mytask__myproject
timeout	int	Time, in seconds, to wait until getting a response.

AemStopTaskResp

Return values
Value	Type	Description
state	AemTaskState { STOPPED = 0, RUNNING = 1, ERROR = 2, RECOVERY = 3 }	The current state of the task.
error_message	string	The description of the error.

All of the general errors as well as the errors listed in the table below.

Error responses
Error	Message	Description
AEM_TASK_ALREADY_STOPPED	Replicate task {task} on server {server} is already stopped.	Cannot stop a task that is in Stopped state.
AEM_STOP_TASK_INNER_ERR	Failed to stop Replicate task {0} on server {1}: <{2}>	An error occurred while trying to stop the task.
AEM_STOP_TASK_TIMEOUT	A timeout occurred when trying to stop Replicate task {0} on server {1}	A timeout occurred while trying to stop the task.

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!