Class DescribeTaskExecutionCommandProtected

Provides information about an execution of your DataSync task. You can use this operation to help monitor the progress of an ongoing transfer or check the results of the transfer.

Example

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

import { DataSyncClient, DescribeTaskExecutionCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, DescribeTaskExecutionCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // DescribeTaskExecutionRequest
  TaskExecutionArn: "STRING_VALUE", // required
};
const command = new DescribeTaskExecutionCommand(input);
const response = await client.send(command);
// { // DescribeTaskExecutionResponse
//   TaskExecutionArn: "STRING_VALUE",
//   Status: "QUEUED" || "LAUNCHING" || "PREPARING" || "TRANSFERRING" || "VERIFYING" || "SUCCESS" || "ERROR",
//   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",
//     },
//   ],
//   Includes: [
//     {
//       FilterType: "SIMPLE_PATTERN",
//       Value: "STRING_VALUE",
//     },
//   ],
//   StartTime: new Date("TIMESTAMP"),
//   EstimatedFilesToTransfer: Number("long"),
//   EstimatedBytesToTransfer: Number("long"),
//   FilesTransferred: Number("long"),
//   BytesWritten: Number("long"),
//   BytesTransferred: Number("long"),
//   Result: { // TaskExecutionResultDetail
//     PrepareDuration: Number("long"),
//     PrepareStatus: "PENDING" || "SUCCESS" || "ERROR",
//     TotalDuration: Number("long"),
//     TransferDuration: Number("long"),
//     TransferStatus: "PENDING" || "SUCCESS" || "ERROR",
//     VerifyDuration: Number("long"),
//     VerifyStatus: "PENDING" || "SUCCESS" || "ERROR",
//     ErrorCode: "STRING_VALUE",
//     ErrorDetail: "STRING_VALUE",
//   },
//   BytesCompressed: Number("long"),
//   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",
//       },
//     },
//   },
//   FilesDeleted: Number("long"),
//   FilesSkipped: Number("long"),
//   FilesVerified: Number("long"),
//   ReportResult: { // ReportResult
//     Status: "PENDING" || "SUCCESS" || "ERROR",
//     ErrorCode: "STRING_VALUE",
//     ErrorDetail: "STRING_VALUE",
//   },
//   EstimatedFilesToDelete: Number("long"),
// };

Param

DescribeTaskExecutionCommandInput

Returns

DescribeTaskExecutionCommandOutput

See

• DescribeTaskExecutionCommandInput for command's input shape.
• DescribeTaskExecutionCommandOutput for command's response shape.
• config for DataSyncClient's config shape.

Throws

InternalException (server fault)

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

Throws

InvalidRequestException (client fault)

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

Throws

DataSyncServiceException

Base exception class for all service exceptions from DataSync service.