Amazon IoT Core

Amazon IoT Core Thing Registration Tasks API

The Thing Registration Tasks API from Amazon IoT Core — 4 operation(s) for thing registration tasks.

Documentation GitHub OpenAPI

Business capability

Device Management & Provisioning AE-200.40

Operations 5

GET /thing-registration-tasks/{taskId} Describe Thing Registration Task #

GET /thing-registration-tasks List Thing Registration Tasks #

POST /thing-registration-tasks Start Thing Registration Task #

PUT /thing-registration-tasks/{taskId}/cancel Stop Thing Registration Task #

GET /thing-registration-tasks/{taskId}/reports List Thing Registration Task Reports #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-iot-core:amazon-iot-core-thing-registration-tasks-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.1.0
info:
  title: AWS IoT Thing Registration Tasks API
  version: '2015-05-28'
  description: Generated from AWS's published Smithy model for AWS IoT. 5 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:
  /thing-registration-tasks/{taskId}:
    get:
      operationId: DescribeThingRegistrationTask
      summary: Describe Thing Registration Task
      description: Describes a bulk thing provisioning task. Requires permission to access the DescribeThingRegistrationTask
        action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeThingRegistrationTaskResponse'
        '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/DescribeThingRegistrationTaskRequest'
      tags:
      - Thing Registration Tasks
  /thing-registration-tasks:
    get:
      operationId: ListThingRegistrationTasks
      summary: List Thing Registration Tasks
      description: List bulk thing provisioning tasks. Requires permission to access the ListThingRegistrationTasks action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListThingRegistrationTasksResponse'
        '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/ListThingRegistrationTasksRequest'
      tags:
      - Thing Registration Tasks
    post:
      operationId: StartThingRegistrationTask
      summary: Start Thing Registration Task
      description: Creates a bulk thing provisioning task. Requires permission to access the StartThingRegistrationTask action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartThingRegistrationTaskResponse'
        '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/StartThingRegistrationTaskRequest'
      tags:
      - Thing Registration Tasks
  /thing-registration-tasks/{taskId}/cancel:
    put:
      operationId: StopThingRegistrationTask
      summary: Stop Thing Registration Task
      description: Cancels a bulk thing provisioning task. Requires permission to access the StopThingRegistrationTask action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StopThingRegistrationTaskResponse'
        '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/StopThingRegistrationTaskRequest'
      tags:
      - Thing Registration Tasks
  /thing-registration-tasks/{taskId}/reports:
    get:
      operationId: ListThingRegistrationTaskReports
      summary: List Thing Registration Task Reports
      description: Information about the thing registration tasks.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListThingRegistrationTaskReportsResponse'
        '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/ListThingRegistrationTaskReportsRequest'
      tags:
      - Thing Registration Tasks
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:
    DescribeThingRegistrationTaskRequest:
      type: object
      properties:
        taskId:
          type: string
          description: The task ID.
      required:
      - taskId
    DescribeThingRegistrationTaskResponse:
      type: object
      properties:
        taskId:
          type: string
          description: The task ID.
        creationDate:
          type: string
          format: date-time
          description: The task creation date.
        lastModifiedDate:
          type: string
          format: date-time
          description: The date when the task was last modified.
        templateBody:
          type: string
          description: The task's template.
        inputFileBucket:
          type: string
          description: The S3 bucket that contains the input file.
        inputFileKey:
          type: string
          description: The input file key.
        roleArn:
          type: string
          description: The role ARN that grants access to the input file bucket.
        status:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          - Cancelled
          - Cancelling
          description: The status of the bulk thing provisioning task.
        message:
          type: string
          description: The message.
        successCount:
          type: integer
          description: The number of things successfully provisioned.
        failureCount:
          type: integer
          description: The number of things that failed to be provisioned.
        percentageProgress:
          type: integer
          description: The progress of the bulk provisioning task expressed as a percentage.
    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.
    ListThingRegistrationTaskReportsRequest:
      type: object
      properties:
        taskId:
          type: string
          description: The id of the task.
        reportType:
          type: string
          enum:
          - ERRORS
          - RESULTS
          description: The type of task report.
        nextToken:
          type: string
          description: To retrieve the next set of results, the nextToken value from a previous response; otherwise null to
            receive the first set of results.
        maxResults:
          type: integer
          description: The maximum number of results to return per request.
      required:
      - taskId
      - reportType
    ListThingRegistrationTaskReportsResponse:
      type: object
      properties:
        resourceLinks:
          type: array
          items:
            type: string
          description: Links to the task resources.
        reportType:
          type: string
          enum:
          - ERRORS
          - RESULTS
          description: The type of task report.
        nextToken:
          type: string
          description: The token to use to get the next set of results, or null if there are no additional results.
    ListThingRegistrationTasksRequest:
      type: object
      properties:
        nextToken:
          type: string
          description: To retrieve the next set of results, the nextToken value from a previous response; otherwise null to
            receive the first set of results.
        maxResults:
          type: integer
          description: The maximum number of results to return at one time.
        status:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          - Cancelled
          - Cancelling
          description: The status of the bulk thing provisioning task.
    ListThingRegistrationTasksResponse:
      type: object
      properties:
        taskIds:
          type: array
          items:
            type: string
          description: A list of bulk thing provisioning task IDs.
        nextToken:
          type: string
          description: The token to use to get the next set of results, or null if there are no additional results.
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
          description: The message for the exception.
    StartThingRegistrationTaskRequest:
      type: object
      properties:
        templateBody:
          type: string
          description: The provisioning template.
        inputFileBucket:
          type: string
          description: The S3 bucket that contains the input file.
        inputFileKey:
          type: string
          description: The name of input file within the S3 bucket. This file contains a newline delimited JSON file. Each
            line contains the parameter values to provision one device (thing).
        roleArn:
          type: string
          description: The IAM role ARN that grants permission the input file.
      required:
      - templateBody
      - inputFileBucket
      - inputFileKey
      - roleArn
    StartThingRegistrationTaskResponse:
      type: object
      properties:
        taskId:
          type: string
          description: The bulk thing provisioning task ID.
    StopThingRegistrationTaskRequest:
      type: object
      properties:
        taskId:
          type: string
          description: The bulk thing provisioning task ID.
      required:
      - taskId
    StopThingRegistrationTaskResponse:
      type: object
      properties: {}
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
          description: The message for the exception.
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)

Amazon IoT Core Thing Registration Tasks API

Operations 5

Documentation

Specifications

Schemas & Data

Other Resources