DataSync / Client / cancel_task_execution

cancel_task_execution#

DataSync.Client.cancel_task_execution(**kwargs)#

Stops an DataSync task execution that’s in progress. The transfer of some files are abruptly interrupted. File contents that’re transferred to the destination might be incomplete or inconsistent with the source files.

However, if you start a new task execution using the same task and allow it to finish, file content on the destination will be complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, DataSync successfully completes the transfer when you start the next task execution.

Request Syntax

response = client.cancel_task_execution(
    TaskExecutionArn='string'
)

Parameters:

TaskExecutionArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the task execution to stop.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

Exceptions

DataSync.Client.exceptions.InvalidRequestException
DataSync.Client.exceptions.InternalException