@aws-sdk/client-datasync

Description

AWS SDK for JavaScript DataSync Client for Node.js, Browser and React Native.

DataSync

DataSync is an online data movement service that simplifies data
migration and helps you quickly, easily, and securely transfer your file or object data to,
from, and between Amazon Web Services storage services.

This API interface reference includes documentation for using DataSync
programmatically. For complete information, see the
DataSync User
Guide
.

Installing

To install this package, simply type add or install @aws-sdk/client-datasync
using your favorite package manager:
- npm install @aws-sdk/client-datasync
- yarn add @aws-sdk/client-datasync
- pnpm add @aws-sdk/client-datasync

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the DataSyncClient and
the commands you need, for example ListAgentsCommand:

``js
// ES5 example
const { DataSyncClient, ListAgentsCommand } = require("@aws-sdk/client-datasync");
`

`ts
// ES6+ example
import { DataSyncClient, ListAgentsCommand } from "@aws-sdk/client-datasync";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new DataSyncClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListAgentsCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
`

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-datasync";
const client = new AWS.DataSync({ region: "REGION" });

// async/await.
try {
const data = await client.listAgents(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listAgents(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listAgents(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
`

Getting Help

Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-datasync` package is updated.
To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

CancelTaskExecution

Command API Reference / Input / Output

CreateAgent

Command API Reference / Input / Output

CreateLocationAzureBlob

Command API Reference / Input / Output

CreateLocationEfs

Command API Reference / Input / Output

CreateLocationFsxLustre

Command API Reference / Input / Output

CreateLocationFsxOntap

Command API Reference / Input / Output

CreateLocationFsxOpenZfs

Command API Reference / Input / Output

CreateLocationFsxWindows

Command API Reference / Input / Output

CreateLocationHdfs

Command API Reference / Input / Output

CreateLocationNfs

Command API Reference / Input / Output

CreateLocationObjectStorage

Command API Reference / Input / Output

CreateLocationS3

Command API Reference / Input / Output

CreateLocationSmb

Command API Reference / Input / Output

CreateTask

Command API Reference / Input / Output

DeleteAgent

Command API Reference / Input / Output

DeleteLocation

Command API Reference / Input / Output

DeleteTask

Command API Reference / Input / Output

DescribeAgent

Command API Reference / Input / Output

DescribeLocationAzureBlob

Command API Reference / Input / Output

DescribeLocationEfs

Command API Reference / Input / Output

DescribeLocationFsxLustre

Command API Reference / Input / Output

DescribeLocationFsxOntap

Command API Reference / Input / Output

DescribeLocationFsxOpenZfs

Command API Reference / Input / Output

DescribeLocationFsxWindows

Command API Reference / Input / Output

DescribeLocationHdfs

Command API Reference / Input / Output

DescribeLocationNfs

Command API Reference / Input / Output

DescribeLocationObjectStorage

Command API Reference / Input / Output

DescribeLocationS3

Command API Reference / Input / Output

DescribeLocationSmb

Command API Reference / Input / Output

DescribeTask

Command API Reference / Input / Output

DescribeTaskExecution

Command API Reference / Input / Output

ListAgents

Command API Reference / Input / Output

ListLocations

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ListTaskExecutions

Command API Reference / Input / Output

ListTasks

Command API Reference / Input / Output

StartTaskExecution

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateAgent

Command API Reference / Input / Output

UpdateLocationAzureBlob

Command API Reference / Input / Output

UpdateLocationEfs

Command API Reference / Input / Output

UpdateLocationFsxLustre

Command API Reference / Input / Output

UpdateLocationFsxOntap

Command API Reference / Input / Output

UpdateLocationFsxOpenZfs

Command API Reference / Input / Output

UpdateLocationFsxWindows

Command API Reference / Input / Output

UpdateLocationHdfs

Command API Reference / Input / Output

UpdateLocationNfs

Command API Reference / Input / Output

UpdateLocationObjectStorage

Command API Reference / Input / Output

UpdateLocationS3

Command API Reference / Input / Output

UpdateLocationSmb

Command API Reference / Input / Output

UpdateTask

Command API Reference / Input / Output

UpdateTaskExecution

Command API Reference / Input / Output