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

Inherits:

Struct

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

Includes:

Structure

Defined in:

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 the Amazon CloudWatch log group that was used to monitor and log events in the task.

• #creation_time ⇒ Time

  The time that the task was created.

• #current_task_execution_arn ⇒ String

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

• #destination_location_arn ⇒ String

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

• #destination_network_interface_arns ⇒ Array<String>

  The Amazon Resource Names (ARNs) of the network interfaces created for your destination location.

• #error_code ⇒ String

  Errors that DataSync encountered during execution of the task.

• #error_detail ⇒ String

  Detailed description of an error that was encountered during the task execution.

• #excludes ⇒ Array<Types::FilterRule>

  A list of filter rules that exclude specific data during your transfer.

• #includes ⇒ Array<Types::FilterRule>

  A list of filter rules that include specific data during your transfer.

• #name ⇒ String

  The name of the task that was described.

• #options ⇒ Types::Options

  The configuration options that control the behavior of the ‘StartTaskExecution` operation.

• #schedule ⇒ Types::TaskSchedule

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

• #source_location_arn ⇒ String

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

• #source_network_interface_arns ⇒ Array<String>

  The Amazon Resource Names (ARNs) of the network interfaces created for your source location.

• #status ⇒ String

  The status of the task that was described.

• #task_arn ⇒ String

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

• #task_report_config ⇒ Types::TaskReportConfig

  The configuration of your task report.

Instance Attribute Details

#cloud_watch_log_group_arn ⇒ String

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)

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

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_time ⇒ Time

The time that the task was created.

Returns:

• (Time)

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

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_arn ⇒ String

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

Returns:

• (String)

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

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_arn ⇒ String

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

Returns:

• (String)

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

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_arns ⇒ Array<String>

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

[1]: docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces

Returns:

• (Array<String>)

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

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_code ⇒ String

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

Returns:

• (String)

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

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_detail ⇒ String

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

Returns:

• (String)

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

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

#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 2776

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

#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 2776

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

#name ⇒ String

The name of the task that was described.

Returns:

• (String)

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

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

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

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

Returns:

• (Types::Options)

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

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

#schedule ⇒ Types::TaskSchedule

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

Returns:

• (Types::TaskSchedule)

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

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_arn ⇒ String

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

Returns:

• (String)

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

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_arns ⇒ Array<String>

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

[1]: docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces

Returns:

• (Array<String>)

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

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

#status ⇒ String

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)

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

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_arn ⇒ String

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

Returns:

• (String)

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

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_config ⇒ Types::TaskReportConfig

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

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

Returns:

• (Types::TaskReportConfig)

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

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