/provisioning-templates/{templateName}

The AWS IoT Wireless multi-region endpoint

https://api.iotwireless.{region}.amazonaws.com

PATCH

Updates a fleet provisioning template.

Requires permission to access the UpdateProvisioningTemplate action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request PATCH 'https://api.iotwireless.{region}.amazonaws.com/provisioning-templates/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "string",
    "enabled": true,
    "defaultVersionId": 0,
    "provisioningRoleArn": "stringstringstringst",
    "preProvisioningHook": {
        "payloadVersion": "string",
        "targetArn": "string"
    },
    "removePreProvisioningHook": true
}'

Response Example

200 - Example 1

{}

Request

Path Params

templateName

string

required

The name of the fleet provisioning template.

Body Params application/json

description

string

optional

The description of the fleet provisioning template.

>= 0 characters<= 500 characters

Match pattern:

[^\p{C}]*

enabled

boolean

optional

True to enable the fleet provisioning template, otherwise false.

defaultVersionId

integer

optional

The ID of the default provisioning template version.

provisioningRoleArn

string

optional

The ARN of the role associated with the 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

removePreProvisioningHook

boolean

optional

Removes pre-provisioning hook template.

Examples

Responses

🟢200Success

application/json

Body

object {0}

🟠480InternalFailureException

🟠481InvalidRequestException

🟠482ResourceNotFoundException

🟠483UnauthorizedException

🟠484ConflictingResourceUpdateException

Modified at 2022-09-10 23:12:16

/provisioning-templates/{templateName}

/provisioning-templates/{templateName}/versions/{versionId}