1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeTaskExecution`](crate::operation::describe_task_execution::builders::DescribeTaskExecutionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`task_execution_arn(impl Into<String>)`](crate::operation::describe_task_execution::builders::DescribeTaskExecutionFluentBuilder::task_execution_arn) / [`set_task_execution_arn(Option<String>)`](crate::operation::describe_task_execution::builders::DescribeTaskExecutionFluentBuilder::set_task_execution_arn):<br>required: **true**<br><p>Specifies the Amazon Resource Name (ARN) of the task execution that you want information about.</p><br>
    /// - On success, responds with [`DescribeTaskExecutionOutput`](crate::operation::describe_task_execution::DescribeTaskExecutionOutput) with field(s):
    ///   - [`task_execution_arn(Option<String>)`](crate::operation::describe_task_execution::DescribeTaskExecutionOutput::task_execution_arn): <p>The ARN of the task execution that you wanted information about. <code>TaskExecutionArn</code> is hierarchical and includes <code>TaskArn</code> for the task that was executed.</p> <p>For example, a <code>TaskExecution</code> value with the ARN <code>arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b</code> executed the task with the ARN <code>arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2</code>.</p>
    ///   - [`status(Option<TaskExecutionStatus>)`](crate::operation::describe_task_execution::DescribeTaskExecutionOutput::status): <p>The status of the task execution.</p>
    ///   - [`options(Option<Options>)`](crate::operation::describe_task_execution::DescribeTaskExecutionOutput::options): <p>Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You also can specify how to verify data integrity, set bandwidth limits for your task, among other options.</p> <p>Each option has a default value. Unless you need to, you don't have to configure any option before calling <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html">StartTaskExecution</a>.</p> <p>You also can override your task options for each task execution. For example, you might want to adjust the <code>LogLevel</code> for an individual execution.</p>
    ///   - [`excludes(Option<Vec::<FilterRule>>)`](crate::operation::describe_task_execution::DescribeTaskExecutionOutput::excludes): <p>A list of filter rules that exclude specific data during your transfer. For more information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
    ///   - [`includes(Option<Vec::<FilterRule>>)`](crate::operation::describe_task_execution::DescribeTaskExecutionOutput::includes): <p>A list of filter rules that include specific data during your transfer. For more information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Filtering data transferred by DataSync</a>.</p>
    ///   - [`manifest_config(Option<ManifestConfig>)`](crate::operation::describe_task_execution::DescribeTaskExecutionOutput::manifest_config): <p>The configuration of the manifest that lists the files or objects to transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html">Specifying what DataSync transfers by using a manifest</a>.</p>
    ///   - [`start_time(Option<DateTime>)`](crate::operation::describe_task_execution::DescribeTaskExecutionOutput::start_time): <p>The time when the task execution started.</p>
    ///   - [`estimated_files_to_transfer(i64)`](crate::operation::describe_task_execution::DescribeTaskExecutionOutput::estimated_files_to_transfer): <p>The expected number of files, objects, and directories that DataSync will transfer over the network. This value is calculated during the task execution's <code>PREPARING</code> phase before the <code>TRANSFERRING</code> phase. The calculation is based on comparing the content of the source and destination locations and finding the difference that needs to be transferred.</p>
    ///   - [`estimated_bytes_to_transfer(i64)`](crate::operation::describe_task_execution::DescribeTaskExecutionOutput::estimated_bytes_to_transfer): <p>The estimated physical number of bytes that will transfer over the network.</p>
    ///   - [`files_transferred(i64)`](crate::operation::describe_task_execution::DescribeTaskExecutionOutput::files_transferred): <p>The actual number of files, objects, and directories that DataSync transferred over the network. This value is updated periodically during the task execution's <code>TRANSFERRING</code> phase when something is read from the source and sent over the network.</p> <p>If DataSync fails to transfer something, this value can be less than <code>EstimatedFilesToTransfer</code>. In some cases, this value can also be greater than <code>EstimatedFilesToTransfer</code>. This element is implementation-specific for some location types, so don't use it as an exact indication of what transferred or to monitor your task execution.</p>
    ///   - [`bytes_written(i64)`](crate::operation::describe_task_execution::DescribeTaskExecutionOutput::bytes_written): <p>The number of logical bytes written to the destination location.</p>
    ///   - [`bytes_transferred(i64)`](crate::operation::describe_task_execution::DescribeTaskExecutionOutput::bytes_transferred): <p>The total number of bytes that are involved in the transfer. For the number of bytes sent over the network, see <code>BytesCompressed</code>.</p>
    ///   - [`bytes_compressed(i64)`](crate::operation::describe_task_execution::DescribeTaskExecutionOutput::bytes_compressed): <p>The physical number of bytes transferred over the network after compression was applied. In most cases, this number is less than <code>BytesTransferred</code> unless the data isn't compressible.</p>
    ///   - [`result(Option<TaskExecutionResultDetail>)`](crate::operation::describe_task_execution::DescribeTaskExecutionOutput::result): <p>The result of the task execution.</p>
    ///   - [`task_report_config(Option<TaskReportConfig>)`](crate::operation::describe_task_execution::DescribeTaskExecutionOutput::task_report_config): <p>The configuration of your task report, which provides detailed information about for your DataSync transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html">Creating a task report</a>.</p>
    ///   - [`files_deleted(i64)`](crate::operation::describe_task_execution::DescribeTaskExecutionOutput::files_deleted): <p>The number of files, objects, and directories that DataSync deleted in your destination location. If you don't <a href="https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html">configure your task</a> to delete data in the destination that isn't in the source, the value is always <code>0</code>.</p>
    ///   - [`files_skipped(i64)`](crate::operation::describe_task_execution::DescribeTaskExecutionOutput::files_skipped): <p>The number of files, objects, and directories that DataSync skipped during your transfer.</p>
    ///   - [`files_verified(i64)`](crate::operation::describe_task_execution::DescribeTaskExecutionOutput::files_verified): <p>The number of files, objects, and directories that DataSync verified during your transfer.</p><note>  <p>When you configure your task to <a href="https://docs.aws.amazon.com/datasync/latest/userguide/configure-data-verification-options.html">verify only the data that's transferred</a>, DataSync doesn't verify directories in some situations or files that fail to transfer.</p> </note>
    ///   - [`report_result(Option<ReportResult>)`](crate::operation::describe_task_execution::DescribeTaskExecutionOutput::report_result): <p>Indicates whether DataSync generated a complete <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html">task report</a> for your transfer.</p>
    ///   - [`estimated_files_to_delete(i64)`](crate::operation::describe_task_execution::DescribeTaskExecutionOutput::estimated_files_to_delete): <p>The expected number of files, objects, and directories that DataSync will delete in your destination location. If you don't <a href="https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html">configure your task</a> to delete data in the destination that isn't in the source, the value is always <code>0</code>.</p>
    /// - On failure, responds with [`SdkError<DescribeTaskExecutionError>`](crate::operation::describe_task_execution::DescribeTaskExecutionError)
    pub fn describe_task_execution(&self) -> crate::operation::describe_task_execution::builders::DescribeTaskExecutionFluentBuilder {
        crate::operation::describe_task_execution::builders::DescribeTaskExecutionFluentBuilder::new(self.handle.clone())
    }
}