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 number of physical bytes that DataSync transfers over the network after compression (if compression is possible).
#bytes_transferred ⇒ Integer

The number of bytes that DataSync sends to the network before compression (if compression is possible).
#bytes_written ⇒ Integer

The number of logical bytes that DataSync actually writes to the destination location.
#estimated_bytes_to_transfer ⇒ Integer

The number of logical bytes that DataSync expects to write to the destination location.
#estimated_files_to_delete ⇒ Integer

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

The number of files, objects, and directories that DataSync expects to 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 actually deletes in your destination location.
#files_failed ⇒ Types::TaskExecutionFilesFailedDetail

The number of objects that DataSync fails to prepare, transfer, verify, and delete during your task execution.
#files_listed ⇒ Types::TaskExecutionFilesListedDetail

The number of objects that DataSync finds at your locations.
#files_prepared ⇒ Integer

The number of objects that DataSync will attempt to transfer after comparing your source and destination locations.
#files_skipped ⇒ Integer

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

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

The number of files, objects, and directories that DataSync verifies 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_mode ⇒ String

The task mode that you’re using.
#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 number of physical bytes that DataSync transfers over the network after compression (if compression is possible). This number is typically less than [BytesTransferred] unless the data isn’t compressible.

[1]: docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-BytesTransferred

Returns:

(Integer)

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

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,
  :task_mode,
  :files_prepared,
  :files_listed,
  :files_failed)
  SENSITIVE = []
  include Aws::Structure
end

#bytes_transferred ⇒ `Integer`

The number of bytes that DataSync sends to the network before compression (if compression is possible). For the number of bytes transferred over the network, see [BytesCompressed].

[1]: docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-BytesCompressed

Returns:

(Integer)

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

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,
  :task_mode,
  :files_prepared,
  :files_listed,
  :files_failed)
  SENSITIVE = []
  include Aws::Structure
end

#bytes_written ⇒ `Integer`

The number of logical bytes that DataSync actually writes to the destination location.

Returns:

(Integer)

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

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,
  :task_mode,
  :files_prepared,
  :files_listed,
  :files_failed)
  SENSITIVE = []
  include Aws::Structure
end

#estimated_bytes_to_transfer ⇒ `Integer`

The number of logical bytes that DataSync expects to write to the destination location.

Returns:

(Integer)

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

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,
  :task_mode,
  :files_prepared,
  :files_listed,
  :files_failed)
  SENSITIVE = []
  include Aws::Structure
end

#estimated_files_to_delete ⇒ `Integer`

The number of files, objects, and directories that DataSync expects to 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 2907

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,
  :task_mode,
  :files_prepared,
  :files_listed,
  :files_failed)
  SENSITIVE = []
  include Aws::Structure
end

#estimated_files_to_transfer ⇒ `Integer`

The number of files, objects, and directories that DataSync expects to transfer over the network. This value is calculated while DataSync [prepares] the transfer.

How this gets calculated depends primarily on your task’s [transfer mode] configuration:

If ‘TranserMode` is set to `CHANGED` - The calculation is based on comparing the content of the source and destination locations and determining the difference that needs to be transferred. The difference can include:
- Anything that’s added or modified at the source location.
- Anything that’s in both locations and modified at the destination after an initial transfer (unless [OverwriteMode] is set to ‘NEVER`).
- **(Basic task mode only)** The number of items that DataSync expects to delete (if [PreserveDeletedFiles] is set to ‘REMOVE`).
If ‘TranserMode` is set to `ALL` - The calculation is based only on the items that DataSync finds at the source location.

[1]: docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses [2]: docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-TransferMode [3]: docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-OverwriteMode [4]: docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-PreserveDeletedFiles

Returns:

(Integer)

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

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,
  :task_mode,
  :files_prepared,
  :files_listed,
  :files_failed)
  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 2907

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,
  :task_mode,
  :files_prepared,
  :files_listed,
  :files_failed)
  SENSITIVE = []
  include Aws::Structure
end

#files_deleted ⇒ `Integer`

