- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
SearchSystemTemplatesCommand
- since: 2022-08-30
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.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { IoTThingsGraphClient, SearchSystemTemplatesCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import
// const { IoTThingsGraphClient, SearchSystemTemplatesCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import
const client = new IoTThingsGraphClient(config);
const input = { // SearchSystemTemplatesRequest
filters: [ // SystemTemplateFilters
{ // SystemTemplateFilter
name: "FLOW_TEMPLATE_ID", // required
value: [ // SystemTemplateFilterValues // required
"STRING_VALUE",
],
},
],
nextToken: "STRING_VALUE",
maxResults: Number("int"),
};
const command = new SearchSystemTemplatesCommand(input);
const response = await client.send(command);
// { // SearchSystemTemplatesResponse
// summaries: [ // SystemTemplateSummaries
// { // SystemTemplateSummary
// id: "STRING_VALUE",
// arn: "STRING_VALUE",
// revisionNumber: Number("long"),
// createdAt: new Date("TIMESTAMP"),
// },
// ],
// nextToken: "STRING_VALUE",
// };
SearchSystemTemplatesCommand Input
See SearchSystemTemplatesCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
filters | SystemTemplateFilter[] | undefined | An array of filters that limit the result set. The only valid filter is |
maxResults | number | undefined | The maximum number of results to return in the response. |
nextToken | string | undefined | The string that specifies the next page of results. Use this when you're paginating results. |
SearchSystemTemplatesCommand Output
See SearchSystemTemplatesCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
nextToken | string | undefined | The string to specify as |
summaries | SystemTemplateSummary[] | undefined | An array of objects that contain summary information about each system deployment in the result set. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
InternalFailureException | server | |
InvalidRequestException | client | |
ThrottlingException | client | |
IoTThingsGraphServiceException | Base exception class for all service exceptions from IoTThingsGraph service. |