IoTThingsGraph / Client / create_system_template

create_system_template

IoTThingsGraph.Client.create_system_template(**kwargs)

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.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.create_system_template(
    definition={
        'language': 'GRAPHQL',
        'text': 'string'
    },
    compatibleNamespaceVersion=123
)
Parameters:

  • definition (dict) –

    [REQUIRED]

    The DefinitionDocument used to create the system.

    • language (string) – [REQUIRED]

      The language used to define the entity. GRAPHQL is the only valid value.

    • text (string) – [REQUIRED]

      The GraphQL text that defines the entity.

  • compatibleNamespaceVersion (integer) –

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

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

Return type:

dict

Returns:

Response Syntax

{
    'summary': {
        'id': 'string',
        'arn': 'string',
        'revisionNumber': 123,
        'createdAt': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • summary (dict) –

      The summary object that describes the created system.

      • id (string) –

        The ID of the system.

      • arn (string) –

        The ARN of the system.

      • revisionNumber (integer) –

        The revision number of the system.

      • createdAt (datetime) –

        The date when the system was created.

Exceptions