Using the Amazon Command Line Interface with Amazon DataSync - Amazon DataSync
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

Using the Amazon Command Line Interface with Amazon DataSync

In this section, you can find examples of using the Amazon Command Line Interface (Amazon CLI) commands for Amazon DataSync. You can use these commands to create an agent, create source and destination locations, and run a task.

Before you begin, we recommend reading How Amazon DataSync works to understand the components and terms used in DataSync and how the service works. We also recommend reading IAM customer managed policies for Amazon DataSync to understand the Amazon Identity and Access Management (IAM) permissions that DataSync requires.

Before you use Amazon CLI commands, install the Amazon CLI. For information about how to install the Amazon CLI, see Installing the Amazon Command Line Interface in the Amazon Command Line Interface User Guide. After you install the Amazon CLI, you can use the help command to see the DataSync operations and the parameters associated with them.

To see the available operations, enter the following command.

aws datasync help

To see the parameters associated with a specific operation, enter the following command.

aws datasync operation help

For more information about the Amazon CLI, see What is the Amazon Command Line Interface?

For information about supported Amazon Web Services Regions and endpoints, see Amazon DataSync endpoints and quotas.

For information about DataSync Amazon Resource Name (ARN) values, see Amazon Resource Names.