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

Inherits:

Struct

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

show all

Includes:: Structure

Defined in:: lib/aws-sdk-datasync/types.rb

Overview

DescribeTaskExecutionResponse

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#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 location.
#estimated_bytes_to_transfer ⇒ Integer

The estimated physical number of bytes that will transfer over the network.
#estimated_files_to_delete ⇒ Integer

The expected number of files, objects, and directories that DataSync will delete in your destination location.
#estimated_files_to_transfer ⇒ Integer

The expected number of files, objects, and directories that DataSync will transfer over the network.
#excludes ⇒ Array<Types::FilterRule>

A list of filter rules that exclude specific data during your transfer.
#files_deleted ⇒ Integer

The number of files, objects, and directories that DataSync deleted in your destination location.
#files_skipped ⇒ Integer

The number of files, objects, and directories that DataSync skipped during your transfer.
#files_transferred ⇒ Integer

The actual number of files, objects, and directories that DataSync transferred over the network.
#files_verified ⇒ Integer

The number of files, objects, and directories that DataSync verified during your transfer.
#includes ⇒ Array<Types::FilterRule>

A list of filter rules that include specific data during your transfer.
#manifest_config ⇒ Types::ManifestConfig

The configuration of the manifest that lists the files or objects to transfer.
#options ⇒ Types::Options

Indicates how your transfer task is configured.
#report_result ⇒ Types::ReportResult

Indicates whether DataSync generated a complete [task report] for your transfer.
#result ⇒ Types::TaskExecutionResultDetail

The result of the task execution.
#start_time ⇒ Time

The time when the task execution started.
#status ⇒ String

The status of the task execution.
#task_execution_arn ⇒ String

The ARN of the task execution that you wanted information about.
#task_report_config ⇒ Types::TaskReportConfig

The configuration of your task report, which provides detailed information about for your DataSync transfer.

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 'lib/aws-sdk-datasync/types.rb', line 2736

class DescribeTaskExecutionResponse < Struct.new(
  :task_execution_arn,
  :status,
  :options,
  :excludes,
  :includes,
  :manifest_config,
  :start_time,
  :estimated_files_to_transfer,
  :estimated_bytes_to_transfer,
  :files_transferred,
  :bytes_written,
  :bytes_transferred,
  :bytes_compressed,
  :result,
  :task_report_config,
  :files_deleted,
  :files_skipped,
  :files_verified,
  :report_result,
  :estimated_files_to_delete)
  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 'lib/aws-sdk-datasync/types.rb', line 2736

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

#bytes_written ⇒ `Integer`

The number of logical bytes written to the destination location.

Returns:

(Integer)

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

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

#estimated_bytes_to_transfer ⇒ `Integer`

The estimated physical number of bytes that will transfer over the network.

Returns:

(Integer)

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

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

#estimated_files_to_delete ⇒ `Integer`

The expected number of files, objects, and directories that DataSync will 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`.

[1]: docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html

Returns:

(Integer)

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

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

#estimated_files_to_transfer ⇒ `Integer`

The expected number of files, objects, and directories that DataSync will transfer over the network. This value is calculated during the task execution’s ‘PREPARING` phase before the `TRANSFERRING` phase. The calculation is based on comparing the content of the source and destination locations and finding the difference that needs to be transferred.

Returns:

(Integer)

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

class DescribeTaskExecutionResponse < Struct.new(
  :task_execution_arn,
  :status,
  :options,
  :excludes,
  :includes,
  :manifest_config,
  :start_time,
  :estimated_files_to_transfer,
  :estimated_bytes_to_transfer,
  :files_transferred,
  :bytes_written,
  :bytes_transferred,
  :bytes_compressed,
  :result,
  :task_report_config,
  :files_deleted,
  :files_skipped,
  :files_verified,
  :report_result,
  :estimated_files_to_delete)
  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].

[1]: docs.aws.amazon.com/datasync/latest/userguide/filtering.html

Returns:

(Array<Types::FilterRule>)

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

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

#files_deleted ⇒ `Integer`

