aws datasync53 CLI commands available for AWS DataSync.
| Command | API Operation | Sample |
|---|---|---|
cancel-task-executionStops an DataSync task execution that's in progress. The transfer of some files are abruptly interrupted. File contents that're transferred to the destination might be incomplete or inconsistent with the source files. However, if you start a new task execution using the same task and allow it to fin | CancelTaskExecution | |
create-agentActivates an DataSync agent that you deploy in your storage environment. The activation process associates the agent with your Amazon Web Services account. If you haven't deployed an agent yet, see Do I need a DataSync agent? | CreateAgent | |
create-location-azure-blobCreates a transfer location for a Microsoft Azure Blob Storage container. DataSync can use this location as a transfer source or destination. You can make transfers with or without a DataSync agent that connects to your container. Before you begin, make sure you know how DataSync accesses Azure Blob | CreateLocationAzureBlob | |
create-location-efsCreates a transfer location for an Amazon EFS file system. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses Amazon EFS file systems. | CreateLocationEfs | |
create-location-fsx-lustreCreates a transfer location for an Amazon FSx for Lustre file system. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses FSx for Lustre file systems. | CreateLocationFsxLustre | |
create-location-fsx-ontapCreates a transfer location for an Amazon FSx for NetApp ONTAP file system. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses FSx for ONTAP file systems. | CreateLocationFsxOntap | |
create-location-fsx-open-zfsCreates a transfer location for an Amazon FSx for OpenZFS file system. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses FSx for OpenZFS file systems. Request parameters related to SMB aren't suppor | CreateLocationFsxOpenZfs | |
create-location-fsx-windowsCreates a transfer location for an Amazon FSx for Windows File Server file system. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses FSx for Windows File Server file systems. | CreateLocationFsxWindows | |
create-location-hdfsCreates a transfer location for a Hadoop Distributed File System (HDFS). DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses HDFS clusters. | CreateLocationHdfs | |
create-location-nfsCreates a transfer location for a Network File System (NFS) file server. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses NFS file servers. | CreateLocationNfs | |
create-location-object-storageCreates a transfer location for an object storage system. DataSync can use this location as a source or destination for transferring data. You can make transfers with or without a DataSync agent. Before you begin, make sure that you understand the prerequisites for DataSync to work with object stora | CreateLocationObjectStorage | |
create-location-s3Creates a transfer location for an Amazon S3 bucket. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you read the following topics: Storage class considerations with Amazon S3 locations Evaluating S3 request costs when using D | CreateLocationS3 | |
create-location-smbCreates a transfer location for a Server Message Block (SMB) file server. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses SMB file servers. For more information, see Providing DataSync access to SM | CreateLocationSmb | |
create-taskConfigures a task, which defines where and how DataSync transfers your data. A task includes a source location, destination location, and transfer options (such as bandwidth limits, scheduling, and more). If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can | CreateTask | |
delete-agentRemoves an DataSync agent resource from your Amazon Web Services account. Keep in mind that this operation (which can't be undone) doesn't remove the agent's virtual machine (VM) or Amazon EC2 instance from your storage environment. For next steps, you can delete the VM or instance from your storage | DeleteAgent | |
delete-locationDeletes a transfer location resource from DataSync. | DeleteLocation | |
delete-taskDeletes a transfer task resource from DataSync. | DeleteTask | |
describe-agentReturns information about an DataSync agent, such as its name, service endpoint type, and status. | DescribeAgent | |
describe-location-azure-blobProvides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured. | DescribeLocationAzureBlob | |
describe-location-efsProvides details about how an DataSync transfer location for an Amazon EFS file system is configured. | DescribeLocationEfs | |
describe-location-fsx-lustreProvides details about how an DataSync transfer location for an Amazon FSx for Lustre file system is configured. | DescribeLocationFsxLustre | |
describe-location-fsx-ontapProvides details about how an DataSync transfer location for an Amazon FSx for NetApp ONTAP file system is configured. If your location uses SMB, the DescribeLocationFsxOntap operation doesn't actually return a Password. | DescribeLocationFsxOntap | |
describe-location-fsx-open-zfsProvides details about how an DataSync transfer location for an Amazon FSx for OpenZFS file system is configured. Response elements related to SMB aren't supported with the DescribeLocationFsxOpenZfs operation. | DescribeLocationFsxOpenZfs | |
describe-location-fsx-windowsProvides details about how an DataSync transfer location for an Amazon FSx for Windows File Server file system is configured. | DescribeLocationFsxWindows | |
describe-location-hdfsProvides details about how an DataSync transfer location for a Hadoop Distributed File System (HDFS) is configured. | DescribeLocationHdfs | |
describe-location-nfsProvides details about how an DataSync transfer location for a Network File System (NFS) file server is configured. | DescribeLocationNfs | |
describe-location-object-storageProvides details about how an DataSync transfer location for an object storage system is configured. | DescribeLocationObjectStorage | |
describe-location-s3Provides details about how an DataSync transfer location for an S3 bucket is configured. | DescribeLocationS3 | |
describe-location-smbProvides details about how an DataSync transfer location for a Server Message Block (SMB) file server is configured. | DescribeLocationSmb | |
describe-taskProvides information about a task, which defines where and how DataSync transfers your data. | DescribeTask | |
describe-task-executionProvides information about an execution of your DataSync task. You can use this operation to help monitor the progress of an ongoing data transfer or check the results of the transfer. Some DescribeTaskExecution response elements are only relevant to a specific task mode. For information, see Under | DescribeTaskExecution | |
list-agentsReturns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region specified in the request. With pagination, you can reduce the number of agents returned in a response. If you get a truncated list of agents in a response, the response contains a marker | ListAgents | |
list-locationsReturns a list of source and destination locations. If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations. | ListLocations | |
list-tags-for-resourceReturns all the tags associated with an Amazon Web Services resource. | ListTagsForResource | |
list-task-executionsReturns a list of executions for an DataSync transfer task. | ListTaskExecutions | |
list-tasksReturns a list of the DataSync tasks you created. | ListTasks | |
start-task-executionStarts an DataSync transfer task. For each task, you can only run one task execution at a time. There are several steps to a task execution. For more information, see Task execution statuses. If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S | StartTaskExecution | |
tag-resourceApplies a tag to an Amazon Web Services resource. Tags are key-value pairs that can help you manage, filter, and search for your resources. These include DataSync resources, such as locations, tasks, and task executions. | TagResource | |
untag-resourceRemoves tags from an Amazon Web Services resource. | UntagResource | |
update-agentUpdates the name of an DataSync agent. | UpdateAgent | |
update-location-azure-blobModifies the following configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with Azure Blob Storage. | UpdateLocationAzureBlob | |
update-location-efsModifies the following configuration parameters of the Amazon EFS transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with Amazon EFS. | UpdateLocationEfs | |
update-location-fsx-lustreModifies the following configuration parameters of the Amazon FSx for Lustre transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with FSx for Lustre. | UpdateLocationFsxLustre | |
update-location-fsx-ontapModifies the following configuration parameters of the Amazon FSx for NetApp ONTAP transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with FSx for ONTAP. | UpdateLocationFsxOntap | |
update-location-fsx-open-zfsModifies the following configuration parameters of the Amazon FSx for OpenZFS transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with FSx for OpenZFS. Request parameters related to SMB aren't supported with the UpdateLocationFsxOpenZfs operat | UpdateLocationFsxOpenZfs | |
update-location-fsx-windowsModifies the following configuration parameters of the Amazon FSx for Windows File Server transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with FSx for Windows File Server. | UpdateLocationFsxWindows | |
update-location-hdfsModifies the following configuration parameters of the Hadoop Distributed File System (HDFS) transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with an HDFS cluster. | UpdateLocationHdfs | |
update-location-nfsModifies the following configuration parameters of the Network File System (NFS) transfer location that you're using with DataSync. For more information, see Configuring transfers with an NFS file server. | UpdateLocationNfs | |
update-location-object-storageModifies the following configuration parameters of the object storage transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with an object storage system. | UpdateLocationObjectStorage | |
update-location-s3Modifies the following configuration parameters of the Amazon S3 transfer location that you're using with DataSync. Before you begin, make sure that you read the following topics: Storage class considerations with Amazon S3 locations Evaluating S3 request costs when using DataSync | UpdateLocationS3 | |
update-location-smbModifies the following configuration parameters of the Server Message Block (SMB) transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with an SMB file server. | UpdateLocationSmb | |
update-taskUpdates the configuration of a task, which defines where and how DataSync transfers your data. | UpdateTask | |
update-task-executionUpdates the configuration of a running DataSync task execution. Currently, the only Option that you can modify with UpdateTaskExecution is BytesPerSecond , which throttles bandwidth for a running or queued task execution. | UpdateTaskExecution |
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterOur bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterDataSync