2024/11/14 - AWS IoT Wireless - 11 updated api methods
Changes New FuotaTask resource type to enable logging for your FUOTA tasks. A ParticipatingGatewaysforMulticast parameter to choose the list of gateways to receive the multicast downlink message and the transmission interval between them. Descriptor field which will be sent to devices during FUOTA transfer.
{'Descriptor': 'string'}
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,
Descriptor='string'
)
string
The name of a FUOTA task.
string
The description of the new resource.
string
Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.
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 the added fragments that are redundant. For example, if the size of the firmware image file is 100 bytes and the 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. This parameter is supported only for FUOTA tasks with multicast groups.
integer
The interval for sending fragments in milliseconds, rounded to the nearest second.
string
The Descriptor specifies some metadata about the File being transferred using FUOTA e.g. the software version. It is sent transparently to the device. It is a binary field encoded in base64
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': {'ParticipatingGateways': {'GatewayList': ['string'],
'TransmissionInterval': 'integer'}}}
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',
'ParticipatingGateways': {
'GatewayList': [
'string',
],
'TransmissionInterval': 123
}
},
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. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.
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.
ParticipatingGateways (dict) --
Specify the list of gateways to which you want to send the multicast downlink messages. The multicast message will be sent to each gateway in the sequence provided in the list.
GatewayList (list) --
The list of gateways that you want to use for sending the multicast downlink. Each downlink will be sent to all the gateways in the list with transmission interval between them. If list is empty the gateway list will be dynamically selected similar to the case of no ParticipatingGateways
(string) --
TransmissionInterval (integer) --
The duration of time for which AWS IoT Core for LoRaWAN will wait before transmitting the multicast payload to the next gateway in the list.
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.
{'Descriptor': 'string'}
Gets information about a FUOTA task.
See also: AWS API Documentation
Request Syntax
client.get_fuota_task(
Id='string'
)
string
[REQUIRED]
The ID of a FUOTA task.
dict
Response Syntax
{
'Arn': 'string',
'Id': 'string',
'Status': 'Pending'|'FuotaSession_Waiting'|'In_FuotaSession'|'FuotaDone'|'Delete_Waiting',
'Name': 'string',
'Description': 'string',
'LoRaWAN': {
'RfRegion': 'string',
'StartTime': datetime(2015, 1, 1)
},
'FirmwareUpdateImage': 'string',
'FirmwareUpdateRole': 'string',
'CreatedAt': datetime(2015, 1, 1),
'RedundancyPercent': 123,
'FragmentSizeBytes': 123,
'FragmentIntervalMS': 123,
'Descriptor': 'string'
}
Response Structure
(dict) --
Arn (string) --
The arn of a FUOTA task.
Id (string) --
The ID of a FUOTA task.
Status (string) --
The status of a FUOTA task.
Name (string) --
The name of a FUOTA task.
Description (string) --
The description of the new resource.
LoRaWAN (dict) --
The LoRaWAN information returned from getting a FUOTA task.
RfRegion (string) --
The frequency band (RFRegion) value.
StartTime (datetime) --
Start time of a FUOTA task.
FirmwareUpdateImage (string) --
The S3 URI points to a firmware update image that is to be used with a FUOTA task.
FirmwareUpdateRole (string) --
The firmware update role that is to be used with a FUOTA task.
CreatedAt (datetime) --
Created at timestamp for the resource.
RedundancyPercent (integer) --
The percentage of the added fragments that are redundant. For example, if the size of the firmware image file is 100 bytes and the fragment size is 10 bytes, with RedundancyPercent set to 50(%), the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.
FragmentSizeBytes (integer) --
The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.
FragmentIntervalMS (integer) --
The interval for sending fragments in milliseconds, rounded to the nearest second.
Descriptor (string) --
The Descriptor specifies some metadata about the File being transferred using FUOTA e.g. the software version. It is sent transparently to the device. It is a binary field encoded in base64
{'FuotaTaskLogOptions': [{'Events': [{'Event': 'Fuota',
'LogLevel': 'INFO | ERROR | DISABLED'}],
'LogLevel': 'INFO | ERROR | DISABLED',
'Type': 'LoRaWAN'}]}
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
client.get_log_levels_by_resource_types()
dict
Response Syntax
{
'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'
},
]
},
],
'FuotaTaskLogOptions': [
{
'Type': 'LoRaWAN',
'LogLevel': 'INFO'|'ERROR'|'DISABLED',
'Events': [
{
'Event': 'Fuota',
'LogLevel': 'INFO'|'ERROR'|'DISABLED'
},
]
},
]
}
Response Structure
(dict) --
DefaultLogLevel (string) --
The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.
WirelessGatewayLogOptions (list) --
The list of wireless gateway log options.
(dict) --
The log options for wireless gateways and can be used to set log levels for a specific type of wireless gateway.
Type (string) --
The wireless gateway type.
LogLevel (string) --
The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.
Events (list) --
The list of wireless gateway event log options.
(dict) --
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.
Event (string) --
The event for a log message, if the log message is tied to a wireless gateway.
LogLevel (string) --
The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.
WirelessDeviceLogOptions (list) --
The list of wireless device log options.
(dict) --
The log options for wireless devices and can be used to set log levels for a specific type of wireless device.
Type (string) --
The wireless device type.
LogLevel (string) --
The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.
Events (list) --
The list of wireless device event log options.
(dict) --
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.
Event (string) --
The event for a log message, if the log message is tied to a wireless device.
LogLevel (string) --
The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.
FuotaTaskLogOptions (list) --
The list of fuota task log options.
(dict) --
The log options for fuota tasks and can be used to set log levels for a specific type of fuota task.
Type (string) --
The fuota task type.
LogLevel (string) --
The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.
Events (list) --
The list of FUOTA task event log options.
(dict) --
The log options for a FUOTA task event and can be used to set log levels for a specific fuota task event.
For a LoRaWAN FuotaTask type, possible event for a log message is Fuota.
Event (string) --
The event for a log message, if the log message is tied to a fuota task.
LogLevel (string) --
The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.
{'LoRaWAN': {'ParticipatingGateways': {'GatewayList': ['string'],
'TransmissionInterval': 'integer'}}}
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,
'ParticipatingGateways': {
'GatewayList': [
'string',
],
'TransmissionInterval': 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.
ParticipatingGateways (dict) --
Specify the list of gateways to which you want to send the multicast downlink messages. The multicast message will be sent to each gateway in the sequence provided in the list.
GatewayList (list) --
The list of gateways that you want to use for sending the multicast downlink. Each downlink will be sent to all the gateways in the list with transmission interval between them. If list is empty the gateway list will be dynamically selected similar to the case of no ParticipatingGateways
(string) --
TransmissionInterval (integer) --
The duration of time for which AWS IoT Core for LoRaWAN will wait before transmitting the multicast payload to the next gateway in the list.
CreatedAt (datetime) --
Created at timestamp for the resource.
{'IdentifierType': {'FuotaTaskId'}}
Get the event configuration for a particular resource identifier.
See also: AWS API Documentation
Request Syntax
client.get_resource_event_configuration(
Identifier='string',
IdentifierType='PartnerAccountId'|'DevEui'|'FuotaTaskId'|'GatewayEui'|'WirelessDeviceId'|'WirelessGatewayId',
PartnerType='Sidewalk'
)
string
[REQUIRED]
Resource identifier to opt in for event messaging.
string
[REQUIRED]
Identifier type of the particular resource identifier for event configuration.
string
Partner type of the resource if the identifier type is PartnerAccountId.
dict
Response Syntax
{
'DeviceRegistrationState': {
'Sidewalk': {
'AmazonIdEventTopic': 'Enabled'|'Disabled'
},
'WirelessDeviceIdEventTopic': 'Enabled'|'Disabled'
},
'Proximity': {
'Sidewalk': {
'AmazonIdEventTopic': 'Enabled'|'Disabled'
},
'WirelessDeviceIdEventTopic': 'Enabled'|'Disabled'
},
'Join': {
'LoRaWAN': {
'DevEuiEventTopic': 'Enabled'|'Disabled'
},
'WirelessDeviceIdEventTopic': 'Enabled'|'Disabled'
},
'ConnectionStatus': {
'LoRaWAN': {
'GatewayEuiEventTopic': 'Enabled'|'Disabled'
},
'WirelessGatewayIdEventTopic': 'Enabled'|'Disabled'
},
'MessageDeliveryStatus': {
'Sidewalk': {
'AmazonIdEventTopic': 'Enabled'|'Disabled'
},
'WirelessDeviceIdEventTopic': '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) --
Denotes whether the Amazon ID event topic is enabled or disabled.
WirelessDeviceIdEventTopic (string) --
Denotes whether the wireless device ID device registration state 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) --
Denotes whether the Amazon ID event topic is enabled or disabled.
WirelessDeviceIdEventTopic (string) --
Denotes whether the wireless device ID proximity event topic is enabled or disabled.
Join (dict) --
Event configuration for the join event.
LoRaWAN (dict) --
Join event configuration object for enabling or disabling LoRaWAN related event topics.
DevEuiEventTopic (string) --
Denotes whether the Dev EUI join event topic is enabled or disabled.
WirelessDeviceIdEventTopic (string) --
Denotes whether the wireless device ID join event topic is enabled or disabled.
ConnectionStatus (dict) --
Event configuration for the connection status event.
LoRaWAN (dict) --
Connection status event configuration object for enabling or disabling LoRaWAN related event topics.
GatewayEuiEventTopic (string) --
Denotes whether the gateway EUI connection status event topic is enabled or disabled.
WirelessGatewayIdEventTopic (string) --
Denotes whether the wireless gateway ID connection status event topic is enabled or disabled.
MessageDeliveryStatus (dict) --
Event configuration for the message delivery status event.
Sidewalk (dict) --
SidewalkEventNotificationConfigurations object, which is the event configuration object for Sidewalk-related event topics.
AmazonIdEventTopic (string) --
Denotes whether the Amazon ID event topic is enabled or disabled.
WirelessDeviceIdEventTopic (string) --
Denotes whether the wireless device ID message delivery status event topic is enabled or disabled.
{'ResourceType': {'FuotaTask'}}
Response {'EventConfigurationsList': {'IdentifierType': {'FuotaTaskId'}}}
List event configurations where at least one event topic has been enabled.
See also: AWS API Documentation
Request Syntax
client.list_event_configurations(
ResourceType='FuotaTask'|'SidewalkAccount'|'WirelessDevice'|'WirelessGateway',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
Resource type to filter event configurations.
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',
'EventConfigurationsList': [
{
'Identifier': 'string',
'IdentifierType': 'PartnerAccountId'|'DevEui'|'FuotaTaskId'|'GatewayEui'|'WirelessDeviceId'|'WirelessGatewayId',
'PartnerType': 'Sidewalk',
'Events': {
'DeviceRegistrationState': {
'Sidewalk': {
'AmazonIdEventTopic': 'Enabled'|'Disabled'
},
'WirelessDeviceIdEventTopic': 'Enabled'|'Disabled'
},
'Proximity': {
'Sidewalk': {
'AmazonIdEventTopic': 'Enabled'|'Disabled'
},
'WirelessDeviceIdEventTopic': 'Enabled'|'Disabled'
},
'Join': {
'LoRaWAN': {
'DevEuiEventTopic': 'Enabled'|'Disabled'
},
'WirelessDeviceIdEventTopic': 'Enabled'|'Disabled'
},
'ConnectionStatus': {
'LoRaWAN': {
'GatewayEuiEventTopic': 'Enabled'|'Disabled'
},
'WirelessGatewayIdEventTopic': 'Enabled'|'Disabled'
},
'MessageDeliveryStatus': {
'Sidewalk': {
'AmazonIdEventTopic': 'Enabled'|'Disabled'
},
'WirelessDeviceIdEventTopic': 'Enabled'|'Disabled'
}
}
},
]
}
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.
EventConfigurationsList (list) --
Event configurations of all events for a single resource.
(dict) --
Event configuration object for a single resource.
Identifier (string) --
Resource identifier opted in for event messaging.
IdentifierType (string) --
Identifier type of the particular resource identifier for event configuration.
PartnerType (string) --
Partner type of the resource if the identifier type is PartnerAccountId.
Events (dict) --
Object of all event configurations and the status of the event topics.
DeviceRegistrationState (dict) --
Device registration state event configuration for an event configuration item.
Sidewalk (dict) --
Device registration state event configuration object for enabling or disabling Sidewalk related event topics.
AmazonIdEventTopic (string) --
Denotes whether the Amazon ID event topic is enabled or disabled.
WirelessDeviceIdEventTopic (string) --
Denotes whether the wireless device ID device registration state event topic is enabled or disabled.
Proximity (dict) --
Proximity event configuration for an event configuration item.
Sidewalk (dict) --
Proximity event configuration object for enabling or disabling Sidewalk related event topics.
AmazonIdEventTopic (string) --
Denotes whether the Amazon ID event topic is enabled or disabled.
WirelessDeviceIdEventTopic (string) --
Denotes whether the wireless device ID proximity event topic is enabled or disabled.
Join (dict) --
Join event configuration for an event configuration item.
LoRaWAN (dict) --
Join event configuration object for enabling or disabling LoRaWAN related event topics.
DevEuiEventTopic (string) --
Denotes whether the Dev EUI join event topic is enabled or disabled.
WirelessDeviceIdEventTopic (string) --
Denotes whether the wireless device ID join event topic is enabled or disabled.
ConnectionStatus (dict) --
Connection status event configuration for an event configuration item.
LoRaWAN (dict) --
Connection status event configuration object for enabling or disabling LoRaWAN related event topics.
GatewayEuiEventTopic (string) --
Denotes whether the gateway EUI connection status event topic is enabled or disabled.
WirelessGatewayIdEventTopic (string) --
Denotes whether the wireless gateway ID connection status event topic is enabled or disabled.
MessageDeliveryStatus (dict) --
Message delivery status event configuration for an event configuration item.
Sidewalk (dict) --
SidewalkEventNotificationConfigurations object, which is the event configuration object for Sidewalk-related event topics.
AmazonIdEventTopic (string) --
Denotes whether the Amazon ID event topic is enabled or disabled.
WirelessDeviceIdEventTopic (string) --
Denotes whether the wireless device ID message delivery status event topic is enabled or disabled.
{'Descriptor': 'string'}
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,
Descriptor='string'
)
string
[REQUIRED]
The ID of a FUOTA task.
string
The name of a FUOTA task.
string
The description of the new resource.
dict
The LoRaWAN information used with a FUOTA task.
RfRegion (string) --
Supported RfRegions
string
The S3 URI points to a firmware update image that is to be used with a FUOTA task.
string
The firmware update role that is to be used with a FUOTA task.
integer
The percentage of the added fragments that are redundant. For example, if the size of the firmware image file is 100 bytes and the 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. This parameter is supported only for FUOTA tasks with multicast groups.
integer
The interval for sending fragments in milliseconds, rounded to the nearest second.
string
The Descriptor specifies some metadata about the File being transferred using FUOTA e.g. the software version. It is sent transparently to the device. It is a binary field encoded in base64
dict
Response Syntax
{}
Response Structure
(dict) --
{'FuotaTaskLogOptions': [{'Events': [{'Event': 'Fuota',
'LogLevel': 'INFO | ERROR | DISABLED'}],
'LogLevel': 'INFO | ERROR | DISABLED',
'Type': 'LoRaWAN'}]}
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
client.update_log_levels_by_resource_types(
DefaultLogLevel='INFO'|'ERROR'|'DISABLED',
FuotaTaskLogOptions=[
{
'Type': 'LoRaWAN',
'LogLevel': 'INFO'|'ERROR'|'DISABLED',
'Events': [
{
'Event': 'Fuota',
'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'
},
]
},
],
WirelessGatewayLogOptions=[
{
'Type': 'LoRaWAN',
'LogLevel': 'INFO'|'ERROR'|'DISABLED',
'Events': [
{
'Event': 'CUPS_Request'|'Certificate',
'LogLevel': 'INFO'|'ERROR'|'DISABLED'
},
]
},
]
)
string
The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.
list
The list of fuota task log options.
(dict) --
The log options for fuota tasks and can be used to set log levels for a specific type of fuota task.
Type (string) -- [REQUIRED]
The fuota task type.
LogLevel (string) -- [REQUIRED]
The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.
Events (list) --
The list of FUOTA task event log options.
(dict) --
The log options for a FUOTA task event and can be used to set log levels for a specific fuota task event.
For a LoRaWAN FuotaTask type, possible event for a log message is Fuota.
Event (string) -- [REQUIRED]
The event for a log message, if the log message is tied to a fuota task.
LogLevel (string) -- [REQUIRED]
The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.
list
The list of wireless device log options.
(dict) --
The log options for wireless devices and can be used to set log levels for a specific type of wireless device.
Type (string) -- [REQUIRED]
The wireless device type.
LogLevel (string) -- [REQUIRED]
The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.
Events (list) --
The list of wireless device event log options.
(dict) --
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.
Event (string) -- [REQUIRED]
The event for a log message, if the log message is tied to a wireless device.
LogLevel (string) -- [REQUIRED]
The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.
list
The list of wireless gateway log options.
(dict) --
The log options for wireless gateways and can be used to set log levels for a specific type of wireless gateway.
Type (string) -- [REQUIRED]
The wireless gateway type.
LogLevel (string) -- [REQUIRED]
The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.
Events (list) --
The list of wireless gateway event log options.
(dict) --
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.
Event (string) -- [REQUIRED]
The event for a log message, if the log message is tied to a wireless gateway.
LogLevel (string) -- [REQUIRED]
The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.
dict
Response Syntax
{}
Response Structure
(dict) --
{'LoRaWAN': {'ParticipatingGateways': {'GatewayList': ['string'],
'TransmissionInterval': 'integer'}}}
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',
'ParticipatingGateways': {
'GatewayList': [
'string',
],
'TransmissionInterval': 123
}
}
)
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.
ParticipatingGateways (dict) --
Specify the list of gateways to which you want to send the multicast downlink messages. The multicast message will be sent to each gateway in the sequence provided in the list.
GatewayList (list) --
The list of gateways that you want to use for sending the multicast downlink. Each downlink will be sent to all the gateways in the list with transmission interval between them. If list is empty the gateway list will be dynamically selected similar to the case of no ParticipatingGateways
(string) --
TransmissionInterval (integer) --
The duration of time for which AWS IoT Core for LoRaWAN will wait before transmitting the multicast payload to the next gateway in the list.
dict
Response Syntax
{}
Response Structure
(dict) --
{'IdentifierType': {'FuotaTaskId'}}
Update the event configuration for a particular resource identifier.
See also: AWS API Documentation
Request Syntax
client.update_resource_event_configuration(
Identifier='string',
IdentifierType='PartnerAccountId'|'DevEui'|'FuotaTaskId'|'GatewayEui'|'WirelessDeviceId'|'WirelessGatewayId',
PartnerType='Sidewalk',
DeviceRegistrationState={
'Sidewalk': {
'AmazonIdEventTopic': 'Enabled'|'Disabled'
},
'WirelessDeviceIdEventTopic': 'Enabled'|'Disabled'
},
Proximity={
'Sidewalk': {
'AmazonIdEventTopic': 'Enabled'|'Disabled'
},
'WirelessDeviceIdEventTopic': 'Enabled'|'Disabled'
},
Join={
'LoRaWAN': {
'DevEuiEventTopic': 'Enabled'|'Disabled'
},
'WirelessDeviceIdEventTopic': 'Enabled'|'Disabled'
},
ConnectionStatus={
'LoRaWAN': {
'GatewayEuiEventTopic': 'Enabled'|'Disabled'
},
'WirelessGatewayIdEventTopic': 'Enabled'|'Disabled'
},
MessageDeliveryStatus={
'Sidewalk': {
'AmazonIdEventTopic': 'Enabled'|'Disabled'
},
'WirelessDeviceIdEventTopic': 'Enabled'|'Disabled'
}
)
string
[REQUIRED]
Resource identifier to opt in for event messaging.
string
[REQUIRED]
Identifier type of the particular resource identifier for event configuration.
string
Partner type of the resource if the identifier type is PartnerAccountId
dict
Event configuration for the device registration state event.
Sidewalk (dict) --
Device registration state event configuration object for enabling or disabling Sidewalk related event topics.
AmazonIdEventTopic (string) --
Denotes whether the Amazon ID event topic is enabled or disabled.
WirelessDeviceIdEventTopic (string) --
Denotes whether the wireless device ID device registration state event topic is enabled or disabled.
dict
Event configuration for the proximity event.
Sidewalk (dict) --
Proximity event configuration object for enabling or disabling Sidewalk related event topics.
AmazonIdEventTopic (string) --
Denotes whether the Amazon ID event topic is enabled or disabled.
WirelessDeviceIdEventTopic (string) --
Denotes whether the wireless device ID proximity event topic is enabled or disabled.
dict
Event configuration for the join event.
LoRaWAN (dict) --
Join event configuration object for enabling or disabling LoRaWAN related event topics.
DevEuiEventTopic (string) --
Denotes whether the Dev EUI join event topic is enabled or disabled.
WirelessDeviceIdEventTopic (string) --
Denotes whether the wireless device ID join event topic is enabled or disabled.
dict
Event configuration for the connection status event.
LoRaWAN (dict) --
Connection status event configuration object for enabling or disabling LoRaWAN related event topics.
GatewayEuiEventTopic (string) --
Denotes whether the gateway EUI connection status event topic is enabled or disabled.
WirelessGatewayIdEventTopic (string) --
Denotes whether the wireless gateway ID connection status event topic is enabled or disabled.
dict
Event configuration for the message delivery status event.
Sidewalk (dict) --
SidewalkEventNotificationConfigurations object, which is the event configuration object for Sidewalk-related event topics.
AmazonIdEventTopic (string) --
Denotes whether the Amazon ID event topic is enabled or disabled.
WirelessDeviceIdEventTopic (string) --
Denotes whether the wireless device ID message delivery status event topic is enabled or disabled.
dict
Response Syntax
{}
Response Structure
(dict) --