/provisioning-templates/{templateName}

The AWS IoT Wireless multi-region endpoint

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

GET

Returns information about a fleet provisioning template.

Requires permission to access the DescribeProvisioningTemplate action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.iotwireless.{region}.amazonaws.com/provisioning-templates/'

Response Example

200 - Example 1

{
    "templateArn": "string",
    "templateName": "string",
    "description": "string",
    "creationDate": "string",
    "lastModifiedDate": "string",
    "defaultVersionId": 0,
    "templateBody": "string",
    "enabled": true,
    "provisioningRoleArn": "string",
    "preProvisioningHook": {
        "payloadVersion": "string",
        "targetArn": "string"
    }
}

Request

Path Params

templateName

string

required

The name of the fleet provisioning template.

Responses

🟢200Success

application/json

Body

templateArn

string

optional

The ARN of the fleet provisioning template.

templateName

string

optional

The name of the fleet provisioning template.

>= 1 characters<= 36 characters

Match pattern:

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

description

string

optional

The description of the fleet provisioning template.

>= 0 characters<= 500 characters

Match pattern:

[^\p{C}]*

creationDate

string <date-time>

optional

The date when the fleet provisioning template was created.

lastModifiedDate

string <date-time>

optional

The date when the fleet provisioning template was last modified.

defaultVersionId

integer

optional

The default fleet template version ID.

templateBody

string

optional

The JSON formatted contents of the fleet provisioning template.

enabled

boolean

optional

True if the fleet provisioning template is enabled, otherwise false.

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

Gets information about a pre-provisioned hook.

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

required

The ARN of the target function.

Note: Only Lambda functions are currently supported.

<= 2048 characters

🟠480InternalFailureException

🟠481InvalidRequestException

🟠482ResourceNotFoundException

🟠483ThrottlingException

🟠484UnauthorizedException

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

/provisioning-templates/{templateName}