Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DescribeTaskExecutionResponse

DescribeTaskExecutionResponse

Hierarchy

Index

Properties

Optional BytesCompressed

BytesCompressed: undefined | number

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.

Optional BytesTransferred

BytesTransferred: undefined | number

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

Optional BytesWritten

BytesWritten: undefined | number

The number of logical bytes written to the destination Amazon Web Services storage resource.

Optional EstimatedBytesToTransfer

EstimatedBytesToTransfer: undefined | number

The estimated physical number of bytes that is to be transferred over the network.

Optional EstimatedFilesToTransfer

EstimatedFilesToTransfer: undefined | number

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 of the task execution. 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.

Optional Excludes

Excludes: FilterRule[]

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

Optional FilesTransferred

FilesTransferred: undefined | number

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 of the task execution. 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. 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 indicator for a correct file number or to monitor your task execution.

Optional Includes

Includes: FilterRule[]

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

Optional Options

Options: Options

Configures your DataSync task settings. These options include how DataSync handles files, objects, and their associated metadata. You also can specify how DataSync verifies data integrity, set bandwidth limits for your task, among other options.

Each task setting has a default value. Unless you need to, you don't have to configure any of these Options before starting your task.

Optional Result

The result of the task execution.

Optional StartTime

StartTime: Date

The time that the task execution was started.

Optional Status

Status: TaskExecutionStatus | string

The status of the task execution.

For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.

Optional TaskExecutionArn

TaskExecutionArn: undefined | string

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.