IoTThingsGraph / Client / update_flow_template

update_flow_template#

IoTThingsGraph.Client.update_flow_template(**kwargs)#

Updates the specified workflow. All deployed systems and system instances that use the workflow will see the changes in the flow when it is redeployed. If you don’t want this behavior, copy the workflow (creating a new workflow with a different ID), and update the copy. The workflow can contain only entities in the specified namespace.

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

  • id (string) –

    [REQUIRED]

    The ID of the workflow to be updated.

    The ID should be in the following format.

    urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME

  • definition (dict) –

    [REQUIRED]

    The DefinitionDocument that contains the updated workflow 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.

    If no value is specified, the latest version is used by default. Use the GetFlowTemplateRevisions if you want to find earlier revisions of the flow to update.

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 workflow.

      • id (string) –

        The ID of the workflow.

      • arn (string) –

        The ARN of the workflow.

      • revisionNumber (integer) –

        The revision number of the workflow.

      • createdAt (datetime) –

        The date when the workflow was created.

Exceptions

  • IoTThingsGraph.Client.exceptions.InvalidRequestException

  • IoTThingsGraph.Client.exceptions.ResourceNotFoundException

  • IoTThingsGraph.Client.exceptions.ThrottlingException

  • IoTThingsGraph.Client.exceptions.InternalFailureException