Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class UndeploySystemInstanceCommandProtected

Deprecated

Removes a system instance from its target (Cloud or Greengrass).

Example

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

import { IoTThingsGraphClient, UndeploySystemInstanceCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import
// const { IoTThingsGraphClient, UndeploySystemInstanceCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import
const client = new IoTThingsGraphClient(config);
const input = { // UndeploySystemInstanceRequest
id: "STRING_VALUE",
};
const command = new UndeploySystemInstanceCommand(input);
const response = await client.send(command);
// { // UndeploySystemInstanceResponse
// summary: { // SystemInstanceSummary
// id: "STRING_VALUE",
// arn: "STRING_VALUE",
// status: "NOT_DEPLOYED" || "BOOTSTRAP" || "DEPLOY_IN_PROGRESS" || "DEPLOYED_IN_TARGET" || "UNDEPLOY_IN_PROGRESS" || "FAILED" || "PENDING_DELETE" || "DELETED_IN_TARGET",
// target: "GREENGRASS" || "CLOUD",
// greengrassGroupName: "STRING_VALUE",
// createdAt: new Date("TIMESTAMP"),
// updatedAt: new Date("TIMESTAMP"),
// greengrassGroupId: "STRING_VALUE",
// greengrassGroupVersionId: "STRING_VALUE",
// },
// };

Param

UndeploySystemInstanceCommandInput

Returns

UndeploySystemInstanceCommandOutput

See

Throws

InternalFailureException (server fault)

Throws

InvalidRequestException (client fault)

Throws

ResourceInUseException (client fault)

Throws

ResourceNotFoundException (client fault)

Throws

ThrottlingException (client fault)

Throws

IoTThingsGraphServiceException

Base exception class for all service exceptions from IoTThingsGraph service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods