AWS API Changes

2022/04/27 - AWS IoT Wireless - 6 new 7 updated api methods

Changes Add list support for event configurations, allow to get and update event configurations by resource type, support LoRaWAN events; Make NetworkAnalyzerConfiguration as a resource, add List, Create, Delete API support; Add FCntStart attribute support for ABP WirelessDevice.

UpdateEventConfigurationByResourceTypes (new)

Link ¶

Update the event configuration by resource types.

See also: AWS API Documentation

Request Syntax

client.update_event_configuration_by_resource_types(
    DeviceRegistrationState={
        'Sidewalk': {
            'WirelessDeviceEventTopic': 'Enabled'|'Disabled'
        }
    },
    Proximity={
        'Sidewalk': {
            'WirelessDeviceEventTopic': 'Enabled'|'Disabled'
        }
    },
    Join={
        'LoRaWAN': {
            'WirelessDeviceEventTopic': 'Enabled'|'Disabled'
        }
    },
    ConnectionStatus={
        'LoRaWAN': {
            'WirelessGatewayEventTopic': 'Enabled'|'Disabled'
        }
    }
)

type DeviceRegistrationState

dict

param DeviceRegistrationState

Device registration state resource type event configuration object for enabling and disabling wireless gateway topic.

Sidewalk (dict) --

Device registration resource type state event configuration object for enabling or disabling Sidewalk related event topics.
- WirelessDeviceEventTopic (string) --
  
  Enum to denote whether the wireless device join event topic is enabled or disabled.

type Proximity

dict

param Proximity

Proximity resource type event configuration object for enabling and disabling wireless gateway topic.

Sidewalk (dict) --

Proximity resource type event configuration object for enabling and disabling wireless device topic.
- WirelessDeviceEventTopic (string) --
  
  Enum to denote whether the wireless device join event topic is enabled or disabled.

type Join

dict

param Join

Join resource type event configuration object for enabling and disabling wireless device topic.

LoRaWAN (dict) --

Join resource type event configuration object for enabling or disabling LoRaWAN related event topics.
- WirelessDeviceEventTopic (string) --
  
  Enum to denote whether the wireless device join event topic is enabled or disabled.

type ConnectionStatus

dict

param ConnectionStatus

Connection status resource type event configuration object for enabling and disabling wireless gateway topic.

LoRaWAN (dict) --

Connection status resource type event configuration object for enabling or disabling LoRaWAN related event topics.
- WirelessGatewayEventTopic (string) --
  
  Enum to denote whether the wireless gateway connection status event topic is enabled or disabled.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

GetEventConfigurationByResourceTypes (new)

Link ¶

Get the event configuration by resource types.

See also: AWS API Documentation

Request Syntax

client.get_event_configuration_by_resource_types()

rtype

dict

returns

Response Syntax

{
    'DeviceRegistrationState': {
        'Sidewalk': {
            'WirelessDeviceEventTopic': 'Enabled'|'Disabled'
        }
    },
    'Proximity': {
        'Sidewalk': {
            'WirelessDeviceEventTopic': 'Enabled'|'Disabled'
        }
    },
    'Join': {
        'LoRaWAN': {
            'WirelessDeviceEventTopic': 'Enabled'|'Disabled'
        }
    },
    'ConnectionStatus': {
        'LoRaWAN': {
            'WirelessGatewayEventTopic': 'Enabled'|'Disabled'
        }
    }
}

Response Structure

(dict) --
- DeviceRegistrationState (dict) --
  
  Resource type event configuration for the device registration state event
  - Sidewalk (dict) --
    
    Device registration resource type state event configuration object for enabling or disabling Sidewalk related event topics.
    - WirelessDeviceEventTopic (string) --
      
      Enum to denote whether the wireless device join event topic is enabled or disabled.
- Proximity (dict) --
  
  Resource type event configuration for the proximity event
  - Sidewalk (dict) --
    
    Proximity resource type event configuration object for enabling and disabling wireless device topic.
    - WirelessDeviceEventTopic (string) --
      
      Enum to denote whether the wireless device join event topic is enabled or disabled.
- Join (dict) --
  
  Resource type event configuration for the join event
  - LoRaWAN (dict) --
    
    Join resource type event configuration object for enabling or disabling LoRaWAN related event topics.
    - WirelessDeviceEventTopic (string) --
      
      Enum to denote whether the wireless device join event topic is enabled or disabled.