The number of files, objects, and directories that DataSync actually deletes 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 2907

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,
  :task_mode,
  :files_prepared,
  :files_listed,
  :files_failed)
  SENSITIVE = []
  include Aws::Structure
end

#files_failed ⇒ `Types::TaskExecutionFilesFailedDetail`

The number of objects that DataSync fails to prepare, transfer, verify, and delete during your task execution.

<note markdown=“1”> Applies only to [Enhanced mode tasks].

</note>

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

Returns:

(Types::TaskExecutionFilesFailedDetail)

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

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,
  :task_mode,
  :files_prepared,
  :files_listed,
  :files_failed)
  SENSITIVE = []
  include Aws::Structure
end

#files_listed ⇒ `Types::TaskExecutionFilesListedDetail`

The number of objects that DataSync finds at your locations.

<note markdown=“1”> Applies only to [Enhanced mode tasks].

</note>

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

Returns:

(Types::TaskExecutionFilesListedDetail)

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

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,
  :task_mode,
  :files_prepared,
  :files_listed,
  :files_failed)
  SENSITIVE = []
  include Aws::Structure
end

#files_prepared ⇒ `Integer`

The number of objects that DataSync will attempt to transfer after comparing your source and destination locations.

<note markdown=“1”> Applies only to [Enhanced mode tasks].

</note>

This counter isn’t applicable if you configure your task to [transfer all data]. In that scenario, DataSync copies everything from the source to the destination without comparing differences between the locations.

[1]: docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html [2]: docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html#task-option-transfer-mode

Returns:

(Integer)

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

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,
  :task_mode,
  :files_prepared,
  :files_listed,
  :files_failed)
  SENSITIVE = []
  include Aws::Structure
end

#files_skipped ⇒ `Integer`

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

Returns:

(Integer)

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

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,
  :task_mode,
  :files_prepared,
  :files_listed,
  :files_failed)
  SENSITIVE = []
  include Aws::Structure
end

#files_transferred ⇒ `Integer`

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

Returns:

(Integer)

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

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,
  :task_mode,
  :files_prepared,
  :files_listed,
  :files_failed)
  SENSITIVE = []
  include Aws::Structure
end

#files_verified ⇒ `Integer`

The number of files, objects, and directories that DataSync verifies 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 2907

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,
  :task_mode,
  :files_prepared,
  :files_listed,
  :files_failed)
  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 2907

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,
  :task_mode,
  :files_prepared,
  :files_listed,
  :files_failed)
  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 2907

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,
  :task_mode,
  :files_prepared,
  :files_listed,
  :files_failed)
  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 2907

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,
  :task_mode,
  :files_prepared,
  :files_listed,
  :files_failed)
  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 2907

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,
  :task_mode,
  :files_prepared,
  :files_listed,
  :files_failed)
  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 2907

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,
  :task_mode,
  :files_prepared,
  :files_listed,
  :files_failed)
  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 2907

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,
  :task_mode,
  :files_prepared,
  :files_listed,
  :files_failed)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

The status of the task execution.

Returns:

(String)

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

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,
  :task_mode,
  :files_prepared,
  :files_listed,
  :files_failed)
  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 2907

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,
  :task_mode,
  :files_prepared,
  :files_listed,
  :files_failed)
  SENSITIVE = []
  include Aws::Structure
end

#task_mode ⇒ `String`

The task mode that you’re using. For more information, see [Choosing a task mode for your data transfer].

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

Returns:

(String)

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

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,
  :task_mode,
  :files_prepared,
  :files_listed,
  :files_failed)
  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 2907

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,
  :task_mode,
  :files_prepared,
  :files_listed,
  :files_failed)
  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_failed ⇒ Types::TaskExecutionFilesFailedDetail

#files_listed ⇒ Types::TaskExecutionFilesListedDetail

#files_prepared ⇒ 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_mode ⇒ 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_failed ⇒ `Types::TaskExecutionFilesFailedDetail`

#files_listed ⇒ `Types::TaskExecutionFilesListedDetail`

#files_prepared ⇒ `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_mode ⇒ `String`

#task_report_config ⇒ `Types::TaskReportConfig`