AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DataSync::Types::DescribeTaskExecutionResponse

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

DescribeTaskExecutionResponse

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#bytes_transferredInteger

The physical number of bytes transferred over the network.

Returns:

  • (Integer)

    The physical number of bytes transferred over the network.

#bytes_writtenInteger

The number of logical bytes written to the destination AWS storage resource.

Returns:

  • (Integer)

    The number of logical bytes written to the destination AWS storage resource.

#estimated_bytes_to_transferInteger

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

Returns:

  • (Integer)

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

#estimated_files_to_transferInteger

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.

Returns:

  • (Integer)

    The expected number of files that is to be transferred over the network.

#excludesArray<Types::FilterRule>

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"

Returns:

  • (Array<Types::FilterRule>)

    A list of filter rules that determines which files to exclude from a task.

#files_transferredInteger

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.

Returns:

  • (Integer)

    The actual number of files that was transferred over the network.

#includesArray<Types::FilterRule>

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"

Returns:

  • (Array<Types::FilterRule>)

    A list of filter rules that determines which files to include when running a task.

#optionsTypes::Options

Represents the options that are available to control the behavior of a StartTaskExecution 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, the default value is used. You can override the defaults options on each task execution by specifying an overriding Options value to StartTaskExecution.

Returns:

#resultTypes::TaskExecutionResultDetail

The result of the task execution.

Returns:

#start_timeTime

The time that the task execution was started.

Returns:

  • (Time)

    The time that the task execution was started.

#statusString

The status of the task execution.

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

Possible values:

  • QUEUED
  • LAUNCHING
  • PREPARING
  • TRANSFERRING
  • VERIFYING
  • SUCCESS
  • ERROR

Returns:

  • (String)

    The status of the task execution.

#task_execution_arnString

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.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the task execution that was described.