Setting up to use Amazon IoT Core for Amazon Sidewalk - Amazon IoT Core
Install Python and Python3-pipSetting up your account and Amazon CLI
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 (PDF).

Setting up to use Amazon IoT Core for Amazon Sidewalk

Before you connect your Sidewalk end device, you must set up your Amazon Web Services account and configure the Amazon CLI.

Important

To perform the entire onboarding workflow for provisioning and registering your Sidewalk end device, you must also set up your Sidewalk gateway and the HDK. For instructions, see Setting up the hardware development kit (HDK) and Setting up a Sidewalk gateway in the Amazon Sidewalk documentation.

Install Python and Python3-pip

To use the Amazon CLI and boto3 as described in the next section, you must use a Python version 3.6 or later. If you want to onboard your end devices using the Amazon IoT console, you can skip this section and continue to setting up your Amazon Web Services account. To check whether you’ve already installed Python and Python3-pip, run the following commands. If running these commands return the version, it means that Python and Python3-pip have been installed correctly.

python3 -V
pip3 --version

If this command returns an error, it might be because Python is not installed, or your operating system calls the Python v3.x executable as Python3. In that case, replace all instances of python with python3 when you run the commands. If it still produces an error, either download and run the Python installer, or install Python depending on your operating system as described below.

Windows

On your Windows machine, download Python from the Python website and then run the installer to install Python on your machine.

Linux

On your Ubuntu machine, run the following sudo command to install Python.

sudo apt install python3
sudo apt install python3-pip
macOS

On your Mac machine, use Homebrew to install Python. Homebrew also installs pip, which then points to the installed Python3 version.

$ brew install python

Setting up your account and Amazon CLI

The following steps show you how to configure your Amazon Web Services account, Amazon CLI, and boto3 (Amazon SDK for Python).

  1. Set up your Amazon Web Services account

    To use Amazon IoT Core for Amazon Sidewalk, sign up for an Amazon Web Services account and create an administrative user. For instructions, see Set up your Amazon Web Services account.

  2. Install and configure the Amazon CLI

    You can use the Amazon CLI to programmatically onboard your Sidewalk end devices to Amazon IoT Core for Amazon Sidewalk. If you want to onboard your devices using the Amazon IoT console, you can skip this section. Open the Amazon IoT Core console and then continue to the next section to get started with connecting your devices to Amazon IoT Core for Amazon Sidewalk. For instructions on configuring the Amazon CLI, see Installing and configuring the Amazon CLI.

  3. Install boto3 (Amazon SDK for Python)

    The following commands show you how to install boto3 (Amazon SDK for Python) and the Amazon CLI. You'll also install botocore, which is required to run boto3. For detailed instructions, see Installing Boto3 in the Boto3 Documentation Guide.

    Note

    awscli version 1.26.6 requires PyYAML version that's 3.10 or later, but not later than 5.5.

    python3 -m pip install botocore-version-py3-none-any.whl
python3 -m pip install boto3-version-py3-none-any.whl
  4. Configure your credentials and default Region

    Configure your credentials and default Region in the ~/.aws/credentials and ~/.aws/config files. The boto3 library uses these credentials to identify your Amazon Web Services account and authorize API calls. For configuration instructions, see: