IoTThingsGraph / Client / update_system_template

update_system_template#

IoTThingsGraph.Client.update_system_template(**kwargs)#

Updates the specified system. You don’t need to run this action after updating a workflow. Any deployment that uses the system will see the changes in the system when it is redeployed.

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.update_system_template(
    id='string',
    definition={
        'language': 'GRAPHQL',
        'text': 'string'
    },
    compatibleNamespaceVersion=123
)
Parameters:

  • id (string) –

    [REQUIRED]

    The ID of the system to be updated.

    The ID should be in the following format.

    urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME

  • definition (dict) –

    [REQUIRED]

    The DefinitionDocument that contains the updated system definition.

    • 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 version of the user’s namespace. Defaults to the latest version of the user’s namespace.

    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) –

      An object containing summary information about the updated 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

  • IoTThingsGraph.Client.exceptions.InvalidRequestException

  • IoTThingsGraph.Client.exceptions.ResourceNotFoundException

  • IoTThingsGraph.Client.exceptions.ThrottlingException

  • IoTThingsGraph.Client.exceptions.InternalFailureException