Class DeploySystemInstanceCommandProtected

Deprecated

Greengrass and Cloud Deployments

Deploys the system instance to the target specified in CreateSystemInstance.

Greengrass Deployments

If the system or any workflows and entities have been updated before this action is called, then the deployment will create a new Amazon Simple Storage Service resource file and then deploy it.

Since this action creates a Greengrass deployment on the caller's behalf, the calling identity must have write permissions to the specified Greengrass group. Otherwise, the call will fail with an authorization error.

For information about the artifacts that get added to your Greengrass core device when you use this API, see AWS IoT Things Graph and AWS IoT Greengrass.

Example

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

import { IoTThingsGraphClient, DeploySystemInstanceCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import
// const { IoTThingsGraphClient, DeploySystemInstanceCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import
const client = new IoTThingsGraphClient(config);
const input = { // DeploySystemInstanceRequest
  id: "STRING_VALUE",
};
const command = new DeploySystemInstanceCommand(input);
const response = await client.send(command);

Param

DeploySystemInstanceCommandInput

Returns

DeploySystemInstanceCommandOutput

See

• DeploySystemInstanceCommandInput for command's input shape.
• DeploySystemInstanceCommandOutput for command's response shape.
• config for IoTThingsGraphClient's config shape.

Throws

InternalFailureException (server fault)

Throws

InvalidRequestException (client fault)

Throws

ResourceInUseException (client fault)

Throws

ResourceNotFoundException (client fault)

Throws

ThrottlingException (client fault)