[ aws . iotwireless ]

create-device-profile

Description

Creates a new device profile.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--name (string)

The name of the new resource.

--tags (list)

The tags to attach to the new device profile. 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"
  }
  ...
]

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

--lorawan (structure)

The device profile information to use to create the device profile.

SupportsClassB -> (boolean)

The SupportsClassB value.

ClassBTimeout -> (integer)

The ClassBTimeout value.

PingSlotPeriod -> (integer)

The PingSlotPeriod value.

PingSlotDr -> (integer)

The PingSlotDR value.

PingSlotFreq -> (integer)

The PingSlotFreq value.

SupportsClassC -> (boolean)

The SupportsClassC value.

ClassCTimeout -> (integer)

The ClassCTimeout value.

MacVersion -> (string)

The MAC version (such as OTAA 1.1 or OTAA 1.0.3) to use with this device profile.

RegParamsRevision -> (string)

The version of regional parameters.

RxDelay1 -> (integer)

The RXDelay1 value.

RxDrOffset1 -> (integer)

The RXDROffset1 value.

RxDataRate2 -> (integer)

The RXDataRate2 value.

RxFreq2 -> (integer)

The RXFreq2 value.

FactoryPresetFreqsList -> (list)

The list of values that make up the FactoryPresetFreqs value.

(integer)

MaxEirp -> (integer)

The MaxEIRP value.

MaxDutyCycle -> (integer)

The MaxDutyCycle value.

RfRegion -> (string)

The frequency band (RFRegion) value.

SupportsJoin -> (boolean)

The SupportsJoin value.

Supports32BitFCnt -> (boolean)

The Supports32BitFCnt value.

Shorthand Syntax:

SupportsClassB=boolean,ClassBTimeout=integer,PingSlotPeriod=integer,PingSlotDr=integer,PingSlotFreq=integer,SupportsClassC=boolean,ClassCTimeout=integer,MacVersion=string,RegParamsRevision=string,RxDelay1=integer,RxDrOffset1=integer,RxDataRate2=integer,RxFreq2=integer,FactoryPresetFreqsList=integer,integer,MaxEirp=integer,MaxDutyCycle=integer,RfRegion=string,SupportsJoin=boolean,Supports32BitFCnt=boolean

JSON Syntax:

{
  "SupportsClassB": true|false,
  "ClassBTimeout": integer,
  "PingSlotPeriod": integer,
  "PingSlotDr": integer,
  "PingSlotFreq": integer,
  "SupportsClassC": true|false,
  "ClassCTimeout": integer,
  "MacVersion": "string",
  "RegParamsRevision": "string",
  "RxDelay1": integer,
  "RxDrOffset1": integer,
  "RxDataRate2": integer,
  "RxFreq2": integer,
  "FactoryPresetFreqsList": [integer, ...],
  "MaxEirp": integer,
  "MaxDutyCycle": integer,
  "RfRegion": "string",
  "SupportsJoin": true|false,
  "Supports32BitFCnt": true|false
}

--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 a new device profile

The following create-device-profile example creates a new IoT wireless device profile.

aws iotwireless create-device-profile

Output:

{
    "Arn": "arn:aws:iotwireless:us-east-1:123456789012:DeviceProfile/12345678-a1b2-3c45-67d8-e90fa1b2c34d",
    "Id": "12345678-a1b2-3c45-67d8-e90fa1b2c34d"
}

For more information, see Add profiles 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 device profile.