Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DescribeTaskCommandOutput

Hierarchy

Index

Properties

$metadata

$metadata: ResponseMetadata

Metadata pertaining to this request.

Optional CloudWatchLogGroupArn

CloudWatchLogGroupArn: undefined | 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.

Optional CreationTime

CreationTime: Date

The time that the task was created.

Optional CurrentTaskExecutionArn

CurrentTaskExecutionArn: undefined | string

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

Optional DestinationLocationArn

DestinationLocationArn: undefined | string

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

Optional DestinationNetworkInterfaceArns

DestinationNetworkInterfaceArns: string[]

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

Optional ErrorCode

ErrorCode: undefined | string

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

Optional ErrorDetail

ErrorDetail: undefined | string

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

Optional Excludes

Excludes: FilterRule[]

A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

Optional Includes

Includes: FilterRule[]

A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

Optional Name

Name: undefined | string

The name of the task that was described.

Optional Options

Options: 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.

Optional Schedule

Schedule: TaskSchedule

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

Optional SourceLocationArn

SourceLocationArn: undefined | string

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

Optional SourceNetworkInterfaceArns

SourceNetworkInterfaceArns: string[]

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

Optional Status

Status: TaskStatus | 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.

Optional TaskArn

TaskArn: undefined | string

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