Class SearchEntitiesCommandProtected

Deprecated

Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking.

Example

Use a bare-bones client and the command you need to make an API call.

import { IoTThingsGraphClient, SearchEntitiesCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import
// const { IoTThingsGraphClient, SearchEntitiesCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import
const client = new IoTThingsGraphClient(config);
const input = { // SearchEntitiesRequest
  entityTypes: [ // EntityTypes // required
    "STRING_VALUE",
  ],
  filters: [ // EntityFilters
    { // EntityFilter
      name: "STRING_VALUE",
      value: [ // EntityFilterValues
        "STRING_VALUE",
      ],
    },
  ],
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
  namespaceVersion: Number("long"),
};
const command = new SearchEntitiesCommand(input);
const response = await client.send(command);

Param

SearchEntitiesCommandInput

Returns

SearchEntitiesCommandOutput

See

• SearchEntitiesCommandInput for command's input shape.
• SearchEntitiesCommandOutput for command's response shape.
• config for IoTThingsGraphClient's config shape.

Throws

InternalFailureException (server fault)

Throws

InvalidRequestException (client fault)

Throws

ThrottlingException (client fault)