Creates a provisioning template.
Requires permission to access the CreateProvisioningTemplate action.
Request SyntaxPOST /provisioning-templates HTTP/1.1
Content-type: application/json
{
"description": "string
",
"enabled": boolean
,
"preProvisioningHook": {
"payloadVersion": "string
",
"targetArn": "string
"
},
"provisioningRoleArn": "string
",
"tags": [
{
"Key": "string
",
"Value": "string
"
}
],
"templateBody": "string
",
"templateName": "string
",
"type": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request BodyThe request accepts the following data in JSON format.
The description of the provisioning template.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
Pattern: [^\p{C}]*
Required: No
True to enable the provisioning template, otherwise false.
Type: Boolean
Required: No
Creates a pre-provisioning hook template. Only supports template of type FLEET_PROVISIONING
. For more information about provisioning template types, see type.
Type: ProvisioningHook object
Required: No
The role ARN for the role associated with the provisioning template. This IoT role grants permission to provision a device.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Required: Yes
Metadata which can be used to manage the provisioning template.
NoteFor URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
Type: Array of Tag objects
Required: No
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
The name of the provisioning template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern: ^[0-9A-Za-z_-]+$
Required: Yes
The type you define in a provisioning template. You can create a template with only one type. You can't change the template type after its creation. The default value is FLEET_PROVISIONING
. For more information about provisioning template, see: Provisioning template.
Type: String
Valid Values: FLEET_PROVISIONING | JITP
Required: No
HTTP/1.1 200
Content-type: application/json
{
"defaultVersionId": number,
"templateArn": "string",
"templateName": "string"
}
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.
The default version of the provisioning template.
Type: Integer
The ARN that identifies the provisioning template.
Type: String
The name of the provisioning template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern: ^[0-9A-Za-z_-]+$
An unexpected error has occurred.
HTTP Status Code: 500
The request is not valid.
HTTP Status Code: 400
A limit has been exceeded.
HTTP Status Code: 410
The resource already exists.
HTTP Status Code: 409
The rate exceeds the limit.
HTTP Status Code: 400
You are not authorized to perform this operation.
HTTP Status Code: 401
For more information about using this API in one of the language-specific AWS SDKs, see the following:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4