- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DeleteTaskCommand
Deletes a transfer task resource from DataSync.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DataSyncClient, DeleteTaskCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, DeleteTaskCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // DeleteTaskRequest
TaskArn: "STRING_VALUE", // required
};
const command = new DeleteTaskCommand(input);
const response = await client.send(command);
// {};
DeleteTaskCommand Input
See DeleteTaskCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
TaskArnRequired | string | undefined | Specifies the Amazon Resource Name (ARN) of the task that you want to delete. |
DeleteTaskCommand Output
See DeleteTaskCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
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. |