DescribeProvisioningTemplate - Amazon IoT
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

DescribeProvisioningTemplate

Returns information about a provisioning template.

Requires permission to access the DescribeProvisioningTemplate action.

Request Syntax

GET /provisioning-templates/templateName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

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 does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "creationDate": number, "defaultVersionId": number, "description": "string", "enabled": boolean, "lastModifiedDate": number, "preProvisioningHook": { "payloadVersion": "string", "targetArn": "string" }, "provisioningRoleArn": "string", "templateArn": "string", "templateBody": "string", "templateName": "string", "type": "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.

creationDate

The date when the provisioning template was created.

Type: Timestamp

defaultVersionId

The default fleet template version ID.

Type: Integer

description

The description of the provisioning template.

Type: String

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

Pattern: [^\p{C}]*

enabled

True if the provisioning template is enabled, otherwise false.

Type: Boolean

lastModifiedDate

The date when the provisioning template was last modified.

Type: Timestamp

preProvisioningHook

Gets information about a pre-provisioned hook.

Type: ProvisioningHook object

provisioningRoleArn

The ARN of 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.

templateArn

The ARN of the provisioning template.

Type: String

templateBody

The JSON formatted contents of the provisioning template.

Type: String

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

Pattern: [\s\S]*

templateName

The name of the provisioning template.

Type: String

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

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

type

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.

Note

This field isn't available in China.

Type: String

Valid Values: FLEET_PROVISIONING | JITP

Errors

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

See Also

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