IoTThingsGraph / Client / get_flow_template

get_flow_template#

IoTThingsGraph.Client.get_flow_template(**kwargs)#

Gets the latest version of the DefinitionDocument and FlowTemplateSummary for the specified workflow.

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.get_flow_template(
    id='string',
    revisionNumber=123
)
Parameters:

  • id (string) –

    [REQUIRED]

    The ID of the workflow.

    The ID should be in the following format.

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

  • revisionNumber (integer) – The number of the workflow revision to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'description': {
        'summary': {
            'id': 'string',
            'arn': 'string',
            'revisionNumber': 123,
            'createdAt': datetime(2015, 1, 1)
        },
        'definition': {
            'language': 'GRAPHQL',
            'text': 'string'
        },
        'validatedNamespaceVersion': 123
    }
}

Response Structure

  • (dict) –

    • description (dict) –

      The object that describes the specified workflow.

      • summary (dict) –

        An object that contains summary information about a 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.

      • definition (dict) –

        A workflow’s definition document.

        • language (string) –

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

        • text (string) –

          The GraphQL text that defines the entity.

      • validatedNamespaceVersion (integer) –

        The version of the user’s namespace against which the workflow was validated. Use this value in your system instance.

Exceptions