DescribeTaskCommand

Suggest an Edit

Provides information about a task, which defines where and how DataSync transfers your data.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataSyncClient, DescribeTaskCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, DescribeTaskCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // DescribeTaskRequest
  TaskArn: "STRING_VALUE", // required
};
const command = new DescribeTaskCommand(input);
const response = await client.send(command);
// { // DescribeTaskResponse
//   TaskArn: "STRING_VALUE",
//   Status: "AVAILABLE" || "CREATING" || "QUEUED" || "RUNNING" || "UNAVAILABLE",
//   Name: "STRING_VALUE",
//   CurrentTaskExecutionArn: "STRING_VALUE",
//   SourceLocationArn: "STRING_VALUE",
//   DestinationLocationArn: "STRING_VALUE",
//   CloudWatchLogGroupArn: "STRING_VALUE",
//   SourceNetworkInterfaceArns: [ // SourceNetworkInterfaceArns
//     "STRING_VALUE",
//   ],
//   DestinationNetworkInterfaceArns: [ // DestinationNetworkInterfaceArns
//     "STRING_VALUE",
//   ],
//   Options: { // Options
//     VerifyMode: "POINT_IN_TIME_CONSISTENT" || "ONLY_FILES_TRANSFERRED" || "NONE",
//     OverwriteMode: "ALWAYS" || "NEVER",
//     Atime: "NONE" || "BEST_EFFORT",
//     Mtime: "NONE" || "PRESERVE",
//     Uid: "NONE" || "INT_VALUE" || "NAME" || "BOTH",
//     Gid: "NONE" || "INT_VALUE" || "NAME" || "BOTH",
//     PreserveDeletedFiles: "PRESERVE" || "REMOVE",
//     PreserveDevices: "NONE" || "PRESERVE",
//     PosixPermissions: "NONE" || "PRESERVE",
//     BytesPerSecond: Number("long"),
//     TaskQueueing: "ENABLED" || "DISABLED",
//     LogLevel: "OFF" || "BASIC" || "TRANSFER",
//     TransferMode: "CHANGED" || "ALL",
//     SecurityDescriptorCopyFlags: "NONE" || "OWNER_DACL" || "OWNER_DACL_SACL",
//     ObjectTags: "PRESERVE" || "NONE",
//   },
//   Excludes: [ // FilterList
//     { // FilterRule
//       FilterType: "SIMPLE_PATTERN",
//       Value: "STRING_VALUE",
//     },
//   ],
//   Schedule: { // TaskSchedule
//     ScheduleExpression: "STRING_VALUE", // required
//     Status: "ENABLED" || "DISABLED",
//   },
//   ErrorCode: "STRING_VALUE",
//   ErrorDetail: "STRING_VALUE",
//   CreationTime: new Date("TIMESTAMP"),
//   Includes: [
//     {
//       FilterType: "SIMPLE_PATTERN",
//       Value: "STRING_VALUE",
//     },
//   ],
//   ManifestConfig: { // ManifestConfig
//     Action: "TRANSFER",
//     Format: "CSV",
//     Source: { // SourceManifestConfig
//       S3: { // S3ManifestConfig
//         ManifestObjectPath: "STRING_VALUE", // required
//         BucketAccessRoleArn: "STRING_VALUE", // required
//         S3BucketArn: "STRING_VALUE", // required
//         ManifestObjectVersionId: "STRING_VALUE",
//       },
//     },
//   },
//   TaskReportConfig: { // TaskReportConfig
//     Destination: { // ReportDestination
//       S3: { // ReportDestinationS3
//         Subdirectory: "STRING_VALUE",
//         S3BucketArn: "STRING_VALUE", // required
//         BucketAccessRoleArn: "STRING_VALUE", // required
//       },
//     },
//     OutputType: "SUMMARY_ONLY" || "STANDARD",
//     ReportLevel: "ERRORS_ONLY" || "SUCCESSES_AND_ERRORS",
//     ObjectVersionIds: "INCLUDE" || "NONE",
//     Overrides: { // ReportOverrides
//       Transferred: { // ReportOverride
//         ReportLevel: "ERRORS_ONLY" || "SUCCESSES_AND_ERRORS",
//       },
//       Verified: {
//         ReportLevel: "ERRORS_ONLY" || "SUCCESSES_AND_ERRORS",
//       },
//       Deleted: {
//         ReportLevel: "ERRORS_ONLY" || "SUCCESSES_AND_ERRORS",
//       },
//       Skipped: {
//         ReportLevel: "ERRORS_ONLY" || "SUCCESSES_AND_ERRORS",
//       },
//     },
//   },
//   ScheduleDetails: { // TaskScheduleDetails
//     StatusUpdateTime: new Date("TIMESTAMP"),
//     DisabledReason: "STRING_VALUE",
//     DisabledBy: "USER" || "SERVICE",
//   },
//   TaskMode: "BASIC" || "ENHANCED",
// };

DescribeTaskCommand Input

See DescribeTaskCommandInput for more details

Parameter
Type
Description
TaskArn
Required
string | undefined

Specifies the Amazon Resource Name (ARN) of the transfer task that you want information about.

DescribeTaskCommand Output

See DescribeTaskCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
CloudWatchLogGroupArn
string | undefined

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 .

CreationTime
Date | undefined

The time that the task was created.

CurrentTaskExecutionArn
string | undefined

The ARN of the most recent task execution.

DestinationLocationArn
string | undefined

The ARN of your transfer's destination location.

DestinationNetworkInterfaceArns
string[] | undefined

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

ErrorCode
string | undefined

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 .

ErrorDetail
string | undefined

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 .

Excludes
FilterRule[] | undefined

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 .

Includes
FilterRule[] | undefined

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 .

ManifestConfig
ManifestConfig | undefined

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 .

Name
string | undefined

The name of your task.

Options
Options | undefined

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.

Schedule
TaskSchedule | undefined

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

ScheduleDetails
TaskScheduleDetails | undefined

The details about your task schedule .

SourceLocationArn
string | undefined

The ARN of your transfer's source location.

SourceNetworkInterfaceArns
string[] | undefined

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

Status
TaskStatus | undefined

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

TaskArn
string | undefined

The ARN of your task.

TaskMode
TaskMode | undefined

The task mode that you're using. For more information, see Choosing a task mode for your data transfer .

TaskReportConfig
TaskReportConfig | undefined

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 .

Throws

Name
Fault
Details
InternalException
server

This exception is thrown when an error occurs in the DataSync service.

InvalidRequestException
client

This exception is thrown when the client submits a malformed request.

DataSyncServiceException
Base exception class for all service exceptions from DataSync service.