AWS IoT Things Graph
Welcome (API Version 2018-09-06)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

CreateSystemTemplate

Creates a system. The system is validated against the entities in the latest version of the user's namespace unless another namespace version is specified in the request.

Request Syntax

{ "compatibleNamespaceVersion": number, "definition": { "language": "string", "text": "string" } }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

compatibleNamespaceVersion

The namespace version in which the system is to be created.

If no value is specified, the latest version is used by default.

Type: Long

Required: No

definition

The DefinitionDocument used to create the system.

Type: DefinitionDocument object

Required: Yes

Response Syntax

{ "summary": { "arn": "string", "createdAt": number, "id": "string", "revisionNumber": number } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

summary

The summary object that describes the created system.

Type: SystemTemplateSummary object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalFailureException

HTTP Status Code: 500

InvalidRequestException

HTTP Status Code: 400

ResourceAlreadyExistsException

HTTP Status Code: 400

ThrottlingException

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: