Skip to content

Cancel Data Repository Task

fsx_cancel_data_repository_task R Documentation

Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING or EXECUTING state

Description

Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING or EXECUTING state. When you cancel am export 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.

For a release task, Amazon FSx will stop releasing files upon cancellation. Any files that have already been released will remain in the released state.

Usage

fsx_cancel_data_repository_task(TaskId)

Arguments

TaskId

[required] Specifies the data repository task to cancel.

Value

A list with the following syntax:

list(
  Lifecycle = "PENDING"|"EXECUTING"|"FAILED"|"SUCCEEDED"|"CANCELED"|"CANCELING",
  TaskId = "string"
)

Request syntax

svc$cancel_data_repository_task(
  TaskId = "string"
)