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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-datasync/types.rb

Overview

DescribeTaskExecutionResponse

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bytes_compressedInteger

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)


2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
# 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_transferredInteger

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

Returns:

  • (Integer)


2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
# 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_writtenInteger

The number of logical bytes written to the destination location.

Returns:

  • (Integer)


2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
# 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_transferInteger

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

Returns:

  • (Integer)


2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
# 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_deleteInteger

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)


2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
# 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_transferInteger

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)


2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
# 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

#excludesArray<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:



2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
# 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_deletedInteger

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)


2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
# 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_skippedInteger

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

Returns:

  • (Integer)


2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
# 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_transferredInteger

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)


2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
# 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_verifiedInteger

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)


2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
# 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

#includesArray<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:



2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
# 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_configTypes::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



2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
# 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

#optionsTypes::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:



2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
# 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_resultTypes::ReportResult

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

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

Returns:



2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
# 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

#resultTypes::TaskExecutionResultDetail

The result of the task execution.



2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
# 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_timeTime

The time when the task execution started.

Returns:

  • (Time)


2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
# 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

#statusString

The status of the task execution.

Returns:

  • (String)


2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
# 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_arnString

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)


2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
# 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_configTypes::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



2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
# 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