Class: Aws::DataSync::Types::DescribeTaskResponse

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

Overview

DescribeTaskResponse

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_log_group_arnString

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to monitor and log events in the task.

For more information on these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch User Guide.

Returns:

  • (String)


2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2845

class DescribeTaskResponse < Struct.new(
  :task_arn,
  :status,
  :name,
  :current_task_execution_arn,
  :source_location_arn,
  :destination_location_arn,
  :cloud_watch_log_group_arn,
  :source_network_interface_arns,
  :destination_network_interface_arns,
  :options,
  :excludes,
  :schedule,
  :error_code,
  :error_detail,
  :creation_time,
  :includes,
  :task_report_config)
  SENSITIVE = []
  include Aws::Structure
end

#creation_timeTime

The time that the task was created.

Returns:

  • (Time)


2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2845

class DescribeTaskResponse < Struct.new(
  :task_arn,
  :status,
  :name,
  :current_task_execution_arn,
  :source_location_arn,
  :destination_location_arn,
  :cloud_watch_log_group_arn,
  :source_network_interface_arns,
  :destination_network_interface_arns,
  :options,
  :excludes,
  :schedule,
  :error_code,
  :error_detail,
  :creation_time,
  :includes,
  :task_report_config)
  SENSITIVE = []
  include Aws::Structure
end

#current_task_execution_arnString

The Amazon Resource Name (ARN) of the task execution that is transferring files.

Returns:

  • (String)


2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2845

class DescribeTaskResponse < Struct.new(
  :task_arn,
  :status,
  :name,
  :current_task_execution_arn,
  :source_location_arn,
  :destination_location_arn,
  :cloud_watch_log_group_arn,
  :source_network_interface_arns,
  :destination_network_interface_arns,
  :options,
  :excludes,
  :schedule,
  :error_code,
  :error_detail,
  :creation_time,
  :includes,
  :task_report_config)
  SENSITIVE = []
  include Aws::Structure
end

#destination_location_arnString

The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location.

Returns:

  • (String)


2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2845

class DescribeTaskResponse < Struct.new(
  :task_arn,
  :status,
  :name,
  :current_task_execution_arn,
  :source_location_arn,
  :destination_location_arn,
  :cloud_watch_log_group_arn,
  :source_network_interface_arns,
  :destination_network_interface_arns,
  :options,
  :excludes,
  :schedule,
  :error_code,
  :error_detail,
  :creation_time,
  :includes,
  :task_report_config)
  SENSITIVE = []
  include Aws::Structure
end

#destination_network_interface_arnsArray<String>

The Amazon Resource Names (ARNs) of the network interfaces created for your destination location. For more information, see Network interface requirements.

Returns:

  • (Array<String>)


2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2845

class DescribeTaskResponse < Struct.new(
  :task_arn,
  :status,
  :name,
  :current_task_execution_arn,
  :source_location_arn,
  :destination_location_arn,
  :cloud_watch_log_group_arn,
  :source_network_interface_arns,
  :destination_network_interface_arns,
  :options,
  :excludes,
  :schedule,
  :error_code,
  :error_detail,
  :creation_time,
  :includes,
  :task_report_config)
  SENSITIVE = []
  include Aws::Structure
end

#error_codeString

Errors that DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.

Returns:

  • (String)


2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2845

class DescribeTaskResponse < Struct.new(
  :task_arn,
  :status,
  :name,
  :current_task_execution_arn,
  :source_location_arn,
  :destination_location_arn,
  :cloud_watch_log_group_arn,
  :source_network_interface_arns,
  :destination_network_interface_arns,
  :options,
  :excludes,
  :schedule,
  :error_code,
  :error_detail,
  :creation_time,
  :includes,
  :task_report_config)
  SENSITIVE = []
  include Aws::Structure
end

#error_detailString

Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.

Returns:

  • (String)


2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2845

class DescribeTaskResponse < Struct.new(
  :task_arn,
  :status,
  :name,
  :current_task_execution_arn,
  :source_location_arn,
  :destination_location_arn,
  :cloud_watch_log_group_arn,
  :source_network_interface_arns,
  :destination_network_interface_arns,
  :options,
  :excludes,
  :schedule,
  :error_code,
  :error_detail,
  :creation_time,
  :includes,
  :task_report_config)
  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.

Returns:



2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2845

class DescribeTaskResponse < Struct.new(
  :task_arn,
  :status,
  :name,
  :current_task_execution_arn,
  :source_location_arn,
  :destination_location_arn,
  :cloud_watch_log_group_arn,
  :source_network_interface_arns,
  :destination_network_interface_arns,
  :options,
  :excludes,
  :schedule,
  :error_code,
  :error_detail,
  :creation_time,
  :includes,
  :task_report_config)
  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.

Returns:



2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2845

class DescribeTaskResponse < Struct.new(
  :task_arn,
  :status,
  :name,
  :current_task_execution_arn,
  :source_location_arn,
  :destination_location_arn,
  :cloud_watch_log_group_arn,
  :source_network_interface_arns,
  :destination_network_interface_arns,
  :options,
  :excludes,
  :schedule,
  :error_code,
  :error_detail,
  :creation_time,
  :includes,
  :task_report_config)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the task that was described.

