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

Inherits:

Struct

• Object
• Struct
• Aws::DataSync::Types::DescribeTaskResponse

Defined in:

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

Overview

DescribeTaskResponse

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cloud_watch_log_group_arn ⇒ String

  The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

• #creation_time ⇒ Time

  The time that the task was created.

• #current_task_execution_arn ⇒ String

  The ARN of the most recent task execution.

• #destination_location_arn ⇒ String

  The ARN of your transfer's destination location.

• #destination_network_interface_arns ⇒ Array<String>

  The ARNs of the [network interfaces][1] that DataSync created for your destination location.

• #error_code ⇒ String

  If there's an issue with your task, you can use the error code to help you troubleshoot the problem.

• #error_detail ⇒ String

  If there's an issue with your task, you can use the error details to help you troubleshoot the problem.

• #excludes ⇒ Array<Types::FilterRule>

  The exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer.

• #includes ⇒ Array<Types::FilterRule>

  The include filters that define the files, objects, and folders in your source location that you want DataSync to transfer.

• #manifest_config ⇒ Types::ManifestConfig

  The configuration of the manifest that lists the files or objects that you want DataSync to transfer.

• #name ⇒ String

  The name of your task.

• #options ⇒ Types::Options

  The task's settings.

• #schedule ⇒ Types::TaskSchedule

  The schedule for when you want your task to run.

• #schedule_details ⇒ Types::TaskScheduleDetails

  The details about your [task schedule][1].

• #source_location_arn ⇒ String

  The ARN of your transfer's source location.

• #source_network_interface_arns ⇒ Array<String>

  The ARNs of the [network interfaces][1] that DataSync created for your source location.

• #status ⇒ String

  The status of your task.

• #task_arn ⇒ String

  The ARN of your task.

• #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 your DataSync transfer.

Instance Attribute Details

#cloud_watch_log_group_arn ⇒ String

The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

For more information, see Monitoring data transfers with CloudWatch Logs.

Returns:

• (String)

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

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,
  :manifest_config,
  :task_report_config,
  :schedule_details,
  :task_mode)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

The time that the task was created.

Returns:

• (Time)

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

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,
  :manifest_config,
  :task_report_config,
  :schedule_details,
  :task_mode)
  SENSITIVE = []
  include Aws::Structure
end

#current_task_execution_arn ⇒ String

The ARN of the most recent task execution.

Returns:

• (String)

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

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,
  :manifest_config,
  :task_report_config,
  :schedule_details,
  :task_mode)
  SENSITIVE = []
  include Aws::Structure
end

#destination_location_arn ⇒ String

The ARN of your transfer's destination location.

Returns:

• (String)

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

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,
  :manifest_config,
  :task_report_config,
  :schedule_details,
  :task_mode)
  SENSITIVE = []
  include Aws::Structure
end

#destination_network_interface_arns ⇒ Array<String>

The ARNs of the network interfaces that DataSync created for your destination location.

Returns:

• (Array<String>)

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

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,
  :manifest_config,
  :task_report_config,
  :schedule_details,
  :task_mode)
  SENSITIVE = []
  include Aws::Structure
end

#error_code ⇒ String

If there's an issue with your task, you can use the error code to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.

Returns:

• (String)

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

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,
  :manifest_config,
  :task_report_config,
  :schedule_details,
  :task_mode)
  SENSITIVE = []
  include Aws::Structure
end

#error_detail ⇒ String

If there's an issue with your task, you can use the error details to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.

Returns:

• (String)

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

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,
  :manifest_config,
  :task_report_config,
  :schedule_details,
  :task_mode)
  SENSITIVE = []
  include Aws::Structure
end

#excludes ⇒ Array<Types::FilterRule>

The exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

Returns:

• (Array<Types::FilterRule>)

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

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,
  :manifest_config,
  :task_report_config,
  :schedule_details,
  :task_mode)
  SENSITIVE = []
  include Aws::Structure
end

#includes ⇒ Array<Types::FilterRule>

The include filters that define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

Returns:

• (Array<Types::FilterRule>)

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

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,
  :manifest_config,
  :task_report_config,
  :schedule_details,
  :task_mode)
  SENSITIVE = []
  include Aws::Structure
end

#manifest_config ⇒ Types::ManifestConfig

The configuration of the manifest that lists the files or objects that you want DataSync to transfer. For more information, see Specifying what DataSync transfers by using a manifest.

Returns:

• (Types::ManifestConfig)

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

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,
  :manifest_config,
  :task_report_config,
  :schedule_details,
  :task_mode)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of your task.

Returns:

• (String)

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

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,
  :manifest_config,
  :task_report_config,
  :schedule_details,
  :task_mode)
  SENSITIVE = []
  include Aws::Structure
end

#options ⇒ Types::Options

The task's settings. For example, what file metadata gets preserved, how data integrity gets verified at the end of your transfer, bandwidth limits, among other options.

Returns:

• (Types::Options)

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

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,
  :manifest_config,
  :task_report_config,
  :schedule_details,
  :task_mode)
  SENSITIVE = []
  include Aws::Structure
end

#schedule ⇒ Types::TaskSchedule

The schedule for when you want your task to run. For more information, see Scheduling your task.

Returns:

• (Types::TaskSchedule)

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

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,
  :manifest_config,
  :task_report_config,
  :schedule_details,
  :task_mode)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_details ⇒ Types::TaskScheduleDetails

The details about your task schedule.

Returns:

• (Types::TaskScheduleDetails)

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

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,
  :manifest_config,
  :task_report_config,
  :schedule_details,
  :task_mode)
  SENSITIVE = []
  include Aws::Structure
end

#source_location_arn ⇒ String

The ARN of your transfer's source location.

Returns:

• (String)

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

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,
  :manifest_config,
  :task_report_config,
  :schedule_details,
  :task_mode)
  SENSITIVE = []
  include Aws::Structure
end

#source_network_interface_arns ⇒ Array<String>

The ARNs of the network interfaces that DataSync created for your source location.

Returns:

• (Array<String>)

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

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,
  :manifest_config,
  :task_report_config,
  :schedule_details,
  :task_mode)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of your task. For information about what each status means, see Task statuses.

Returns:

• (String)

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

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,
  :manifest_config,
  :task_report_config,
  :schedule_details,
  :task_mode)
  SENSITIVE = []
  include Aws::Structure
end

#task_arn ⇒ String

The ARN of your task.

Returns:

• (String)

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

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,
  :manifest_config,
  :task_report_config,
  :schedule_details,
  :task_mode)
  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.

Returns:

• (String)

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

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,
  :manifest_config,
  :task_report_config,
  :schedule_details,
  :task_mode)
  SENSITIVE = []
  include Aws::Structure
end

#task_report_config ⇒ Types::TaskReportConfig

The configuration of your task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.

Returns:

• (Types::TaskReportConfig)

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

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,
  :manifest_config,
  :task_report_config,
  :schedule_details,
  :task_mode)
  SENSITIVE = []
  include Aws::Structure
end