aws_sdk_datasync/client/
start_task_execution.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartTaskExecution`](crate::operation::start_task_execution::builders::StartTaskExecutionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`task_arn(impl Into<String>)`](crate::operation::start_task_execution::builders::StartTaskExecutionFluentBuilder::task_arn) / [`set_task_arn(Option<String>)`](crate::operation::start_task_execution::builders::StartTaskExecutionFluentBuilder::set_task_arn):<br>required: **true**<br><p>Specifies the Amazon Resource Name (ARN) of the task that you want to start.</p><br>
    ///   - [`override_options(Options)`](crate::operation::start_task_execution::builders::StartTaskExecutionFluentBuilder::override_options) / [`set_override_options(Option<Options>)`](crate::operation::start_task_execution::builders::StartTaskExecutionFluentBuilder::set_override_options):<br>required: **false**<br><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><br>
    ///   - [`includes(FilterRule)`](crate::operation::start_task_execution::builders::StartTaskExecutionFluentBuilder::includes) / [`set_includes(Option<Vec::<FilterRule>>)`](crate::operation::start_task_execution::builders::StartTaskExecutionFluentBuilder::set_includes):<br>required: **false**<br><p>Specifies a list of filter rules that determines which files to include when running a task. The pattern should contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example, <code>"/folder1|/folder2"</code>.</p><br>
    ///   - [`excludes(FilterRule)`](crate::operation::start_task_execution::builders::StartTaskExecutionFluentBuilder::excludes) / [`set_excludes(Option<Vec::<FilterRule>>)`](crate::operation::start_task_execution::builders::StartTaskExecutionFluentBuilder::set_excludes):<br>required: **false**<br><p>Specifies a list of filter rules that determines which files to exclude from a task. The list contains a single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example, <code>"/folder1|/folder2"</code>.</p><br>
    ///   - [`manifest_config(ManifestConfig)`](crate::operation::start_task_execution::builders::StartTaskExecutionFluentBuilder::manifest_config) / [`set_manifest_config(Option<ManifestConfig>)`](crate::operation::start_task_execution::builders::StartTaskExecutionFluentBuilder::set_manifest_config):<br>required: **false**<br><p>Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, 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> <p>When using this parameter, your caller identity (the role that you're using DataSync with) must have the <code>iam:PassRole</code> permission. The <a href="https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess">AWSDataSyncFullAccess</a> policy includes this permission.</p> <p>To remove a manifest configuration, specify this parameter with an empty value.</p><br>
    ///   - [`task_report_config(TaskReportConfig)`](crate::operation::start_task_execution::builders::StartTaskExecutionFluentBuilder::task_report_config) / [`set_task_report_config(Option<TaskReportConfig>)`](crate::operation::start_task_execution::builders::StartTaskExecutionFluentBuilder::set_task_report_config):<br>required: **false**<br><p>Specifies how you want to configure a 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> <p>When using this parameter, your caller identity (the role that you're using DataSync with) must have the <code>iam:PassRole</code> permission. The <a href="https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess">AWSDataSyncFullAccess</a> policy includes this permission.</p> <p>To remove a task report configuration, specify this parameter as empty.</p><br>
    ///   - [`tags(TagListEntry)`](crate::operation::start_task_execution::builders::StartTaskExecutionFluentBuilder::tags) / [`set_tags(Option<Vec::<TagListEntry>>)`](crate::operation::start_task_execution::builders::StartTaskExecutionFluentBuilder::set_tags):<br>required: **false**<br><p>Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution.</p> <p><i>Tags</i> are key-value pairs that help you manage, filter, and search for your DataSync resources.</p><br>
    /// - On success, responds with [`StartTaskExecutionOutput`](crate::operation::start_task_execution::StartTaskExecutionOutput) with field(s):
    ///   - [`task_execution_arn(Option<String>)`](crate::operation::start_task_execution::StartTaskExecutionOutput::task_execution_arn): <p>The ARN of the running task execution.</p>
    /// - On failure, responds with [`SdkError<StartTaskExecutionError>`](crate::operation::start_task_execution::StartTaskExecutionError)
    pub fn start_task_execution(&self) -> crate::operation::start_task_execution::builders::StartTaskExecutionFluentBuilder {
        crate::operation::start_task_execution::builders::StartTaskExecutionFluentBuilder::new(self.handle.clone())
    }
}
aws_sdk_datasync/client/start_task_execution.rs

aws_sdk_datasync/client/
start_task_execution.rs
