可对无线设备目标执行的 AWS IoT Wireless API 操作
您可以对 LoRaWAN 和 Sidewalk 设备的目标执行以下 API 操作:
-
CreateDestinationAPI 或create-destinationCLI -
GetDestinationAPI 或get-destinationCLI -
UpdateDestinationAPI 或update-destinationCLI -
ListDestinationsAPI 或list-destinationsCLI -
DeleteDestinationAPI 或delete-destinationCLI
以下各节将向您介绍如何获取、列出、更新和删除目标。有关如何创建目标的信息,请参阅为 Sidewalk 终端设备添加目标。
获取有关您的目标的信息
您可以使用 GetDestination API 操作来获取有关您针对 AWS IoT Wireless 添加到您的账户中的目标的信息。提供目标名称作为 API 的输入。API 将返回有关与指定的标识符匹配的目标的信息。
下面显示了 CLI 命令示例:
aws iotwireless get-destination --nameSidewalkDestination
运行此命令会返回目标的参数。
{ "Arn": "arn:aws:iotwireless:us-east-1:123456789012:Destination/IoTWirelessDestination", "Name": "SidewalkDestination", "Expression": "IoTWirelessRule", "ExpressionType": "RuleName", "RoleArn": "arn:aws:iam::123456789012:role/IoTWirelessDestinationRole" }
更新目标的属性
使用 UpdateDestination API 操作更新您针对 AWS IoT Wireless 添加到您的账户中的目标的属性。下面显示了更新描述属性的示例 CLI 命令:
aws iotwireless update-destination --nameSidewalkDestination\ --description"Destination for messages processed using IoTWirelessRule"
列出您的 AWS 账户中的目标
使用 ListDestinations API 操作列出您的 AWS 账户中添加到 AWS IoT Wireless 的目标。要筛选列表以便仅返回 LoRaWAN 和 Sidewalk 终端设备的目标,请使用 WirelessDeviceType 参数。
下面显示了 CLI 命令示例:
aws iotwireless list-destinations --wireless-device-type "Sidewalk"
运行此命令将返回您添加的目标列表,包括其 Amazon 资源名称(ARN)。要检索有关特定目标的更多详细信息,请使用 GetDestination API。
{ "DestinationList": [ { "Arn": "arn:aws:iotwireless:us-east-1:123456789012:Destination/IoTWirelessDestination", "Name": "IoTWirelessDestination", "Expression": "IoTWirelessRule", "Description": "Destination for messages processed using IoTWirelessRule", "RoleArn": "arn:aws:iam::123456789012:role/IoTWirelessDestinationRole" }, { "Arn": "arn:aws:iotwireless:us-east-1:123456789012:Destination/IoTWirelessDestination2", "Name": "IoTWirelessDestination2", "Expression": "IoTWirelessRule2", "RoleArn": "arn:aws:iam::123456789012:role/IoTWirelessDestinationRole" } ] }
从您的 AWS 账户中删除目标
要删除您的目标,请将要删除的目标的名称作为输入传递给 DeleteDestination API 操作。下面显示了 CLI 命令示例:
警告
删除操作无法撤消。将从您的 AWS 账户中永久删除目标。
aws iotwireless delete-destination --name "SidewalkDestination"
此命令不会生成任何输出。您可以使用 GetDestination API 或 ListDestinations API 操作来验证目标是否已从您的账户中删除。