AWS IoT Wireless

2021/03/26 - AWS IoT Wireless - 1 updated api methods

Changes  Support tag-on-create for WirelessDevice.

CreateWirelessDevice (updated) Link ΒΆ
Changes (request)
{'Tags': [{'Key': 'string', 'Value': 'string'}]}

Provisions a wireless device.

See also: AWS API Documentation

Request Syntax

client.create_wireless_device(
    Type='Sidewalk'|'LoRaWAN',
    Name='string',
    Description='string',
    DestinationName='string',
    ClientRequestToken='string',
    LoRaWAN={
        'DevEui': 'string',
        'DeviceProfileId': 'string',
        'ServiceProfileId': 'string',
        'OtaaV1_1': {
            'AppKey': 'string',
            'NwkKey': 'string',
            'JoinEui': 'string'
        },
        'OtaaV1_0_x': {
            'AppKey': 'string',
            'AppEui': 'string'
        },
        'AbpV1_1': {
            'DevAddr': 'string',
            'SessionKeys': {
                'FNwkSIntKey': 'string',
                'SNwkSIntKey': 'string',
                'NwkSEncKey': 'string',
                'AppSKey': 'string'
            }
        },
        'AbpV1_0_x': {
            'DevAddr': 'string',
            'SessionKeys': {
                'NwkSKey': 'string',
                'AppSKey': 'string'
            }
        }
    },
    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:

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.

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.

  • 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.

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.