2023/03/27 - AWS IoT Wireless - 8 new11 updated api methods
Changes Introducing new APIs that enable Sidewalk devices to communicate with AWS IoT Core through Sidewalk gateways. This will empower AWS customers to connect Sidewalk devices with other AWS IoT Services, creating possibilities for seamless integration and advanced device management.
Start import task for a single wireless device.
See also: AWS API Documentation
Request Syntax
client.start_single_wireless_device_import_task(
DestinationName='string',
ClientRequestToken='string',
DeviceName='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
Sidewalk={
'SidewalkManufacturingSn': 'string'
}
)
string
[REQUIRED]
The name of the Sidewalk destination that describes the IoT rule to route messages from the device in the import task that will be onboarded to AWS IoT Wireless.
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.
string
The name of the wireless device for which an import task is being started.
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
[REQUIRED]
The Sidewalk-related parameters for importing a single wireless device.
SidewalkManufacturingSn (string) --
The Sidewalk manufacturing serial number (SMSN) of the device added to the import task.
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string'
}
Response Structure
(dict) --
Id (string) --
The import task ID.
Arn (string) --
The ARN (Amazon Resource Name) of the import task.
Get information about an import task and count of device onboarding summary information for the import task.
See also: AWS API Documentation
Request Syntax
client.get_wireless_device_import_task(
Id='string'
)
string
[REQUIRED]
The identifier of the import task for which information is requested.
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string',
'DestinationName': 'string',
'Sidewalk': {
'DeviceCreationFileList': [
'string',
],
'Role': 'string'
},
'CreationTime': datetime(2015, 1, 1),
'Status': 'INITIALIZING'|'INITIALIZED'|'PENDING'|'COMPLETE'|'FAILED'|'DELETING',
'StatusReason': 'string',
'InitializedImportedDeviceCount': 123,
'PendingImportedDeviceCount': 123,
'OnboardedImportedDeviceCount': 123,
'FailedImportedDeviceCount': 123
}
Response Structure
(dict) --
Id (string) --
The identifier of the import task for which information is retrieved.
Arn (string) --
The ARN (Amazon Resource Name) of the import task.
DestinationName (string) --
The name of the destination that's assigned to the wireless devices in the import task.
Sidewalk (dict) --
The Sidewalk-related information about an import task.
DeviceCreationFileList (list) --
List of Sidewalk devices that are added to the import task.
(string) --
Role (string) --
The IAM role that allows AWS IoT Wireless to access the CSV file in the S3 bucket.
CreationTime (datetime) --
The time at which the import task was created.
Status (string) --
The import task status.
StatusReason (string) --
The reason for the provided status information, such as a validation error that causes the import task to fail.
InitializedImportedDeviceCount (integer) --
The number of devices in the import task that are waiting for the control log to start processing.
PendingImportedDeviceCount (integer) --
The number of devices in the import task that are waiting in the import task queue to be onboarded.
OnboardedImportedDeviceCount (integer) --
The number of devices in the import task that have been onboarded to the import task.
FailedImportedDeviceCount (integer) --
The number of devices in the import task that failed to onboard to the import task.
List the Sidewalk devices in an import task and their onboarding status.
See also: AWS API Documentation
Request Syntax
client.list_devices_for_wireless_device_import_task(
Id='string',
MaxResults=123,
NextToken='string',
Status='INITIALIZED'|'PENDING'|'ONBOARDED'|'FAILED'
)
string
[REQUIRED]
The identifier of the import task for which wireless devices are listed.
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
The status of the devices in the import task.
dict
Response Syntax
{
'NextToken': 'string',
'DestinationName': 'string',
'ImportedWirelessDeviceList': [
{
'Sidewalk': {
'SidewalkManufacturingSn': 'string',
'OnboardingStatus': 'INITIALIZED'|'PENDING'|'ONBOARDED'|'FAILED',
'OnboardingStatusReason': 'string',
'LastUpdateTime': datetime(2015, 1, 1)
}
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token to use to get the next set of results, or null if there are no additional results.
DestinationName (string) --
The name of the Sidewalk destination that describes the IoT rule to route messages received from devices in an import task that are onboarded to AWS IoT Wireless.
ImportedWirelessDeviceList (list) --
List of wireless devices in an import task and their onboarding status.
(dict) --
Information about a wireless device that has been added to an import task.
Sidewalk (dict) --
The Sidewalk-related information about a device that has been added to an import task.
SidewalkManufacturingSn (string) --
The Sidewalk manufacturing serial number (SMSN) of the Sidewalk device.
OnboardingStatus (string) --
The onboarding status of the Sidewalk device in the import task.
OnboardingStatusReason (string) --
The reason for the onboarding status information for the Sidewalk device.
LastUpdateTime (datetime) --
The time at which the status information was last updated.
Update an import task to add more devices to the task.
See also: AWS API Documentation
Request Syntax
client.update_wireless_device_import_task(
Id='string',
Sidewalk={
'DeviceCreationFile': 'string'
}
)
string
[REQUIRED]
The identifier of the import task to be updated.
dict
[REQUIRED]
The Sidewalk-related parameters of the import task to be updated.
DeviceCreationFile (string) --
The CSV file contained in an S3 bucket that's used for appending devices to an existing import task.
dict
Response Syntax
{}
Response Structure
(dict) --
Deregister a wireless device from AWS IoT Wireless.
See also: AWS API Documentation
Request Syntax
client.deregister_wireless_device(
Identifier='string',
WirelessDeviceType='Sidewalk'|'LoRaWAN'
)
string
[REQUIRED]
The identifier of the wireless device to deregister from AWS IoT Wireless.
string
The type of wireless device to deregister from AWS IoT Wireless, which can be LoRaWAN or Sidewalk.
dict
Response Syntax
{}
Response Structure
(dict) --
Delete an import task.
See also: AWS API Documentation
Request Syntax
client.delete_wireless_device_import_task(
Id='string'
)
string
[REQUIRED]
The unique identifier of the import task to be deleted.
dict
Response Syntax
{}
Response Structure
(dict) --
Start import task for provisioning Sidewalk devices in bulk using an S3 CSV file.
See also: AWS API Documentation
Request Syntax
client.start_wireless_device_import_task(
DestinationName='string',
ClientRequestToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
Sidewalk={
'DeviceCreationFile': 'string',
'Role': 'string'
}
)
string
[REQUIRED]
The name of the Sidewalk destination that describes the IoT rule to route messages from the devices in the import task that are onboarded to AWS IoT Wireless.
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.
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
[REQUIRED]
The Sidewalk-related parameters for importing wireless devices that need to be provisioned in bulk.
DeviceCreationFile (string) --
The CSV file contained in an S3 bucket that's used for adding devices to an import task.
Role (string) --
The IAM role that allows AWS IoT Wireless to access the CSV file in the S3 bucket.
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string'
}
Response Structure
(dict) --
Id (string) --
The import task ID.
Arn (string) --
The ARN (Amazon Resource Name) of the import task.
List wireless devices that have been added to an import task.
See also: AWS API Documentation
Request Syntax
client.list_wireless_device_import_tasks(
MaxResults=123,
NextToken='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.
dict
Response Syntax
{
'NextToken': 'string',
'WirelessDeviceImportTaskList': [
{
'Id': 'string',
'Arn': 'string',
'DestinationName': 'string',
'Sidewalk': {
'DeviceCreationFileList': [
'string',
],
'Role': 'string'
},
'CreationTime': datetime(2015, 1, 1),
'Status': 'INITIALIZING'|'INITIALIZED'|'PENDING'|'COMPLETE'|'FAILED'|'DELETING',
'StatusReason': 'string',
'InitializedImportedDeviceCount': 123,
'PendingImportedDeviceCount': 123,
'OnboardedImportedDeviceCount': 123,
'FailedImportedDeviceCount': 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.
WirelessDeviceImportTaskList (list) --
List of import tasks and summary information of onboarding status of devices in each import task.
(dict) --
Information about an import task for wireless devices.
Id (string) --
The ID of the wireless device import task.
Arn (string) --
The ARN (Amazon Resource Name) of the wireless device import task.
DestinationName (string) --
The name of the Sidewalk destination that that describes the IoT rule to route messages from the device in the import task that will be onboarded to AWS IoT Wireless
Sidewalk (dict) --
The Sidewalk-related information of the wireless device import task.
DeviceCreationFileList (list) --
List of Sidewalk devices that are added to the import task.
(string) --
Role (string) --
The IAM role that allows AWS IoT Wireless to access the CSV file in the S3 bucket.
CreationTime (datetime) --
The time at which the import task was created.
Status (string) --
The status information of the wireless device import task.
StatusReason (string) --
The reason that provides additional information about the import task status.
InitializedImportedDeviceCount (integer) --
The summary information of count of wireless devices that are waiting for the control log to be added to an import task.
PendingImportedDeviceCount (integer) --
The summary information of count of wireless devices in an import task that are waiting in the queue to be onboarded.
OnboardedImportedDeviceCount (integer) --
The summary information of count of wireless devices in an import task that have been onboarded to the import task.
FailedImportedDeviceCount (integer) --
The summary information of count of wireless devices in an import task that failed to onboarded to the import task.
{'Sidewalk': {}}
Creates a new device profile.
See also: AWS API Documentation
Request Syntax
client.create_device_profile(
Name='string',
LoRaWAN={
'SupportsClassB': True|False,
'ClassBTimeout': 123,
'PingSlotPeriod': 123,
'PingSlotDr': 123,
'PingSlotFreq': 123,
'SupportsClassC': True|False,
'ClassCTimeout': 123,
'MacVersion': 'string',
'RegParamsRevision': 'string',
'RxDelay1': 123,
'RxDrOffset1': 123,
'RxDataRate2': 123,
'RxFreq2': 123,
'FactoryPresetFreqsList': [
123,
],
'MaxEirp': 123,
'MaxDutyCycle': 123,
'RfRegion': 'string',
'SupportsJoin': True|False,
'Supports32BitFCnt': True|False
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientRequestToken='string',
Sidewalk={}
)
string
The name of the new resource.
dict
The device profile information to use to create the device profile.
SupportsClassB (boolean) --
The SupportsClassB value.
ClassBTimeout (integer) --
The ClassBTimeout value.
PingSlotPeriod (integer) --
The PingSlotPeriod value.
PingSlotDr (integer) --
The PingSlotDR value.
PingSlotFreq (integer) --
The PingSlotFreq value.
SupportsClassC (boolean) --
The SupportsClassC value.
ClassCTimeout (integer) --
The ClassCTimeout value.
MacVersion (string) --
The MAC version (such as OTAA 1.1 or OTAA 1.0.3) to use with this device profile.
RegParamsRevision (string) --
The version of regional parameters.
RxDelay1 (integer) --
The RXDelay1 value.
RxDrOffset1 (integer) --
The RXDROffset1 value.
RxDataRate2 (integer) --
The RXDataRate2 value.
RxFreq2 (integer) --
The RXFreq2 value.
FactoryPresetFreqsList (list) --
The list of values that make up the FactoryPresetFreqs value.
(integer) --
MaxEirp (integer) --
The MaxEIRP value.
MaxDutyCycle (integer) --
The MaxDutyCycle value.
RfRegion (string) --
The frequency band (RFRegion) value.
SupportsJoin (boolean) --
The SupportsJoin value.
Supports32BitFCnt (boolean) --
The Supports32BitFCnt value.
list
The tags to attach to the new device profile. 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.
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 Sidewalk-related information for creating the Sidewalk device profile.
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 device profile.
{'LoRaWAN': {'RfRegion': {'AS923-2',
'AS923-3',
'AS923-4',
'CN470',
'CN779',
'EU433',
'IN865',
'KR920',
'RU864'}}}
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'|'AS923-2'|'AS923-3'|'AS923-4'|'EU433'|'CN470'|'CN779'|'RU864'|'KR920'|'IN865'
},
FirmwareUpdateImage='string',
FirmwareUpdateRole='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
RedundancyPercent=123,
FragmentSizeBytes=123,
FragmentIntervalMS=123
)
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.
integer
The percentage of added redundant fragments. For example, if firmware file is 100 bytes and fragment size is 10 bytes, with RedundancyPercent set to 50(%), the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.
integer
The size of each fragment in bytes. Currently only supported in fuota tasks with multicast groups.
integer
The interval of sending fragments in milliseconds. Currently the interval will be rounded to the nearest second. Note that this interval only controls the timing when the cloud sends the fragments down. The actual delay of receiving fragments at device side depends on the device's class and the communication delay with the cloud.
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.
{'LoRaWAN': {'RfRegion': {'AS923-2',
'AS923-3',
'AS923-4',
'CN470',
'CN779',
'EU433',
'IN865',
'KR920',
'RU864'}}}
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'|'AS923-2'|'AS923-3'|'AS923-4'|'EU433'|'CN470'|'CN779'|'RU864'|'KR920'|'IN865',
'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.
{'Sidewalk': {'DeviceProfileId': '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'
},
'FCntStart': 123
},
'AbpV1_0_x': {
'DevAddr': 'string',
'SessionKeys': {
'NwkSKey': 'string',
'AppSKey': 'string'
},
'FCntStart': 123
},
'FPorts': {
'Fuota': 123,
'Multicast': 123,
'ClockSync': 123,
'Positioning': {
'ClockSync': 123,
'Stream': 123,
'Gnss': 123
},
'Applications': [
{
'FPort': 123,
'Type': 'SemtechGeolocation',
'DestinationName': 'string'
},
]
}
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
Positioning='Enabled'|'Disabled',
Sidewalk={
'DeviceProfileId': '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.
FCntStart (integer) --
The FCnt init 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.
FCntStart (integer) --
The FCnt init 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.
Positioning (dict) --
FPort values for the GNSS, stream, and ClockSync functions of the positioning information.
ClockSync (integer) --
The Fport value.
Stream (integer) --
The Fport value.
Gnss (integer) --
The Fport value.
Applications (list) --
Optional LoRaWAN application information, which can be used for geolocation.
(dict) --
LoRaWAN application configuration, which can be used to perform geolocation.
FPort (integer) --
The Fport value.
Type (string) --
Application type, which can be specified to obtain real-time position information of your LoRaWAN device.
DestinationName (string) --
The name of the position data destination that describes the AWS IoT rule that processes the device's position data for use by AWS IoT Core for LoRaWAN.
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.
string
FPort values for the GNSS, stream, and ClockSync functions of the positioning information.
dict
The device configuration information to use to create the Sidewalk device.
DeviceProfileId (string) --
The ID of the Sidewalk device profile.
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.
{'Sidewalk': {'ApplicationServerPublicKey': 'string',
'DakCertificateMetadata': [{'ApId': 'string',
'CertificateId': 'string',
'DeviceTypeId': 'string',
'FactorySupport': 'boolean',
'MaxAllowedSignature': 'integer'}],
'QualificationStatus': 'boolean'}}
Gets information about a device profile.
See also: AWS API Documentation
Request Syntax
client.get_device_profile(
Id='string'
)
string
[REQUIRED]
The ID of the resource to get.
dict
Response Syntax
{
'Arn': 'string',
'Name': 'string',
'Id': 'string',
'LoRaWAN': {
'SupportsClassB': True|False,
'ClassBTimeout': 123,
'PingSlotPeriod': 123,
'PingSlotDr': 123,
'PingSlotFreq': 123,
'SupportsClassC': True|False,
'ClassCTimeout': 123,
'MacVersion': 'string',
'RegParamsRevision': 'string',
'RxDelay1': 123,
'RxDrOffset1': 123,
'RxDataRate2': 123,
'RxFreq2': 123,
'FactoryPresetFreqsList': [
123,
],
'MaxEirp': 123,
'MaxDutyCycle': 123,
'RfRegion': 'string',
'SupportsJoin': True|False,
'Supports32BitFCnt': True|False
},
'Sidewalk': {
'ApplicationServerPublicKey': 'string',
'QualificationStatus': True|False,
'DakCertificateMetadata': [
{
'CertificateId': 'string',
'MaxAllowedSignature': 123,
'FactorySupport': True|False,
'ApId': 'string',
'DeviceTypeId': 'string'
},
]
}
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name of the resource.
Name (string) --
The name of the resource.
Id (string) --
The ID of the device profile.
LoRaWAN (dict) --
Information about the device profile.
SupportsClassB (boolean) --
The SupportsClassB value.
ClassBTimeout (integer) --
The ClassBTimeout value.
PingSlotPeriod (integer) --
The PingSlotPeriod value.
PingSlotDr (integer) --
The PingSlotDR value.
PingSlotFreq (integer) --
The PingSlotFreq value.
SupportsClassC (boolean) --
The SupportsClassC value.
ClassCTimeout (integer) --
The ClassCTimeout value.
MacVersion (string) --
The MAC version (such as OTAA 1.1 or OTAA 1.0.3) to use with this device profile.
RegParamsRevision (string) --
The version of regional parameters.
RxDelay1 (integer) --
The RXDelay1 value.
RxDrOffset1 (integer) --
The RXDROffset1 value.
RxDataRate2 (integer) --
The RXDataRate2 value.
RxFreq2 (integer) --
The RXFreq2 value.
FactoryPresetFreqsList (list) --
The list of values that make up the FactoryPresetFreqs value.
(integer) --
MaxEirp (integer) --
The MaxEIRP value.
MaxDutyCycle (integer) --
The MaxDutyCycle value.
RfRegion (string) --
The frequency band (RFRegion) value.
SupportsJoin (boolean) --
The SupportsJoin value.
Supports32BitFCnt (boolean) --
The Supports32BitFCnt value.
Sidewalk (dict) --
Information about the Sidewalk parameters in the device profile.
ApplicationServerPublicKey (string) --
The Sidewalk application server public key.
QualificationStatus (boolean) --
Gets information about the certification status of a Sidewalk device profile.
DakCertificateMetadata (list) --
The DAK certificate information of the Sidewalk device profile.
(dict) --
The device attestation key (DAK) information.
CertificateId (string) --
The certificate ID for the DAK.
MaxAllowedSignature (integer) --
The maximum number of signatures that the DAK can sign. A value of -1 indicates that there's no device limit.
FactorySupport (boolean) --
Whether factory support has been enabled.
ApId (string) --
The advertised product ID (APID) that's used for pre-production and production applications.
DeviceTypeId (string) --
The device type ID that's used for prototyping applications.
{'LoRaWAN': {'RfRegion': {'AS923-2',
'AS923-3',
'AS923-4',
'CN470',
'CN779',
'EU433',
'IN865',
'KR920',
'RU864'}}}
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'|'AS923-2'|'AS923-3'|'AS923-4'|'EU433'|'CN470'|'CN779'|'RU864'|'KR920'|'IN865',
'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.
{'Sidewalk': {'CertificateId': 'string',
'DeviceProfileId': 'string',
'PrivateKeys': [{'SigningAlg': 'Ed25519 | P256r1',
'Value': 'string'}],
'Status': 'PROVISIONED | REGISTERED | ACTIVATED | UNKNOWN'}}
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'
},
'FCntStart': 123
},
'AbpV1_0_x': {
'DevAddr': 'string',
'SessionKeys': {
'NwkSKey': 'string',
'AppSKey': 'string'
},
'FCntStart': 123
},
'FPorts': {
'Fuota': 123,
'Multicast': 123,
'ClockSync': 123,
'Positioning': {
'ClockSync': 123,
'Stream': 123,
'Gnss': 123
},
'Applications': [
{
'FPort': 123,
'Type': 'SemtechGeolocation',
'DestinationName': 'string'
},
]
}
},
'Sidewalk': {
'AmazonId': 'string',
'SidewalkId': 'string',
'SidewalkManufacturingSn': 'string',
'DeviceCertificates': [
{
'SigningAlg': 'Ed25519'|'P256r1',
'Value': 'string'
},
],
'PrivateKeys': [
{
'SigningAlg': 'Ed25519'|'P256r1',
'Value': 'string'
},
],
'DeviceProfileId': 'string',
'CertificateId': 'string',
'Status': 'PROVISIONED'|'REGISTERED'|'ACTIVATED'|'UNKNOWN'
},
'Positioning': 'Enabled'|'Disabled'
}
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.
FCntStart (integer) --
The FCnt init 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.
FCntStart (integer) --
The FCnt init 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.
Positioning (dict) --
FPort values for the GNSS, stream, and ClockSync functions of the positioning information.
ClockSync (integer) --
The Fport value.
Stream (integer) --
The Fport value.
Gnss (integer) --
The Fport value.
Applications (list) --
Optional LoRaWAN application information, which can be used for geolocation.
(dict) --
LoRaWAN application configuration, which can be used to perform geolocation.
FPort (integer) --
The Fport value.
Type (string) --
Application type, which can be specified to obtain real-time position information of your LoRaWAN device.
DestinationName (string) --
The name of the position data destination that describes the AWS IoT rule that processes the device's position data for use by AWS IoT Core for LoRaWAN.
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.
PrivateKeys (list) --
The Sidewalk device private keys that will be used for onboarding the device.
(dict) --
List of sidewalk certificates.
SigningAlg (string) --
The certificate chain algorithm provided by sidewalk.
Value (string) --
The value of the chosen sidewalk certificate.
DeviceProfileId (string) --
The ID of the Sidewalk device profile.
CertificateId (string) --
The ID of the Sidewalk device profile.
Status (string) --
The Sidewalk device status, such as provisioned or registered.
Positioning (string) --
FPort values for the GNSS, stream, and ClockSync functions of the positioning information.
{'DeviceProfileType': 'Sidewalk | LoRaWAN'}
Lists the device profiles registered to your AWS account.
See also: AWS API Documentation
Request Syntax
client.list_device_profiles(
NextToken='string',
MaxResults=123,
DeviceProfileType='Sidewalk'|'LoRaWAN'
)
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.
string
A filter to list only device profiles that use this type, which can be LoRaWAN or Sidewalk.
dict
Response Syntax
{
'NextToken': 'string',
'DeviceProfileList': [
{
'Arn': 'string',
'Name': 'string',
'Id': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token to use to get the next set of results, or null if there are no additional results.
DeviceProfileList (list) --
The list of device profiles.
(dict) --
Describes a device profile.
Arn (string) --
The Amazon Resource Name of the resource.
Name (string) --
The name of the resource.
Id (string) --
The ID of the device profile.
{'WirelessDeviceList': {'Sidewalk': {'DeviceProfileId': 'string',
'Status': 'PROVISIONED | REGISTERED | '
'ACTIVATED | UNKNOWN'}}}
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'
},
],
'DeviceProfileId': 'string',
'Status': 'PROVISIONED'|'REGISTERED'|'ACTIVATED'|'UNKNOWN'
},
'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.
DeviceProfileId (string) --
Sidewalk object used by list functions.
Status (string) --
The status of the Sidewalk devices, such as provisioned or registered.
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.
{'LoRaWAN': {'RfRegion': {'AS923-2',
'AS923-3',
'AS923-4',
'CN470',
'CN779',
'EU433',
'IN865',
'KR920',
'RU864'}}}
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'|'AS923-2'|'AS923-3'|'AS923-4'|'EU433'|'CN470'|'CN779'|'RU864'|'KR920'|'IN865'
},
FirmwareUpdateImage='string',
FirmwareUpdateRole='string',
RedundancyPercent=123,
FragmentSizeBytes=123,
FragmentIntervalMS=123
)
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.
integer
The percentage of added redundant fragments. For example, if firmware file is 100 bytes and fragment size is 10 bytes, with RedundancyPercent set to 50(%), the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.
integer
The size of each fragment in bytes. Currently only supported in fuota tasks with multicast groups.
integer
The interval of sending fragments in milliseconds. Currently the interval will be rounded to the nearest second. Note that this interval only controls the timing when the cloud sends the fragments down. The actual delay of receiving fragments at device side depends on the device's class and the communication delay with the cloud.
dict
Response Syntax
{}
Response Structure
(dict) --
{'LoRaWAN': {'RfRegion': {'AS923-2',
'AS923-3',
'AS923-4',
'CN470',
'CN779',
'EU433',
'IN865',
'KR920',
'RU864'}}}
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'|'AS923-2'|'AS923-3'|'AS923-4'|'EU433'|'CN470'|'CN779'|'RU864'|'KR920'|'IN865',
'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) --