- ConnectionStatus (dict) --
  
  Resource type event configuration for the connection status event
  - LoRaWAN (dict) --
    
    Connection status resource type event configuration object for enabling or disabling LoRaWAN related event topics.
    - WirelessGatewayEventTopic (string) --
      
      Enum to denote whether the wireless gateway connection status event topic is enabled or disabled.

ListNetworkAnalyzerConfigurations (new)

Link ¶

Lists the network analyzer configurations.

See also: AWS API Documentation

Request Syntax

client.list_network_analyzer_configurations(
    MaxResults=123,
    NextToken='string'
)

type MaxResults

integer

param MaxResults

The maximum number of results to return in this operation.

type NextToken

string

param NextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'NetworkAnalyzerConfigurationList': [
        {
            'Arn': 'string',
            'Name': '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.
- NetworkAnalyzerConfigurationList (list) --
  
  The list of network analyzer configurations.
  - (dict) --
    
    Network analyzer configurations.
    - Arn (string) --
      
      The Amazon Resource Name of the new resource.
    - Name (string) --
      
      Name of the network analyzer configuration.

ListEventConfigurations (new)

Link ¶

List event configurations where at least one event topic has been enabled.

See also: AWS API Documentation

Request Syntax

client.list_event_configurations(
    ResourceType='SidewalkAccount'|'WirelessDevice'|'WirelessGateway',
    MaxResults=123,
    NextToken='string'
)

type ResourceType

string

param ResourceType

[REQUIRED]

Resource type to filter event configurations.

type MaxResults

integer

param MaxResults

The maximum number of results to return in this operation.

type NextToken

string

param NextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'EventConfigurationsList': [
        {
            'Identifier': 'string',
            'IdentifierType': 'PartnerAccountId'|'DevEui'|'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'
                }
            }
        },
    ]
}

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) --
        
        Enum to denote whether amazon id event topic is enabled or disabled.
        
        WirelessDeviceIdEventTopic (string) --
        
        Enum to denote 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) --
        
        Enum to denote whether amazon id event topic is enabled or disabled.
        
        WirelessDeviceIdEventTopic (string) --
        
        Enum to denote 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) --
        
        Enum to denote whether the dev eui join event topic is enabled or disabled.
        
        WirelessDeviceIdEventTopic (string) --
        
        Enum to denote 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) --
        
        Enum to denote whether the gateway eui connection status event topic is enabled or disabled.
        
        WirelessGatewayIdEventTopic (string) --
        
        Enum to denote whether the wireless gateway id connection status event topic is enabled or disabled .

CreateNetworkAnalyzerConfiguration (new)

Link ¶

Creates a new network analyzer configuration.

See also: AWS API Documentation

Request Syntax

client.create_network_analyzer_configuration(
    Name='string',
    TraceContent={
        'WirelessDeviceFrameInfo': 'ENABLED'|'DISABLED',
        'LogLevel': 'INFO'|'ERROR'|'DISABLED'
    },
    WirelessDevices=[
        'string',
    ],
    WirelessGateways=[
        'string',
    ],
    Description='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientRequestToken='string'
)

type Name

string

param Name

[REQUIRED]

Name of the network analyzer configuration.

type TraceContent

dict

param TraceContent

Trace content for your wireless gateway and wireless device resources.

WirelessDeviceFrameInfo (string) --

FrameInfo of your wireless device resources for the trace content. Use FrameInfo to debug the communication between your LoRaWAN end devices and the network server.
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.

type WirelessDevices

list

param WirelessDevices

Wireless device resources to add to the network analyzer configuration. Provide the WirelessDeviceId of the resource to add in the input array.

(string) --

The ID of the wireless device.

type WirelessGateways

list

param WirelessGateways

Wireless gateway resources to add to the network analyzer configuration. Provide the WirelessGatewayId of the resource to add in the input array.

(string) --

type Description

string

param Description

The description of the new resource.

type Tags

list

param Tags

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.

type ClientRequestToken

string

param ClientRequestToken

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.

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'Name': 'string'
}

Response Structure

(dict) --
- Arn (string) --
  
  The Amazon Resource Name of the new resource.
