CreateProvisioningTemplateVersion - AWS IoT

CreateProvisioningTemplateVersion

Creates a new version of a provisioning template.

Requires permission to access the CreateProvisioningTemplateVersion action.

Request Syntax

POST /provisioning-templates/templateName/versions?setAsDefault=setAsDefault HTTP/1.1 Content-type: application/json { "templateBody": "string" }

URI Request Parameters

The request uses the following URI parameters.

setAsDefault

Sets a fleet provision template version as the default version.

templateName

The name of the provisioning template.

Length Constraints: Minimum length of 1. Maximum length of 36.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

templateBody

The JSON formatted contents of the provisioning template.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 10240.

Pattern: [\s\S]*

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "isDefaultVersion": boolean, "templateArn": "string", "templateName": "string", "versionId": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

isDefaultVersion

True if the provisioning template version is the default version, otherwise false.

Type: Boolean

templateArn

The ARN that identifies the provisioning template.

Type: String

templateName

The name of the provisioning template.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

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

versionId

The version of the provisioning template.

Type: Integer

Errors

ConflictingResourceUpdateException

A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.

HTTP Status Code: 409

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 400

UnauthorizedException

You are not authorized to perform this operation.

HTTP Status Code: 401

VersionsLimitExceededException

The number of policy versions exceeds the limit.

HTTP Status Code: 409

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: