Navigation Guide
You are on the package index page for the Client of a service. Return to the Client landing page

@aws-sdk/client-datasync

Description

DataSync

DataSync is an online data movement and discovery 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 .

Installation

NPM

npm install @aws-sdk/client-datasync

Yarn

yarn add @aws-sdk/client-datasync

pnpm

pnpm add @aws-sdk/client-datasync

Types

Type Name	Type
AddStorageSystemCommand	Class
AddStorageSystemCommandInput	Interface
AddStorageSystemCommandOutput	Interface
AddStorageSystemRequest	Interface
AddStorageSystemResponse	Interface
AgentListEntry	Interface
AgentStatus	TypeAlias
AgentStatusenum	Variable
Atime	TypeAlias
Atimeenum	Variable
AzureAccessTier	TypeAlias
AzureAccessTierenum	Variable
AzureBlobAuthenticationType	TypeAlias
AzureBlobAuthenticationTypeenum	Variable
AzureBlobSasConfiguration	Interface
AzureBlobType	TypeAlias
AzureBlobTypeenum	Variable
CancelTaskExecutionCommand	Class
CancelTaskExecutionCommandInput	Interface
CancelTaskExecutionCommandOutput	Interface
CancelTaskExecutionRequest	Interface
CancelTaskExecutionResponse	Interface
Capacity	Interface
ClientDefaults	Interface
ClientInputEndpointParameters	Interface
CreateAgentCommand	Class
CreateAgentCommandInput	Interface
CreateAgentCommandOutput	Interface
CreateAgentRequest	Interface
CreateAgentResponse	Interface
CreateLocationAzureBlobCommand	Class
CreateLocationAzureBlobCommandInput	Interface
CreateLocationAzureBlobCommandOutput	Interface
CreateLocationAzureBlobRequest	Interface
CreateLocationAzureBlobResponse	Interface
CreateLocationEfsCommand	Class
CreateLocationEfsCommandInput	Interface
CreateLocationEfsCommandOutput	Interface
CreateLocationEfsRequest	Interface
CreateLocationEfsResponse	Interface
CreateLocationFsxLustreCommand	Class
CreateLocationFsxLustreCommandInput	Interface
CreateLocationFsxLustreCommandOutput	Interface
CreateLocationFsxLustreRequest	Interface
CreateLocationFsxLustreResponse	Interface
CreateLocationFsxOntapCommand	Class
CreateLocationFsxOntapCommandInput	Interface
CreateLocationFsxOntapCommandOutput	Interface
CreateLocationFsxOntapRequest	Interface
CreateLocationFsxOntapResponse	Interface
CreateLocationFsxOpenZfsCommand	Class
CreateLocationFsxOpenZfsCommandInput	Interface
CreateLocationFsxOpenZfsCommandOutput	Interface
CreateLocationFsxOpenZfsRequest	Interface
CreateLocationFsxOpenZfsResponse	Interface
CreateLocationFsxWindowsCommand	Class
CreateLocationFsxWindowsCommandInput	Interface
CreateLocationFsxWindowsCommandOutput	Interface
CreateLocationFsxWindowsRequest	Interface
CreateLocationFsxWindowsResponse	Interface
CreateLocationHdfsCommand	Class
CreateLocationHdfsCommandInput	Interface
CreateLocationHdfsCommandOutput	Interface
CreateLocationHdfsRequest	Interface
CreateLocationHdfsResponse	Interface
CreateLocationNfsCommand	Class
CreateLocationNfsCommandInput	Interface
CreateLocationNfsCommandOutput	Interface
CreateLocationNfsRequest	Interface
CreateLocationNfsResponse	Interface
CreateLocationObjectStorageCommand	Class
CreateLocationObjectStorageCommandInput	Interface
CreateLocationObjectStorageCommandOutput	Interface
CreateLocationObjectStorageRequest	Interface
CreateLocationObjectStorageResponse	Interface
CreateLocationS3Command	Class
CreateLocationS3CommandInput	Interface
CreateLocationS3CommandOutput	Interface
CreateLocationS3Request	Interface
CreateLocationS3Response	Interface
CreateLocationSmbCommand	Class
CreateLocationSmbCommandInput	Interface
CreateLocationSmbCommandOutput	Interface
CreateLocationSmbRequest	Interface
CreateLocationSmbResponse	Interface
CreateTaskCommand	Class
CreateTaskCommandInput	Interface
CreateTaskCommandOutput	Interface
CreateTaskRequest	Interface
CreateTaskResponse	Interface
Credentials	Interface
DataSync	Class
DataSync	Interface
DataSyncClient	Class
DataSyncClientConfig	Interface
DataSyncClientConfigType	TypeAlias
DataSyncClientResolvedConfig	Interface
DataSyncClientResolvedConfigType	TypeAlias
DataSyncPaginationConfiguration	Interface
DataSyncServiceException	Class
DeleteAgentCommand	Class
DeleteAgentCommandInput	Interface
DeleteAgentCommandOutput	Interface
DeleteAgentRequest	Interface
DeleteAgentResponse	Interface
DeleteLocationCommand	Class
DeleteLocationCommandInput	Interface
DeleteLocationCommandOutput	Interface
DeleteLocationRequest	Interface
DeleteLocationResponse	Interface
DeleteTaskCommand	Class
DeleteTaskCommandInput	Interface
DeleteTaskCommandOutput	Interface
DeleteTaskRequest	Interface
DeleteTaskResponse	Interface
DescribeAgentCommand	Class
DescribeAgentCommandInput	Interface
DescribeAgentCommandOutput	Interface
DescribeAgentRequest	Interface
DescribeAgentResponse	Interface
DescribeDiscoveryJobCommand	Class
DescribeDiscoveryJobCommandInput	Interface
DescribeDiscoveryJobCommandOutput	Interface
DescribeDiscoveryJobRequest	Interface
DescribeDiscoveryJobResponse	Interface
DescribeLocationAzureBlobCommand	Class
DescribeLocationAzureBlobCommandInput	Interface
DescribeLocationAzureBlobCommandOutput	Interface
DescribeLocationAzureBlobRequest	Interface
DescribeLocationAzureBlobResponse	Interface
DescribeLocationEfsCommand	Class
DescribeLocationEfsCommandInput	Interface
DescribeLocationEfsCommandOutput	Interface
DescribeLocationEfsRequest	Interface
DescribeLocationEfsResponse	Interface
DescribeLocationFsxLustreCommand	Class
DescribeLocationFsxLustreCommandInput	Interface
DescribeLocationFsxLustreCommandOutput	Interface
DescribeLocationFsxLustreRequest	Interface
DescribeLocationFsxLustreResponse	Interface
DescribeLocationFsxOntapCommand	Class
DescribeLocationFsxOntapCommandInput	Interface
DescribeLocationFsxOntapCommandOutput	Interface
DescribeLocationFsxOntapRequest	Interface
DescribeLocationFsxOntapResponse	Interface
DescribeLocationFsxOpenZfsCommand	Class
DescribeLocationFsxOpenZfsCommandInput	Interface
DescribeLocationFsxOpenZfsCommandOutput	Interface
DescribeLocationFsxOpenZfsRequest	Interface
DescribeLocationFsxOpenZfsResponse	Interface
DescribeLocationFsxWindowsCommand	Class
DescribeLocationFsxWindowsCommandInput	Interface
DescribeLocationFsxWindowsCommandOutput	Interface
DescribeLocationFsxWindowsRequest	Interface
DescribeLocationFsxWindowsResponse	Interface
DescribeLocationHdfsCommand	Class
DescribeLocationHdfsCommandInput	Interface
DescribeLocationHdfsCommandOutput	Interface
DescribeLocationHdfsRequest	Interface
DescribeLocationHdfsResponse	Interface
DescribeLocationNfsCommand	Class
DescribeLocationNfsCommandInput	Interface
DescribeLocationNfsCommandOutput	Interface
DescribeLocationNfsRequest	Interface
DescribeLocationNfsResponse	Interface
DescribeLocationObjectStorageCommand	Class
DescribeLocationObjectStorageCommandInput	Interface
DescribeLocationObjectStorageCommandOutput	Interface
DescribeLocationObjectStorageRequest	Interface
DescribeLocationObjectStorageResponse	Interface
DescribeLocationS3Command	Class
DescribeLocationS3CommandInput	Interface
DescribeLocationS3CommandOutput	Interface
DescribeLocationS3Request	Interface
DescribeLocationS3Response	Interface
DescribeLocationSmbCommand	Class
DescribeLocationSmbCommandInput	Interface
DescribeLocationSmbCommandOutput	Interface
DescribeLocationSmbRequest	Interface
DescribeLocationSmbResponse	Interface
DescribeStorageSystemCommand	Class
DescribeStorageSystemCommandInput	Interface
DescribeStorageSystemCommandOutput	Interface
DescribeStorageSystemRequest	Interface
DescribeStorageSystemResourceMetricsCommand	Class
DescribeStorageSystemResourceMetricsCommandInput	Interface
DescribeStorageSystemResourceMetricsCommandOutput	Interface
DescribeStorageSystemResourceMetricsRequest	Interface
DescribeStorageSystemResourceMetricsResponse	Interface
DescribeStorageSystemResourcesCommand	Class
DescribeStorageSystemResourcesCommandInput	Interface
DescribeStorageSystemResourcesCommandOutput	Interface
DescribeStorageSystemResourcesRequest	Interface
DescribeStorageSystemResourcesResponse	Interface
DescribeStorageSystemResponse	Interface
DescribeTaskCommand	Class
DescribeTaskCommandInput	Interface
DescribeTaskCommandOutput	Interface
DescribeTaskExecutionCommand	Class
DescribeTaskExecutionCommandInput	Interface
DescribeTaskExecutionCommandOutput	Interface
DescribeTaskExecutionRequest	Interface
DescribeTaskExecutionResponse	Interface
DescribeTaskRequest	Interface
DescribeTaskResponse	Interface
DiscoveryJobListEntry	Interface
DiscoveryJobStatus	TypeAlias
DiscoveryJobStatusenum	Variable
DiscoveryResourceFilter	TypeAlias
DiscoveryResourceFilterenum	Variable
DiscoveryResourceType	TypeAlias
DiscoveryResourceTypeenum	Variable
DiscoveryServerConfiguration	Interface
DiscoverySystemType	TypeAlias
DiscoverySystemTypeenum	Variable
Ec2Config	Interface
EfsInTransitEncryption	TypeAlias
EfsInTransitEncryptionenum	Variable
EndpointType	TypeAlias
EndpointTypeenum	Variable
FilterRule	Interface
FilterType	TypeAlias
FilterTypeenum	Variable
FsxProtocol	Interface
FsxProtocolNfs	Interface
FsxProtocolSmb	Interface
FsxUpdateProtocol	Interface
FsxUpdateProtocolSmb	Interface
GenerateRecommendationsCommand	Class
GenerateRecommendationsCommandInput	Interface
GenerateRecommendationsCommandOutput	Interface
GenerateRecommendationsRequest	Interface
GenerateRecommendationsResponse	Interface
Gid	TypeAlias
Gidenum	Variable
HdfsAuthenticationType	TypeAlias
HdfsAuthenticationTypeenum	Variable
HdfsDataTransferProtection	TypeAlias
HdfsDataTransferProtectionenum	Variable
HdfsNameNode	Interface
HdfsRpcProtection	TypeAlias
HdfsRpcProtectionenum	Variable
InternalException	Class
InvalidRequestException	Class
IOPS	Interface
Latency	Interface
ListAgentsCommand	Class
ListAgentsCommandInput	Interface
ListAgentsCommandOutput	Interface
ListAgentsRequest	Interface
ListAgentsResponse	Interface
ListDiscoveryJobsCommand	Class
ListDiscoveryJobsCommandInput	Interface
ListDiscoveryJobsCommandOutput	Interface
ListDiscoveryJobsRequest	Interface
ListDiscoveryJobsResponse	Interface
ListLocationsCommand	Class
ListLocationsCommandInput	Interface
ListLocationsCommandOutput	Interface
ListLocationsRequest	Interface
ListLocationsResponse	Interface
ListStorageSystemsCommand	Class
ListStorageSystemsCommandInput	Interface
ListStorageSystemsCommandOutput	Interface
ListStorageSystemsRequest	Interface
ListStorageSystemsResponse	Interface
ListTagsForResourceCommand	Class
ListTagsForResourceCommandInput	Interface
ListTagsForResourceCommandOutput	Interface
ListTagsForResourceRequest	Interface
ListTagsForResourceResponse	Interface
ListTaskExecutionsCommand	Class
ListTaskExecutionsCommandInput	Interface
ListTaskExecutionsCommandOutput	Interface
ListTaskExecutionsRequest	Interface
ListTaskExecutionsResponse	Interface
ListTasksCommand	Class
ListTasksCommandInput	Interface
ListTasksCommandOutput	Interface
ListTasksRequest	Interface
ListTasksResponse	Interface
LocationFilter	Interface
LocationFilterName	TypeAlias
LocationFilterNameenum	Variable
LocationListEntry	Interface
LogLevel	TypeAlias
LogLevelenum	Variable
ManifestAction	TypeAlias
ManifestActionenum	Variable
ManifestConfig	Interface
ManifestFormat	TypeAlias
ManifestFormatenum	Variable
MaxP95Performance	Interface
Mtime	TypeAlias
Mtimeenum	Variable
NetAppONTAPCluster	Interface
NetAppONTAPSVM	Interface
NetAppONTAPVolume	Interface
NfsMountOptions	Interface
NfsVersion	TypeAlias
NfsVersionenum	Variable
ObjectStorageServerProtocol	TypeAlias
ObjectStorageServerProtocolenum	Variable
ObjectTags	TypeAlias
ObjectTagsenum	Variable
ObjectVersionIds	TypeAlias
ObjectVersionIdsenum	Variable
OnPremConfig	Interface
Operator	TypeAlias
Operatorenum	Variable
Options	Interface
OverwriteMode	TypeAlias
OverwriteModeenum	Variable
P95Metrics	Interface
paginateDescribeStorageSystemResourceMetrics	Variable
paginateDescribeStorageSystemResources	Variable
paginateListAgents	Variable
paginateListDiscoveryJobs	Variable
paginateListLocations	Variable
paginateListStorageSystems	Variable
paginateListTagsForResource	Variable
paginateListTaskExecutions	Variable
paginateListTasks	Variable
PhaseStatus	TypeAlias
PhaseStatusenum	Variable
Platform	Interface
PosixPermissions	TypeAlias
PosixPermissionsenum	Variable
PreserveDeletedFiles	TypeAlias
PreserveDeletedFilesenum	Variable
PreserveDevices	TypeAlias
PreserveDevicesenum	Variable
PrivateLinkConfig	Interface
QopConfiguration	Interface
Recommendation	Interface
RecommendationStatus	TypeAlias
RecommendationStatusenum	Variable
RemoveStorageSystemCommand	Class
RemoveStorageSystemCommandInput	Interface
RemoveStorageSystemCommandOutput	Interface
RemoveStorageSystemRequest	Interface
RemoveStorageSystemResponse	Interface
ReportDestination	Interface
ReportDestinationS3	Interface
ReportLevel	TypeAlias
ReportLevelenum	Variable
ReportOutputType	TypeAlias
ReportOutputTypeenum	Variable
ReportOverride	Interface
ReportOverrides	Interface
ReportResult	Interface
ResourceDetails	Interface
ResourceMetrics	Interface
RuntimeExtension	Interface
S3Config	Interface
S3ManifestConfig	Interface
S3StorageClass	TypeAlias
S3StorageClassenum	Variable
ScheduleDisabledBy	TypeAlias
ScheduleDisabledByenum	Variable
ScheduleStatus	TypeAlias
ScheduleStatusenum	Variable
ServiceInputTypes	TypeAlias
ServiceOutputTypes	TypeAlias
SmbAuthenticationType	TypeAlias
SmbAuthenticationTypeenum	Variable
SmbMountOptions	Interface
SmbSecurityDescriptorCopyFlags	TypeAlias
SmbSecurityDescriptorCopyFlagsenum	Variable
SmbVersion	TypeAlias
SmbVersionenum	Variable
SourceManifestConfig	Interface
StartDiscoveryJobCommand	Class
StartDiscoveryJobCommandInput	Interface
StartDiscoveryJobCommandOutput	Interface
StartDiscoveryJobRequest	Interface
StartDiscoveryJobResponse	Interface
StartTaskExecutionCommand	Class
StartTaskExecutionCommandInput	Interface
StartTaskExecutionCommandOutput	Interface
StartTaskExecutionRequest	Interface
StartTaskExecutionResponse	Interface
StopDiscoveryJobCommand	Class
StopDiscoveryJobCommandInput	Interface
StopDiscoveryJobCommandOutput	Interface
StopDiscoveryJobRequest	Interface
StopDiscoveryJobResponse	Interface
StorageSystemConnectivityStatus	TypeAlias
StorageSystemConnectivityStatusenum	Variable
StorageSystemListEntry	Interface
TagListEntry	Interface
TagResourceCommand	Class
TagResourceCommandInput	Interface
TagResourceCommandOutput	Interface
TagResourceRequest	Interface
TagResourceResponse	Interface
TaskExecutionFilesFailedDetail	Interface
TaskExecutionFilesListedDetail	Interface
TaskExecutionListEntry	Interface
TaskExecutionResultDetail	Interface
TaskExecutionStatus	TypeAlias
TaskExecutionStatusenum	Variable
TaskFilter	Interface
TaskFilterName	TypeAlias
TaskFilterNameenum	Variable
TaskListEntry	Interface
TaskMode	TypeAlias
TaskModeenum	Variable
TaskQueueing	TypeAlias
TaskQueueingenum	Variable
TaskReportConfig	Interface
TaskSchedule	Interface
TaskScheduleDetails	Interface
TaskStatus	TypeAlias
TaskStatusenum	Variable
Throughput	Interface
TransferMode	TypeAlias
TransferModeenum	Variable
Uid	TypeAlias
Uidenum	Variable
UntagResourceCommand	Class
UntagResourceCommandInput	Interface
UntagResourceCommandOutput	Interface
UntagResourceRequest	Interface
UntagResourceResponse	Interface
UpdateAgentCommand	Class
UpdateAgentCommandInput	Interface
UpdateAgentCommandOutput	Interface
UpdateAgentRequest	Interface
UpdateAgentResponse	Interface
UpdateDiscoveryJobCommand	Class
UpdateDiscoveryJobCommandInput	Interface
UpdateDiscoveryJobCommandOutput	Interface
UpdateDiscoveryJobRequest	Interface
UpdateDiscoveryJobResponse	Interface
UpdateLocationAzureBlobCommand	Class
UpdateLocationAzureBlobCommandInput	Interface
UpdateLocationAzureBlobCommandOutput	Interface
UpdateLocationAzureBlobRequest	Interface
UpdateLocationAzureBlobResponse	Interface
UpdateLocationEfsCommand	Class
UpdateLocationEfsCommandInput	Interface
UpdateLocationEfsCommandOutput	Interface
UpdateLocationEfsRequest	Interface
UpdateLocationEfsResponse	Interface
UpdateLocationFsxLustreCommand	Class
UpdateLocationFsxLustreCommandInput	Interface
UpdateLocationFsxLustreCommandOutput	Interface
UpdateLocationFsxLustreRequest	Interface
UpdateLocationFsxLustreResponse	Interface
UpdateLocationFsxOntapCommand	Class
UpdateLocationFsxOntapCommandInput	Interface
UpdateLocationFsxOntapCommandOutput	Interface
UpdateLocationFsxOntapRequest	Interface
UpdateLocationFsxOntapResponse	Interface
UpdateLocationFsxOpenZfsCommand	Class
UpdateLocationFsxOpenZfsCommandInput	Interface
UpdateLocationFsxOpenZfsCommandOutput	Interface
UpdateLocationFsxOpenZfsRequest	Interface
UpdateLocationFsxOpenZfsResponse	Interface
UpdateLocationFsxWindowsCommand	Class
UpdateLocationFsxWindowsCommandInput	Interface
UpdateLocationFsxWindowsCommandOutput	Interface
UpdateLocationFsxWindowsRequest	Interface
UpdateLocationFsxWindowsResponse	Interface
UpdateLocationHdfsCommand	Class
UpdateLocationHdfsCommandInput	Interface
UpdateLocationHdfsCommandOutput	Interface
UpdateLocationHdfsRequest	Interface
UpdateLocationHdfsResponse	Interface
UpdateLocationNfsCommand	Class
UpdateLocationNfsCommandInput	Interface
UpdateLocationNfsCommandOutput	Interface
UpdateLocationNfsRequest	Interface
UpdateLocationNfsResponse	Interface
UpdateLocationObjectStorageCommand	Class
UpdateLocationObjectStorageCommandInput	Interface
UpdateLocationObjectStorageCommandOutput	Interface
UpdateLocationObjectStorageRequest	Interface
UpdateLocationObjectStorageResponse	Interface
UpdateLocationS3Command	Class
UpdateLocationS3CommandInput	Interface
UpdateLocationS3CommandOutput	Interface
UpdateLocationS3Request	Interface
UpdateLocationS3Response	Interface
UpdateLocationSmbCommand	Class
UpdateLocationSmbCommandInput	Interface
UpdateLocationSmbCommandOutput	Interface
UpdateLocationSmbRequest	Interface
UpdateLocationSmbResponse	Interface
UpdateStorageSystemCommand	Class
UpdateStorageSystemCommandInput	Interface
UpdateStorageSystemCommandOutput	Interface
UpdateStorageSystemRequest	Interface
UpdateStorageSystemResponse	Interface
UpdateTaskCommand	Class
UpdateTaskCommandInput	Interface
UpdateTaskCommandOutput	Interface
UpdateTaskExecutionCommand	Class
UpdateTaskExecutionCommandInput	Interface
UpdateTaskExecutionCommandOutput	Interface
UpdateTaskExecutionRequest	Interface
UpdateTaskExecutionResponse	Interface
UpdateTaskRequest	Interface
UpdateTaskResponse	Interface
VerifyMode	TypeAlias
VerifyModeenum	Variable

Item	Package	Type
AcceptPrimaryEmailUpdateCommand Command/Operation Page	@aws-sdk/client-account	Class
AccessDeniedException	@aws-sdk/client-account	Class
Account	@aws-sdk/client-account	Class
AccountClient	@aws-sdk/client-account	Class
AccountServiceException	@aws-sdk/client-account	Class
ConflictException	@aws-sdk/client-account	Class
DeleteAlternateContactCommand Command/Operation Page	@aws-sdk/client-account	Class
DisableRegionCommand Command/Operation Page	@aws-sdk/client-account	Class
EnableRegionCommand Command/Operation Page	@aws-sdk/client-account	Class
GetAccountInformationCommand Command/Operation Page	@aws-sdk/client-account	Class

Select your cookie preferences

Customize cookie preferences

Essential

Performance

Functional

Advertising

Unable to save cookie preferences

Getting Started

References

@aws-sdk/client-datasync

Description

Installation

Types

Table of Contents

Search