Returns:

  • (String)


2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2845

class DescribeTaskResponse < Struct.new(
  :task_arn,
  :status,
  :name,
  :current_task_execution_arn,
  :source_location_arn,
  :destination_location_arn,
  :cloud_watch_log_group_arn,
  :source_network_interface_arns,
  :destination_network_interface_arns,
  :options,
  :excludes,
  :schedule,
  :error_code,
  :error_detail,
  :creation_time,
  :includes,
  :task_report_config)
  SENSITIVE = []
  include Aws::Structure
end

#optionsTypes::Options

The configuration options that control the behavior of the StartTaskExecution operation. Some options include preserving file or object metadata and verifying data integrity.

You can override these options for each task execution. For more information, see StartTaskExecution.

Returns:



2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2845

class DescribeTaskResponse < Struct.new(
  :task_arn,
  :status,
  :name,
  :current_task_execution_arn,
  :source_location_arn,
  :destination_location_arn,
  :cloud_watch_log_group_arn,
  :source_network_interface_arns,
  :destination_network_interface_arns,
  :options,
  :excludes,
  :schedule,
  :error_code,
  :error_detail,
  :creation_time,
  :includes,
  :task_report_config)
  SENSITIVE = []
  include Aws::Structure
end

#scheduleTypes::TaskSchedule

The schedule used to periodically transfer files from a source to a destination location.

Returns:



2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2845

class DescribeTaskResponse < Struct.new(
  :task_arn,
  :status,
  :name,
  :current_task_execution_arn,
  :source_location_arn,
  :destination_location_arn,
  :cloud_watch_log_group_arn,
  :source_network_interface_arns,
  :destination_network_interface_arns,
  :options,
  :excludes,
  :schedule,
  :error_code,
  :error_detail,
  :creation_time,
  :includes,
  :task_report_config)
  SENSITIVE = []
  include Aws::Structure
end

#source_location_arnString

The Amazon Resource Name (ARN) of the source file system's location.

Returns:

  • (String)


2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2845

class DescribeTaskResponse < Struct.new(
  :task_arn,
  :status,
  :name,
  :current_task_execution_arn,
  :source_location_arn,
  :destination_location_arn,
  :cloud_watch_log_group_arn,
  :source_network_interface_arns,
  :destination_network_interface_arns,
  :options,
  :excludes,
  :schedule,
  :error_code,
  :error_detail,
  :creation_time,
  :includes,
  :task_report_config)
  SENSITIVE = []
  include Aws::Structure
end

#source_network_interface_arnsArray<String>

The Amazon Resource Names (ARNs) of the network interfaces created for your source location. For more information, see Network interface requirements.

Returns:

  • (Array<String>)


2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2845

class DescribeTaskResponse < Struct.new(
  :task_arn,
  :status,
  :name,
  :current_task_execution_arn,
  :source_location_arn,
  :destination_location_arn,
  :cloud_watch_log_group_arn,
  :source_network_interface_arns,
  :destination_network_interface_arns,
  :options,
  :excludes,
  :schedule,
  :error_code,
  :error_detail,
  :creation_time,
  :includes,
  :task_report_config)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of the task that was described.

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

Returns:

  • (String)


2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2845

class DescribeTaskResponse < Struct.new(
  :task_arn,
  :status,
  :name,
  :current_task_execution_arn,
  :source_location_arn,
  :destination_location_arn,
  :cloud_watch_log_group_arn,
  :source_network_interface_arns,
  :destination_network_interface_arns,
  :options,
  :excludes,
  :schedule,
  :error_code,
  :error_detail,
  :creation_time,
  :includes,
  :task_report_config)
  SENSITIVE = []
  include Aws::Structure
end

#task_arnString

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

Returns:

  • (String)


2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2845

class DescribeTaskResponse < Struct.new(
  :task_arn,
  :status,
  :name,
  :current_task_execution_arn,
  :source_location_arn,
  :destination_location_arn,
  :cloud_watch_log_group_arn,
  :source_network_interface_arns,
  :destination_network_interface_arns,
  :options,
  :excludes,
  :schedule,
  :error_code,
  :error_detail,
  :creation_time,
  :includes,
  :task_report_config)
  SENSITIVE = []
  include Aws::Structure
end

#task_report_configTypes::TaskReportConfig

The configuration of your task report. For more information, see Creating a task report.



2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2845

class DescribeTaskResponse < Struct.new(
  :task_arn,
  :status,
  :name,
  :current_task_execution_arn,
  :source_location_arn,
  :destination_location_arn,
  :cloud_watch_log_group_arn,
  :source_network_interface_arns,
  :destination_network_interface_arns,
  :options,
  :excludes,
  :schedule,
  :error_code,
  :error_detail,
  :creation_time,
  :includes,
  :task_report_config)
  SENSITIVE = []
  include Aws::Structure
end