The number of files, objects, and directories that DataSync deleted 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`.

[1]: docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html

Returns:

(Integer)

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

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

#files_skipped ⇒ `Integer`

The number of files, objects, and directories that DataSync skipped during your transfer.

Returns:

(Integer)

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

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

#files_transferred ⇒ `Integer`

The actual number of files, objects, and directories that DataSync transferred over the network. This value is updated periodically during the task execution’s ‘TRANSFERRING` phase 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 transferred or to monitor your task execution.

Returns:

(Integer)

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

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

#files_verified ⇒ `Integer`

The number of files, objects, and directories that DataSync verified during your transfer.

<note markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/datasync/latest/userguide/configure-data-verification-options.html

Returns:

(Integer)

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

class DescribeTaskExecutionResponse < Struct.new(
  :task_execution_arn,
  :status,
  :options,
  :excludes,
  :includes,
  :manifest_config,
  :start_time,
  :estimated_files_to_transfer,
  :estimated_bytes_to_transfer,
  :files_transferred,
  :bytes_written,
  :bytes_transferred,
  :bytes_compressed,
  :result,
  :task_report_config,
  :files_deleted,
  :files_skipped,
  :files_verified,
  :report_result,
  :estimated_files_to_delete)
  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].

[1]: docs.aws.amazon.com/datasync/latest/userguide/filtering.html

Returns:

(Array<Types::FilterRule>)

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

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

#manifest_config ⇒ `Types::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].

[1]: docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html

Returns:

(Types::ManifestConfig)

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

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

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

[1]: docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html

Returns:

(Types::Options)

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

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

#report_result ⇒ `Types::ReportResult`

Indicates whether DataSync generated a complete [task report] for your transfer.

[1]: docs.aws.amazon.com/datasync/latest/userguide/task-reports.html

Returns:

(Types::ReportResult)

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

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

#result ⇒ `Types::TaskExecutionResultDetail`

The result of the task execution.

Returns:

(Types::TaskExecutionResultDetail)

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

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

#start_time ⇒ `Time`

The time when the task execution started.

Returns:

(Time)

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

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

#status ⇒ `String`

The status of the task execution.

Returns:

(String)

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

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

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

Returns:

(String)

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

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

#task_report_config ⇒ `Types::TaskReportConfig`

The configuration of your task report, which provides detailed information about for your DataSync transfer. For more information, see [Creating a task report].

[1]: docs.aws.amazon.com/datasync/latest/userguide/task-reports.html

Returns:

(Types::TaskReportConfig)

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

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

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#bytes_compressed ⇒ Integer

#bytes_transferred ⇒ Integer

#bytes_written ⇒ Integer

#estimated_bytes_to_transfer ⇒ Integer

#estimated_files_to_delete ⇒ Integer

#estimated_files_to_transfer ⇒ Integer

#excludes ⇒ Array<Types::FilterRule>

#files_deleted ⇒ Integer

#files_skipped ⇒ Integer

#files_transferred ⇒ Integer

#files_verified ⇒ Integer

#includes ⇒ Array<Types::FilterRule>

#manifest_config ⇒ Types::ManifestConfig

#options ⇒ Types::Options

#report_result ⇒ Types::ReportResult

#result ⇒ Types::TaskExecutionResultDetail

#start_time ⇒ Time

#status ⇒ String

#task_execution_arn ⇒ String

#task_report_config ⇒ Types::TaskReportConfig

#bytes_compressed ⇒ `Integer`

#bytes_transferred ⇒ `Integer`

#bytes_written ⇒ `Integer`

#estimated_bytes_to_transfer ⇒ `Integer`

#estimated_files_to_delete ⇒ `Integer`

#estimated_files_to_transfer ⇒ `Integer`

#excludes ⇒ `Array<Types::FilterRule>`

#files_deleted ⇒ `Integer`

#files_skipped ⇒ `Integer`

#files_transferred ⇒ `Integer`

#files_verified ⇒ `Integer`

#includes ⇒ `Array<Types::FilterRule>`

#manifest_config ⇒ `Types::ManifestConfig`

#options ⇒ `Types::Options`

#report_result ⇒ `Types::ReportResult`

#result ⇒ `Types::TaskExecutionResultDetail`

#start_time ⇒ `Time`

#status ⇒ `String`

#task_execution_arn ⇒ `String`

#task_report_config ⇒ `Types::TaskReportConfig`