[ aws . iot ]

create-thing-type

Description

Creates a new thing type.

Requires permission to access the CreateThingType action.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-thing-type
--thing-type-name <value>
[--thing-type-properties <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--thing-type-name (string)

The name of the thing type.

--thing-type-properties (structure)

The ThingTypeProperties for the thing type to create. It contains information about the new thing type including a description, and a list of searchable thing attribute names.

thingTypeDescription -> (string)

The description of the thing type.

searchableAttributes -> (list)

A list of searchable thing attribute names.

(string)

Shorthand Syntax:

thingTypeDescription=string,searchableAttributes=string,string

JSON Syntax:

{
  "thingTypeDescription": "string",
  "searchableAttributes": ["string", ...]
}

--tags (list)

Metadata which can be used to manage the thing type.

(structure)

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

Key -> (string)

The tag’s key.

Value -> (string)

The tag’s value.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To define a thing type

The following create-thing-type example defines a thing type and associated attributes.

aws iot create-thing-type \
    --thing-type-name "LightBulb" \
    --thing-type-properties "thingTypeDescription=light bulb type, searchableAttributes=wattage,model"

Output:

{
    "thingTypeName": "LightBulb",
    "thingTypeArn": "arn:aws:iot:us-west-2:123456789012:thingtype/LightBulb",
    "thingTypeId": "ce3573b0-0a3c-45a7-ac93-4e0ce14cd190"
}

For more information, see Thing Types in the AWS IoT Developers Guide.

Output

thingTypeName -> (string)

The name of the thing type.

thingTypeArn -> (string)

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

thingTypeId -> (string)

The thing type ID.