SearchSystemInstances - AWS IoT Things Graph


Searches for system instances in the user's account.

Request Syntax

{ "filters": [ { "name": "string", "value": [ "string" ] } ], "maxResults": number, "nextToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


Optional filter to apply to the search. Valid filters are SYSTEM_TEMPLATE_ID, STATUS, and GREENGRASS_GROUP_NAME.

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

Type: Array of SystemInstanceFilter objects

Required: No


The maximum number of results to return in the response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 250.

Required: No


The string that specifies the next page of results. Use this when you're paginating results.

Type: String

Required: No

Response Syntax

{ "nextToken": "string", "summaries": [ { "arn": "string", "createdAt": number, "greengrassGroupId": "string", "greengrassGroupName": "string", "greengrassGroupVersionId": "string", "id": "string", "status": "string", "target": "string", "updatedAt": number } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


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

Type: String


An array of objects that contain summary data abour the system instances in the result set.

Type: Array of SystemInstanceSummary objects


For information about the errors that are common to all actions, see Common Errors.


HTTP Status Code: 500


HTTP Status Code: 400


HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: