Class CreateSystemInstanceCommandProtected

Deprecated

Creates a system instance.

This action validates the system instance, prepares the deployment-related resources. For Greengrass deployments, it updates the Greengrass group that is specified by the greengrassGroupName parameter. It also adds a file to the S3 bucket specified by the s3BucketName parameter. You need to call DeploySystemInstance after running this action.

For Greengrass deployments, since this action modifies and adds resources to a Greengrass group and an S3 bucket on the caller's behalf, the calling identity must have write permissions to both the specified Greengrass group and S3 bucket. Otherwise, the call will fail with an authorization error.

For cloud deployments, this action requires a flowActionsRoleArn value. This is an IAM role that has permissions to access AWS services, such as AWS Lambda and AWS IoT, that the flow uses when it executes.

If the definition document doesn't specify a version of the user's namespace, the latest version will be used by default.

Example

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

import { IoTThingsGraphClient, CreateSystemInstanceCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import
// const { IoTThingsGraphClient, CreateSystemInstanceCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS import
const client = new IoTThingsGraphClient(config);
const input = { // CreateSystemInstanceRequest
  tags: [ // TagList
    { // Tag
      key: "STRING_VALUE", // required
      value: "STRING_VALUE", // required
    },
  ],
  definition: { // DefinitionDocument
    language: "STRING_VALUE", // required
    text: "STRING_VALUE", // required
  },
  target: "STRING_VALUE", // required
  greengrassGroupName: "STRING_VALUE",
  s3BucketName: "STRING_VALUE",
  metricsConfiguration: { // MetricsConfiguration
    cloudMetricEnabled: true || false,
    metricRuleRoleArn: "STRING_VALUE",
  },
  flowActionsRoleArn: "STRING_VALUE",
};
const command = new CreateSystemInstanceCommand(input);
const response = await client.send(command);

Param

CreateSystemInstanceCommandInput

Returns

CreateSystemInstanceCommandOutput

See

• CreateSystemInstanceCommandInput for command's input shape.
• CreateSystemInstanceCommandOutput for command's response shape.
• config for IoTThingsGraphClient's config shape.

Throws

InternalFailureException (server fault)

Throws

InvalidRequestException (client fault)

Throws

LimitExceededException (client fault)

Throws

ResourceAlreadyExistsException (client fault)

Throws

ThrottlingException (client fault)