IoTThingsGraph / Client / search_system_templates

search_system_templates#

IoTThingsGraph.Client.search_system_templates(**kwargs)#

Searches for summary information about systems in the user’s account. You can filter by the ID of a workflow to return only systems that use 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.search_system_templates(
    filters=[
        {
            'name': 'FLOW_TEMPLATE_ID',
            'value': [
                'string',
            ]
        },
    ],
    nextToken='string',
    maxResults=123
)
Parameters:

  • filters (list) –

    An array of filters that limit the result set. The only valid filter is FLOW_TEMPLATE_ID.

    • (dict) –

      An object that filters a system search.

      • name (string) – [REQUIRED]

        The name of the system 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 system deployment in the result set.

      • (dict) –

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

    • 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