Amazon IoT Core Provisioning Templates API

openapi: 3.1.0
info:
  title: AWS IoT Provisioning Templates API
  version: '2015-05-28'
  description: Generated from AWS's published Smithy model for AWS IoT. 10 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://iot.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /provisioning-templates:
    post:
      operationId: CreateProvisioningTemplate
      summary: Create Provisioning Template
      description: Creates a provisioning template. Requires permission to access the CreateProvisioningTemplate action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateProvisioningTemplateResponse'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '410':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '409':
          description: ResourceAlreadyExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceAlreadyExistsException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateProvisioningTemplateRequest'
      tags:
      - Provisioning Templates
    get:
      operationId: ListProvisioningTemplates
      summary: List Provisioning Templates
      description: Lists the provisioning templates in your Amazon Web Services account. Requires permission to access the
        ListProvisioningTemplates action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListProvisioningTemplatesResponse'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListProvisioningTemplatesRequest'
      tags:
      - Provisioning Templates
  /provisioning-templates/{templateName}:
    delete:
      operationId: DeleteProvisioningTemplate
      summary: Delete Provisioning Template
      description: Deletes a provisioning template. Requires permission to access the DeleteProvisioningTemplate action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteProvisioningTemplateResponse'
        '409':
          description: ConflictingResourceUpdateException; DeleteConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictingResourceUpdateException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteProvisioningTemplateRequest'
      tags:
      - Provisioning Templates
    get:
      operationId: DescribeProvisioningTemplate
      summary: Describe Provisioning Template
      description: Returns information about a provisioning template. Requires permission to access the DescribeProvisioningTemplate
        action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeProvisioningTemplateResponse'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeProvisioningTemplateRequest'
      tags:
      - Provisioning Templates
    patch:
      operationId: UpdateProvisioningTemplate
      summary: Update Provisioning Template
      description: Updates a provisioning template. Requires permission to access the UpdateProvisioningTemplate action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateProvisioningTemplateResponse'
        '409':
          description: ConflictingResourceUpdateException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictingResourceUpdateException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateProvisioningTemplateRequest'
      tags:
      - Provisioning Templates
  /provisioning-templates/{templateName}/versions:
    post:
      operationId: CreateProvisioningTemplateVersion
      summary: Create Provisioning Template Version
      description: Creates a new version of a provisioning template. Requires permission to access the CreateProvisioningTemplateVersion
        action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateProvisioningTemplateVersionResponse'
        '409':
          description: ConflictingResourceUpdateException; VersionsLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictingResourceUpdateException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateProvisioningTemplateVersionRequest'
      tags:
      - Provisioning Templates
    get:
      operationId: ListProvisioningTemplateVersions
      summary: List Provisioning Template Versions
      description: A list of provisioning template versions. Requires permission to access the ListProvisioningTemplateVersions
        action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListProvisioningTemplateVersionsResponse'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListProvisioningTemplateVersionsRequest'
      tags:
      - Provisioning Templates
  /provisioning-templates/{templateName}/versions/{versionId}:
    delete:
      operationId: DeleteProvisioningTemplateVersion
      summary: Delete Provisioning Template Version
      description: Deletes a provisioning template version. Requires permission to access the DeleteProvisioningTemplateVersion
        action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteProvisioningTemplateVersionResponse'
        '409':
          description: ConflictingResourceUpdateException; DeleteConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictingResourceUpdateException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteProvisioningTemplateVersionRequest'
      tags:
      - Provisioning Templates
    get:
      operationId: DescribeProvisioningTemplateVersion
      summary: Describe Provisioning Template Version
      description: Returns information about a provisioning template version. Requires permission to access the DescribeProvisioningTemplateVersion
        action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeProvisioningTemplateVersionResponse'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeProvisioningTemplateVersionRequest'
      tags:
      - Provisioning Templates
  /provisioning-templates/{templateName}/provisioning-claim:
    post:
      operationId: CreateProvisioningClaim
      summary: Create Provisioning Claim
      description: Creates a provisioning claim. Requires permission to access the CreateProvisioningClaim action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateProvisioningClaimResponse'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateProvisioningClaimRequest'
      tags:
      - Provisioning Templates
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: iot
  schemas:
    ConflictingResourceUpdateException:
      type: object
      properties:
        message:
          type: string
          description: The message for the exception.
    CreateProvisioningClaimRequest:
      type: object
      properties:
        templateName:
          type: string
          description: The name of the provisioning template to use.
      required:
      - templateName
    CreateProvisioningClaimResponse:
      type: object
      properties:
        certificateId:
          type: string
          description: The ID of the certificate.
        certificatePem:
          type: string
          description: The provisioning claim certificate.
        keyPair:
          $ref: '#/components/schemas/KeyPair'
        expiration:
          type: string
          format: date-time
          description: The provisioning claim expiration time.
    CreateProvisioningTemplateRequest:
      type: object
      properties:
        templateName:
          type: string
          description: The name of the provisioning template.
        description:
          type: string
          description: The description of the provisioning template.
        templateBody:
          type: string
          description: The JSON formatted contents of the provisioning template.
        enabled:
          type: boolean
          description: True to enable the provisioning template, otherwise false.
        provisioningRoleArn:
          type: string
          description: The role ARN for the role associated with the provisioning template. This IoT role grants permission
            to provision a device.
        preProvisioningHook:
          $ref: '#/components/schemas/ProvisioningHook'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: 'Metadata which can be used to manage the provisioning template. For 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:
          type: string
          enum:
          - FLEET_PROVISIONING
          - JITP
          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 FLEET_PROVISIONING. For more information
            about provisioning template, see: Provisioning template.'
      required:
      - templateName
      - templateBody
      - provisioningRoleArn
    CreateProvisioningTemplateResponse:
      type: object
      properties:
        templateArn:
          type: string
          description: The ARN that identifies the provisioning template.
        templateName:
          type: string
          description: The name of the provisioning template.
        defaultVersionId:
          type: integer
          description: The default version of the provisioning template.
    CreateProvisioningTemplateVersionRequest:
      type: object
      properties:
        templateName:
          type: string
          description: The name of the provisioning template.
        templateBody:
          type: string
          description: The JSON formatted contents of the provisioning template.
        setAsDefault:
          type: boolean
          description: Sets a fleet provision template version as the default version.
      required:
      - templateName
      - templateBody
    CreateProvisioningTemplateVersionResponse:
      type: object
      properties:
        templateArn:
          type: string
          description: The ARN that identifies the provisioning template.
        templateName:
          type: string
          description: The name of the provisioning template.
        versionId:
          type: integer
          description: The version of the provisioning template.
        isDefaultVersion:
          type: boolean
          description: True if the provisioning template version is the default version, otherwise false.
    DeleteProvisioningTemplateRequest:
      type: object
      properties:
        templateName:
          type: string
          description: The name of the fleet provision template to delete.
      required:
      - templateName
    DeleteProvisioningTemplateResponse:
      type: object
      properties: {}
    DeleteProvisioningTemplateVersionRequest:
      type: object
      properties:
        templateName:
          type: string
          description: The name of the provisioning template version to delete.
        versionId:
          type: integer
          description: The provisioning template version ID to delete.
      required:
      - templateName
      - versionId
    DeleteProvisioningTemplateVersionResponse:
      type: object
      properties: {}
    DescribeProvisioningTemplateRequest:
      type: object
      properties:
        templateName:
          type: string
          description: The name of the provisioning template.
      required:
      - templateName
    DescribeProvisioningTemplateResponse:
      type: object
      properties:
        templateArn:
          type: string
          description: The ARN of the provisioning template.
        templateName:
          type: string
          description: The name of the provisioning template.
        description:
          type: string
          description: The description of the provisioning template.
        creationDate:
          type: string
          format: date-time
          description: The date when the provisioning template was created.
        lastModifiedDate:
          type: string
          format: date-time
          description: The date when the provisioning template was last modified.
        defaultVersionId:
          type: integer
          description: The default fleet template version ID.
        templateBody:
          type: string
          description: The JSON formatted contents of the provisioning template.
        enabled:
          type: boolean
          description: True if the provisioning template is enabled, otherwise false.
        provisioningRoleArn:
          type: string
          description: The ARN of the role associated with the provisioning template. This IoT role grants permission to provision
            a device.
        preProvisioningHook:
          $ref: '#/components/schemas/ProvisioningHook'
        type:
          type: string
          enum:
          - FLEET_PROVISIONING
          - JITP
          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 FLEET_PROVISIONING. For more information
            about provisioning template, see: Provisioning template.'
    DescribeProvisioningTemplateVersionRequest:
      type: object
      properties:
        templateName:
          type: string
          description: The template name.
        versionId:
          type: integer
          description: The provisioning template version ID.
      required:
      - templateName
      - versionId
    DescribeProvisioningTemplateVersionResponse:
      type: object
      properties:
        versionId:
          type: integer
          description: The provisioning template version ID.
        creationDate:
          type: string
          format: date-time
          description: The date when the provisioning template version was created.
        templateBody:
          type: string
          description: The JSON formatted contents of the provisioning template version.
        isDefaultVersion:
          type: boolean
          description: True if the provisioning template version is the default version.
    InternalFailureException:
      type: object
      properties:
        message:
          type: string
          description: The message for the exception.
    InvalidRequestException:
      type: object
      properties:
        message:
          type: string
          description: The message for the exception.
    KeyPair:
      type: object
      properties:
        PublicKey:
          type: string
          description: The public key.
        PrivateKey:
          type: string
          description: The private key.
    LimitExceededException:
      type: object
      properties:
        message:
          type: string
          description: The message for the exception.
    ListProvisioningTemplateVersionsRequest:
      type: object
      properties:
        templateName:
          type: string
          description: The name of the provisioning template.
        maxResults:
          type: integer
          description: The maximum number of results to return at one time.
        nextToken:
          type: string
          description: A token to retrieve the next set of results.
      required:
      - templateName
    ListProvisioningTemplateVersionsResponse:
      type: object
      properties:
        versions:
          type: array
          items:
            $ref: '#/components/schemas/ProvisioningTemplateVersionSummary'
          description: The list of provisioning template versions.
        nextToken:
          type: string
          description: A token to retrieve the next set of results.
    ListProvisioningTemplatesRequest:
      type: object
      properties:
        maxResults:
          type: integer
          description: The maximum number of results to return at one time.
        nextToken:
          type: string
          description: A token to retrieve the next set of results.
    ListProvisioningTemplatesResponse:
      type: object
      properties:
        templates:
          type: array
          items:
            $ref: '#/components/schemas/ProvisioningTemplateSummary'
          description: A list of provisioning templates
        nextToken:
          type: string
          description: A token to retrieve the next set of results.
    ProvisioningHook:
      type: object
      properties:
        payloadVersion:
          type: string
          description: 'The payload that was sent to the target function. Note: Only Lambda functions are currently supported.'
        targetArn:
          type: string
          description: 'The ARN of the target function. Note: Only Lambda functions are currently supported.'
      required:
      - targetArn
    ProvisioningTemplateSummary:
      type: object
      properties:
        templateArn:
          type: string
          description: The ARN of the provisioning template.
        templateName:
          type: string
          description: The name of the provisioning template.
        description:
          type: string
          description: The description of the provisioning template.
        creationDate:
          type: string
          format: date-time
          description: The date when the provisioning template summary was created.
        lastModifiedDate:
          type: string
          format: date-time
          description: The date when the provisioning template summary was last modified.
        enabled:
          type: boolean
          description: True if the fleet provision template is enabled, otherwise false.
        type:
          type: string
          enum:
          - FLEET_PROVISIONING
          - JITP
          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 FLEET_PROVISIONING. For more information
            about provisioning template, see: Provisioning template.'
    ProvisioningTemplateVersionSummary:
      type: object
      properties:
        versionId:
          type: integer
          description: The ID of the fleet provisioning template version.
        creationDate:
          type: string
          format: date-time
          description: The date when the provisioning template version was created
        isDefaultVersion:
          type: boolean
          description: True if the provisioning template version is the default version, otherwise false.
    ResourceAlreadyExistsException:
      type: object
      properties:
        message:
          type: string
          description: The message for the exception.
        resourceId:
          type: string
          description: The ID of the resource that caused the exception.
        resourceArn:
          type: string
          description: The ARN of the resource that caused the exception.
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
          description: The message for the exception.
    ServiceUnavailableException:
      type: object
      properties:
        message:
          type: string
          description: The message for the exception.
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The tag's key.
        Value:
          type: string
          description: The tag's value.
      required:
      - Key
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
          description: The message for the exception.
    UpdateProvisioningTemplateRequest:
      type: object
      properties:
        templateName:
          type: string
          description: The name of the provisioning template.
        description:
          type: string
          description: The description of the provisioning template.
        enabled:
          type: boolean
          description: True to enable the provisioning template, otherwise false.
        defaultVersionId:
          type: integer
          description: The ID of the default provisioning template version.
        provisioningRoleArn:
          type: string
          description: The ARN of the role associated with the provisioning template. This IoT role grants permission to provision
            a device.
        preProvisioningHook:
          $ref: '#/components/schemas/ProvisioningHook'
        removePreProvisioningHook:
          type: boolean
          description: Removes pre-provisioning hook template.
      required:
      - templateName
    UpdateProvisioningTemplateResponse:
      type: object
      properties: {}
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/iot/service/2015-05-28/iot-2015-05-28.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)