[ aws . iotwireless ]

create-wireless-device

Description

Provisions a wireless device.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-wireless-device
--type <value>
[--name <value>]
[--description <value>]
--destination-name <value>
[--client-request-token <value>]
[--tags <value>]
[--lorawan <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--type (string)

The wireless device type.

Possible values:

• Sidewalk

• LoRaWAN

--name (string)

The name of the new resource.

--description (string)

The description of the new resource.

--destination-name (string)

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

--client-request-token (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.

--tags (list)

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

(structure)

A simple label consisting of a customer-defined key-value pair

Key -> (string)

The tag’s key value.

Value -> (string)

The tag’s value.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--lorawan (structure)

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 -> (structure)

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 -> (structure)

OTAA device object for create APIs for v1.0.x

AppKey -> (string)

The AppKey value.

AppEui -> (string)

The AppEUI value.

AbpV1_1 -> (structure)

ABP device object for create APIs for v1.1

DevAddr -> (string)

The DevAddr value.

SessionKeys -> (structure)

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 -> (structure)

LoRaWAN object for create APIs

DevAddr -> (string)

The DevAddr value.

SessionKeys -> (structure)

Session keys for ABP v1.0.x

NwkSKey -> (string)

The NwkSKey value.

AppSKey -> (string)

The AppSKey value.

Shorthand Syntax:

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

JSON Syntax:

{
  "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"
    }
  }
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To create an IoT wireless device

The following create-wireless-device example creates a wireless device resource of the type LoRaWAN.

aws iotwireless create-wireless-device \
    --cli-input-json file://input.json

Contents of input.json:

{
    "Description": "My LoRaWAN wireless device"
    "DestinationName": "IoTWirelessDestination"
    "LoRaWAN": {
        "DeviceProfileId": "ab0c23d3-b001-45ef-6a01-2bc3de4f5333",
        "ServiceProfileId": "fe98dc76-cd12-001e-2d34-5550432da100",
        "OtaaV1_1": {
            "AppKey": "3f4ca100e2fc675ea123f4eb12c4a012",
            "JoinEui": "b4c231a359bc2e3d",
            "NwkKey": "01c3f004a2d6efffe32c4eda14bcd2b4"
        },
        "DevEui": "ac12efc654d23fc2"
    },
    "Name": "SampleIoTWirelessThing"
    "Type": LoRaWAN
}

Output:

{
    "Arn": "arn:aws:iotwireless:us-east-1:123456789012:WirelessDevice/1ffd32c8-8130-4194-96df-622f072a315f",
    "Id": "1ffd32c8-8130-4194-96df-622f072a315f"
}

For more information, see Connecting devices and gateways to AWS IoT Core for LoRaWAN in the AWS IoT Developers Guide.

Output

Arn -> (string)

The Amazon Resource Name of the new resource.

Id -> (string)

The ID of the new wireless device.