Menu
AWS IoT
Developer Guide

RegisterThing

Provisions a thing.

Request syntax:

POST /things Content-type: application/json { "templateBody": "string", "parameters": { "string": "string" } }

Request Body Parameters:

Name

Type

Req?

Description

templateBody

TemplateBody

yes

The provisioning template. See Programmatic Provisioning for more information.

parameters

Parameters

no

The parameters for provisioning a thing. See Programmatic Provisioning for more information.

Response syntax:

Content-type: application/json { "certificatePem": "string", "resourceArns": { "string": "string" } }

Response Body Parameters:

Name

Type

Req?

Description

certificatePem

CertificatePem

no

resourceArns

ResourceArns

no

ARNs for the generated resources.

Errors:

InternalFailureException

An unexpected error has occurred.

HTTP response code: 500

ServiceUnavailableException

The service is temporarily unavailable.

HTTP response code: 503

InvalidRequestException

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

HTTP response code: 400

UnauthorizedException

You are not authorized to perform this operation.

HTTP response code: 401

ThrottlingException

The rate exceeds the limit.

HTTP response code: 429

ConflictingResourceUpdateException

A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.

HTTP response code: 409

ResourceRegistrationFailureException

The resource registration failed.

HTTP response code: 400

CLI

Synopsis:

aws iot register-thing \ --template-body <value> \ [--parameters <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "templateBody": "string", "parameters": { "string": "string" } }

cli-input-json fields:

Name

Type

Description

templateBody

string

The provisioning template. See Programmatic Provisioning for more information.

parameters

map

key: Parameter

value: Value

The parameters for provisioning a thing. See Programmatic Provisioning for more information.

Parameter

string

Value

string

Output:

{ "certificatePem": "string", "resourceArns": { "string": "string" } }

cli output fields:

Name

Type

Description

certificatePem

string

length max:65536 min:1

resourceArns

map

key: ResourceLogicalId

value: ResourceArn

ARNs for the generated resources.

ResourceLogicalId

string

ResourceArn

string

On this page: