IoTThingsGraph / Client / search_flow_templates

search_flow_templates#

IoTThingsGraph.Client.search_flow_templates(**kwargs)#

Searches for summary information about workflows.

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.search_flow_templates(
    filters=[
        {
            'name': 'DEVICE_MODEL_ID',
            'value': [
                'string',
            ]
        },
    ],
    nextToken='string',
    maxResults=123
)
Parameters:

  • filters (list) –

    An array of objects that limit the result set. The only valid filter is DEVICE_MODEL_ID .

    • (dict) –

      An object that filters a workflow search.

      • name (string) – [REQUIRED]

        The name of the search filter field.

      • value (list) – [REQUIRED]

        An array of string values for the search filter field. Multiple values function as AND criteria in the search.

        • (string) –

  • nextToken (string) – The string that specifies the next page of results. Use this when you’re paginating results.

  • maxResults (integer) – The maximum number of results to return in the response.

Return type:

dict

Returns:

Response Syntax

{
    'summaries': [
        {
            'id': 'string',
            'arn': 'string',
            'revisionNumber': 123,
            'createdAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • summaries (list) –

      An array of objects that contain summary information about each workflow in the result set.

      • (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.

    • nextToken (string) –

      The string to specify as nextToken when you request the next page of results.

Exceptions

  • IoTThingsGraph.Client.exceptions.InvalidRequestException

  • IoTThingsGraph.Client.exceptions.ThrottlingException

  • IoTThingsGraph.Client.exceptions.InternalFailureException