Menu
AWS IoT
Developer Guide

DeprecateThingType

Deprecates a thing type. You can not associate new things with deprecated thing type.

Request syntax:

POST /thing-types/thingTypeName/deprecate Content-type: application/json { "undoDeprecate": "boolean" }

URI Request Parameters:

Name

Type

Req?

Description

thingTypeName

ThingTypeName

yes

The name of the thing type to deprecate.

Request Body Parameters:

Name

Type

Req?

Description

undoDeprecate

UndoDeprecate

no

Whether to undeprecate a deprecated thing type. If true, the thing type will not be deprecated anymore and you can associate it with things.

Errors:

ResourceNotFoundException

The specified resource does not exist.

HTTP response code: 404

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

ThrottlingException

The rate exceeds the limit.

HTTP response code: 429

UnauthorizedException

You are not authorized to perform this operation.

HTTP response code: 401

ServiceUnavailableException

The service is temporarily unavailable.

HTTP response code: 503

InternalFailureException

An unexpected error has occurred.

HTTP response code: 500

CLI

Synopsis:

aws iot deprecate-thing-type \ --thing-type-name <value> \ [--undo-deprecate | --no-undo-deprecate] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "thingTypeName": "string", "undoDeprecate": "boolean" }

cli-input-json fields:

Name

Type

Description

thingTypeName

string

length max:128 min:1

pattern: [a-zA-Z0-9:_-]+

The name of the thing type to deprecate.

undoDeprecate

boolean

Whether to undeprecate a deprecated thing type. If true, the thing type will not be deprecated anymore and you can associate it with things.

Output:

None

On this page: