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)


1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1710

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)
  SENSITIVE = []
  include Aws::Structure
end

#creation_timeTime

The time that the task was created.

Returns:

  • (Time)


1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1710

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)
  SENSITIVE = []
  include Aws::Structure
end

#current_task_execution_arnString

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

Returns:

  • (String)


1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1710

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)
  SENSITIVE = []
  include Aws::Structure
end

#destination_location_arnString

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

Returns:

  • (String)


1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1710

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)
  SENSITIVE = []
  include Aws::Structure
end

#destination_network_interface_arnsArray<String>

The Amazon Resource Name (ARN) of the destination ENIs (Elastic Network Interface) that was created for your subnet.

Returns:

  • (Array<String>)


1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1710

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)
  SENSITIVE = []
  include Aws::Structure
end

#error_codeString

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

Returns:

  • (String)


1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1710

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)
  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)


1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1710

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)
  SENSITIVE = []
  include Aws::Structure
end

#excludesArray<Types::FilterRule>

A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example: "/folder1|/folder2"

Returns:



1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1710

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)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the task that was described.

Returns:

  • (String)


1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1710

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)
  SENSITIVE = []
  include Aws::Structure
end

#optionsTypes::Options

The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group (GID), file permissions, data integrity verification, and so on.

For each individual task execution, you can override these options by specifying the overriding OverrideOptions value to operation.

Returns:



1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1710

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)
  SENSITIVE = []
  include Aws::Structure
end

#scheduleTypes::TaskSchedule

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

Returns:



1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1710

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)
  SENSITIVE = []
  include Aws::Structure
end

#source_location_arnString

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

Returns:

  • (String)


1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1710

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)
  SENSITIVE = []
  include Aws::Structure
end

#source_network_interface_arnsArray<String>

The Amazon Resource Name (ARN) of the source ENIs (Elastic Network Interface) that was created for your subnet.

Returns:

  • (Array<String>)


1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1710

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)
  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 AWS DataSync User Guide.

Returns:

  • (String)


1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1710

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)
  SENSITIVE = []
  include Aws::Structure
end

#task_arnString

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

Returns:

  • (String)


1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1710

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)
  SENSITIVE = []
  include Aws::Structure
end