aws_sdk_datasync/client/
describe_task.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeTask`](crate::operation::describe_task::builders::DescribeTaskFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`task_arn(impl Into<String>)`](crate::operation::describe_task::builders::DescribeTaskFluentBuilder::task_arn) / [`set_task_arn(Option<String>)`](crate::operation::describe_task::builders::DescribeTaskFluentBuilder::set_task_arn):<br>required: **true**<br><p>Specifies the Amazon Resource Name (ARN) of the transfer task that you want information about.</p><br>
    /// - On success, responds with [`DescribeTaskOutput`](crate::operation::describe_task::DescribeTaskOutput) with field(s):
    ///   - [`task_arn(Option<String>)`](crate::operation::describe_task::DescribeTaskOutput::task_arn): <p>The ARN of your task.</p>
    ///   - [`status(Option<TaskStatus>)`](crate::operation::describe_task::DescribeTaskOutput::status): <p>The status of your task. For information about what each status means, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/understand-task-statuses.html#understand-task-creation-statuses">Task statuses</a>.</p>
    ///   - [`name(Option<String>)`](crate::operation::describe_task::DescribeTaskOutput::name): <p>The name of your task.</p>
    ///   - [`current_task_execution_arn(Option<String>)`](crate::operation::describe_task::DescribeTaskOutput::current_task_execution_arn): <p>The ARN of the most recent task execution.</p>
    ///   - [`source_location_arn(Option<String>)`](crate::operation::describe_task::DescribeTaskOutput::source_location_arn): <p>The ARN of your transfer's source location.</p>
    ///   - [`destination_location_arn(Option<String>)`](crate::operation::describe_task::DescribeTaskOutput::destination_location_arn): <p>The ARN of your transfer's destination location.</p>
    ///   - [`cloud_watch_log_group_arn(Option<String>)`](crate::operation::describe_task::DescribeTaskOutput::cloud_watch_log_group_arn): <p>The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/configure-logging.html">Monitoring data transfers with CloudWatch Logs</a>.</p>
    ///   - [`source_network_interface_arns(Option<Vec::<String>>)`](crate::operation::describe_task::DescribeTaskOutput::source_network_interface_arns): <p>The ARNs of the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces">network interfaces</a> that DataSync created for your source location.</p>
    ///   - [`destination_network_interface_arns(Option<Vec::<String>>)`](crate::operation::describe_task::DescribeTaskOutput::destination_network_interface_arns): <p>The ARNs of the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces">network interfaces</a> that DataSync created for your destination location.</p>
    ///   - [`options(Option<Options>)`](crate::operation::describe_task::DescribeTaskOutput::options): <p>The task's settings. For example, what file metadata gets preserved, how data integrity gets verified at the end of your transfer, bandwidth limits, among other options.</p>
    ///   - [`excludes(Option<Vec::<FilterRule>>)`](crate::operation::describe_task::DescribeTaskOutput::excludes): <p>The exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Specifying what DataSync transfers by using filters</a>.</p>
    ///   - [`schedule(Option<TaskSchedule>)`](crate::operation::describe_task::DescribeTaskOutput::schedule): <p>The schedule for when you want your task to run. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html">Scheduling your task</a>.</p>
    ///   - [`error_code(Option<String>)`](crate::operation::describe_task::DescribeTaskOutput::error_code): <p>If there's an issue with your task, you can use the error code to help you troubleshoot the problem. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html">Troubleshooting issues with DataSync transfers</a>.</p>
    ///   - [`error_detail(Option<String>)`](crate::operation::describe_task::DescribeTaskOutput::error_detail): <p>If there's an issue with your task, you can use the error details to help you troubleshoot the problem. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html">Troubleshooting issues with DataSync transfers</a>.</p>
    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_task::DescribeTaskOutput::creation_time): <p>The time that the task was created.</p>
    ///   - [`includes(Option<Vec::<FilterRule>>)`](crate::operation::describe_task::DescribeTaskOutput::includes): <p>The include filters that define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html">Specifying what DataSync transfers by using filters</a>.</p>
    ///   - [`manifest_config(Option<ManifestConfig>)`](crate::operation::describe_task::DescribeTaskOutput::manifest_config): <p>The configuration of the manifest that lists the files or objects that you want DataSync 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>
    ///   - [`task_report_config(Option<TaskReportConfig>)`](crate::operation::describe_task::DescribeTaskOutput::task_report_config): <p>The configuration of your task report, which provides detailed information about your DataSync transfer. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html">Monitoring your DataSync transfers with task reports</a>.</p>
    ///   - [`schedule_details(Option<TaskScheduleDetails>)`](crate::operation::describe_task::DescribeTaskOutput::schedule_details): <p>The details about your <a href="https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html">task schedule</a>.</p>
    ///   - [`task_mode(Option<TaskMode>)`](crate::operation::describe_task::DescribeTaskOutput::task_mode): <p>The task mode that you're using. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html">Choosing a task mode for your data transfer</a>.</p>
    /// - On failure, responds with [`SdkError<DescribeTaskError>`](crate::operation::describe_task::DescribeTaskError)
    pub fn describe_task(&self) -> crate::operation::describe_task::builders::DescribeTaskFluentBuilder {
        crate::operation::describe_task::builders::DescribeTaskFluentBuilder::new(self.handle.clone())
    }
}
aws_sdk_datasync/client/describe_task.rs

aws_sdk_datasync/client/
describe_task.rs
