/provisioning-templates

Creates a fleet provisioning template.

Requires permission to access the CreateProvisioningTemplate action.

curl --location -g --request POST 'https://api.iotwireless.{region}.amazonaws.com/provisioning-templates' \ --header 'Content-Type: application/json' \ --data-raw '{ "templateName": "string", "description": "string", "templateBody": "string", "enabled": true, "provisioningRoleArn": "stringstringstringst", "preProvisioningHook": { "payloadVersion": "string", "targetArn": "string" }, "tags": [ { "Key": "string", "Value": "string" } ] }'

Request

Body Params application/json

templateName

string

required

The name of the fleet provisioning template.

>= 1 characters<= 36 characters

Match pattern:

^[0-9A-Za-z_-]+$

description

string

optional

The description of the fleet provisioning template.

>= 0 characters<= 500 characters

Match pattern:

[^\p{C}]*

templateBody

string

required

The JSON formatted contents of the fleet provisioning template.

enabled

boolean

optional

True to enable the fleet provisioning template, otherwise false.

provisioningRoleArn

string

required

The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission to provision a device.

>= 20 characters<= 2048 characters

preProvisioningHook

object

optional

Structure that contains payloadVersion and targetArn.

payloadVersion

string

optional

The payload that was sent to the target function.

Note: Only Lambda functions are currently supported.

>= 10 characters<= 32 characters

Match pattern:

^[0-9-]+$

targetArn

string

optional

The ARN of the target function.

Note: Only Lambda functions are currently supported.

<= 2048 characters

Request

Responses