2021/11/04 - AWS IoT Wireless - 26 new3 updated api methods
Changes Adding APIs for the FUOTA (firmware update over the air) and multicast for LoRaWAN devices and APIs to support event notification opt-in feature for Sidewalk related events. A few existing APIs need to be modified for this new feature.
Starts a bulk disassociatin of all qualifying wireless devices from a multicast group.
See also: AWS API Documentation
Request Syntax
client.start_bulk_disassociate_wireless_device_from_multicast_group(
Id='string',
QueryString='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The ID of the multicast group.
string
Query string used to search for wireless devices as part of the bulk associate and disassociate process.
list
The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.
(dict) --
A simple label consisting of a customer-defined key-value pair
Key (string) -- [REQUIRED]
The tag's key value.
Value (string) -- [REQUIRED]
The tag's value.
dict
Response Syntax
{}
Response Structure
(dict) --
Get the event configuration for a particular resource identifier.
See also: AWS API Documentation
Request Syntax
client.get_resource_event_configuration(
Identifier='string',
IdentifierType='PartnerAccountId',
PartnerType='Sidewalk'
)
string
[REQUIRED]
Resource identifier to opt in for event messaging.
string
[REQUIRED]
Identifier type of the particular resource identifier for event configuration.
string
Partner type of the resource if the identifier type is PartnerAccountId.
dict
Response Syntax
{
'DeviceRegistrationState': {
'Sidewalk': {
'AmazonIdEventTopic': 'Enabled'|'Disabled'
}
},
'Proximity': {
'Sidewalk': {
'AmazonIdEventTopic': 'Enabled'|'Disabled'
}
}
}
Response Structure
(dict) --
DeviceRegistrationState (dict) --
Event configuration for the device registration state event
Sidewalk (dict) --
Device registration state event configuration object for enabling or disabling Sidewalk related event topics.
AmazonIdEventTopic (string) --
Enum to denote whether amazon id event topic is enabled or disabled.
Proximity (dict) --
Event configuration for the Proximity event
Sidewalk (dict) --
Proximity event configuration object for enabling or disabling Sidewalk related event topics.
AmazonIdEventTopic (string) --
Enum to denote whether amazon id event topic is enabled or disabled.
Creates a FUOTA task.
See also: AWS API Documentation
Request Syntax
client.create_fuota_task(
Name='string',
Description='string',
ClientRequestToken='string',
LoRaWAN={
'RfRegion': 'EU868'|'US915'|'AU915'|'AS923-1'
},
FirmwareUpdateImage='string',
FirmwareUpdateRole='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
The name of a FUOTA task.
string
The description of the new resource.
string
Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
This field is autopopulated if not provided.
dict
The LoRaWAN information used with a FUOTA task.
RfRegion (string) --
Supported RfRegions
string
[REQUIRED]
The S3 URI points to a firmware update image that is to be used with a FUOTA task.
string
[REQUIRED]
The firmware update role that is to be used with a FUOTA task.
list
The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.
(dict) --
A simple label consisting of a customer-defined key-value pair
Key (string) -- [REQUIRED]
The tag's key value.
Value (string) -- [REQUIRED]
The tag's value.
dict
Response Syntax
{
'Arn': 'string',
'Id': 'string'
}
Response Structure
(dict) --
Arn (string) --
The arn of a FUOTA task.
Id (string) --
The ID of a FUOTA task.
Associate a multicast group with a FUOTA task.
See also: AWS API Documentation
Request Syntax
client.associate_multicast_group_with_fuota_task(
Id='string',
MulticastGroupId='string'
)
string
[REQUIRED]
The ID of a FUOTA task.
string
[REQUIRED]
The ID of the multicast group.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists the FUOTA tasks registered to your AWS account.
See also: AWS API Documentation
Request Syntax
client.list_fuota_tasks(
NextToken='string',
MaxResults=123
)
string
To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
integer
The maximum number of results to return in this operation.
dict
Response Syntax
{
'NextToken': 'string',
'FuotaTaskList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
FuotaTaskList (list) --
Lists the FUOTA tasks registered to your AWS account.
(dict) --
A FUOTA task.
Id (string) --
The ID of a FUOTA task.
Arn (string) --
The arn of a FUOTA task.
Name (string) --
The name of a FUOTA task.
Disassociates a multicast group from a fuota task.
See also: AWS API Documentation
Request Syntax
client.disassociate_multicast_group_from_fuota_task(
Id='string',
MulticastGroupId='string'
)
string
[REQUIRED]
The ID of a FUOTA task.
string
[REQUIRED]
The ID of the multicast group.
dict
Response Syntax
{}
Response Structure
(dict) --
Sends the specified data to a multicast group.
See also: AWS API Documentation
Request Syntax
client.send_data_to_multicast_group(
Id='string',
PayloadData='string',
WirelessMetadata={
'LoRaWAN': {
'FPort': 123
}
}
)
string
[REQUIRED]
The ID of the multicast group.
string
[REQUIRED]
The binary to be sent to the end device, encoded in base64.
dict
[REQUIRED]
Wireless metadata that is to be sent to multicast group.
LoRaWAN (dict) --
The metadata information of the LoRaWAN multicast group.
FPort (integer) --
The Fport value.
dict
Response Syntax
{
'MessageId': 'string'
}
Response Structure
(dict) --
MessageId (string) --
ID of a multicast group message.
Starts a FUOTA task.
See also: AWS API Documentation
Request Syntax
client.start_fuota_task(
Id='string',
LoRaWAN={
'StartTime': datetime(2015, 1, 1)
}
)
string
[REQUIRED]
The ID of a FUOTA task.
dict
The LoRaWAN information used to start a FUOTA task.
StartTime (datetime) --
Start time of a FUOTA task.
dict
Response Syntax
{}
Response Structure
(dict) --
Starts a bulk association of all qualifying wireless devices with a multicast group.
See also: AWS API Documentation
Request Syntax
client.start_bulk_associate_wireless_device_with_multicast_group(
Id='string',
QueryString='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The ID of the multicast group.
string
Query string used to search for wireless devices as part of the bulk associate and disassociate process.
list
The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.
(dict) --
A simple label consisting of a customer-defined key-value pair
Key (string) -- [REQUIRED]
The tag's key value.
Value (string) -- [REQUIRED]
The tag's value.
dict
Response Syntax
{}
Response Structure
(dict) --
Associates a wireless device with a multicast group.
See also: AWS API Documentation
Request Syntax
client.associate_wireless_device_with_multicast_group(
Id='string',
WirelessDeviceId='string'
)
string
[REQUIRED]
The ID of the multicast group.
string
[REQUIRED]
The ID of the wireless device.
dict
Response Syntax
{}
Response Structure
(dict) --
Disassociates a wireless device from a FUOTA task.
See also: AWS API Documentation
Request Syntax
client.disassociate_wireless_device_from_fuota_task(
Id='string',
WirelessDeviceId='string'
)
string
[REQUIRED]
The ID of a FUOTA task.
string
[REQUIRED]
The ID of the wireless device.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a multicast group if it is not in use by a fuota task.
See also: AWS API Documentation
Request Syntax
client.delete_multicast_group(
Id='string'
)
string
[REQUIRED]
The ID of the multicast group.
dict
Response Syntax
{}
Response Structure
(dict) --
Starts a multicast group session.
See also: AWS API Documentation
Request Syntax
client.start_multicast_group_session(
Id='string',
LoRaWAN={
'DlDr': 123,
'DlFreq': 123,
'SessionStartTime': datetime(2015, 1, 1),
'SessionTimeout': 123
}
)
string
[REQUIRED]
The ID of the multicast group.
dict
[REQUIRED]
The LoRaWAN information used with the multicast session.
DlDr (integer) --
Downlink data rate.
DlFreq (integer) --
Downlink frequency.
SessionStartTime (datetime) --
Timestamp of when the multicast group session is to start.
SessionTimeout (integer) --
How long before a multicast group session is to timeout.
dict
Response Syntax
{}
Response Structure
(dict) --
Gets information about a FUOTA task.
See also: AWS API Documentation
Request Syntax
client.get_fuota_task(
Id='string'
)
string
[REQUIRED]
The ID of a FUOTA task.
dict
Response Syntax
{
'Arn': 'string',
'Id': 'string',
'Status': 'Pending'|'FuotaSession_Waiting'|'In_FuotaSession'|'FuotaDone'|'Delete_Waiting',
'Name': 'string',
'Description': 'string',
'LoRaWAN': {
'RfRegion': 'string',
'StartTime': datetime(2015, 1, 1)
},
'FirmwareUpdateImage': 'string',
'FirmwareUpdateRole': 'string',
'CreatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Arn (string) --
The arn of a FUOTA task.
Id (string) --
The ID of a FUOTA task.
Status (string) --
The status of a FUOTA task.
Name (string) --
The name of a FUOTA task.
Description (string) --
The description of the new resource.
LoRaWAN (dict) --
The LoRaWAN information returned from getting a FUOTA task.
RfRegion (string) --
The frequency band (RFRegion) value.
StartTime (datetime) --
Start time of a FUOTA task.
FirmwareUpdateImage (string) --
The S3 URI points to a firmware update image that is to be used with a FUOTA task.
FirmwareUpdateRole (string) --
The firmware update role that is to be used with a FUOTA task.
CreatedAt (datetime) --
Created at timestamp for the resource.
Associate a wireless device with a FUOTA task.
See also: AWS API Documentation
Request Syntax
client.associate_wireless_device_with_fuota_task(
Id='string',
WirelessDeviceId='string'
)
string
[REQUIRED]
The ID of a FUOTA task.
string
[REQUIRED]
The ID of the wireless device.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates properties of a FUOTA task.
See also: AWS API Documentation
Request Syntax
client.update_fuota_task(
Id='string',
Name='string',
Description='string',
LoRaWAN={
'RfRegion': 'EU868'|'US915'|'AU915'|'AS923-1'
},
FirmwareUpdateImage='string',
FirmwareUpdateRole='string'
)
string
[REQUIRED]
The ID of a FUOTA task.
string
The name of a FUOTA task.
string
The description of the new resource.
dict
The LoRaWAN information used with a FUOTA task.
RfRegion (string) --
Supported RfRegions
string
The S3 URI points to a firmware update image that is to be used with a FUOTA task.
string
The firmware update role that is to be used with a FUOTA task.
dict
Response Syntax
{}
Response Structure
(dict) --
Disassociates a wireless device from a multicast group.
See also: AWS API Documentation
Request Syntax
client.disassociate_wireless_device_from_multicast_group(
Id='string',
WirelessDeviceId='string'
)
string
[REQUIRED]
The ID of the multicast group.
string
[REQUIRED]
The ID of the wireless device.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists the multicast groups registered to your AWS account.
See also: AWS API Documentation
Request Syntax
client.list_multicast_groups(
NextToken='string',
MaxResults=123
)
string
To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
integer
The maximum number of results to return in this operation.
dict
Response Syntax
{
'NextToken': 'string',
'MulticastGroupList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
MulticastGroupList (list) --
List of multicast groups.
(dict) --
A multicast group.
Id (string) --
The ID of the multicast group.
Arn (string) --
The arn of the multicast group.
Name (string) --
The name of the multicast group.
Gets information about a multicast group.
See also: AWS API Documentation
Request Syntax
client.get_multicast_group(
Id='string'
)
string
[REQUIRED]
The ID of the multicast group.
dict
Response Syntax
{
'Arn': 'string',
'Id': 'string',
'Name': 'string',
'Description': 'string',
'Status': 'string',
'LoRaWAN': {
'RfRegion': 'EU868'|'US915'|'AU915'|'AS923-1',
'DlClass': 'ClassB'|'ClassC',
'NumberOfDevicesRequested': 123,
'NumberOfDevicesInGroup': 123
},
'CreatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Arn (string) --
The arn of the multicast group.
Id (string) --
The ID of the multicast group.
Name (string) --
The name of the multicast group.
Description (string) --
The description of the new resource.
Status (string) --
The status of the multicast group.
LoRaWAN (dict) --
The LoRaWAN information that is to be returned from getting multicast group information.
RfRegion (string) --
Supported RfRegions
DlClass (string) --
DlClass for LoRaWAM, valid values are ClassB and ClassC.
NumberOfDevicesRequested (integer) --
Number of devices that are requested to be associated with the multicast group.
NumberOfDevicesInGroup (integer) --
Number of devices that are associated to the multicast group.
CreatedAt (datetime) --
Created at timestamp for the resource.
List all multicast groups associated with a fuota task.
See also: AWS API Documentation
Request Syntax
client.list_multicast_groups_by_fuota_task(
Id='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The ID of a FUOTA task.
string
To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
integer
The maximum number of results to return in this operation.
dict
Response Syntax
{
'NextToken': 'string',
'MulticastGroupList': [
{
'Id': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
MulticastGroupList (list) --
List of multicast groups associated with a FUOTA task.
(dict) --
A multicast group that is associated with a FUOTA task.
Id (string) --
The ID of the multicast group.
Deletes a FUOTA task.
See also: AWS API Documentation
Request Syntax
client.delete_fuota_task(
Id='string'
)
string
[REQUIRED]
The ID of a FUOTA task.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a multicast group.
See also: AWS API Documentation
Request Syntax
client.create_multicast_group(
Name='string',
Description='string',
ClientRequestToken='string',
LoRaWAN={
'RfRegion': 'EU868'|'US915'|'AU915'|'AS923-1',
'DlClass': 'ClassB'|'ClassC'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
The name of the multicast group.
string
The description of the multicast group.
string
Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
This field is autopopulated if not provided.
dict
[REQUIRED]
The LoRaWAN information that is to be used with the multicast group.
RfRegion (string) --
Supported RfRegions
DlClass (string) --
DlClass for LoRaWAM, valid values are ClassB and ClassC.
list
The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.
(dict) --
A simple label consisting of a customer-defined key-value pair
Key (string) -- [REQUIRED]
The tag's key value.
Value (string) -- [REQUIRED]
The tag's value.
dict
Response Syntax
{
'Arn': 'string',
'Id': 'string'
}
Response Structure
(dict) --
Arn (string) --
The arn of the multicast group.
Id (string) --
The ID of the multicast group.
Cancels an existing multicast group session.
See also: AWS API Documentation
Request Syntax
client.cancel_multicast_group_session(
Id='string'
)
string
[REQUIRED]
The ID of the multicast group.
dict
Response Syntax
{}
Response Structure
(dict) --
Update the event configuration for a particular resource identifier.
See also: AWS API Documentation
Request Syntax
client.update_resource_event_configuration(
Identifier='string',
IdentifierType='PartnerAccountId',
PartnerType='Sidewalk',
DeviceRegistrationState={
'Sidewalk': {
'AmazonIdEventTopic': 'Enabled'|'Disabled'
}
},
Proximity={
'Sidewalk': {
'AmazonIdEventTopic': 'Enabled'|'Disabled'
}
}
)
string
[REQUIRED]
Resource identifier to opt in for event messaging.
string
[REQUIRED]
Identifier type of the particular resource identifier for event configuration.
string
Partner type of the resource if the identifier type is PartnerAccountId
dict
Event configuration for the device registration state event
Sidewalk (dict) --
Device registration state event configuration object for enabling or disabling Sidewalk related event topics.
AmazonIdEventTopic (string) --
Enum to denote whether amazon id event topic is enabled or disabled.
dict
Event configuration for the Proximity event
Sidewalk (dict) --
Proximity event configuration object for enabling or disabling Sidewalk related event topics.
AmazonIdEventTopic (string) --
Enum to denote whether amazon id event topic is enabled or disabled.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates properties of a multicast group session.
See also: AWS API Documentation
Request Syntax
client.update_multicast_group(
Id='string',
Name='string',
Description='string',
LoRaWAN={
'RfRegion': 'EU868'|'US915'|'AU915'|'AS923-1',
'DlClass': 'ClassB'|'ClassC'
}
)
string
[REQUIRED]
The ID of the multicast group.
string
The name of the multicast group.
string
The description of the new resource.
dict
The LoRaWAN information that is to be used with the multicast group.
RfRegion (string) --
Supported RfRegions
DlClass (string) --
DlClass for LoRaWAM, valid values are ClassB and ClassC.
dict
Response Syntax
{}
Response Structure
(dict) --
Gets information about a multicast group session.
See also: AWS API Documentation
Request Syntax
client.get_multicast_group_session(
Id='string'
)
string
[REQUIRED]
The ID of the multicast group.
dict
Response Syntax
{
'LoRaWAN': {
'DlDr': 123,
'DlFreq': 123,
'SessionStartTime': datetime(2015, 1, 1),
'SessionTimeout': 123
}
}
Response Structure
(dict) --
LoRaWAN (dict) --
The LoRaWAN information used with the multicast session.
DlDr (integer) --
Downlink data rate.
DlFreq (integer) --
Downlink frequency.
SessionStartTime (datetime) --
Timestamp of when the multicast group session is to start.
SessionTimeout (integer) --
How long before a multicast group session is to timeout.
{'LoRaWAN': {'FPorts': {'ClockSync': 'integer',
'Fuota': 'integer',
'Multicast': 'integer'},
'OtaaV1_0_x': {'GenAppKey': 'string'}}}
Provisions a wireless device.
See also: AWS API Documentation
Request Syntax
client.create_wireless_device(
Type='Sidewalk'|'LoRaWAN',
Name='string',
Description='string',
DestinationName='string',
ClientRequestToken='string',
LoRaWAN={
'DevEui': 'string',
'DeviceProfileId': 'string',
'ServiceProfileId': 'string',
'OtaaV1_1': {
'AppKey': 'string',
'NwkKey': 'string',
'JoinEui': 'string'
},
'OtaaV1_0_x': {
'AppKey': 'string',
'AppEui': 'string',
'GenAppKey': 'string'
},
'AbpV1_1': {
'DevAddr': 'string',
'SessionKeys': {
'FNwkSIntKey': 'string',
'SNwkSIntKey': 'string',
'NwkSEncKey': 'string',
'AppSKey': 'string'
}
},
'AbpV1_0_x': {
'DevAddr': 'string',
'SessionKeys': {
'NwkSKey': 'string',
'AppSKey': 'string'
}
},
'FPorts': {
'Fuota': 123,
'Multicast': 123,
'ClockSync': 123
}
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The wireless device type.
string
The name of the new resource.
string
The description of the new resource.
string
[REQUIRED]
The name of the destination to assign to the new wireless device.
string
Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
This field is autopopulated if not provided.
dict
The device configuration information to use to create the wireless device.
DevEui (string) --
The DevEUI value.
DeviceProfileId (string) --
The ID of the device profile for the new wireless device.
ServiceProfileId (string) --
The ID of the service profile.
OtaaV1_1 (dict) --
OTAA device object for v1.1 for create APIs
AppKey (string) --
The AppKey value.
NwkKey (string) --
The NwkKey value.
JoinEui (string) --
The JoinEUI value.
OtaaV1_0_x (dict) --
OTAA device object for create APIs for v1.0.x
AppKey (string) --
The AppKey value.
AppEui (string) --
The AppEUI value.
GenAppKey (string) --
The GenAppKey value.
AbpV1_1 (dict) --
ABP device object for create APIs for v1.1
DevAddr (string) --
The DevAddr value.
SessionKeys (dict) --
Session keys for ABP v1.1
FNwkSIntKey (string) --
The FNwkSIntKey value.
SNwkSIntKey (string) --
The SNwkSIntKey value.
NwkSEncKey (string) --
The NwkSEncKey value.
AppSKey (string) --
The AppSKey value.
AbpV1_0_x (dict) --
LoRaWAN object for create APIs
DevAddr (string) --
The DevAddr value.
SessionKeys (dict) --
Session keys for ABP v1.0.x
NwkSKey (string) --
The NwkSKey value.
AppSKey (string) --
The AppSKey value.
FPorts (dict) --
List of FPort assigned for different LoRaWAN application packages to use
Fuota (integer) --
The Fport value.
Multicast (integer) --
The Fport value.
ClockSync (integer) --
The Fport value.
list
The tags to attach to the new wireless device. Tags are metadata that you can use to manage a resource.
(dict) --
A simple label consisting of a customer-defined key-value pair
Key (string) -- [REQUIRED]
The tag's key value.
Value (string) -- [REQUIRED]
The tag's value.
dict
Response Syntax
{
'Arn': 'string',
'Id': 'string'
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name of the new resource.
Id (string) --
The ID of the new wireless device.
{'LoRaWAN': {'FPorts': {'ClockSync': 'integer',
'Fuota': 'integer',
'Multicast': 'integer'},
'OtaaV1_0_x': {'GenAppKey': 'string'}}}
Gets information about a wireless device.
See also: AWS API Documentation
Request Syntax
client.get_wireless_device(
Identifier='string',
IdentifierType='WirelessDeviceId'|'DevEui'|'ThingName'|'SidewalkManufacturingSn'
)
string
[REQUIRED]
The identifier of the wireless device to get.
string
[REQUIRED]
The type of identifier used in identifier.
dict
Response Syntax
{
'Type': 'Sidewalk'|'LoRaWAN',
'Name': 'string',
'Description': 'string',
'DestinationName': 'string',
'Id': 'string',
'Arn': 'string',
'ThingName': 'string',
'ThingArn': 'string',
'LoRaWAN': {
'DevEui': 'string',
'DeviceProfileId': 'string',
'ServiceProfileId': 'string',
'OtaaV1_1': {
'AppKey': 'string',
'NwkKey': 'string',
'JoinEui': 'string'
},
'OtaaV1_0_x': {
'AppKey': 'string',
'AppEui': 'string',
'GenAppKey': 'string'
},
'AbpV1_1': {
'DevAddr': 'string',
'SessionKeys': {
'FNwkSIntKey': 'string',
'SNwkSIntKey': 'string',
'NwkSEncKey': 'string',
'AppSKey': 'string'
}
},
'AbpV1_0_x': {
'DevAddr': 'string',
'SessionKeys': {
'NwkSKey': 'string',
'AppSKey': 'string'
}
},
'FPorts': {
'Fuota': 123,
'Multicast': 123,
'ClockSync': 123
}
},
'Sidewalk': {
'AmazonId': 'string',
'SidewalkId': 'string',
'SidewalkManufacturingSn': 'string',
'DeviceCertificates': [
{
'SigningAlg': 'Ed25519'|'P256r1',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
Type (string) --
The wireless device type.
Name (string) --
The name of the resource.
Description (string) --
The description of the resource.
DestinationName (string) --
The name of the destination to which the device is assigned.
Id (string) --
The ID of the wireless device.
Arn (string) --
The Amazon Resource Name of the resource.
ThingName (string) --
The name of the thing associated with the wireless device. The value is empty if a thing isn't associated with the device.
ThingArn (string) --
The ARN of the thing associated with the wireless device.
LoRaWAN (dict) --
Information about the wireless device.
DevEui (string) --
The DevEUI value.
DeviceProfileId (string) --
The ID of the device profile for the new wireless device.
ServiceProfileId (string) --
The ID of the service profile.
OtaaV1_1 (dict) --
OTAA device object for v1.1 for create APIs
AppKey (string) --
The AppKey value.
NwkKey (string) --
The NwkKey value.
JoinEui (string) --
The JoinEUI value.
OtaaV1_0_x (dict) --
OTAA device object for create APIs for v1.0.x
AppKey (string) --
The AppKey value.
AppEui (string) --
The AppEUI value.
GenAppKey (string) --
The GenAppKey value.
AbpV1_1 (dict) --
ABP device object for create APIs for v1.1
DevAddr (string) --
The DevAddr value.
SessionKeys (dict) --
Session keys for ABP v1.1
FNwkSIntKey (string) --
The FNwkSIntKey value.
SNwkSIntKey (string) --
The SNwkSIntKey value.
NwkSEncKey (string) --
The NwkSEncKey value.
AppSKey (string) --
The AppSKey value.
AbpV1_0_x (dict) --
LoRaWAN object for create APIs
DevAddr (string) --
The DevAddr value.
SessionKeys (dict) --
Session keys for ABP v1.0.x
NwkSKey (string) --
The NwkSKey value.
AppSKey (string) --
The AppSKey value.
FPorts (dict) --
List of FPort assigned for different LoRaWAN application packages to use
Fuota (integer) --
The Fport value.
Multicast (integer) --
The Fport value.
ClockSync (integer) --
The Fport value.
Sidewalk (dict) --
Sidewalk device object.
AmazonId (string) --
The Sidewalk Amazon ID.
SidewalkId (string) --
The sidewalk device identification.
SidewalkManufacturingSn (string) --
The Sidewalk manufacturing series number.
DeviceCertificates (list) --
The sidewalk device certificates for Ed25519 and P256r1.
(dict) --
List of sidewalk certificates.
SigningAlg (string) --
The certificate chain algorithm provided by sidewalk.
Value (string) --
The value of the chosen sidewalk certificate.
{'FuotaTaskId': 'string', 'MulticastGroupId': 'string'}
Response {'WirelessDeviceList': {'FuotaDeviceStatus': 'Initial | Package_Not_Supported '
'| FragAlgo_unsupported | '
'Not_enough_memory | '
'FragIndex_unsupported | '
'Wrong_descriptor | '
'SessionCnt_replay | MissingFrag '
'| MemoryError | MICError | '
'Successful',
'McGroupId': 'integer',
'MulticastDeviceStatus': 'string'}}
Lists the wireless devices registered to your AWS account.
See also: AWS API Documentation
Request Syntax
client.list_wireless_devices(
MaxResults=123,
NextToken='string',
DestinationName='string',
DeviceProfileId='string',
ServiceProfileId='string',
WirelessDeviceType='Sidewalk'|'LoRaWAN',
FuotaTaskId='string',
MulticastGroupId='string'
)
integer
The maximum number of results to return in this operation.
string
To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
string
A filter to list only the wireless devices that use this destination.
string
A filter to list only the wireless devices that use this device profile.
string
A filter to list only the wireless devices that use this service profile.
string
A filter to list only the wireless devices that use this wireless device type.
string
The ID of a FUOTA task.
string
The ID of the multicast group.
dict
Response Syntax
{
'NextToken': 'string',
'WirelessDeviceList': [
{
'Arn': 'string',
'Id': 'string',
'Type': 'Sidewalk'|'LoRaWAN',
'Name': 'string',
'DestinationName': 'string',
'LastUplinkReceivedAt': 'string',
'LoRaWAN': {
'DevEui': 'string'
},
'Sidewalk': {
'AmazonId': 'string',
'SidewalkId': 'string',
'SidewalkManufacturingSn': 'string',
'DeviceCertificates': [
{
'SigningAlg': 'Ed25519'|'P256r1',
'Value': 'string'
},
]
},
'FuotaDeviceStatus': 'Initial'|'Package_Not_Supported'|'FragAlgo_unsupported'|'Not_enough_memory'|'FragIndex_unsupported'|'Wrong_descriptor'|'SessionCnt_replay'|'MissingFrag'|'MemoryError'|'MICError'|'Successful',
'MulticastDeviceStatus': 'string',
'McGroupId': 123
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token to use to get the next set of results, or null if there are no additional results.
WirelessDeviceList (list) --
The ID of the wireless device.
(dict) --
Information about a wireless device's operation.
Arn (string) --
The Amazon Resource Name of the resource.
Id (string) --
The ID of the wireless device reporting the data.
Type (string) --
The wireless device type.
Name (string) --
The name of the resource.
DestinationName (string) --
The name of the destination to which the device is assigned.
LastUplinkReceivedAt (string) --
The date and time when the most recent uplink was received.
LoRaWAN (dict) --
LoRaWAN device info.
DevEui (string) --
The DevEUI value.
Sidewalk (dict) --
The Sidewalk account credentials.
AmazonId (string) --
The Sidewalk Amazon ID.
SidewalkId (string) --
The sidewalk device identification.
SidewalkManufacturingSn (string) --
The Sidewalk manufacturing series number.
DeviceCertificates (list) --
The sidewalk device certificates for Ed25519 and P256r1.
(dict) --
List of sidewalk certificates.
SigningAlg (string) --
The certificate chain algorithm provided by sidewalk.
Value (string) --
The value of the chosen sidewalk certificate.
FuotaDeviceStatus (string) --
The status of a wireless device in a FUOTA task.
MulticastDeviceStatus (string) --
The status of the wireless device in the multicast group.
McGroupId (integer) --
Id of the multicast group.