PATCH

/provisioning-templates/{templateName}

http://iot.{region}.amazonaws.com/provisioning-templates/{templateName}

<p>Updates a provisioning template.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateProvisioningTemplate</a> action.</p>

Access Token Required: API Key

Path Parameters

templateNamestringrequired

The name of the provisioning template.

Body Params

enabledboolean

True to enable the provisioning template, otherwise false.

descriptionstring

The description of the provisioning template.

defaultVersionIdinteger

The ID of the default provisioning template version.

preProvisioningHookobject

Structure that contains <code>payloadVersion</code> and <code>targetArn</code>.

provisioningRoleArnstring

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

removePreProvisioningHookboolean

Removes pre-provisioning hook template.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PATCH \
2     --url 'http://iot.{region}.amazonaws.com/provisioning-templates/{templateName}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}