aws_sdk_fsx/client/cancel_data_repository_task.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`CancelDataRepositoryTask`](crate::operation::cancel_data_repository_task::builders::CancelDataRepositoryTaskFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`task_id(impl Into<String>)`](crate::operation::cancel_data_repository_task::builders::CancelDataRepositoryTaskFluentBuilder::task_id) / [`set_task_id(Option<String>)`](crate::operation::cancel_data_repository_task::builders::CancelDataRepositoryTaskFluentBuilder::set_task_id):<br>required: **true**<br><p>Specifies the data repository task to cancel.</p><br>
7 /// - On success, responds with [`CancelDataRepositoryTaskOutput`](crate::operation::cancel_data_repository_task::CancelDataRepositoryTaskOutput) with field(s):
8 /// - [`lifecycle(Option<DataRepositoryTaskLifecycle>)`](crate::operation::cancel_data_repository_task::CancelDataRepositoryTaskOutput::lifecycle): <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 <code>DataRepositoryTaskFailureDetails</code> 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>
9 /// - [`task_id(Option<String>)`](crate::operation::cancel_data_repository_task::CancelDataRepositoryTaskOutput::task_id): <p>The ID of the task being canceled.</p>
10 /// - On failure, responds with [`SdkError<CancelDataRepositoryTaskError>`](crate::operation::cancel_data_repository_task::CancelDataRepositoryTaskError)
11 pub fn cancel_data_repository_task(&self) -> crate::operation::cancel_data_repository_task::builders::CancelDataRepositoryTaskFluentBuilder {
12 crate::operation::cancel_data_repository_task::builders::CancelDataRepositoryTaskFluentBuilder::new(self.handle.clone())
13 }
14}