Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1441397379.2 KB

Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING or EXECUTING state. When you cancel a task, Amazon FSx does the following.

  • Any files that FSx has already exported are not reverted.

  • FSx continues to export any files that are "in-flight" when the cancel operation is received.

  • FSx does not export any files that have not yet been exported.

post/#X-Amz-Target=AWSSimbaAPIService_v20180301.CancelDataRepositoryTask

Headers

X-Amz-Target'AWSSimbaAPIService_v20180301.CancelDataRepositoryTask' required

Request body

TaskIdstring required

Specifies the data repository task to cancel.

Response

Success

Lifecycle'PENDING' | 'EXECUTING' | 'FAILED' | 'SUCCEEDED' | 'CANCELED' | 'CANCELING'
<p>The lifecycle status of the data repository task, as follows:</p> <ul> <li> <p> <code>PENDING</code> - Amazon FSx has not started the task.</p> </li> <li> <p> <code>EXECUTING</code> - Amazon FSx is processing the task.</p> </li> <li> <p> <code>FAILED</code> - Amazon FSx was not able to complete the task. For example, there may be files the task failed to process. The <a>DataRepositoryTaskFailureDetails</a> property provides more information about task failures.</p> </li> <li> <p> <code>SUCCEEDED</code> - FSx completed the task successfully.</p> </li> <li> <p> <code>CANCELED</code> - Amazon FSx canceled the task and it did not complete.</p> </li> <li> <p> <code>CANCELING</code> - FSx is in process of canceling the task.</p> </li> </ul>
TaskIdstring

The ID of the task being canceled.