#[non_exhaustive]pub struct DescribeTaskExecutionOutput {Show 24 fields
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,
pub task_mode: Option<TaskMode>,
pub files_prepared: i64,
pub files_listed: Option<TaskExecutionFilesListedDetail>,
pub files_failed: Option<TaskExecutionFilesFailedDetail>,
/* private fields */
}Expand description
DescribeTaskExecutionResponse
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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: i64The number of files, objects, and directories that DataSync expects to transfer over the network. This value is calculated while DataSync prepares the transfer.
How this gets calculated depends primarily on your task’s transfer mode configuration:
-
If
TranserModeis set toCHANGED- The calculation is based on comparing the content of the source and destination locations and determining the difference that needs to be transferred. The difference can include:-
Anything that's added or modified at the source location.
-
Anything that's in both locations and modified at the destination after an initial transfer (unless OverwriteMode is set to
NEVER). -
(Basic task mode only) The number of items that DataSync expects to delete (if PreserveDeletedFiles is set to
REMOVE).
-
-
If
TranserModeis set toALL- The calculation is based only on the items that DataSync finds at the source location.
estimated_bytes_to_transfer: i64The number of logical bytes that DataSync expects to write to the destination location.
files_transferred: i64The number of files, objects, and directories that DataSync actually transfers over the network. This value is updated periodically during your task execution 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's transferring or to monitor your task execution.
bytes_written: i64The number of logical bytes that DataSync actually writes to the destination location.
bytes_transferred: i64The number of bytes that DataSync sends to the network before compression (if compression is possible). For the number of bytes transferred over the network, see BytesCompressed.
bytes_compressed: i64The number of physical bytes that DataSync transfers over the network after compression (if compression is possible). This number is typically 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: i64The number of files, objects, and directories that DataSync actually deletes 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: i64The number of files, objects, and directories that DataSync skips during your transfer.
files_verified: i64The number of files, objects, and directories that DataSync verifies 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: i64The number of files, objects, and directories that DataSync expects to 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.
task_mode: Option<TaskMode>The task mode that you're using. For more information, see Choosing a task mode for your data transfer.
files_prepared: i64The number of objects that DataSync will attempt to transfer after comparing your source and destination locations.
Applies only to Enhanced mode tasks.
This counter isn't applicable if you configure your task to transfer all data. In that scenario, DataSync copies everything from the source to the destination without comparing differences between the locations.
files_listed: Option<TaskExecutionFilesListedDetail>The number of objects that DataSync finds at your locations.
Applies only to Enhanced mode tasks.
files_failed: Option<TaskExecutionFilesFailedDetail>The number of objects that DataSync fails to prepare, transfer, verify, and delete during your task execution.
Applies only to Enhanced mode tasks.
Implementations§
Source§impl DescribeTaskExecutionOutput
impl DescribeTaskExecutionOutput
Sourcepub fn task_execution_arn(&self) -> Option<&str>
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.
Sourcepub fn status(&self) -> Option<&TaskExecutionStatus>
pub fn status(&self) -> Option<&TaskExecutionStatus>
The status of the task execution.
Sourcepub fn options(&self) -> Option<&Options>
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.
Sourcepub fn excludes(&self) -> &[FilterRule]
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().
Sourcepub fn includes(&self) -> &[FilterRule]
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().
Sourcepub fn manifest_config(&self) -> Option<&ManifestConfig>
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.
Sourcepub fn start_time(&self) -> Option<&DateTime>
pub fn start_time(&self) -> Option<&DateTime>
The time when the task execution started.
Sourcepub fn estimated_files_to_transfer(&self) -> i64
pub fn estimated_files_to_transfer(&self) -> i64
The number of files, objects, and directories that DataSync expects to transfer over the network. This value is calculated while DataSync prepares the transfer.
How this gets calculated depends primarily on your task’s transfer mode configuration:
-
If
TranserModeis set toCHANGED- The calculation is based on comparing the content of the source and destination locations and determining the difference that needs to be transferred. The difference can include:-
Anything that's added or modified at the source location.
-
Anything that's in both locations and modified at the destination after an initial transfer (unless OverwriteMode is set to
NEVER). -
(Basic task mode only) The number of items that DataSync expects to delete (if PreserveDeletedFiles is set to
REMOVE).
-
-
If
TranserModeis set toALL- The calculation is based only on the items that DataSync finds at the source location.
Sourcepub fn estimated_bytes_to_transfer(&self) -> i64
pub fn estimated_bytes_to_transfer(&self) -> i64
The number of logical bytes that DataSync expects to write to the destination location.
Sourcepub fn files_transferred(&self) -> i64
pub fn files_transferred(&self) -> i64
The number of files, objects, and directories that DataSync actually transfers over the network. This value is updated periodically during your task execution 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's transferring or to monitor your task execution.
Sourcepub fn bytes_written(&self) -> i64
pub fn bytes_written(&self) -> i64
The number of logical bytes that DataSync actually writes to the destination location.
Sourcepub fn bytes_transferred(&self) -> i64
pub fn bytes_transferred(&self) -> i64
The number of bytes that DataSync sends to the network before compression (if compression is possible). For the number of bytes transferred over the network, see BytesCompressed.
Sourcepub fn bytes_compressed(&self) -> i64
pub fn bytes_compressed(&self) -> i64
The number of physical bytes that DataSync transfers over the network after compression (if compression is possible). This number is typically less than BytesTransferred unless the data isn't compressible.
Sourcepub fn result(&self) -> Option<&TaskExecutionResultDetail>
pub fn result(&self) -> Option<&TaskExecutionResultDetail>
The result of the task execution.
Sourcepub fn task_report_config(&self) -> Option<&TaskReportConfig>
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.
Sourcepub fn files_deleted(&self) -> i64
pub fn files_deleted(&self) -> i64
The number of files, objects, and directories that DataSync actually deletes 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.
Sourcepub fn files_skipped(&self) -> i64
pub fn files_skipped(&self) -> i64
The number of files, objects, and directories that DataSync skips during your transfer.
Sourcepub fn files_verified(&self) -> i64
pub fn files_verified(&self) -> i64
The number of files, objects, and directories that DataSync verifies 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.
Sourcepub fn report_result(&self) -> Option<&ReportResult>
pub fn report_result(&self) -> Option<&ReportResult>
Indicates whether DataSync generated a complete task report for your transfer.
Sourcepub fn estimated_files_to_delete(&self) -> i64
pub fn estimated_files_to_delete(&self) -> i64
The number of files, objects, and directories that DataSync expects to 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.
Sourcepub fn task_mode(&self) -> Option<&TaskMode>
pub fn task_mode(&self) -> Option<&TaskMode>
The task mode that you're using. For more information, see Choosing a task mode for your data transfer.
Sourcepub fn files_prepared(&self) -> i64
pub fn files_prepared(&self) -> i64
The number of objects that DataSync will attempt to transfer after comparing your source and destination locations.
Applies only to Enhanced mode tasks.
This counter isn't applicable if you configure your task to transfer all data. In that scenario, DataSync copies everything from the source to the destination without comparing differences between the locations.
Sourcepub fn files_listed(&self) -> Option<&TaskExecutionFilesListedDetail>
pub fn files_listed(&self) -> Option<&TaskExecutionFilesListedDetail>
The number of objects that DataSync finds at your locations.
Applies only to Enhanced mode tasks.
Sourcepub fn files_failed(&self) -> Option<&TaskExecutionFilesFailedDetail>
pub fn files_failed(&self) -> Option<&TaskExecutionFilesFailedDetail>
The number of objects that DataSync fails to prepare, transfer, verify, and delete during your task execution.
Applies only to Enhanced mode tasks.
Source§impl DescribeTaskExecutionOutput
impl DescribeTaskExecutionOutput
Sourcepub fn builder() -> DescribeTaskExecutionOutputBuilder
pub fn builder() -> DescribeTaskExecutionOutputBuilder
Creates a new builder-style object to manufacture DescribeTaskExecutionOutput.
Trait Implementations§
Source§impl Clone for DescribeTaskExecutionOutput
impl Clone for DescribeTaskExecutionOutput
Source§fn clone(&self) -> DescribeTaskExecutionOutput
fn clone(&self) -> DescribeTaskExecutionOutput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for DescribeTaskExecutionOutput
impl Debug for DescribeTaskExecutionOutput
Source§impl RequestId for DescribeTaskExecutionOutput
impl RequestId for DescribeTaskExecutionOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None if the service could not be reached.impl StructuralPartialEq for DescribeTaskExecutionOutput
Auto Trait Implementations§
impl Freeze for DescribeTaskExecutionOutput
impl RefUnwindSafe for DescribeTaskExecutionOutput
impl Send for DescribeTaskExecutionOutput
impl Sync for DescribeTaskExecutionOutput
impl Unpin for DescribeTaskExecutionOutput
impl UnwindSafe for DescribeTaskExecutionOutput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightBlack.
§Example
println!("{}", value.bright_black());Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightGreen.
§Example
println!("{}", value.bright_green());Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightYellow.
§Example
println!("{}", value.bright_yellow());Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightMagenta.
§Example
println!("{}", value.bright_magenta());Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightWhite.
§Example
println!("{}", value.bright_white());Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightBlack.
§Example
println!("{}", value.on_bright_black());Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightGreen.
§Example
println!("{}", value.on_bright_green());Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightYellow.
§Example
println!("{}", value.on_bright_yellow());Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightBlue.
§Example
println!("{}", value.on_bright_blue());Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightMagenta.
§Example
println!("{}", value.on_bright_magenta());Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightCyan.
§Example
println!("{}", value.on_bright_cyan());Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightWhite.
§Example
println!("{}", value.on_bright_white());Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::Underline.
§Example
println!("{}", value.underline());Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::RapidBlink.
§Example
println!("{}", value.rapid_blink());Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);