v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1483477323.4 KB

Creates a managed thing. A managed thing contains the device identifier, protocol supported, and capabilities of the device in a data model format defined by Managed integrations.

post/managed-things

Request body

Role'CONTROLLER' | 'DEVICE' required

The type of device used. This will be the hub controller, cloud device, or AWS IoT device.

Ownerstring password

Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.

CredentialLockerIdstring

The identifier of the credential for the managed thing.

AuthenticationMaterialstring password required

The authentication material defining the device connectivity setup requests. The authorization materials used are the device bar code.

AuthenticationMaterialType'CUSTOM_PROTOCOL_QR_BAR_CODE' | 'WIFI_SETUP_QR_BAR_CODE' | 'ZWAVE_QR_BAR_CODE' | 'ZIGBEE_QR_BAR_CODE' | 'DISCOVERED_DEVICE' | 'PRE_ONBOARDED_CLOUD' required

The type of authentication material used for device connectivity setup requests.

SerialNumberstring password

The serial number of the device.

Brandstring password

The brand of the device.

Modelstring password

The model of the device.

Namestring

The name of the managed thing representing the physical device.

Capabilitiesstring

The capabilities of the device such as light bulb.

ClientTokenstring

An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

Classificationstring password

The classification of the managed thing such as light bulb or thermostat.

Tagsobject

A set of key/value pairs that are used to manage the managed thing.

MetaDataobject
<p>The metadata for the managed thing.</p> <note> <p>The <code>managedThing</code> <code>metadata</code> parameter is used for associating attributes with a <code>managedThing</code> that can be used for grouping over-the-air (OTA) tasks. Name value pairs in <code>metadata</code> can be used in the <code>OtaTargetQueryString</code> parameter for the <code>CreateOtaTask</code> API operation.</p> </note>

Response

Success

Idstring

The id of the managed thing.

Arnstring

The Amazon Resource Name (ARN) of the managed thing.

CreatedAtstring date-time

The timestamp value of when the device creation request occurred.