- Name (string) --
  
  Name of the network analyzer configuration.

DeleteNetworkAnalyzerConfiguration (new)

Link ¶

Deletes a network analyzer configuration.

See also: AWS API Documentation

Request Syntax

client.delete_network_analyzer_configuration(
    ConfigurationName='string'
)

type ConfigurationName

string

param ConfigurationName

[REQUIRED]

Name of the network analyzer configuration.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

CreateWirelessDevice (updated)

Link ¶
Changes (request)

{'LoRaWAN': {'AbpV1_0_x': {'FCntStart': 'integer'},
             'AbpV1_1': {'FCntStart': 'integer'}}}

Provisions a wireless device.

See also: AWS API Documentation

Request Syntax

client.create_wireless_device(
    Type='Sidewalk'|'LoRaWAN',
    Name='string',
    Description='string',
    DestinationName='string',
    ClientRequestToken='string',
    LoRaWAN={
        'DevEui': 'string',
        'DeviceProfileId': 'string',
        'ServiceProfileId': 'string',
        'OtaaV1_1': {
            'AppKey': 'string',
            'NwkKey': 'string',
            'JoinEui': 'string'
        },
        'OtaaV1_0_x': {
            'AppKey': 'string',
            'AppEui': 'string',
            'GenAppKey': 'string'
        },
        'AbpV1_1': {
            'DevAddr': 'string',
            'SessionKeys': {
                'FNwkSIntKey': 'string',
                'SNwkSIntKey': 'string',
                'NwkSEncKey': 'string',
                'AppSKey': 'string'
            },
            'FCntStart': 123
        },
        'AbpV1_0_x': {
            'DevAddr': 'string',
            'SessionKeys': {
                'NwkSKey': 'string',
                'AppSKey': 'string'
            },
            'FCntStart': 123
        },
        'FPorts': {
            'Fuota': 123,
            'Multicast': 123,
            'ClockSync': 123
        }
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type Type

string

param Type

[REQUIRED]

The wireless device type.

type Name

string

param Name

The name of the new resource.

type Description

string

param Description

The description of the new resource.

type DestinationName

string

param DestinationName

[REQUIRED]

The name of the destination to assign to the new wireless device.

type ClientRequestToken

string

param ClientRequestToken

This field is autopopulated if not provided.

type LoRaWAN

dict

param LoRaWAN

The device configuration information to use to create the wireless device.

DevEui (string) --

The DevEUI value.
DeviceProfileId (string) --

The ID of the device profile for the new wireless device.
ServiceProfileId (string) --

The ID of the service profile.
OtaaV1_1 (dict) --

OTAA device object for v1.1 for create APIs
- AppKey (string) --
  
  The AppKey value.
- NwkKey (string) --
  
  The NwkKey value.
- JoinEui (string) --
  
  The JoinEUI value.
OtaaV1_0_x (dict) --

OTAA device object for create APIs for v1.0.x
- AppKey (string) --
  
  The AppKey value.
- AppEui (string) --
  
  The AppEUI value.
- GenAppKey (string) --
  
  The GenAppKey value.
AbpV1_1 (dict) --

ABP device object for create APIs for v1.1
- DevAddr (string) --
  
  The DevAddr value.
- SessionKeys (dict) --
  
  Session keys for ABP v1.1
  - FNwkSIntKey (string) --
    
    The FNwkSIntKey value.
  - SNwkSIntKey (string) --
    
    The SNwkSIntKey value.
  - NwkSEncKey (string) --
    
    The NwkSEncKey value.
  - AppSKey (string) --
    
    The AppSKey value.
- FCntStart (integer) --
  
  The FCnt init value.
AbpV1_0_x (dict) --

LoRaWAN object for create APIs
- DevAddr (string) --
  
  The DevAddr value.
- SessionKeys (dict) --
  
  Session keys for ABP v1.0.x
  - NwkSKey (string) --
    
    The NwkSKey value.
  - AppSKey (string) --
    
    The AppSKey value.
- FCntStart (integer) --
  
  The FCnt init value.
FPorts (dict) --

List of FPort assigned for different LoRaWAN application packages to use
- Fuota (integer) --
  
  The Fport value.
- Multicast (integer) --
  
  The Fport value.
- ClockSync (integer) --
  
  The Fport value.

type Tags

list

param Tags

The tags to attach to the new wireless device. Tags are metadata that you can use to manage a resource.

(dict) --

A simple label consisting of a customer-defined key-value pair
- Key (string) -- [REQUIRED]
  
  The tag's key value.
- Value (string) -- [REQUIRED]
  
  The tag's value.

rtype

dict

returns

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.

GetNetworkAnalyzerConfiguration (updated)

Link ¶
Changes (response)

{'Arn': 'string', 'Description': 'string', 'Name': 'string'}

Get network analyzer configuration.

See also: AWS API Documentation

Request Syntax

client.get_network_analyzer_configuration(
    ConfigurationName='string'
)

type ConfigurationName

string

param ConfigurationName

[REQUIRED]

Name of the network analyzer configuration.

rtype

dict

returns

Response Syntax

{
    'TraceContent': {
        'WirelessDeviceFrameInfo': 'ENABLED'|'DISABLED',
        'LogLevel': 'INFO'|'ERROR'|'DISABLED'
    },
    'WirelessDevices': [
        'string',
    ],
    'WirelessGateways': [
        'string',
    ],
    'Description': 'string',
    'Arn': 'string',
    'Name': 'string'
}

Response Structure

(dict) --
- TraceContent (dict) --
  
  Trace content for your wireless gateway and wireless device resources.
  - WirelessDeviceFrameInfo (string) --
    
    FrameInfo of your wireless device resources for the trace content. Use FrameInfo to debug the communication between your LoRaWAN end devices and the network server.
  - 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.
- WirelessDevices (list) --
  
  List of wireless gateway resources that have been added to the network analyzer configuration.
  - (string) --
    
    The ID of the wireless device.
- WirelessGateways (list) --
  
  List of wireless gateway resources that have been added to the network analyzer configuration.
  - (string) --
- Description (string) --
  
  The description of the new resource.
- Arn (string) --
  
  The Amazon Resource Name of the new resource.
- Name (string) --
  
  Name of the network analyzer configuration.

GetResourceEventConfiguration (updated)

Link ¶
Changes (request, response)
Request

{'IdentifierType': {'DevEui',
                    'GatewayEui',
                    'WirelessDeviceId',
                    'WirelessGatewayId'}}

Response

{'ConnectionStatus': {'LoRaWAN': {'GatewayEuiEventTopic': 'Enabled | Disabled'},
                      'WirelessGatewayIdEventTopic': 'Enabled | Disabled'},
 'DeviceRegistrationState': {'WirelessDeviceIdEventTopic': 'Enabled | '
                                                           'Disabled'},
 'Join': {'LoRaWAN': {'DevEuiEventTopic': 'Enabled | Disabled'},
          'WirelessDeviceIdEventTopic': 'Enabled | Disabled'},
 'Proximity': {'WirelessDeviceIdEventTopic': 'Enabled | Disabled'}}

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'|'GatewayEui'|'WirelessDeviceId'|'WirelessGatewayId',
    PartnerType='Sidewalk'
)

type Identifier

string

param Identifier

[REQUIRED]

Resource identifier to opt in for event messaging.

type IdentifierType

string

param IdentifierType

[REQUIRED]

Identifier type of the particular resource identifier for event configuration.

type PartnerType

string

param PartnerType

Partner type of the resource if the identifier type is PartnerAccountId.

rtype

dict

returns

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'
    }
}

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.
  - WirelessDeviceIdEventTopic (string) --
    
    Enum to denote 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) --
      
      Enum to denote whether amazon id event topic is enabled or disabled.
  - WirelessDeviceIdEventTopic (string) --
    
    Enum to denote 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) --
      
      Enum to denote whether the dev eui join event topic is enabled or disabled.
  - WirelessDeviceIdEventTopic (string) --
    
    Enum to denote 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) --
      
      Enum to denote whether the gateway eui connection status event topic is enabled or disabled.
  - WirelessGatewayIdEventTopic (string) --
    
    Enum to denote whether the wireless gateway id connection status event topic is enabled or disabled .

GetWirelessDevice (updated)

Link ¶
Changes (response)

{'LoRaWAN': {'AbpV1_0_x': {'FCntStart': 'integer'},
             'AbpV1_1': {'FCntStart': 'integer'}}}

Gets information about a wireless device.

See also: AWS API Documentation

Request Syntax

client.get_wireless_device(
    Identifier='string',
    IdentifierType='WirelessDeviceId'|'DevEui'|'ThingName'|'SidewalkManufacturingSn'
)

type Identifier

string

param Identifier

[REQUIRED]

The identifier of the wireless device to get.

type IdentifierType

string

param IdentifierType

[REQUIRED]

The type of identifier used in identifier .

rtype

dict

returns

Response Syntax

{
    'Type': 'Sidewalk'|'LoRaWAN',
    'Name': 'string',
    'Description': 'string',
    'DestinationName': 'string',
    'Id': 'string',
    'Arn': 'string',
    'ThingName': 'string',
    'ThingArn': 'string',
    'LoRaWAN': {
        'DevEui': 'string',
        'DeviceProfileId': 'string',
        'ServiceProfileId': 'string',
        'OtaaV1_1': {
            'AppKey': 'string',
            'NwkKey': 'string',
            'JoinEui': 'string'
        },
        'OtaaV1_0_x': {
            'AppKey': 'string',
            'AppEui': 'string',
            'GenAppKey': 'string'
        },
        'AbpV1_1': {
            'DevAddr': 'string',
            'SessionKeys': {
                'FNwkSIntKey': 'string',
                'SNwkSIntKey': 'string',
                'NwkSEncKey': 'string',
                'AppSKey': 'string'
            },
            'FCntStart': 123
        },
        'AbpV1_0_x': {
            'DevAddr': 'string',
            'SessionKeys': {
                'NwkSKey': 'string',
                'AppSKey': 'string'
            },
            'FCntStart': 123
        },
        'FPorts': {
            'Fuota': 123,
            'Multicast': 123,
            'ClockSync': 123
        }
    },
    '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.
    - FCntStart (integer) --
      
      The FCnt init value.
  - AbpV1_0_x (dict) --
    
    LoRaWAN object for create APIs
    - DevAddr (string) --
      
      The DevAddr value.
    - SessionKeys (dict) --
      
      Session keys for ABP v1.0.x
      - NwkSKey (string) --
        
        The NwkSKey value.
      - AppSKey (string) --
        
        The AppSKey value.
    - FCntStart (integer) --
      
      The FCnt init value.
  - FPorts (dict) --
    
    List of FPort assigned for different LoRaWAN application packages to use
    - Fuota (integer) --
      
      The Fport value.
    - Multicast (integer) --
      
      The Fport value.
    - ClockSync (integer) --
      
      The Fport value.
- 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.

UpdateNetworkAnalyzerConfiguration (updated)

Link ¶
Changes (request)

{'Description': 'string'}

Update network analyzer configuration.

See also: AWS API Documentation

Request Syntax

client.update_network_analyzer_configuration(
    ConfigurationName='string',
    TraceContent={
        'WirelessDeviceFrameInfo': 'ENABLED'|'DISABLED',
        'LogLevel': 'INFO'|'ERROR'|'DISABLED'
    },
    WirelessDevicesToAdd=[
        'string',
    ],
    WirelessDevicesToRemove=[
        'string',
    ],
    WirelessGatewaysToAdd=[
        'string',
    ],
    WirelessGatewaysToRemove=[
        'string',
    ],
    Description='string'
)

type ConfigurationName

string

param ConfigurationName

[REQUIRED]

Name of the network analyzer configuration.

type TraceContent

dict

param TraceContent

Trace content for your wireless gateway and wireless device resources.

WirelessDeviceFrameInfo (string) --

FrameInfo of your wireless device resources for the trace content. Use FrameInfo to debug the communication between your LoRaWAN end devices and the network server.
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.

type WirelessDevicesToAdd

list

param WirelessDevicesToAdd

Wireless device resources to add to the network analyzer configuration. Provide the WirelessDeviceId of the resource to add in the input array.

(string) --

The ID of the wireless device.

type WirelessDevicesToRemove

list

param WirelessDevicesToRemove

Wireless device resources to remove from the network analyzer configuration. Provide the WirelessDeviceId of the resources to remove in the input array.

(string) --

The ID of the wireless device.

type WirelessGatewaysToAdd

list

param WirelessGatewaysToAdd

Wireless gateway resources to add to the network analyzer configuration. Provide the WirelessGatewayId of the resource to add in the input array.

(string) --

type WirelessGatewaysToRemove

list

param WirelessGatewaysToRemove

Wireless gateway resources to remove from the network analyzer configuration. Provide the WirelessGatewayId of the resources to remove in the input array.

(string) --

type Description

string

param Description

The description of the new resource.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

UpdateResourceEventConfiguration (updated)

Link ¶
Changes (request)

{'ConnectionStatus': {'LoRaWAN': {'GatewayEuiEventTopic': 'Enabled | Disabled'},
                      'WirelessGatewayIdEventTopic': 'Enabled | Disabled'},
 'DeviceRegistrationState': {'WirelessDeviceIdEventTopic': 'Enabled | '
                                                           'Disabled'},
 'IdentifierType': {'DevEui',
                    'GatewayEui',
                    'WirelessDeviceId',
                    'WirelessGatewayId'},
 'Join': {'LoRaWAN': {'DevEuiEventTopic': 'Enabled | Disabled'},
          'WirelessDeviceIdEventTopic': 'Enabled | Disabled'},
 'Proximity': {'WirelessDeviceIdEventTopic': 'Enabled | Disabled'}}

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'|'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'
    }
)

type Identifier

string

param Identifier

[REQUIRED]

Resource identifier to opt in for event messaging.

type IdentifierType

string

param IdentifierType

[REQUIRED]

Identifier type of the particular resource identifier for event configuration.

type PartnerType

string

param PartnerType

Partner type of the resource if the identifier type is PartnerAccountId

type DeviceRegistrationState

dict

param DeviceRegistrationState

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.
WirelessDeviceIdEventTopic (string) --

Enum to denote whether the wireless device id device registration state event topic is enabled or disabled.

type Proximity

dict

param Proximity

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.
WirelessDeviceIdEventTopic (string) --

Enum to denote whether the wireless device id proximity event topic is enabled or disabled.

type Join

dict

param Join

Event configuration for the join event

LoRaWAN (dict) --

Join event configuration object for enabling or disabling LoRaWAN related event topics.
- DevEuiEventTopic (string) --
  
  Enum to denote whether the dev eui join event topic is enabled or disabled.
WirelessDeviceIdEventTopic (string) --

Enum to denote whether the wireless device id join event topic is enabled or disabled.

type ConnectionStatus

dict

param ConnectionStatus

Event configuration for the connection status event

LoRaWAN (dict) --

Connection status event configuration object for enabling or disabling LoRaWAN related event topics.
- GatewayEuiEventTopic (string) --
  
  Enum to denote whether the gateway eui connection status event topic is enabled or disabled.
