# DataSync API Reference

> In addition to the AWS Management Console and AWS Command Line Interface, you can use the AWS DataSync API to configure and manage DataSync with the AWS SDKs.

- [Welcome](https://docs.aws.amazon.com/datasync/latest/apireference/Welcome.md)
- [Common Parameters](https://docs.aws.amazon.com/datasync/latest/apireference/CommonParameters.md)
- [Common Error Types](https://docs.aws.amazon.com/datasync/latest/apireference/CommonErrors.md)

## [Actions](https://docs.aws.amazon.com/datasync/latest/apireference/API_Operations.md)

- [CancelTaskExecution](https://docs.aws.amazon.com/datasync/latest/apireference/API_CancelTaskExecution.md): Stops an AWS DataSync task execution that's in progress.
- [CreateAgent](https://docs.aws.amazon.com/datasync/latest/apireference/API_CreateAgent.md): Activates an AWS DataSync agent that you deploy in your storage environment.
- [CreateLocationAzureBlob](https://docs.aws.amazon.com/datasync/latest/apireference/API_CreateLocationAzureBlob.md): Creates a transfer location for a Microsoft Azure Blob Storage container.
- [CreateLocationEfs](https://docs.aws.amazon.com/datasync/latest/apireference/API_CreateLocationEfs.md): Creates a transfer location for an Amazon EFS file system.
- [CreateLocationFsxLustre](https://docs.aws.amazon.com/datasync/latest/apireference/API_CreateLocationFsxLustre.md): Creates a transfer location for an Amazon FSx for Lustre file system.
- [CreateLocationFsxOntap](https://docs.aws.amazon.com/datasync/latest/apireference/API_CreateLocationFsxOntap.md): Creates a transfer location for an Amazon FSx for NetApp ONTAP file system.
- [CreateLocationFsxOpenZfs](https://docs.aws.amazon.com/datasync/latest/apireference/API_CreateLocationFsxOpenZfs.md): Creates a transfer location for an Amazon FSx for OpenZFS file system.
- [CreateLocationFsxWindows](https://docs.aws.amazon.com/datasync/latest/apireference/API_CreateLocationFsxWindows.md): Creates a transfer location for an Amazon FSx for Windows File Server file system.
- [CreateLocationHdfs](https://docs.aws.amazon.com/datasync/latest/apireference/API_CreateLocationHdfs.md): Creates a transfer location for a Hadoop Distributed File System (HDFS).
- [CreateLocationNfs](https://docs.aws.amazon.com/datasync/latest/apireference/API_CreateLocationNfs.md): Creates a transfer location for a Network File System (NFS) file server.
- [CreateLocationObjectStorage](https://docs.aws.amazon.com/datasync/latest/apireference/API_CreateLocationObjectStorage.md): Creates a transfer location for an object storage system.
- [CreateLocationS3](https://docs.aws.amazon.com/datasync/latest/apireference/API_CreateLocationS3.md): Creates a transfer location for an Amazon S3 bucket.
- [CreateLocationSmb](https://docs.aws.amazon.com/datasync/latest/apireference/API_CreateLocationSmb.md): Creates a transfer location for a Server Message Block (SMB) file server.
- [CreateTask](https://docs.aws.amazon.com/datasync/latest/apireference/API_CreateTask.md): Configures a task, which defines where and how AWS DataSync transfers your data.
- [DeleteAgent](https://docs.aws.amazon.com/datasync/latest/apireference/API_DeleteAgent.md): Removes an AWS DataSync agent resource from your AWS account.
- [DeleteLocation](https://docs.aws.amazon.com/datasync/latest/apireference/API_DeleteLocation.md): Deletes a transfer location resource from AWS DataSync.
- [DeleteTask](https://docs.aws.amazon.com/datasync/latest/apireference/API_DeleteTask.md): Deletes a transfer task resource from AWS DataSync.
- [DescribeAgent](https://docs.aws.amazon.com/datasync/latest/apireference/API_DescribeAgent.md): Returns information about an AWS DataSync agent, such as its name, service endpoint type, and status.
- [DescribeLocationAzureBlob](https://docs.aws.amazon.com/datasync/latest/apireference/API_DescribeLocationAzureBlob.md): Provides details about how an AWS DataSync transfer location for Microsoft Azure Blob Storage is configured.
- [DescribeLocationEfs](https://docs.aws.amazon.com/datasync/latest/apireference/API_DescribeLocationEfs.md): Provides details about how an AWS DataSync transfer location for an Amazon EFS file system is configured.
- [DescribeLocationFsxLustre](https://docs.aws.amazon.com/datasync/latest/apireference/API_DescribeLocationFsxLustre.md): Provides details about how an AWS DataSync transfer location for an Amazon FSx for Lustre file system is configured.
- [DescribeLocationFsxOntap](https://docs.aws.amazon.com/datasync/latest/apireference/API_DescribeLocationFsxOntap.md): Provides details about how an AWS DataSync transfer location for an Amazon FSx for NetApp ONTAP file system is configured.
- [DescribeLocationFsxOpenZfs](https://docs.aws.amazon.com/datasync/latest/apireference/API_DescribeLocationFsxOpenZfs.md): Provides details about how an AWS DataSync transfer location for an Amazon FSx for OpenZFS file system is configured.
- [DescribeLocationFsxWindows](https://docs.aws.amazon.com/datasync/latest/apireference/API_DescribeLocationFsxWindows.md): Provides details about how an AWS DataSync transfer location for an Amazon FSx for Windows File Server file system is configured.
- [DescribeLocationHdfs](https://docs.aws.amazon.com/datasync/latest/apireference/API_DescribeLocationHdfs.md): Provides details about how an AWS DataSync transfer location for a Hadoop Distributed File System (HDFS) is configured.
- [DescribeLocationNfs](https://docs.aws.amazon.com/datasync/latest/apireference/API_DescribeLocationNfs.md): Provides details about how an AWS DataSync transfer location for a Network File System (NFS) file server is configured.
- [DescribeLocationObjectStorage](https://docs.aws.amazon.com/datasync/latest/apireference/API_DescribeLocationObjectStorage.md): Provides details about how an AWS DataSync transfer location for an object storage system is configured.
- [DescribeLocationS3](https://docs.aws.amazon.com/datasync/latest/apireference/API_DescribeLocationS3.md): Provides details about how an AWS DataSync transfer location for an S3 bucket is configured.
- [DescribeLocationSmb](https://docs.aws.amazon.com/datasync/latest/apireference/API_DescribeLocationSmb.md): Provides details about how an AWS DataSync transfer location for a Server Message Block (SMB) file server is configured.
- [DescribeTask](https://docs.aws.amazon.com/datasync/latest/apireference/API_DescribeTask.md): Provides information about a task, which defines where and how AWS DataSync transfers your data.
- [DescribeTaskExecution](https://docs.aws.amazon.com/datasync/latest/apireference/API_DescribeTaskExecution.md): Provides information about an execution of your AWS DataSync task.
- [ListAgents](https://docs.aws.amazon.com/datasync/latest/apireference/API_ListAgents.md): Returns a list of AWS DataSync agents that belong to an AWS account in the AWS Region specified in the request.
- [ListLocations](https://docs.aws.amazon.com/datasync/latest/apireference/API_ListLocations.md): Returns a list of source and destination locations.
- [ListTagsForResource](https://docs.aws.amazon.com/datasync/latest/apireference/API_ListTagsForResource.md): Returns all the tags associated with an AWS resource.
- [ListTaskExecutions](https://docs.aws.amazon.com/datasync/latest/apireference/API_ListTaskExecutions.md): Returns a list of executions for an AWS DataSync transfer task.
- [ListTasks](https://docs.aws.amazon.com/datasync/latest/apireference/API_ListTasks.md): Returns a list of the AWS DataSync tasks you created.
- [StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/apireference/API_StartTaskExecution.md): Starts an AWS DataSync transfer task.
- [TagResource](https://docs.aws.amazon.com/datasync/latest/apireference/API_TagResource.md): Applies a tag to an AWS resource.
- [UntagResource](https://docs.aws.amazon.com/datasync/latest/apireference/API_UntagResource.md): Removes tags from an AWS resource.
- [UpdateAgent](https://docs.aws.amazon.com/datasync/latest/apireference/API_UpdateAgent.md): Updates the name of an AWS DataSync agent.
- [UpdateLocationAzureBlob](https://docs.aws.amazon.com/datasync/latest/apireference/API_UpdateLocationAzureBlob.md): Modifies the following configurations of the Microsoft Azure Blob Storage transfer location that you're using with AWS DataSync.
- [UpdateLocationEfs](https://docs.aws.amazon.com/datasync/latest/apireference/API_UpdateLocationEfs.md): Modifies the following configuration parameters of the Amazon EFS transfer location that you're using with AWS DataSync.
- [UpdateLocationFsxLustre](https://docs.aws.amazon.com/datasync/latest/apireference/API_UpdateLocationFsxLustre.md): Modifies the following configuration parameters of the Amazon FSx for Lustre transfer location that you're using with AWS DataSync.
- [UpdateLocationFsxOntap](https://docs.aws.amazon.com/datasync/latest/apireference/API_UpdateLocationFsxOntap.md): Modifies the following configuration parameters of the Amazon FSx for NetApp ONTAP transfer location that you're using with AWS DataSync.
- [UpdateLocationFsxOpenZfs](https://docs.aws.amazon.com/datasync/latest/apireference/API_UpdateLocationFsxOpenZfs.md): Modifies the following configuration parameters of the Amazon FSx for OpenZFS transfer location that you're using with AWS DataSync.
- [UpdateLocationFsxWindows](https://docs.aws.amazon.com/datasync/latest/apireference/API_UpdateLocationFsxWindows.md): Modifies the following configuration parameters of the Amazon FSx for Windows File Server transfer location that you're using with AWS DataSync.
- [UpdateLocationHdfs](https://docs.aws.amazon.com/datasync/latest/apireference/API_UpdateLocationHdfs.md): Modifies the following configuration parameters of the Hadoop Distributed File System (HDFS) transfer location that you're using with AWS DataSync.
- [UpdateLocationNfs](https://docs.aws.amazon.com/datasync/latest/apireference/API_UpdateLocationNfs.md): Modifies the following configuration parameters of the Network File System (NFS) transfer location that you're using with AWS DataSync.
- [UpdateLocationObjectStorage](https://docs.aws.amazon.com/datasync/latest/apireference/API_UpdateLocationObjectStorage.md): Modifies the following configuration parameters of the object storage transfer location that you're using with AWS DataSync.
- [UpdateLocationS3](https://docs.aws.amazon.com/datasync/latest/apireference/API_UpdateLocationS3.md): Modifies the following configuration parameters of the Amazon S3 transfer location that you're using with AWS DataSync.
- [UpdateLocationSmb](https://docs.aws.amazon.com/datasync/latest/apireference/API_UpdateLocationSmb.md): Modifies the following configuration parameters of the Server Message Block (SMB) transfer location that you're using with AWS DataSync.
- [UpdateTask](https://docs.aws.amazon.com/datasync/latest/apireference/API_UpdateTask.md): Updates the configuration of a task, which defines where and how AWS DataSync transfers your data.
- [UpdateTaskExecution](https://docs.aws.amazon.com/datasync/latest/apireference/API_UpdateTaskExecution.md): Updates the configuration of a running AWS DataSync task execution.


## [Data Types](https://docs.aws.amazon.com/datasync/latest/apireference/API_Types.md)

- [AgentListEntry](https://docs.aws.amazon.com/datasync/latest/apireference/API_AgentListEntry.md): Represents a single entry in a list (or array) of AWS DataSync agents when you call the ListAgents operation.
- [AzureBlobSasConfiguration](https://docs.aws.amazon.com/datasync/latest/apireference/API_AzureBlobSasConfiguration.md): The shared access signature (SAS) configuration that allows AWS DataSync to access your Microsoft Azure Blob Storage.
- [CmkSecretConfig](https://docs.aws.amazon.com/datasync/latest/apireference/API_CmkSecretConfig.md): Specifies configuration information for a DataSync-managed secret, such as an authentication token, secret key, password, or Kerberos keytab that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key.
- [CustomSecretConfig](https://docs.aws.amazon.com/datasync/latest/apireference/API_CustomSecretConfig.md): Specifies configuration information for a customer-managed Secrets Manager secret where a storage location credentials is stored in Secrets Manager as plain text (for authentication token, secret key, or password) or as binary (for Kerberos keytab).
- [Ec2Config](https://docs.aws.amazon.com/datasync/latest/apireference/API_Ec2Config.md): The subnet and security groups that AWS DataSync uses to connect to one of your Amazon EFS file system's mount targets.
- [FilterRule](https://docs.aws.amazon.com/datasync/latest/apireference/API_FilterRule.md): Specifies which files, folders, and objects to include or exclude when transferring files from source to destination.
- [FsxProtocol](https://docs.aws.amazon.com/datasync/latest/apireference/API_FsxProtocol.md): Specifies the data transfer protocol that AWS DataSync uses to access your Amazon FSx file system.
- [FsxProtocolNfs](https://docs.aws.amazon.com/datasync/latest/apireference/API_FsxProtocolNfs.md): Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your FSx for OpenZFS file system or FSx for ONTAP file system's storage virtual machine (SVM).
- [FsxProtocolSmb](https://docs.aws.amazon.com/datasync/latest/apireference/API_FsxProtocolSmb.md): Specifies the Server Message Block (SMB) protocol configuration that AWS DataSync uses to access your Amazon FSx for NetApp ONTAP file system's storage virtual machine (SVM).
- [FsxUpdateProtocol](https://docs.aws.amazon.com/datasync/latest/apireference/API_FsxUpdateProtocol.md): Specifies the data transfer protocol that AWS DataSync uses to access your Amazon FSx file system.
- [FsxUpdateProtocolSmb](https://docs.aws.amazon.com/datasync/latest/apireference/API_FsxUpdateProtocolSmb.md): Specifies the Server Message Block (SMB) protocol configuration that AWS DataSync uses to access your Amazon FSx for NetApp ONTAP file system's storage virtual machine (SVM).
- [HdfsNameNode](https://docs.aws.amazon.com/datasync/latest/apireference/API_HdfsNameNode.md): The NameNode of the Hadoop Distributed File System (HDFS).
- [LocationFilter](https://docs.aws.amazon.com/datasync/latest/apireference/API_LocationFilter.md): Narrow down the list of resources returned by ListLocations.
- [LocationListEntry](https://docs.aws.amazon.com/datasync/latest/apireference/API_LocationListEntry.md): Represents a single entry in a list of locations.
- [ManagedSecretConfig](https://docs.aws.amazon.com/datasync/latest/apireference/API_ManagedSecretConfig.md): Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location.
- [ManifestConfig](https://docs.aws.amazon.com/datasync/latest/apireference/API_ManifestConfig.md): Configures a manifest, which is a list of files or objects that you want AWS DataSync to transfer.
- [NfsMountOptions](https://docs.aws.amazon.com/datasync/latest/apireference/API_NfsMountOptions.md): Specifies how DataSync can access a location using the NFS protocol.
- [OnPremConfig](https://docs.aws.amazon.com/datasync/latest/apireference/API_OnPremConfig.md): The AWS DataSync agents that can connect to your Network File System (NFS) file server.
- [Options](https://docs.aws.amazon.com/datasync/latest/apireference/API_Options.md): Indicates how your transfer task is configured.
- [Platform](https://docs.aws.amazon.com/datasync/latest/apireference/API_Platform.md): The platform-related details about the AWS DataSync agent, such as the version number.
- [PrivateLinkConfig](https://docs.aws.amazon.com/datasync/latest/apireference/API_PrivateLinkConfig.md): Specifies how your AWS DataSync agent connects to AWS using a virtual private cloud (VPC) service endpoint.
- [QopConfiguration](https://docs.aws.amazon.com/datasync/latest/apireference/API_QopConfiguration.md): The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC) and data transfer privacy settings configured on the Hadoop Distributed File System (HDFS) cluster.
- [ReportDestination](https://docs.aws.amazon.com/datasync/latest/apireference/API_ReportDestination.md): Specifies where DataSync uploads your task report.
- [ReportDestinationS3](https://docs.aws.amazon.com/datasync/latest/apireference/API_ReportDestinationS3.md): Specifies the Amazon S3 bucket where DataSync uploads your task report.
- [ReportOverride](https://docs.aws.amazon.com/datasync/latest/apireference/API_ReportOverride.md): Specifies the level of detail for a particular aspect of your DataSync task report.
- [ReportOverrides](https://docs.aws.amazon.com/datasync/latest/apireference/API_ReportOverrides.md): The level of detail included in each aspect of your DataSync task report.
- [ReportResult](https://docs.aws.amazon.com/datasync/latest/apireference/API_ReportResult.md): Indicates whether DataSync created a complete task report for your transfer.
- [S3Config](https://docs.aws.amazon.com/datasync/latest/apireference/API_S3Config.md): Specifies the Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket.
- [S3ManifestConfig](https://docs.aws.amazon.com/datasync/latest/apireference/API_S3ManifestConfig.md): Specifies the S3 bucket where you're hosting the manifest that you want AWS DataSync to use.
- [SmbMountOptions](https://docs.aws.amazon.com/datasync/latest/apireference/API_SmbMountOptions.md): Specifies the version of the Server Message Block (SMB) protocol that AWS DataSync uses to access an SMB file server.
- [SourceManifestConfig](https://docs.aws.amazon.com/datasync/latest/apireference/API_SourceManifestConfig.md): Specifies the manifest that you want AWS DataSync to use and where it's hosted.
- [TagListEntry](https://docs.aws.amazon.com/datasync/latest/apireference/API_TagListEntry.md): A key-value pair representing a single tag that's been applied to an AWS resource.
- [TaskExecutionFilesFailedDetail](https://docs.aws.amazon.com/datasync/latest/apireference/API_TaskExecutionFilesFailedDetail.md): The number of files or objects that DataSync fails to prepare, transfer, verify, and delete during your task execution.
- [TaskExecutionFilesListedDetail](https://docs.aws.amazon.com/datasync/latest/apireference/API_TaskExecutionFilesListedDetail.md): The number of files or objects that DataSync finds at your locations.
- [TaskExecutionFoldersFailedDetail](https://docs.aws.amazon.com/datasync/latest/apireference/API_TaskExecutionFoldersFailedDetail.md): The number of directories that DataSync fails to list, prepare, transfer, verify, and delete during your task execution.
- [TaskExecutionFoldersListedDetail](https://docs.aws.amazon.com/datasync/latest/apireference/API_TaskExecutionFoldersListedDetail.md): The number of directories that DataSync finds at your locations.
- [TaskExecutionListEntry](https://docs.aws.amazon.com/datasync/latest/apireference/API_TaskExecutionListEntry.md): Represents a single entry in a list of AWS DataSync task executions that's returned with the ListTaskExecutions operation.
- [TaskExecutionResultDetail](https://docs.aws.amazon.com/datasync/latest/apireference/API_TaskExecutionResultDetail.md): Provides detailed information about the result of your AWS DataSync task execution.
- [TaskFilter](https://docs.aws.amazon.com/datasync/latest/apireference/API_TaskFilter.md): You can use API filters to narrow down the list of resources returned by ListTasks.
- [TaskListEntry](https://docs.aws.amazon.com/datasync/latest/apireference/API_TaskListEntry.md): Represents a single entry in a list of tasks.
- [TaskReportConfig](https://docs.aws.amazon.com/datasync/latest/apireference/API_TaskReportConfig.md): Specifies how you want to configure a task report, which provides detailed information about for your AWS DataSync transfer.
- [TaskSchedule](https://docs.aws.amazon.com/datasync/latest/apireference/API_TaskSchedule.md): Configures your AWS DataSync task to run on a schedule (at a minimum interval of 1 hour).
- [TaskScheduleDetails](https://docs.aws.amazon.com/datasync/latest/apireference/API_TaskScheduleDetails.md): Provides information about your AWS DataSync task schedule.


## Full content

The entire guide is also available as a single markdown file, useful for feeding the full guide to an LLM in one pass:

- [Complete guide (single file)](https://docs.aws.amazon.com/datasync/latest/apireference/full.md)