Describing your Sidewalk resources
Before you get started and create resources, we recommend that you consider the naming convention of your resources. Your wireless resources can include Sidewalk end devices, device profiles, or destinations. Amazon IoT Core for Amazon Sidewalk assigns a unique identifier to the resources that you create. However, you can give them more descriptive names, add a description, or add optional tags to help identify and manage them.
The following sections show the various Sidewalk resources and their length constraints.
Resource names and description
Sidewalk resources can have a name of up to 256 characters. For
Sidewalk end devices and profiles, the resource name is optional and can be
changed after the resource has been created. For destinations, provide a name that's
unique to your Amazon Web Services account and Amazon Web Services Region. The destination name can't be changed
after you create it. We recommend that you use short, meaningful names to help you
identify your resource. For example, if your Sidewalk end device is used for
object location, you can specify a name such as
.Sidewalk_Object_Locator_Device
In the Amazon IoT console, the name field appears in the resource hub list of resources. When selecting names for your resources, consider how you want them to be identified and displayed on the console. As space is limited in the console, only the first 15-30 characters might be visible.
Sidewalk name field constraints | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Resource name | Name field constraints | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Destination | Name is a unique ID and can't be changed. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Sidewalk end device | Name is an optional descriptor and can be changed after the resource has been created. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Device profile | Name is an optional descriptor and can be changed after the resource has been created. |
Destinations, end devices, and profiles also support a description field, which
can have up to 2,048 characters. While the description field can hold a lot of
information, it appears only in the details page of your resource in the Amazon IoT
console, and might not be convenient for scanning in the context of multiple
resources. To help you identify and manage your resources, we recommend that you
provide a short, meaningful description. For example, if your destination
republishes sensor data to an IoT topic, you can specify a description such as
.Sidewalk destination to republish sensor
data
Resource tags
Tags are words or phrases that act as metadata that you can use to identify and organize your Amazon resources. Tags can help you categorize your resources. You choose tag keys and their corresponding values.
Destinations and profiles can have up to 50 Amazon tags attached to them. Sidewalk devices don't support tags. For example, you can define a set of tags for a group of profiles that are associated with a particular set of Sidewalk end devices. To more easily manage your resources, we recommend that you create a consistent set of tag keys that meets your needs for each kind of resource. The following table shows the supported tags for your Sidewalk resources.
Sidewalk tag limits | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Resource name | Tag limits | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Destination | Up to 50 Amazon tags can be added to each resource. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Sidewalk device | This resource doesn't support tags. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Device profile | Up to 50 Amazon tags can be added to each resource. |
You can think of the tag key as a category of information and the tag value as a
specific value in that category. For example, you might have a tag value of
and then give some resources a
value of color
for that tag and others a
value of blue
. With that, you could use the
Tag Editor in the Amazon Web Services Management Console to find the resources with a color tag value of
red
.blue
For more information about tagging and tagging strategies, see Tag editor.