You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

DescribeTaskResponse

Returned by:

See Also:

Instance Attribute Summary collapse

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

    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.

Returns:

  • (Time) —

    The time that the task was created.

#current_task_execution_arn ⇒ String

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

Returns:

  • (String) —

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

#destination_location_arn ⇒ String

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

Returns:

  • (String) —

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

#destination_network_interface_arns ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#error_code ⇒ String

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

Returns:

  • (String) —

    Errors that AWS DataSync encountered during execution of the task.

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

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

#excludes ⇒ Array<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:

  • (Array<Types::FilterRule>) —

    A list of filter rules that determines which files to exclude from a task.

#name ⇒ String

The name of the task that was described.

Returns:

  • (String) —

    The name of the task that was described.

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

  • (Types::Options) —

    The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution.

#schedule ⇒ Types::TaskSchedule

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

Returns:

  • (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.

Returns:

  • (String) —

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

#source_network_interface_arns ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#status ⇒ String

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.

Possible values:

  • AVAILABLE
  • CREATING
  • QUEUED
  • RUNNING
  • UNAVAILABLE

Returns:

  • (String) —

    The status of the task that was described.

#task_arn ⇒ String

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

Returns:

  • (String) —

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