Amazon IoT Device Defender Provisioning Templates API
The Provisioning Templates API from Amazon IoT Device Defender — 5 operation(s) for provisioning templates.
OpenAPI Specification
openapi: 3.0.0
info:
version: 2015-05-28
x-release: v4
title: AWS IoT Accept Certificate Transfer Provisioning Templates API
description: '<fullname>IoT</fullname> <p>IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.</p> <p>The service endpoints that expose this API are listed in <a href="https://docs.aws.amazon.com/general/latest/gr/iot-core.html">Amazon Web Services IoT Core Endpoints and Quotas</a>. You must use the endpoint for the region that has the resources you want to access.</p> <p>The service name used by <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Amazon Web Services Signature Version 4</a> to sign the request is: <i>execute-api</i>.</p> <p>For more information about how IoT works, see the <a href="https://docs.aws.amazon.com/iot/latest/developerguide/aws-iot-how-it-works.html">Developer Guide</a>.</p> <p>For information about how to use the credentials provider for IoT, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/authorizing-direct-aws.html">Authorizing Direct Calls to Amazon Web Services Services</a>.</p>'
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: iot
x-aws-signingName: iot
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iot-2015-05-28.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://iot.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS IoT multi-region endpoint
- url: https://iot.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS IoT multi-region endpoint
- url: http://iot.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS IoT endpoint for China (Beijing) and China (Ningxia)
- url: https://iot.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS IoT endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Provisioning Templates
paths:
/provisioning-templates/{templateName}/provisioning-claim:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateProvisioningClaim
description: <p>Creates a provisioning claim.</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">CreateProvisioningClaim</a> action.</p>
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProvisioningClaimResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'484':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
'485':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
parameters:
- name: templateName
in: path
required: true
description: The name of the provisioning template to use.
schema:
type: string
pattern: ^[0-9A-Za-z_-]+$
minLength: 1
maxLength: 36
summary: Amazon IoT Device Defender Create Provisioning Claim
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Provisioning Templates
/provisioning-templates:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateProvisioningTemplate
description: <p>Creates 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">CreateProvisioningTemplate</a> action.</p>
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProvisioningTemplateResponse'
'480':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'481':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'482':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'484':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'485':
description: ResourceAlreadyExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceAlreadyExistsException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- templateName
- templateBody
- provisioningRoleArn
properties:
templateName:
description: The name of the provisioning template.
type: string
pattern: ^[0-9A-Za-z_-]+$
minLength: 1
maxLength: 36
description:
description: The description of the provisioning template.
type: string
pattern: '[^\p{C}]*'
minLength: 0
maxLength: 500
templateBody:
description: The JSON formatted contents of the provisioning template.
type: string
pattern: '[\s\S]*'
minLength: 0
maxLength: 10240
enabled:
description: True to enable the provisioning template, otherwise false.
type: boolean
provisioningRoleArn:
description: The role ARN for the role associated with the provisioning template. This IoT role grants permission to provision a device.
type: string
minLength: 20
maxLength: 2048
preProvisioningHook:
description: Structure that contains <code>payloadVersion</code> and <code>targetArn</code>.
type: object
properties:
payloadVersion:
allOf:
- $ref: '#/components/schemas/PayloadVersion'
- description: <p>The payload that was sent to the target function.</p> <p> <i>Note:</i> Only Lambda functions are currently supported.</p>
targetArn:
allOf:
- $ref: '#/components/schemas/TargetArn'
- description: <p>The ARN of the target function.</p> <p> <i>Note:</i> Only Lambda functions are currently supported.</p>
tags:
description: '<p>Metadata which can be used to manage the provisioning template.</p> <note> <p>For URI Request parameters use format: ...key1=value1&key2=value2...</p> <p>For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."</p> <p>For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."</p> </note>'
type: array
items:
$ref: '#/components/schemas/Tag'
type:
description: '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 <code>FLEET_PROVISIONING</code>. For more information about provisioning template, see: <a href="https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html">Provisioning template</a>. '
type: string
enum:
- FLEET_PROVISIONING
- JITP
summary: Amazon IoT Device Defender Create Provisioning Template
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Provisioning Templates
get:
operationId: ListProvisioningTemplates
description: <p>Lists the provisioning templates in your Amazon Web Services account.</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">ListProvisioningTemplates</a> action.</p>
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListProvisioningTemplatesResponse'
'480':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'481':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
parameters:
- name: maxResults
in: query
required: false
description: The maximum number of results to return at one time.
schema:
type: integer
minimum: 1
maximum: 250
- name: nextToken
in: query
required: false
description: A token to retrieve the next set of results.
schema:
type: string
summary: Amazon IoT Device Defender List Provisioning Templates
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Provisioning Templates
/provisioning-templates/{templateName}/versions:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateProvisioningTemplateVersion
description: <p>Creates a new version of 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">CreateProvisioningTemplateVersion</a> action.</p>
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProvisioningTemplateVersionResponse'
'480':
description: VersionsLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/VersionsLimitExceededException'
'481':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'482':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'486':
description: ConflictingResourceUpdateException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictingResourceUpdateException'
parameters:
- name: templateName
in: path
required: true
description: The name of the provisioning template.
schema:
type: string
pattern: ^[0-9A-Za-z_-]+$
minLength: 1
maxLength: 36
- name: setAsDefault
in: query
required: false
description: Sets a fleet provision template version as the default version.
schema:
type: boolean
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- templateBody
properties:
templateBody:
description: The JSON formatted contents of the provisioning template.
type: string
pattern: '[\s\S]*'
minLength: 0
maxLength: 10240
summary: Amazon IoT Device Defender Create Provisioning Template Version
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Provisioning Templates
get:
operationId: ListProvisioningTemplateVersions
description: <p>A list of provisioning template versions.</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">ListProvisioningTemplateVersions</a> action.</p>
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListProvisioningTemplateVersionsResponse'
'480':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'481':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
parameters:
- name: templateName
in: path
required: true
description: The name of the provisioning template.
schema:
type: string
pattern: ^[0-9A-Za-z_-]+$
minLength: 1
maxLength: 36
- name: maxResults
in: query
required: false
description: The maximum number of results to return at one time.
schema:
type: integer
minimum: 1
maximum: 250
- name: nextToken
in: query
required: false
description: A token to retrieve the next set of results.
schema:
type: string
summary: Amazon IoT Device Defender List Provisioning Template Versions
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Provisioning Templates
/provisioning-templates/{templateName}:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
delete:
operationId: DeleteProvisioningTemplate
description: <p>Deletes 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">DeleteProvisioningTemplate</a> action.</p>
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteProvisioningTemplateResponse'
'480':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'481':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'483':
description: DeleteConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteConflictException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'485':
description: ConflictingResourceUpdateException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictingResourceUpdateException'
'486':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
parameters:
- name: templateName
in: path
required: true
description: The name of the fleet provision template to delete.
schema:
type: string
pattern: ^[0-9A-Za-z_-]+$
minLength: 1
maxLength: 36
summary: Amazon IoT Device Defender Delete Provisioning Template
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Provisioning Templates
get:
operationId: DescribeProvisioningTemplate
description: <p>Returns information about 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">DescribeProvisioningTemplate</a> action.</p>
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeProvisioningTemplateResponse'
'480':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'481':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'484':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
parameters:
- name: templateName
in: path
required: true
description: The name of the provisioning template.
schema:
type: string
pattern: ^[0-9A-Za-z_-]+$
minLength: 1
maxLength: 36
summary: Amazon IoT Device Defender Describe Provisioning Template
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Provisioning Templates
patch:
operationId: UpdateProvisioningTemplate
description: <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>
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateProvisioningTemplateResponse'
'480':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'481':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'483':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'484':
description: ConflictingResourceUpdateException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictingResourceUpdateException'
parameters:
- name: templateName
in: path
required: true
description: The name of the provisioning template.
schema:
type: string
pattern: ^[0-9A-Za-z_-]+$
minLength: 1
maxLength: 36
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
description:
description: The description of the provisioning template.
type: string
pattern: '[^\p{C}]*'
minLength: 0
maxLength: 500
enabled:
description: True to enable the provisioning template, otherwise false.
type: boolean
defaultVersionId:
description: The ID of the default provisioning template version.
type: integer
provisioningRoleArn:
description: The ARN of the role associated with the provisioning template. This IoT role grants permission to provision a device.
type: string
minLength: 20
maxLength: 2048
preProvisioningHook:
description: Structure that contains <code>payloadVersion</code> and <code>targetArn</code>.
type: object
properties:
payloadVersion:
allOf:
- $ref: '#/components/schemas/PayloadVersion'
- description: <p>The payload that was sent to the target function.</p> <p> <i>Note:</i> Only Lambda functions are currently supported.</p>
targetArn:
allOf:
- $ref: '#/components/schemas/TargetArn'
- description: <p>The ARN of the target function.</p> <p> <i>Note:</i> Only Lambda functions are currently supported.</p>
removePreProvisioningHook:
description: Removes pre-provisioning hook template.
type: boolean
summary: Amazon IoT Device Defender Update Provisioning Template
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Provisioning Templates
/provisioning-templates/{templateName}/versions/{versionId}:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
delete:
operationId: DeleteProvisioningTemplateVersion
description: <p>Deletes a provisioning template version.</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">DeleteProvisioningTemplateVersion</a> action.</p>
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteProvisioningTemplateVersionResponse'
'480':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'481':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'485':
description: ConflictingResourceUpdateException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictingResourceUpdateException'
'486':
description: DeleteConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteConflictException'
parameters:
- name: templateName
in: path
required: true
description: The name of the provisioning template version to delete.
schema:
type: string
pattern: ^[0-9A-Za-z_-]+$
minLength: 1
maxLength: 36
- name: versionId
in: path
required: true
description: The provisioning template version ID to delete.
schema:
type: integer
summary: Amazon IoT Device Defender Delete Provisioning Template Version
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Provisioning Templates
get:
operationId: DescribeProvisioningTemplateVersion
description: <p>Returns information about a provisioning template version.</p> <p>Requires permission to access the <a
# --- truncated at 32 KB (46 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-iot-device-defender/refs/heads/main/openapi/amazon-iot-device-defender-provisioning-templates-api-openapi.yml