Table of Contents
A low-level client representing AWS IoT Wireless
AWS IoT Wireless provides bi-directional communication between internet-connected wireless devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS IoT, use the IoT Wireless API. These wireless devices use the Low Power Wide Area Networking (LPWAN) communication protocol to communicate with AWS IoT.
Using the API, you can perform create, read, update, and delete operations for your wireless devices, gateways, destinations, and profiles. After onboarding your devices, you can use the API operations to set log levels and monitor your devices with CloudWatch.
You can also use the API operations to create multicast groups and schedule a multicast session for sending a downlink message to devices in the group. By using Firmware Updates Over-The-Air (FUOTA) API operations, you can create a FUOTA task and schedule a session to update the firmware of individual devices or an entire group of devices in a multicast group.
import boto3
client = boto3.client('iotwireless')
These are the available methods:
Associates a partner account with your AWS account.
See also: AWS API Documentation
Request Syntax
response = client.associate_aws_account_with_partner_account(
Sidewalk={
'AmazonId': 'string',
'AppServerPrivateKey': 'string'
},
ClientRequestToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Sidewalk account credentials.
The Sidewalk Amazon ID.
The Sidewalk application server private key.
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.
The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.
A simple label consisting of a customer-defined key-value pair
The tag's key value.
The tag's value.
dict
Response Syntax
{
'Sidewalk': {
'AmazonId': 'string',
'AppServerPrivateKey': 'string'
},
'Arn': 'string'
}
Response Structure
(dict) --
Sidewalk (dict) --
The Sidewalk account credentials.
AmazonId (string) --
The Sidewalk Amazon ID.
AppServerPrivateKey (string) --
The Sidewalk application server private key.
Arn (string) --
The Amazon Resource Name of the resource.
Exceptions
Associate a multicast group with a FUOTA task.
See also: AWS API Documentation
Request Syntax
response = client.associate_multicast_group_with_fuota_task(
Id='string',
MulticastGroupId='string'
)
[REQUIRED]
The ID of a FUOTA task.
[REQUIRED]
The ID of the multicast group.
dict
Response Syntax
{}
Response Structure
Exceptions
Associate a wireless device with a FUOTA task.
See also: AWS API Documentation
Request Syntax
response = client.associate_wireless_device_with_fuota_task(
Id='string',
WirelessDeviceId='string'
)
[REQUIRED]
The ID of a FUOTA task.
[REQUIRED]
The ID of the wireless device.
dict
Response Syntax
{}
Response Structure
Exceptions
Associates a wireless device with a multicast group.
See also: AWS API Documentation
Request Syntax
response = client.associate_wireless_device_with_multicast_group(
Id='string',
WirelessDeviceId='string'
)
[REQUIRED]
The ID of the multicast group.
[REQUIRED]
The ID of the wireless device.
dict
Response Syntax
{}
Response Structure
Exceptions
Associates a wireless device with a thing.
See also: AWS API Documentation
Request Syntax
response = client.associate_wireless_device_with_thing(
Id='string',
ThingArn='string'
)
[REQUIRED]
The ID of the resource to update.
[REQUIRED]
The ARN of the thing to associate with the wireless device.
dict
Response Syntax
{}
Response Structure
Exceptions
Associates a wireless gateway with a certificate.
See also: AWS API Documentation
Request Syntax
response = client.associate_wireless_gateway_with_certificate(
Id='string',
IotCertificateId='string'
)
[REQUIRED]
The ID of the resource to update.
[REQUIRED]
The ID of the certificate to associate with the wireless gateway.
dict
Response Syntax
{
'IotCertificateId': 'string'
}
Response Structure
(dict) --
IotCertificateId (string) --
The ID of the certificate associated with the wireless gateway.
Exceptions
Associates a wireless gateway with a thing.
See also: AWS API Documentation
Request Syntax
response = client.associate_wireless_gateway_with_thing(
Id='string',
ThingArn='string'
)
[REQUIRED]
The ID of the resource to update.
[REQUIRED]
The ARN of the thing to associate with the wireless gateway.
dict
Response Syntax
{}
Response Structure
Exceptions
Check if an operation can be paginated.
Cancels an existing multicast group session.
See also: AWS API Documentation
Request Syntax
response = client.cancel_multicast_group_session(
Id='string'
)
[REQUIRED]
The ID of the multicast group.
{}
Response Structure
Exceptions
Creates a new destination that maps a device message to an AWS IoT rule.
See also: AWS API Documentation
Request Syntax
response = client.create_destination(
Name='string',
ExpressionType='RuleName'|'MqttTopic',
Expression='string',
Description='string',
RoleArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientRequestToken='string'
)
[REQUIRED]
The name of the new resource.
[REQUIRED]
The type of value in Expression .
[REQUIRED]
The rule name or topic rule to send messages to.
[REQUIRED]
The ARN of the IAM Role that authorizes the destination.
The tags to attach to the new destination. Tags are metadata that you can use to manage a resource.
A simple label consisting of a customer-defined key-value pair
The tag's key value.
The tag's value.
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
Response Syntax
{
'Arn': 'string',
'Name': 'string'
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name of the new resource.
Name (string) --
The name of the new resource.
Exceptions
Creates a new device profile.
See also: AWS API Documentation
Request Syntax
response = 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'
)
The device profile information to use to create the device profile.
The SupportsClassB value.
The ClassBTimeout value.
The PingSlotPeriod value.
The PingSlotDR value.
The PingSlotFreq value.
The SupportsClassC value.
The ClassCTimeout value.
The MAC version (such as OTAA 1.1 or OTAA 1.0.3) to use with this device profile.
The version of regional parameters.
The RXDelay1 value.
The RXDROffset1 value.
The RXDataRate2 value.
The RXFreq2 value.
The list of values that make up the FactoryPresetFreqs value.
The MaxEIRP value.
The MaxDutyCycle value.
The frequency band (RFRegion) value.
The SupportsJoin value.
The Supports32BitFCnt value.
The tags to attach to the new device profile. Tags are metadata that you can use to manage a resource.
A simple label consisting of a customer-defined key-value pair
The tag's key value.
The tag's value.
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
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.
Exceptions
Creates a FUOTA task.
See also: AWS API Documentation
Request Syntax
response = 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'
},
]
)
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.
The LoRaWAN information used with a FUOTA task.
Supported RfRegions
[REQUIRED]
The S3 URI points to a firmware update image that is to be used with a FUOTA task.
[REQUIRED]
The firmware update role that is to be used with a FUOTA task.
The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.
A simple label consisting of a customer-defined key-value pair
The tag's key value.
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.
Exceptions
Creates a multicast group.
See also: AWS API Documentation
Request Syntax
response = 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'
},
]
)
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.
[REQUIRED]
The LoRaWAN information that is to be used with the multicast group.
Supported RfRegions
DlClass for LoRaWAM, valid values are ClassB and ClassC.
The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.
A simple label consisting of a customer-defined key-value pair
The tag's key value.
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.
Exceptions
Creates a new service profile.
See also: AWS API Documentation
Request Syntax
response = client.create_service_profile(
Name='string',
LoRaWAN={
'AddGwMetadata': True|False
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientRequestToken='string'
)
The service profile information to use to create the service profile.
The AddGWMetaData value.
The tags to attach to the new service profile. Tags are metadata that you can use to manage a resource.
A simple label consisting of a customer-defined key-value pair
The tag's key value.
The tag's value.
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
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 service profile.
Exceptions
Provisions a wireless device.
See also: AWS API Documentation
Request Syntax
response = 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'
},
]
)
[REQUIRED]
The wireless device type.
[REQUIRED]
The name of the destination to assign to the new wireless device.
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.
The device configuration information to use to create the wireless device.
The DevEUI value.
The ID of the device profile for the new wireless device.
The ID of the service profile.
OTAA device object for v1.1 for create APIs
The AppKey value.
The NwkKey value.
The JoinEUI value.
OTAA device object for create APIs for v1.0.x
The AppKey value.
The AppEUI value.
The GenAppKey value.
ABP device object for create APIs for v1.1
The DevAddr value.
Session keys for ABP v1.1
The FNwkSIntKey value.
The SNwkSIntKey value.
The NwkSEncKey value.
The AppSKey value.
LoRaWAN object for create APIs
The DevAddr value.
Session keys for ABP v1.0.x
The NwkSKey value.
The AppSKey value.
List of FPort assigned for different LoRaWAN application packages to use
The Fport value.
The Fport value.
The Fport value.
The tags to attach to the new wireless device. Tags are metadata that you can use to manage a resource.
A simple label consisting of a customer-defined key-value pair
The tag's key value.
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.
Exceptions
Provisions a wireless gateway.
See also: AWS API Documentation
Request Syntax
response = client.create_wireless_gateway(
Name='string',
Description='string',
LoRaWAN={
'GatewayEui': 'string',
'RfRegion': 'string',
'JoinEuiFilters': [
[
'string',
],
],
'NetIdFilters': [
'string',
],
'SubBands': [
123,
]
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientRequestToken='string'
)
[REQUIRED]
The gateway configuration information to use to create the wireless gateway.
The gateway's EUI value.
The frequency band (RFRegion) value.
A list of JoinEuiRange used by LoRa gateways to filter LoRa frames.
A pair of join EUI describing a range [BegEui, EndEui], both ends are inclusive.
A list of NetId values that are used by LoRa gateways to filter the uplink frames.
LoRaWAN network ID.
A list of integer indicating which sub bands are supported by LoRa gateway.
A subset of supported frequency channels in a certain RFRegion.
The tags to attach to the new wireless gateway. Tags are metadata that you can use to manage a resource.
A simple label consisting of a customer-defined key-value pair
The tag's key value.
The tag's value.
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
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 gateway.
Exceptions
Creates a task for a wireless gateway.
See also: AWS API Documentation
Request Syntax
response = client.create_wireless_gateway_task(
Id='string',
WirelessGatewayTaskDefinitionId='string'
)
[REQUIRED]
The ID of the resource to update.
[REQUIRED]
The ID of the WirelessGatewayTaskDefinition.
dict
Response Syntax
{
'WirelessGatewayTaskDefinitionId': 'string',
'Status': 'PENDING'|'IN_PROGRESS'|'FIRST_RETRY'|'SECOND_RETRY'|'COMPLETED'|'FAILED'
}
Response Structure
(dict) --
WirelessGatewayTaskDefinitionId (string) --
The ID of the WirelessGatewayTaskDefinition.
Status (string) --
The status of the request.
Exceptions
Creates a gateway task definition.
See also: AWS API Documentation
Request Syntax
response = client.create_wireless_gateway_task_definition(
AutoCreateTasks=True|False,
Name='string',
Update={
'UpdateDataSource': 'string',
'UpdateDataRole': 'string',
'LoRaWAN': {
'UpdateSignature': 'string',
'SigKeyCrc': 123,
'CurrentVersion': {
'PackageVersion': 'string',
'Model': 'string',
'Station': 'string'
},
'UpdateVersion': {
'PackageVersion': 'string',
'Model': 'string',
'Station': 'string'
}
}
},
ClientRequestToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
Whether to automatically create tasks using this task definition for all gateways with the specified current version. If false , the task must me created by calling CreateWirelessGatewayTask .
Information about the gateways to update.
The link to the S3 bucket.
The IAM role used to read data from the S3 bucket.
The properties that relate to the LoRaWAN wireless gateway.
The signature used to verify the update firmware.
The CRC of the signature private key to check.
The version of the gateways that should receive the update.
The version of the wireless gateway firmware.
The model number of the wireless gateway.
The basic station version of the wireless gateway.
The firmware version to update the gateway to.
The version of the wireless gateway firmware.
The model number of the wireless gateway.
The basic station version of the wireless gateway.
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.
The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.
A simple label consisting of a customer-defined key-value pair
The tag's key value.
The tag's value.
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string'
}
Response Structure
(dict) --
Id (string) --
The ID of the new wireless gateway task definition.
Arn (string) --
The Amazon Resource Name of the resource.
Exceptions
Deletes a destination.
See also: AWS API Documentation
Request Syntax
response = client.delete_destination(
Name='string'
)
[REQUIRED]
The name of the resource to delete.
{}
Response Structure
Exceptions
Deletes a device profile.
See also: AWS API Documentation
Request Syntax
response = client.delete_device_profile(
Id='string'
)
[REQUIRED]
The ID of the resource to delete.
{}
Response Structure
Exceptions
Deletes a FUOTA task.
See also: AWS API Documentation
Request Syntax
response = client.delete_fuota_task(
Id='string'
)
[REQUIRED]
The ID of a FUOTA task.
{}
Response Structure
Exceptions
Deletes a multicast group if it is not in use by a fuota task.
See also: AWS API Documentation
Request Syntax
response = client.delete_multicast_group(
Id='string'
)
[REQUIRED]
The ID of the multicast group.
{}
Response Structure
Exceptions
The operation to delete queued messages.
See also: AWS API Documentation
Request Syntax
response = client.delete_queued_messages(
Id='string',
MessageId='string',
WirelessDeviceType='Sidewalk'|'LoRaWAN'
)
[REQUIRED]
Id of a given wireless device which messages will be deleted
[REQUIRED]
if messageID=="*", the queue for a particular wireless deviceId will be purged, otherwise, the specific message with messageId will be deleted
dict
Response Syntax
{}
Response Structure
Exceptions
Deletes a service profile.
See also: AWS API Documentation
Request Syntax
response = client.delete_service_profile(
Id='string'
)
[REQUIRED]
The ID of the resource to delete.
{}
Response Structure
Exceptions
Deletes a wireless device.
See also: AWS API Documentation
Request Syntax
response = client.delete_wireless_device(
Id='string'
)
[REQUIRED]
The ID of the resource to delete.
{}
Response Structure
Exceptions
Deletes a wireless gateway.
See also: AWS API Documentation
Request Syntax
response = client.delete_wireless_gateway(
Id='string'
)
[REQUIRED]
The ID of the resource to delete.
{}
Response Structure
Exceptions
Deletes a wireless gateway task.
See also: AWS API Documentation
Request Syntax
response = client.delete_wireless_gateway_task(
Id='string'
)
[REQUIRED]
The ID of the resource to delete.
{}
Response Structure
Exceptions
Deletes a wireless gateway task definition. Deleting this task definition does not affect tasks that are currently in progress.
See also: AWS API Documentation
Request Syntax
response = client.delete_wireless_gateway_task_definition(
Id='string'
)
[REQUIRED]
The ID of the resource to delete.
{}
Response Structure
Exceptions
Disassociates your AWS account from a partner account. If PartnerAccountId and PartnerType are null , disassociates your AWS account from all partner accounts.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_aws_account_from_partner_account(
PartnerAccountId='string',
PartnerType='Sidewalk'
)
[REQUIRED]
The partner account ID to disassociate from the AWS account.
[REQUIRED]
The partner type.
dict
Response Syntax
{}
Response Structure
Exceptions
Disassociates a multicast group from a fuota task.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_multicast_group_from_fuota_task(
Id='string',
MulticastGroupId='string'
)
[REQUIRED]
The ID of a FUOTA task.
[REQUIRED]
The ID of the multicast group.
dict
Response Syntax
{}
Response Structure
Exceptions
Disassociates a wireless device from a FUOTA task.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_wireless_device_from_fuota_task(
Id='string',
WirelessDeviceId='string'
)
[REQUIRED]
The ID of a FUOTA task.
[REQUIRED]
The ID of the wireless device.
dict
Response Syntax
{}
Response Structure
Exceptions
Disassociates a wireless device from a multicast group.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_wireless_device_from_multicast_group(
Id='string',
WirelessDeviceId='string'
)
[REQUIRED]
The ID of the multicast group.
[REQUIRED]
The ID of the wireless device.
dict
Response Syntax
{}
Response Structure
Exceptions
Disassociates a wireless device from its currently associated thing.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_wireless_device_from_thing(
Id='string'
)
[REQUIRED]
The ID of the resource to update.
{}
Response Structure
Exceptions
Disassociates a wireless gateway from its currently associated certificate.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_wireless_gateway_from_certificate(
Id='string'
)
[REQUIRED]
The ID of the resource to update.
{}
Response Structure
Exceptions
Disassociates a wireless gateway from its currently associated thing.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_wireless_gateway_from_thing(
Id='string'
)
[REQUIRED]
The ID of the resource to update.
{}
Response Structure
Exceptions
Gets information about a destination.
See also: AWS API Documentation
Request Syntax
response = client.get_destination(
Name='string'
)
[REQUIRED]
The name of the resource to get.
{
'Arn': 'string',
'Name': 'string',
'Expression': 'string',
'ExpressionType': 'RuleName'|'MqttTopic',
'Description': 'string',
'RoleArn': 'string'
}
Response Structure
The Amazon Resource Name of the resource.
The name of the resource.
The rule name or topic rule to send messages to.
The type of value in Expression .
The description of the resource.
The ARN of the IAM Role that authorizes the destination.
Exceptions
Gets information about a device profile.
See also: AWS API Documentation
Request Syntax
response = client.get_device_profile(
Id='string'
)
[REQUIRED]
The ID of the resource to get.
{
'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
}
}
Response Structure
The Amazon Resource Name of the resource.
The name of the resource.
The ID of the device profile.
Information about the device profile.
The SupportsClassB value.
The ClassBTimeout value.
The PingSlotPeriod value.
The PingSlotDR value.
The PingSlotFreq value.
The SupportsClassC value.
The ClassCTimeout value.
The MAC version (such as OTAA 1.1 or OTAA 1.0.3) to use with this device profile.
The version of regional parameters.
The RXDelay1 value.
The RXDROffset1 value.
The RXDataRate2 value.
The RXFreq2 value.
The list of values that make up the FactoryPresetFreqs value.
The MaxEIRP value.
The MaxDutyCycle value.
The frequency band (RFRegion) value.
The SupportsJoin value.
The Supports32BitFCnt value.
Exceptions
Gets information about a FUOTA task.
See also: AWS API Documentation
Request Syntax
response = client.get_fuota_task(
Id='string'
)
[REQUIRED]
The ID of a FUOTA task.
{
'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
The arn of a FUOTA task.
The ID of a FUOTA task.
The status of a FUOTA task.
The name of a FUOTA task.
The description of the new resource.
The LoRaWAN information returned from getting a FUOTA task.
The frequency band (RFRegion) value.
Start time of a FUOTA task.
The S3 URI points to a firmware update image that is to be used with a FUOTA task.
The firmware update role that is to be used with a FUOTA task.
Created at timestamp for the resource.
Exceptions
Returns current default log levels or log levels by resource types. Based on resource types, log levels can be for wireless device log options or wireless gateway log options.
See also: AWS API Documentation
Request Syntax
response = client.get_log_levels_by_resource_types()
{
'DefaultLogLevel': 'INFO'|'ERROR'|'DISABLED',
'WirelessGatewayLogOptions': [
{
'Type': 'LoRaWAN',
'LogLevel': 'INFO'|'ERROR'|'DISABLED',
'Events': [
{
'Event': 'CUPS_Request'|'Certificate',
'LogLevel': 'INFO'|'ERROR'|'DISABLED'
},
]
},
],
'WirelessDeviceLogOptions': [
{
'Type': 'Sidewalk'|'LoRaWAN',
'LogLevel': 'INFO'|'ERROR'|'DISABLED',
'Events': [
{
'Event': 'Join'|'Rejoin'|'Uplink_Data'|'Downlink_Data'|'Registration',
'LogLevel': 'INFO'|'ERROR'|'DISABLED'
},
]
},
]
}
Response Structure
The log level for a log message.
The list of wireless gateway log options.
The log options for wireless gateways and can be used to set log levels for a specific type of wireless gateway.
The wireless gateway type.
The log level for a log message.
The list of wireless gateway event log options.
The log options for a wireless gateway event and can be used to set log levels for a specific wireless gateway event.
For a LoRaWAN gateway, possible events for a log message are CUPS_Request and Certificate .
The event for a log message, if the log message is tied to a wireless gateway.
The log level for a log message.
The list of wireless device log options.
The log options for wireless devices and can be used to set log levels for a specific type of wireless device.
The wireless device type.
The log level for a log message.
The list of wireless device event log options.
The log options for a wireless device event and can be used to set log levels for a specific wireless device event.
For a LoRaWAN device, possible events for a log messsage are: Join , Rejoin , Downlink_Data , and Uplink_Data . For a Sidewalk device, possible events for a log message are Registration , Downlink_Data , and Uplink_Data .
The event for a log message, if the log message is tied to a wireless device.
The log level for a log message.
Exceptions
Gets information about a multicast group.
See also: AWS API Documentation
Request Syntax
response = client.get_multicast_group(
Id='string'
)
[REQUIRED]
The ID of the multicast group.
{
'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
The arn of the multicast group.
The ID of the multicast group.
The name of the multicast group.
The description of the new resource.
The status of the multicast group.
The LoRaWAN information that is to be returned from getting multicast group information.
Supported RfRegions
DlClass for LoRaWAM, valid values are ClassB and ClassC.
Number of devices that are requested to be associated with the multicast group.
Number of devices that are associated to the multicast group.
Created at timestamp for the resource.
Exceptions
Gets information about a multicast group session.
See also: AWS API Documentation
Request Syntax
response = client.get_multicast_group_session(
Id='string'
)
[REQUIRED]
The ID of the multicast group.
{
'LoRaWAN': {
'DlDr': 123,
'DlFreq': 123,
'SessionStartTime': datetime(2015, 1, 1),
'SessionTimeout': 123
}
}
Response Structure
The LoRaWAN information used with the multicast session.
Downlink data rate.
Downlink frequency.
Timestamp of when the multicast group session is to start.
How long before a multicast group session is to timeout.
Exceptions
Get NetworkAnalyzer configuration.
See also: AWS API Documentation
Request Syntax
response = client.get_network_analyzer_configuration(
ConfigurationName='string'
)
[REQUIRED]
NetworkAnalyzer configuration name.
{
'TraceContent': {
'WirelessDeviceFrameInfo': 'ENABLED'|'DISABLED',
'LogLevel': 'INFO'|'ERROR'|'DISABLED'
},
'WirelessDevices': [
'string',
],
'WirelessGateways': [
'string',
]
}
Response Structure
Trace Content for resources.
WirelessDevice FrameInfo for trace content.
The log level for a log message.
List of WirelessDevices in the NetworkAnalyzerConfiguration.
The ID of the wireless device.
List of WirelessGateways in the NetworkAnalyzerConfiguration.
Exceptions
Create a paginator for an operation.
Gets information about a partner account. If PartnerAccountId and PartnerType are null , returns all partner accounts.
See also: AWS API Documentation
Request Syntax
response = client.get_partner_account(
PartnerAccountId='string',
PartnerType='Sidewalk'
)
[REQUIRED]
The partner account ID to disassociate from the AWS account.
[REQUIRED]
The partner type.
dict
Response Syntax
{
'Sidewalk': {
'AmazonId': 'string',
'Fingerprint': 'string',
'Arn': 'string'
},
'AccountLinked': True|False
}
Response Structure
(dict) --
Sidewalk (dict) --
The Sidewalk account credentials.
AmazonId (string) --
The Sidewalk Amazon ID.
Fingerprint (string) --
The fingerprint of the Sidewalk application server private key.
Arn (string) --
The Amazon Resource Name of the resource.
AccountLinked (boolean) --
Whether the partner account is linked to the AWS account.
Exceptions
Get the event configuration for a particular resource identifier.
See also: AWS API Documentation
Request Syntax
response = client.get_resource_event_configuration(
Identifier='string',
IdentifierType='PartnerAccountId',
PartnerType='Sidewalk'
)
[REQUIRED]
Resource identifier to opt in for event messaging.
[REQUIRED]
Identifier type of the particular resource identifier for event configuration.
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.
Exceptions
Fetches the log-level override, if any, for a given resource-ID and resource-type. It can be used for a wireless device or a wireless gateway.
See also: AWS API Documentation
Request Syntax
response = client.get_resource_log_level(
ResourceIdentifier='string',
ResourceType='string'
)
[REQUIRED]
The identifier of the resource. For a Wireless Device, it is the wireless device ID. For a wireless gateway, it is the wireless gateway ID.
[REQUIRED]
The type of the resource, which can be WirelessDevice or WirelessGateway .
dict
Response Syntax
{
'LogLevel': 'INFO'|'ERROR'|'DISABLED'
}
Response Structure
(dict) --
LogLevel (string) --
The log level for a log message.
Exceptions
Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.
See also: AWS API Documentation
Request Syntax
response = client.get_service_endpoint(
ServiceType='CUPS'|'LNS'
)
{
'ServiceType': 'CUPS'|'LNS',
'ServiceEndpoint': 'string',
'ServerTrust': 'string'
}
Response Structure
The endpoint's service type.
The service endpoint value.
The Root CA of the server trust certificate.
Exceptions
Gets information about a service profile.
See also: AWS API Documentation
Request Syntax
response = client.get_service_profile(
Id='string'
)
[REQUIRED]
The ID of the resource to get.
{
'Arn': 'string',
'Name': 'string',
'Id': 'string',
'LoRaWAN': {
'UlRate': 123,
'UlBucketSize': 123,
'UlRatePolicy': 'string',
'DlRate': 123,
'DlBucketSize': 123,
'DlRatePolicy': 'string',
'AddGwMetadata': True|False,
'DevStatusReqFreq': 123,
'ReportDevStatusBattery': True|False,
'ReportDevStatusMargin': True|False,
'DrMin': 123,
'DrMax': 123,
'ChannelMask': 'string',
'PrAllowed': True|False,
'HrAllowed': True|False,
'RaAllowed': True|False,
'NwkGeoLoc': True|False,
'TargetPer': 123,
'MinGwDiversity': 123
}
}
Response Structure
The Amazon Resource Name of the resource.
The name of the resource.
The ID of the service profile.
Information about the service profile.
The ULRate value.
The ULBucketSize value.
The ULRatePolicy value.
The DLRate value.
The DLBucketSize value.
The DLRatePolicy value.
The AddGWMetaData value.
The DevStatusReqFreq value.
The ReportDevStatusBattery value.
The ReportDevStatusMargin value.
The DRMin value.
The DRMax value.
The ChannelMask value.
The PRAllowed value that describes whether passive roaming is allowed.
The HRAllowed value that describes whether handover roaming is allowed.
The RAAllowed value that describes whether roaming activation is allowed.
The NwkGeoLoc value.
The TargetPER value.
The MinGwDiversity value.
Exceptions
Returns an object that can wait for some condition.
Gets information about a wireless device.
See also: AWS API Documentation
Request Syntax
response = client.get_wireless_device(
Identifier='string',
IdentifierType='WirelessDeviceId'|'DevEui'|'ThingName'|'SidewalkManufacturingSn'
)
[REQUIRED]
The identifier of the wireless device to get.
[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.
Exceptions
Gets operating information about a wireless device.
See also: AWS API Documentation
Request Syntax
response = client.get_wireless_device_statistics(
WirelessDeviceId='string'
)
[REQUIRED]
The ID of the wireless device for which to get the data.
{
'WirelessDeviceId': 'string',
'LastUplinkReceivedAt': 'string',
'LoRaWAN': {
'DevEui': 'string',
'FPort': 123,
'DataRate': 123,
'Frequency': 123,
'Timestamp': 'string',
'Gateways': [
{
'GatewayEui': 'string',
'Snr': 123.0,
'Rssi': 123.0
},
]
},
'Sidewalk': {
'Rssi': 123,
'BatteryLevel': 'normal'|'low'|'critical',
'Event': 'discovered'|'lost'|'ack'|'nack'|'passthrough',
'DeviceState': 'Provisioned'|'RegisteredNotSeen'|'RegisteredReachable'|'RegisteredUnreachable'
}
}
Response Structure
The ID of the wireless device.
The date and time when the most recent uplink was received.
Information about the wireless device's operations.
The DevEUI value.
The FPort value.
The DataRate value.
The device's channel frequency in Hz.
The date and time of the metadata.
Information about the gateways accessed by the device.
LoRaWAN gateway metatdata.
The gateway's EUI value.
The SNR value.
The RSSI value.
MetaData for Sidewalk device.
The RSSI value.
Sidewalk device battery level.
Sidewalk device status notification.
Device state defines the device status of sidewalk device.
Exceptions
Gets information about a wireless gateway.
See also: AWS API Documentation
Request Syntax
response = client.get_wireless_gateway(
Identifier='string',
IdentifierType='GatewayEui'|'WirelessGatewayId'|'ThingName'
)
[REQUIRED]
The identifier of the wireless gateway to get.
[REQUIRED]
The type of identifier used in identifier .
dict
Response Syntax
{
'Name': 'string',
'Id': 'string',
'Description': 'string',
'LoRaWAN': {
'GatewayEui': 'string',
'RfRegion': 'string',
'JoinEuiFilters': [
[
'string',
],
],
'NetIdFilters': [
'string',
],
'SubBands': [
123,
]
},
'Arn': 'string',
'ThingName': 'string',
'ThingArn': 'string'
}
Response Structure
(dict) --
Name (string) --
The name of the resource.
Id (string) --
The ID of the wireless gateway.
Description (string) --
The description of the resource.
LoRaWAN (dict) --
Information about the wireless gateway.
GatewayEui (string) --
The gateway's EUI value.
RfRegion (string) --
The frequency band (RFRegion) value.
JoinEuiFilters (list) --
A list of JoinEuiRange used by LoRa gateways to filter LoRa frames.
(list) --
A pair of join EUI describing a range [BegEui, EndEui], both ends are inclusive.
NetIdFilters (list) --
A list of NetId values that are used by LoRa gateways to filter the uplink frames.
(string) --
LoRaWAN network ID.
SubBands (list) --
A list of integer indicating which sub bands are supported by LoRa gateway.
(integer) --
A subset of supported frequency channels in a certain RFRegion.
Arn (string) --
The Amazon Resource Name of the resource.
ThingName (string) --
The name of the thing associated with the wireless gateway. The value is empty if a thing isn't associated with the gateway.
ThingArn (string) --
The ARN of the thing associated with the wireless gateway.
Exceptions
Gets the ID of the certificate that is currently associated with a wireless gateway.
See also: AWS API Documentation
Request Syntax
response = client.get_wireless_gateway_certificate(
Id='string'
)
[REQUIRED]
The ID of the resource to get.
{
'IotCertificateId': 'string',
'LoRaWANNetworkServerCertificateId': 'string'
}
Response Structure
The ID of the certificate associated with the wireless gateway.
The ID of the certificate that is associated with the wireless gateway and used for the LoRaWANNetworkServer endpoint.
Exceptions
Gets the firmware version and other information about a wireless gateway.
See also: AWS API Documentation
Request Syntax
response = client.get_wireless_gateway_firmware_information(
Id='string'
)
[REQUIRED]
The ID of the resource to get.
{
'LoRaWAN': {
'CurrentVersion': {
'PackageVersion': 'string',
'Model': 'string',
'Station': 'string'
}
}
}
Response Structure
Information about the wireless gateway's firmware.
The version of the gateways that should receive the update.
The version of the wireless gateway firmware.
The model number of the wireless gateway.
The basic station version of the wireless gateway.
Exceptions
Gets operating information about a wireless gateway.
See also: AWS API Documentation
Request Syntax
response = client.get_wireless_gateway_statistics(
WirelessGatewayId='string'
)
[REQUIRED]
The ID of the wireless gateway for which to get the data.
{
'WirelessGatewayId': 'string',
'LastUplinkReceivedAt': 'string',
'ConnectionStatus': 'Connected'|'Disconnected'
}
Response Structure
The ID of the wireless gateway.
The date and time when the most recent uplink was received.
The connection status of the wireless gateway.
Exceptions
Gets information about a wireless gateway task.
See also: AWS API Documentation
Request Syntax
response = client.get_wireless_gateway_task(
Id='string'
)
[REQUIRED]
The ID of the resource to get.
{
'WirelessGatewayId': 'string',
'WirelessGatewayTaskDefinitionId': 'string',
'LastUplinkReceivedAt': 'string',
'TaskCreatedAt': 'string',
'Status': 'PENDING'|'IN_PROGRESS'|'FIRST_RETRY'|'SECOND_RETRY'|'COMPLETED'|'FAILED'
}
Response Structure
The ID of the wireless gateway.
The ID of the WirelessGatewayTask.
The date and time when the most recent uplink was received.
The date and time when the task was created.
The status of the request.
Exceptions
Gets information about a wireless gateway task definition.
See also: AWS API Documentation
Request Syntax
response = client.get_wireless_gateway_task_definition(
Id='string'
)
[REQUIRED]
The ID of the resource to get.
{
'AutoCreateTasks': True|False,
'Name': 'string',
'Update': {
'UpdateDataSource': 'string',
'UpdateDataRole': 'string',
'LoRaWAN': {
'UpdateSignature': 'string',
'SigKeyCrc': 123,
'CurrentVersion': {
'PackageVersion': 'string',
'Model': 'string',
'Station': 'string'
},
'UpdateVersion': {
'PackageVersion': 'string',
'Model': 'string',
'Station': 'string'
}
}
},
'Arn': 'string'
}
Response Structure
Whether to automatically create tasks using this task definition for all gateways with the specified current version. If false , the task must me created by calling CreateWirelessGatewayTask .
The name of the resource.
Information about the gateways to update.
The link to the S3 bucket.
The IAM role used to read data from the S3 bucket.
The properties that relate to the LoRaWAN wireless gateway.
The signature used to verify the update firmware.
The CRC of the signature private key to check.
The version of the gateways that should receive the update.
The version of the wireless gateway firmware.
The model number of the wireless gateway.
The basic station version of the wireless gateway.
The firmware version to update the gateway to.
The version of the wireless gateway firmware.
The model number of the wireless gateway.
The basic station version of the wireless gateway.
The Amazon Resource Name of the resource.
Exceptions
Lists the destinations registered to your AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_destinations(
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'NextToken': 'string',
'DestinationList': [
{
'Arn': 'string',
'Name': 'string',
'ExpressionType': 'RuleName'|'MqttTopic',
'Expression': 'string',
'Description': 'string',
'RoleArn': '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.
DestinationList (list) --
The list of destinations.
(dict) --
Describes a destination.
Arn (string) --
The Amazon Resource Name of the resource.
Name (string) --
The name of the resource.
ExpressionType (string) --
The type of value in Expression .
Expression (string) --
The rule name or topic rule to send messages to.
Description (string) --
The description of the resource.
RoleArn (string) --
The ARN of the IAM Role that authorizes the destination.
Exceptions
Lists the device profiles registered to your AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_device_profiles(
NextToken='string',
MaxResults=123
)
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.
Exceptions
Lists the FUOTA tasks registered to your AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_fuota_tasks(
NextToken='string',
MaxResults=123
)
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.
Exceptions
Lists the multicast groups registered to your AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_multicast_groups(
NextToken='string',
MaxResults=123
)
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.
Exceptions
List all multicast groups associated with a fuota task.
See also: AWS API Documentation
Request Syntax
response = client.list_multicast_groups_by_fuota_task(
Id='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The ID of a FUOTA task.
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.
Exceptions
Lists the partner accounts associated with your AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_partner_accounts(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'NextToken': 'string',
'Sidewalk': [
{
'AmazonId': 'string',
'Fingerprint': 'string',
'Arn': '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.
Sidewalk (list) --
The Sidewalk account credentials.
(dict) --
Information about a Sidewalk account.
AmazonId (string) --
The Sidewalk Amazon ID.
Fingerprint (string) --
The fingerprint of the Sidewalk application server private key.
Arn (string) --
The Amazon Resource Name of the resource.
Exceptions
The operation to list queued messages.
See also: AWS API Documentation
Request Syntax
response = client.list_queued_messages(
Id='string',
NextToken='string',
MaxResults=123,
WirelessDeviceType='Sidewalk'|'LoRaWAN'
)
[REQUIRED]
Id of a given wireless device which the downlink packets are targeted
dict
Response Syntax
{
'NextToken': 'string',
'DownlinkQueueMessagesList': [
{
'MessageId': 'string',
'TransmitMode': 123,
'ReceivedAt': 'string',
'LoRaWAN': {
'FPort': 123
}
},
]
}
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.
DownlinkQueueMessagesList (list) --
The messages in downlink queue.
(dict) --
The message in downlink queue.
MessageId (string) --
The messageId allocated by IoT Wireless for tracing purpose
TransmitMode (integer) --
The transmit mode to use to send data to the wireless device. Can be: 0 for UM (unacknowledge mode) or 1 for AM (acknowledge mode).
ReceivedAt (string) --
The timestamp that Iot Wireless received the message.
LoRaWAN (dict) --
LoRaWAN router info.
FPort (integer) --
The Fport value.
Exceptions
Lists the service profiles registered to your AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_service_profiles(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'NextToken': 'string',
'ServiceProfileList': [
{
'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.
ServiceProfileList (list) --
The list of service profiles.
(dict) --
Information about a service profile.
Arn (string) --
The Amazon Resource Name of the resource.
Name (string) --
The name of the resource.
Id (string) --
The ID of the service profile.
Exceptions
Lists the tags (metadata) you have assigned to the resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
[REQUIRED]
The ARN of the resource for which you want to list tags.
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.
A simple label consisting of a customer-defined key-value pair
The tag's key value.
The tag's value.
Exceptions
Lists the wireless devices registered to your AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_wireless_devices(
MaxResults=123,
NextToken='string',
DestinationName='string',
DeviceProfileId='string',
ServiceProfileId='string',
WirelessDeviceType='Sidewalk'|'LoRaWAN',
FuotaTaskId='string',
MulticastGroupId='string'
)
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.
Exceptions
List the wireless gateway tasks definitions registered to your AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_wireless_gateway_task_definitions(
MaxResults=123,
NextToken='string',
TaskDefinitionType='UPDATE'
)
dict
Response Syntax
{
'NextToken': 'string',
'TaskDefinitions': [
{
'Id': 'string',
'LoRaWAN': {
'CurrentVersion': {
'PackageVersion': 'string',
'Model': 'string',
'Station': 'string'
},
'UpdateVersion': {
'PackageVersion': 'string',
'Model': 'string',
'Station': 'string'
}
},
'Arn': '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.
TaskDefinitions (list) --
The list of task definitions.
(dict) --
UpdateWirelessGatewayTaskEntry object.
Id (string) --
The ID of the new wireless gateway task entry.
LoRaWAN (dict) --
The properties that relate to the LoRaWAN wireless gateway.
CurrentVersion (dict) --
The version of the gateways that should receive the update.
PackageVersion (string) --
The version of the wireless gateway firmware.
Model (string) --
The model number of the wireless gateway.
Station (string) --
The basic station version of the wireless gateway.
UpdateVersion (dict) --
The firmware version to update the gateway to.
PackageVersion (string) --
The version of the wireless gateway firmware.
Model (string) --
The model number of the wireless gateway.
Station (string) --
The basic station version of the wireless gateway.
Arn (string) --
The Amazon Resource Name of the resource.
Exceptions
Lists the wireless gateways registered to your AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_wireless_gateways(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'NextToken': 'string',
'WirelessGatewayList': [
{
'Arn': 'string',
'Id': 'string',
'Name': 'string',
'Description': 'string',
'LoRaWAN': {
'GatewayEui': 'string',
'RfRegion': 'string',
'JoinEuiFilters': [
[
'string',
],
],
'NetIdFilters': [
'string',
],
'SubBands': [
123,
]
},
'LastUplinkReceivedAt': '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.
WirelessGatewayList (list) --
The ID of the wireless gateway.
(dict) --
Information about a wireless gateway's operation.
Arn (string) --
The Amazon Resource Name of the resource.
Id (string) --
The ID of the wireless gateway reporting the data.
Name (string) --
The name of the resource.
Description (string) --
The description of the resource.
LoRaWAN (dict) --
LoRaWAN gateway info.
GatewayEui (string) --
The gateway's EUI value.
RfRegion (string) --
The frequency band (RFRegion) value.
JoinEuiFilters (list) --
A list of JoinEuiRange used by LoRa gateways to filter LoRa frames.
(list) --
A pair of join EUI describing a range [BegEui, EndEui], both ends are inclusive.
NetIdFilters (list) --
A list of NetId values that are used by LoRa gateways to filter the uplink frames.
(string) --
LoRaWAN network ID.
SubBands (list) --
A list of integer indicating which sub bands are supported by LoRa gateway.
(integer) --
A subset of supported frequency channels in a certain RFRegion.
LastUplinkReceivedAt (string) --
The date and time when the most recent uplink was received.
Exceptions
Sets the log-level override for a resource-ID and resource-type. This option can be specified for a wireless gateway or a wireless device. A limit of 200 log level override can be set per account.
See also: AWS API Documentation
Request Syntax
response = client.put_resource_log_level(
ResourceIdentifier='string',
ResourceType='string',
LogLevel='INFO'|'ERROR'|'DISABLED'
)
[REQUIRED]
The identifier of the resource. For a Wireless Device, it is the wireless device ID. For a wireless gateway, it is the wireless gateway ID.
[REQUIRED]
The type of the resource, which can be WirelessDevice or WirelessGateway .
[REQUIRED]
The log level for a log message.
dict
Response Syntax
{}
Response Structure
Exceptions
Removes the log-level overrides for all resources; both wireless devices and wireless gateways.
See also: AWS API Documentation
Request Syntax
response = client.reset_all_resource_log_levels()
{}
Response Structure
Exceptions
Removes the log-level override, if any, for a specific resource-ID and resource-type. It can be used for a wireless device or a wireless gateway.
See also: AWS API Documentation
Request Syntax
response = client.reset_resource_log_level(
ResourceIdentifier='string',
ResourceType='string'
)
[REQUIRED]
The identifier of the resource. For a Wireless Device, it is the wireless device ID. For a wireless gateway, it is the wireless gateway ID.
[REQUIRED]
The type of the resource, which can be WirelessDevice or WirelessGateway .
dict
Response Syntax
{}
Response Structure
Exceptions
Sends the specified data to a multicast group.
See also: AWS API Documentation
Request Syntax
response = client.send_data_to_multicast_group(
Id='string',
PayloadData='string',
WirelessMetadata={
'LoRaWAN': {
'FPort': 123
}
}
)
[REQUIRED]
The ID of the multicast group.
[REQUIRED]
The binary to be sent to the end device, encoded in base64.
[REQUIRED]
Wireless metadata that is to be sent to multicast group.
The metadata information of the LoRaWAN multicast group.
The Fport value.
dict
Response Syntax
{
'MessageId': 'string'
}
Response Structure
(dict) --
MessageId (string) --
ID of a multicast group message.
Exceptions
Sends a decrypted application data frame to a device.
See also: AWS API Documentation
Request Syntax
response = client.send_data_to_wireless_device(
Id='string',
TransmitMode=123,
PayloadData='string',
WirelessMetadata={
'LoRaWAN': {
'FPort': 123
},
'Sidewalk': {
'Seq': 123,
'MessageType': 'CUSTOM_COMMAND_ID_NOTIFY'|'CUSTOM_COMMAND_ID_GET'|'CUSTOM_COMMAND_ID_SET'|'CUSTOM_COMMAND_ID_RESP'
}
}
)
[REQUIRED]
The ID of the wireless device to receive the data.
[REQUIRED]
The transmit mode to use to send data to the wireless device. Can be: 0 for UM (unacknowledge mode) or 1 for AM (acknowledge mode).
[REQUIRED]
The binary to be sent to the end device, encoded in base64.
Metadata about the message request.
LoRaWAN device info.
The Fport value.
The Sidewalk account credentials.
The sequence number.
Sidewalk device message type. Default value is CUSTOM_COMMAND_ID_NOTIFY .
dict
Response Syntax
{
'MessageId': 'string'
}
Response Structure
(dict) --
MessageId (string) --
The ID of the message sent to the wireless device.
Exceptions
Starts a bulk association of all qualifying wireless devices with a multicast group.
See also: AWS API Documentation
Request Syntax
response = client.start_bulk_associate_wireless_device_with_multicast_group(
Id='string',
QueryString='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The ID of the multicast group.
The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.
A simple label consisting of a customer-defined key-value pair
The tag's key value.
The tag's value.
dict
Response Syntax
{}
Response Structure
Exceptions
Starts a bulk disassociatin of all qualifying wireless devices from a multicast group.
See also: AWS API Documentation
Request Syntax
response = client.start_bulk_disassociate_wireless_device_from_multicast_group(
Id='string',
QueryString='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The ID of the multicast group.
The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.
A simple label consisting of a customer-defined key-value pair
The tag's key value.
The tag's value.
dict
Response Syntax
{}
Response Structure
Exceptions
Starts a FUOTA task.
See also: AWS API Documentation
Request Syntax
response = client.start_fuota_task(
Id='string',
LoRaWAN={
'StartTime': datetime(2015, 1, 1)
}
)
[REQUIRED]
The ID of a FUOTA task.
The LoRaWAN information used to start a FUOTA task.
Start time of a FUOTA task.
dict
Response Syntax
{}
Response Structure
Exceptions
Starts a multicast group session.
See also: AWS API Documentation
Request Syntax
response = client.start_multicast_group_session(
Id='string',
LoRaWAN={
'DlDr': 123,
'DlFreq': 123,
'SessionStartTime': datetime(2015, 1, 1),
'SessionTimeout': 123
}
)
[REQUIRED]
The ID of the multicast group.
[REQUIRED]
The LoRaWAN information used with the multicast session.
Downlink data rate.
Downlink frequency.
Timestamp of when the multicast group session is to start.
How long before a multicast group session is to timeout.
dict
Response Syntax
{}
Response Structure
Exceptions
Adds a tag to a resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The ARN of the resource to add tags to.
[REQUIRED]
Adds to or modifies the tags of the given resource. Tags are metadata that you can use to manage a resource.
A simple label consisting of a customer-defined key-value pair
The tag's key value.
The tag's value.
dict
Response Syntax
{}
Response Structure
Exceptions
Simulates a provisioned device by sending an uplink data payload of Hello .
See also: AWS API Documentation
Request Syntax
response = client.test_wireless_device(
Id='string'
)
[REQUIRED]
The ID of the wireless device to test.
{
'Result': 'string'
}
Response Structure
The result returned by the test.
Exceptions
Removes one or more tags from a resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The ARN of the resource to remove tags from.
[REQUIRED]
A list of the keys of the tags to remove from the resource.
dict
Response Syntax
{}
Response Structure
Exceptions
Updates properties of a destination.
See also: AWS API Documentation
Request Syntax
response = client.update_destination(
Name='string',
ExpressionType='RuleName'|'MqttTopic',
Expression='string',
Description='string',
RoleArn='string'
)
[REQUIRED]
The new name of the resource.
dict
Response Syntax
{}
Response Structure
Exceptions
Updates properties of a FUOTA task.
See also: AWS API Documentation
Request Syntax
response = client.update_fuota_task(
Id='string',
Name='string',
Description='string',
LoRaWAN={
'RfRegion': 'EU868'|'US915'|'AU915'|'AS923-1'
},
FirmwareUpdateImage='string',
FirmwareUpdateRole='string'
)
[REQUIRED]
The ID of a FUOTA task.
The LoRaWAN information used with a FUOTA task.
Supported RfRegions
dict
Response Syntax
{}
Response Structure
Exceptions
Set default log level, or log levels by resource types. This can be for wireless device log options or wireless gateways log options and is used to control the log messages that'll be displayed in CloudWatch.
See also: AWS API Documentation
Request Syntax
response = client.update_log_levels_by_resource_types(
DefaultLogLevel='INFO'|'ERROR'|'DISABLED',
WirelessDeviceLogOptions=[
{
'Type': 'Sidewalk'|'LoRaWAN',
'LogLevel': 'INFO'|'ERROR'|'DISABLED',
'Events': [
{
'Event': 'Join'|'Rejoin'|'Uplink_Data'|'Downlink_Data'|'Registration',
'LogLevel': 'INFO'|'ERROR'|'DISABLED'
},
]
},
],
WirelessGatewayLogOptions=[
{
'Type': 'LoRaWAN',
'LogLevel': 'INFO'|'ERROR'|'DISABLED',
'Events': [
{
'Event': 'CUPS_Request'|'Certificate',
'LogLevel': 'INFO'|'ERROR'|'DISABLED'
},
]
},
]
)
The list of wireless device log options.
The log options for wireless devices and can be used to set log levels for a specific type of wireless device.
The wireless device type.
The log level for a log message.
The list of wireless device event log options.
The log options for a wireless device event and can be used to set log levels for a specific wireless device event.
For a LoRaWAN device, possible events for a log messsage are: Join , Rejoin , Downlink_Data , and Uplink_Data . For a Sidewalk device, possible events for a log message are Registration , Downlink_Data , and Uplink_Data .
The event for a log message, if the log message is tied to a wireless device.
The log level for a log message.
The list of wireless gateway log options.
The log options for wireless gateways and can be used to set log levels for a specific type of wireless gateway.
The wireless gateway type.
The log level for a log message.
The list of wireless gateway event log options.
The log options for a wireless gateway event and can be used to set log levels for a specific wireless gateway event.
For a LoRaWAN gateway, possible events for a log message are CUPS_Request and Certificate .
The event for a log message, if the log message is tied to a wireless gateway.
The log level for a log message.
dict
Response Syntax
{}
Response Structure
Exceptions
Updates properties of a multicast group session.
See also: AWS API Documentation
Request Syntax
response = client.update_multicast_group(
Id='string',
Name='string',
Description='string',
LoRaWAN={
'RfRegion': 'EU868'|'US915'|'AU915'|'AS923-1',
'DlClass': 'ClassB'|'ClassC'
}
)
[REQUIRED]
The ID of the multicast group.
The LoRaWAN information that is to be used with the multicast group.
Supported RfRegions
DlClass for LoRaWAM, valid values are ClassB and ClassC.
dict
Response Syntax
{}
Response Structure
Exceptions
Update NetworkAnalyzer configuration.
See also: AWS API Documentation
Request Syntax
response = client.update_network_analyzer_configuration(
ConfigurationName='string',
TraceContent={
'WirelessDeviceFrameInfo': 'ENABLED'|'DISABLED',
'LogLevel': 'INFO'|'ERROR'|'DISABLED'
},
WirelessDevicesToAdd=[
'string',
],
WirelessDevicesToRemove=[
'string',
],
WirelessGatewaysToAdd=[
'string',
],
WirelessGatewaysToRemove=[
'string',
]
)
[REQUIRED]
NetworkAnalyzer configuration name.
Trace Content for resources.
WirelessDevice FrameInfo for trace content.
The log level for a log message.
WirelessDevices to add into NetworkAnalyzerConfiguration.
The ID of the wireless device.
WirelessDevices to remove from NetworkAnalyzerConfiguration.
The ID of the wireless device.
WirelessGateways to add into NetworkAnalyzerConfiguration.
WirelessGateways to remove from NetworkAnalyzerConfiguration.
dict
Response Syntax
{}
Response Structure
Exceptions
Updates properties of a partner account.
See also: AWS API Documentation
Request Syntax
response = client.update_partner_account(
Sidewalk={
'AppServerPrivateKey': 'string'
},
PartnerAccountId='string',
PartnerType='Sidewalk'
)
[REQUIRED]
The Sidewalk account credentials.
The new Sidewalk application server private key.
[REQUIRED]
The ID of the partner account to update.
[REQUIRED]
The partner type.
dict
Response Syntax
{}
Response Structure
Exceptions
Update the event configuration for a particular resource identifier.
See also: AWS API Documentation
Request Syntax
response = client.update_resource_event_configuration(
Identifier='string',
IdentifierType='PartnerAccountId',
PartnerType='Sidewalk',
DeviceRegistrationState={
'Sidewalk': {
'AmazonIdEventTopic': 'Enabled'|'Disabled'
}
},
Proximity={
'Sidewalk': {
'AmazonIdEventTopic': 'Enabled'|'Disabled'
}
}
)
[REQUIRED]
Resource identifier to opt in for event messaging.
[REQUIRED]
Identifier type of the particular resource identifier for event configuration.
Event configuration for the device registration state event
Device registration state event configuration object for enabling or disabling Sidewalk related event topics.
Enum to denote whether amazon id event topic is enabled or disabled.
Event configuration for the Proximity event
Proximity event configuration object for enabling or disabling Sidewalk related event topics.
Enum to denote whether amazon id event topic is enabled or disabled.
dict
Response Syntax
{}
Response Structure
Exceptions
Updates properties of a wireless device.
See also: AWS API Documentation
Request Syntax
response = client.update_wireless_device(
Id='string',
DestinationName='string',
Name='string',
Description='string',
LoRaWAN={
'DeviceProfileId': 'string',
'ServiceProfileId': 'string'
}
)
[REQUIRED]
The ID of the resource to update.
The updated wireless device's configuration.
The ID of the device profile for the wireless device.
The ID of the service profile.
dict
Response Syntax
{}
Response Structure
Exceptions
Updates properties of a wireless gateway.
See also: AWS API Documentation
Request Syntax
response = client.update_wireless_gateway(
Id='string',
Name='string',
Description='string',
JoinEuiFilters=[
[
'string',
],
],
NetIdFilters=[
'string',
]
)
[REQUIRED]
The ID of the resource to update.
A list of JoinEuiRange used by LoRa gateways to filter LoRa frames.
A pair of join EUI describing a range [BegEui, EndEui], both ends are inclusive.
A list of NetId values that are used by LoRa gateways to filter the uplink frames.
LoRaWAN network ID.
dict
Response Syntax
{}
Response Structure
Exceptions
The available paginators are: