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

Inherits:

Struct

• Object
• Struct
• Aws::DataSync::Types::DescribeTaskExecutionResponse

Defined in:

gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb

Overview

DescribeTaskExecutionResponse

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bytes_compressed ⇒ Integer

  The physical number of bytes transferred over the network after compression was applied.

• #bytes_transferred ⇒ Integer

  The total number of bytes that are involved in the transfer.

• #bytes_written ⇒ Integer

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

• #estimated_bytes_to_transfer ⇒ Integer

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

• #estimated_files_to_transfer ⇒ Integer

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

• #excludes ⇒ Array<Types::FilterRule>

  A list of filter rules that exclude specific data during your transfer.

• #files_transferred ⇒ Integer

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

• #includes ⇒ Array<Types::FilterRule>

  A list of filter rules that include specific data during your transfer.

• #options ⇒ Types::Options

  Configures your DataSync task settings.

• #result ⇒ Types::TaskExecutionResultDetail

  The result of the task execution.

• #start_time ⇒ Time

  The time that the task execution was started.

• #status ⇒ String

  The status of the task execution.

• #task_execution_arn ⇒ String

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

Instance Attribute Details

#bytes_compressed ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2404

class DescribeTaskExecutionResponse < Struct.new(
  :task_execution_arn,
  :status,
  :options,
  :excludes,
  :includes,
  :start_time,
  :estimated_files_to_transfer,
  :estimated_bytes_to_transfer,
  :files_transferred,
  :bytes_written,
  :bytes_transferred,
  :result,
  :bytes_compressed)
  SENSITIVE = []
  include Aws::Structure
end

#bytes_transferred ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2404

class DescribeTaskExecutionResponse < Struct.new(
  :task_execution_arn,
  :status,
  :options,
  :excludes,
  :includes,
  :start_time,
  :estimated_files_to_transfer,
  :estimated_bytes_to_transfer,
  :files_transferred,
  :bytes_written,
  :bytes_transferred,
  :result,
  :bytes_compressed)
  SENSITIVE = []
  include Aws::Structure
end

#bytes_written ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2404

class DescribeTaskExecutionResponse < Struct.new(
  :task_execution_arn,
  :status,
  :options,
  :excludes,
  :includes,
  :start_time,
  :estimated_files_to_transfer,
  :estimated_bytes_to_transfer,
  :files_transferred,
  :bytes_written,
  :bytes_transferred,
  :result,
  :bytes_compressed)
  SENSITIVE = []
  include Aws::Structure
end

#estimated_bytes_to_transfer ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2404

class DescribeTaskExecutionResponse < Struct.new(
  :task_execution_arn,
  :status,
  :options,
  :excludes,
  :includes,
  :start_time,
  :estimated_files_to_transfer,
  :estimated_bytes_to_transfer,
  :files_transferred,
  :bytes_written,
  :bytes_transferred,
  :result,
  :bytes_compressed)
  SENSITIVE = []
  include Aws::Structure
end

#estimated_files_to_transfer ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2404

class DescribeTaskExecutionResponse < Struct.new(
  :task_execution_arn,
  :status,
  :options,
  :excludes,
  :includes,
  :start_time,
  :estimated_files_to_transfer,
  :estimated_bytes_to_transfer,
  :files_transferred,
  :bytes_written,
  :bytes_transferred,
  :result,
  :bytes_compressed)
  SENSITIVE = []
  include Aws::Structure
end

#excludes ⇒ Array<Types::FilterRule>

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

Returns:

• (Array<Types::FilterRule>)

# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2404

class DescribeTaskExecutionResponse < Struct.new(
  :task_execution_arn,
  :status,
  :options,
  :excludes,
  :includes,
  :start_time,
  :estimated_files_to_transfer,
  :estimated_bytes_to_transfer,
  :files_transferred,
  :bytes_written,
  :bytes_transferred,
  :result,
  :bytes_compressed)
  SENSITIVE = []
  include Aws::Structure
end

#files_transferred ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2404

class DescribeTaskExecutionResponse < Struct.new(
  :task_execution_arn,
  :status,
  :options,
  :excludes,
  :includes,
  :start_time,
  :estimated_files_to_transfer,
  :estimated_bytes_to_transfer,
  :files_transferred,
  :bytes_written,
  :bytes_transferred,
  :result,
  :bytes_compressed)
  SENSITIVE = []
  include Aws::Structure
end

#includes ⇒ Array<Types::FilterRule>

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

Returns:

• (Array<Types::FilterRule>)

# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2404

class DescribeTaskExecutionResponse < Struct.new(
  :task_execution_arn,
  :status,
  :options,
  :excludes,
  :includes,
  :start_time,
  :estimated_files_to_transfer,
  :estimated_bytes_to_transfer,
  :files_transferred,
  :bytes_written,
  :bytes_transferred,
  :result,
  :bytes_compressed)
  SENSITIVE = []
  include Aws::Structure
end

#options ⇒ Types::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.

Returns:

• (Types::Options)

# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2404

class DescribeTaskExecutionResponse < Struct.new(
  :task_execution_arn,
  :status,
  :options,
  :excludes,
  :includes,
  :start_time,
  :estimated_files_to_transfer,
  :estimated_bytes_to_transfer,
  :files_transferred,
  :bytes_written,
  :bytes_transferred,
  :result,
  :bytes_compressed)
  SENSITIVE = []
  include Aws::Structure
end

#result ⇒ Types::TaskExecutionResultDetail

The result of the task execution.

Returns:

• (Types::TaskExecutionResultDetail)

# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2404

class DescribeTaskExecutionResponse < Struct.new(
  :task_execution_arn,
  :status,
  :options,
  :excludes,
  :includes,
  :start_time,
  :estimated_files_to_transfer,
  :estimated_bytes_to_transfer,
  :files_transferred,
  :bytes_written,
  :bytes_transferred,
  :result,
  :bytes_compressed)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The time that the task execution was started.

Returns:

• (Time)

# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2404

class DescribeTaskExecutionResponse < Struct.new(
  :task_execution_arn,
  :status,
  :options,
  :excludes,
  :includes,
  :start_time,
  :estimated_files_to_transfer,
  :estimated_bytes_to_transfer,
  :files_transferred,
  :bytes_written,
  :bytes_transferred,
  :result,
  :bytes_compressed)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the task execution.

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

Returns:

• (String)

# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2404

class DescribeTaskExecutionResponse < Struct.new(
  :task_execution_arn,
  :status,
  :options,
  :excludes,
  :includes,
  :start_time,
  :estimated_files_to_transfer,
  :estimated_bytes_to_transfer,
  :files_transferred,
  :bytes_written,
  :bytes_transferred,
  :result,
  :bytes_compressed)
  SENSITIVE = []
  include Aws::Structure
end

#task_execution_arn ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2404

class DescribeTaskExecutionResponse < Struct.new(
  :task_execution_arn,
  :status,
  :options,
  :excludes,
  :includes,
  :start_time,
  :estimated_files_to_transfer,
  :estimated_bytes_to_transfer,
  :files_transferred,
  :bytes_written,
  :bytes_transferred,
  :result,
  :bytes_compressed)
  SENSITIVE = []
  include Aws::Structure
end