class Aws::DataSync::Types::DescribeTaskExecutionResponse

DescribeTaskExecutionResponse

@!attribute [rw] task_execution_arn

The Amazon Resource Name (ARN) of the task execution that was
described. `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`.
@return [String]

@!attribute [rw] status

The status of the task execution.

For detailed information about task execution statuses, see
Understanding Task Statuses in the *DataSync User Guide.*
@return [String]

@!attribute [rw] options

Represents the options that are available to control the behavior of
a [StartTaskExecution][1] operation. Behavior includes preserving
metadata such as user ID (UID), group ID (GID), and file
permissions, and also overwriting files in the destination, data
integrity verification, and so on.

A task has a set of default options associated with it. If you
don't specify an option in [StartTaskExecution][1], the default
value is used. You can override the defaults options on each task
execution by specifying an overriding `Options` value to
[StartTaskExecution][1].

[1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
@return [Types::Options]

@!attribute [rw] excludes

A list of filter rules that determines which files to exclude from a
task. The list should contain a single filter string that consists
of the patterns to exclude. The patterns are delimited by "\|"
(that is, a pipe), for example: `"/folder1|/folder2"`
@return [Array<Types::FilterRule>]

@!attribute [rw] includes

A list of filter rules that determines which files to include when
running a task. The list should contain a single filter string that
consists of the patterns to include. The patterns are delimited by
"\|" (that is, a pipe), for example: `"/folder1|/folder2"`
@return [Array<Types::FilterRule>]

@!attribute [rw] start_time

The time that the task execution was started.
@return [Time]

@!attribute [rw] estimated_files_to_transfer

The expected number of files that is to be transferred over the
network. This value is calculated during the PREPARING phase, before
the TRANSFERRING phase. This value is the expected number of files
to be transferred. It's calculated based on comparing the content
of the source and destination locations and finding the delta that
needs to be transferred.
@return [Integer]

@!attribute [rw] estimated_bytes_to_transfer

The estimated physical number of bytes that is to be transferred
over the network.
@return [Integer]

@!attribute [rw] files_transferred

The actual number of files that was transferred over the network.
This value is calculated and updated on an ongoing basis during the
TRANSFERRING phase. It's updated periodically when each file is
read from the source and sent over the network.

If failures occur during a transfer, this value can be less than
`EstimatedFilesToTransfer`. This value can also be greater than
`EstimatedFilesTransferred` in some cases. This element is
implementation-specific for some location types, so don't use it as
an indicator for a correct file number or to monitor your task
execution.
@return [Integer]

@!attribute [rw] bytes_written

The number of logical bytes written to the destination Amazon Web
Services storage resource.
@return [Integer]

@!attribute [rw] bytes_transferred

The physical number of bytes transferred over the network.
@return [Integer]

@!attribute [rw] result

The result of the task execution.
@return [Types::TaskExecutionResultDetail]

@see docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTaskExecutionResponse AWS API Documentation

Constants

SENSITIVE