WirelessGatewayIdEventTopic (string) --

Enum to denote whether the wireless gateway id connection status event topic is enabled or disabled .

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

UpdateWirelessDevice (updated)

Link ¶
Changes (request)

{'LoRaWAN': {'AbpV1_0_x': {'FCntStart': 'integer'},
             'AbpV1_1': {'FCntStart': 'integer'}}}

Updates properties of a wireless device.

See also: AWS API Documentation

Request Syntax

client.update_wireless_device(
    Id='string',
    DestinationName='string',
    Name='string',
    Description='string',
    LoRaWAN={
        'DeviceProfileId': 'string',
        'ServiceProfileId': 'string',
        'AbpV1_1': {
            'FCntStart': 123
        },
        'AbpV1_0_x': {
            'FCntStart': 123
        }
    }
)

type Id

string

param Id

[REQUIRED]

The ID of the resource to update.

type DestinationName

string

param DestinationName

The name of the new destination for the device.

type Name

string

param Name

The new name of the resource.

type Description

string

param Description

A new description of the resource.

type LoRaWAN

dict

param LoRaWAN

The updated wireless device's configuration.

DeviceProfileId (string) --

The ID of the device profile for the wireless device.
ServiceProfileId (string) --

The ID of the service profile.
AbpV1_1 (dict) --

ABP device object for update APIs for v1.1
- FCntStart (integer) --
  
  The FCnt init value.
AbpV1_0_x (dict) --

ABP device object for update APIs for v1.0.x
- FCntStart (integer) --
  
  The FCnt init value.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --