Struct aws_sdk_datasync::operation::describe_task_execution::DescribeTaskExecutionOutput

#[non_exhaustive]
pub struct DescribeTaskExecutionOutput {

    pub task_execution_arn: Option<String>,
    pub status: Option<TaskExecutionStatus>,
    pub options: Option<Options>,
    pub excludes: Option<Vec<FilterRule>>,
    pub includes: Option<Vec<FilterRule>>,
    pub manifest_config: Option<ManifestConfig>,
    pub start_time: Option<DateTime>,
    pub estimated_files_to_transfer: i64,
    pub estimated_bytes_to_transfer: i64,
    pub files_transferred: i64,
    pub bytes_written: i64,
    pub bytes_transferred: i64,
    pub bytes_compressed: i64,
    pub result: Option<TaskExecutionResultDetail>,
    pub task_report_config: Option<TaskReportConfig>,
    pub files_deleted: i64,
    pub files_skipped: i64,
    pub files_verified: i64,
    pub report_result: Option<ReportResult>,
    pub estimated_files_to_delete: i64,
    /* private fields */
}

DescribeTaskExecutionResponse

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

task_execution_arn: Option<String>

The ARN of the task execution that you wanted information about. TaskExecutionArn is hierarchical and includes TaskArn for the task that was executed.

For example, a TaskExecution value with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b executed the task with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2.

status: Option<TaskExecutionStatus>

The status of the task execution.

options: Option<Options>

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.

Each option has a default value. Unless you need to, you don't have to configure any option before calling StartTaskExecution.

You also can override your task options for each task execution. For example, you might want to adjust the LogLevel for an individual execution.

excludes: Option<Vec<FilterRule>>

A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

includes: Option<Vec<FilterRule>>

A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

manifest_config: Option<ManifestConfig>

The configuration of the manifest that lists the files or objects to transfer. For more information, see Specifying what DataSync transfers by using a manifest.

start_time: Option<DateTime>

The time when the task execution started.

estimated_files_to_transfer: i64

The expected number of files, objects, and directories that DataSync will transfer over the network. This value is calculated during the task execution's PREPARING phase before the TRANSFERRING phase. The calculation is based on comparing the content of the source and destination locations and finding the difference that needs to be transferred.

estimated_bytes_to_transfer: i64

The estimated physical number of bytes that will transfer over the network.

files_transferred: i64

The actual number of files, objects, and directories that DataSync transferred over the network. This value is updated periodically during the task execution's TRANSFERRING phase when something is read from the source and sent over the network.

If DataSync fails to transfer something, this value can be less than EstimatedFilesToTransfer. In some cases, this value can also be greater than EstimatedFilesToTransfer. 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.

bytes_written: i64

The number of logical bytes written to the destination location.

bytes_transferred: i64

The total number of bytes that are involved in the transfer. For the number of bytes sent over the network, see BytesCompressed.

bytes_compressed: i64

The physical number of bytes transferred over the network after compression was applied. In most cases, this number is less than BytesTransferred unless the data isn't compressible.

result: Option<TaskExecutionResultDetail>

The result of the task execution.

task_report_config: Option<TaskReportConfig>

The configuration of your task report, which provides detailed information about for your DataSync transfer. For more information, see Creating a task report.

files_deleted: i64

The number of files, objects, and directories that DataSync deleted in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always 0.

files_skipped: i64

The number of files, objects, and directories that DataSync skipped during your transfer.

files_verified: i64

The number of files, objects, and directories that DataSync verified during your transfer.

When you configure your task to verify only the data that's transferred, DataSync doesn't verify directories in some situations or files that fail to transfer.

report_result: Option<ReportResult>

Indicates whether DataSync generated a complete task report for your transfer.

estimated_files_to_delete: i64

The expected number of files, objects, and directories that DataSync will delete in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always 0.

Implementations

impl DescribeTaskExecutionOutput

pub fn task_execution_arn(&self) -> Option<&str>

The ARN of the task execution that you wanted information about. TaskExecutionArn is hierarchical and includes TaskArn for the task that was executed.

For example, a TaskExecution value with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b executed the task with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2.

pub fn status(&self) -> Option<&TaskExecutionStatus>

The status of the task execution.

pub fn options(&self) -> Option<&Options>

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.

Each option has a default value. Unless you need to, you don't have to configure any option before calling StartTaskExecution.

You also can override your task options for each task execution. For example, you might want to adjust the LogLevel for an individual execution.

pub fn excludes(&self) -> &[FilterRule]

A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .excludes.is_none().

pub fn includes(&self) -> &[FilterRule]

A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .includes.is_none().

pub fn manifest_config(&self) -> Option<&ManifestConfig>

The configuration of the manifest that lists the files or objects to transfer. For more information, see Specifying what DataSync transfers by using a manifest.

pub fn start_time(&self) -> Option<&DateTime>

The time when the task execution started.

pub fn estimated_files_to_transfer(&self) -> i64

The expected number of files, objects, and directories that DataSync will transfer over the network. This value is calculated during the task execution's PREPARING phase before the TRANSFERRING phase. The calculation is based on comparing the content of the source and destination locations and finding the difference that needs to be transferred.

pub fn estimated_bytes_to_transfer(&self) -> i64

The estimated physical number of bytes that will transfer over the network.

pub fn files_transferred(&self) -> i64

The actual number of files, objects, and directories that DataSync transferred over the network. This value is updated periodically during the task execution's TRANSFERRING phase when something is read from the source and sent over the network.

If DataSync fails to transfer something, this value can be less than EstimatedFilesToTransfer. In some cases, this value can also be greater than EstimatedFilesToTransfer. 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.

pub fn bytes_written(&self) -> i64

The number of logical bytes written to the destination location.

pub fn bytes_transferred(&self) -> i64

The total number of bytes that are involved in the transfer. For the number of bytes sent over the network, see BytesCompressed.

pub fn bytes_compressed(&self) -> i64

The physical number of bytes transferred over the network after compression was applied. In most cases, this number is less than BytesTransferred unless the data isn't compressible.

pub fn result(&self) -> Option<&TaskExecutionResultDetail>

The result of the task execution.

pub fn task_report_config(&self) -> Option<&TaskReportConfig>

The configuration of your task report, which provides detailed information about for your DataSync transfer. For more information, see Creating a task report.

pub fn files_deleted(&self) -> i64

The number of files, objects, and directories that DataSync deleted in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always 0.

pub fn files_skipped(&self) -> i64

The number of files, objects, and directories that DataSync skipped during your transfer.

pub fn files_verified(&self) -> i64

The number of files, objects, and directories that DataSync verified during your transfer.

When you configure your task to verify only the data that's transferred, DataSync doesn't verify directories in some situations or files that fail to transfer.

pub fn report_result(&self) -> Option<&ReportResult>

Indicates whether DataSync generated a complete task report for your transfer.

pub fn estimated_files_to_delete(&self) -> i64

The expected number of files, objects, and directories that DataSync will delete in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always 0.

impl DescribeTaskExecutionOutput

pub fn builder() -> DescribeTaskExecutionOutputBuilder

Creates a new builder-style object to manufacture DescribeTaskExecutionOutput.

Trait Implementations

impl Clone for DescribeTaskExecutionOutput

fn clone(&self) -> DescribeTaskExecutionOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeTaskExecutionOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DescribeTaskExecutionOutput

fn eq(&self, other: &DescribeTaskExecutionOutput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for DescribeTaskExecutionOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for DescribeTaskExecutionOutput