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).

Amazon IoT Core for Amazon Sidewalk API operations for device profiles

You can perform the following API operations for your Sidewalk device profiles:

The following sections show you how to list and delete profiles. For information about creating and retrieving device profiles, see Step 1: Create a device profile.

List device profiles in your Amazon Web Services account

You can use the ListDeviceProfiles API operation to list device profiles in your Amazon Web Services account that you added to Amazon IoT Core for Amazon Sidewalk. You can use this information to identify the devices that you want to associate this profile to.

To filter the list to display only Sidewalk device profiles, set Type to Sidewalk when running the API. Following shows an example CLI command:

aws iotwireless list-device-profiles --wireless-device-type "Sidewalk"

Running this command returns a list of device profiles that you added, including their profile identifier and Amazon Resource Name (ARN). To retrieve additional details about a specific profile, use the GetDeviceProfile API.

{
    "DeviceProfileList": [
        {
            "Name": "SidewalkDeviceProfile1",
            "Id": "12345678-a1b2-3c45-67d8-e90fa1b2c34d",
            "Arn": "arn:aws:iotwireless:us-east-1:123456789012:DeviceProfile/12345678-a1b2-3c45-67d8-e90fa1b2c34d"
        },
        {
            "Name": "SidewalkDeviceProfile2",
            "Id": "a1b2c3d4-5678-90ab-cdef-12ab345c67de",
            "Arn": "arn:aws:iotwireless:us-east-1:123456789012:DeviceProfile/a1b2c3d4-5678-90ab-cdef-12ab345c67de"
        }
    ]
}

Delete device profiles from your Amazon Web Services account

You can delete your device profiles using the DeleteDeviceProfile API operation. The following shows an example CLI command:

aws iotwireless delete-device-profile --name "SidewalkProfile"

This command doesn't produce any output. You can use the GetDeviceProfile API or the ListDeviceProfiles API operation to verify that the profile has been removed from your account.