Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
Synopsis
- data CancelDataRepositoryTask = CancelDataRepositoryTask' {}
- newCancelDataRepositoryTask :: Text -> CancelDataRepositoryTask
- cancelDataRepositoryTask_taskId :: Lens' CancelDataRepositoryTask Text
- data CancelDataRepositoryTaskResponse = CancelDataRepositoryTaskResponse' {}
- newCancelDataRepositoryTaskResponse :: Int -> CancelDataRepositoryTaskResponse
- cancelDataRepositoryTaskResponse_lifecycle :: Lens' CancelDataRepositoryTaskResponse (Maybe DataRepositoryTaskLifecycle)
- cancelDataRepositoryTaskResponse_taskId :: Lens' CancelDataRepositoryTaskResponse (Maybe Text)
- cancelDataRepositoryTaskResponse_httpStatus :: Lens' CancelDataRepositoryTaskResponse Int
Creating a Request
data CancelDataRepositoryTask Source #
Cancels a data repository task.
See: newCancelDataRepositoryTask
smart constructor.
Instances
newCancelDataRepositoryTask Source #
Create a value of CancelDataRepositoryTask
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CancelDataRepositoryTask
, cancelDataRepositoryTask_taskId
- Specifies the data repository task to cancel.
Request Lenses
cancelDataRepositoryTask_taskId :: Lens' CancelDataRepositoryTask Text Source #
Specifies the data repository task to cancel.
Destructuring the Response
data CancelDataRepositoryTaskResponse Source #
See: newCancelDataRepositoryTaskResponse
smart constructor.
CancelDataRepositoryTaskResponse' | |
|
Instances
newCancelDataRepositoryTaskResponse Source #
Create a value of CancelDataRepositoryTaskResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CancelDataRepositoryTaskResponse
, cancelDataRepositoryTaskResponse_lifecycle
- The lifecycle status of the data repository task, as follows:
PENDING
- Amazon FSx has not started the task.EXECUTING
- Amazon FSx is processing the task.FAILED
- Amazon FSx was not able to complete the task. For example, there may be files the task failed to process. The DataRepositoryTaskFailureDetails property provides more information about task failures.SUCCEEDED
- FSx completed the task successfully.CANCELED
- Amazon FSx canceled the task and it did not complete.CANCELING
- FSx is in process of canceling the task.
CancelDataRepositoryTask
, cancelDataRepositoryTaskResponse_taskId
- The ID of the task being canceled.
$sel:httpStatus:CancelDataRepositoryTaskResponse'
, cancelDataRepositoryTaskResponse_httpStatus
- The response's http status code.
Response Lenses
cancelDataRepositoryTaskResponse_lifecycle :: Lens' CancelDataRepositoryTaskResponse (Maybe DataRepositoryTaskLifecycle) Source #
The lifecycle status of the data repository task, as follows:
PENDING
- Amazon FSx has not started the task.EXECUTING
- Amazon FSx is processing the task.FAILED
- Amazon FSx was not able to complete the task. For example, there may be files the task failed to process. The DataRepositoryTaskFailureDetails property provides more information about task failures.SUCCEEDED
- FSx completed the task successfully.CANCELED
- Amazon FSx canceled the task and it did not complete.CANCELING
- FSx is in process of canceling the task.
cancelDataRepositoryTaskResponse_taskId :: Lens' CancelDataRepositoryTaskResponse (Maybe Text) Source #
The ID of the task being canceled.
cancelDataRepositoryTaskResponse_httpStatus :: Lens' CancelDataRepositoryTaskResponse Int Source #
The response's http status code.