We are excited to announce our new API Documentation.
Protected
Gets a system instance.
Use a bare-bones client and the command you need to make an API call.
import { IoTThingsGraphClient, GetSystemInstanceCommand } from "@aws-sdk/client-iotthingsgraph"; // ES Modules import// const { IoTThingsGraphClient, GetSystemInstanceCommand } = require("@aws-sdk/client-iotthingsgraph"); // CommonJS importconst client = new IoTThingsGraphClient(config);const input = { // GetSystemInstanceRequest id: "STRING_VALUE", // required};const command = new GetSystemInstanceCommand(input);const response = await client.send(command);// { // GetSystemInstanceResponse// description: { // SystemInstanceDescription// 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",// },// definition: { // DefinitionDocument// language: "GRAPHQL", // required// text: "STRING_VALUE", // required// },// s3BucketName: "STRING_VALUE",// metricsConfiguration: { // MetricsConfiguration// cloudMetricEnabled: true || false,// metricRuleRoleArn: "STRING_VALUE",// },// validatedNamespaceVersion: Number("long"),// validatedDependencyRevisions: [ // DependencyRevisions// { // DependencyRevision// id: "STRING_VALUE",// revisionNumber: Number("long"),// },// ],// flowActionsRoleArn: "STRING_VALUE",// },// };
GetSystemInstanceCommandInput
GetSystemInstanceCommandOutput
input
response
config
InternalFailureException (server fault)
InvalidRequestException (client fault)
ResourceNotFoundException (client fault)
ThrottlingException (client fault)
IoTThingsGraphServiceException
Base exception class for all service exceptions from IoTThingsGraph service.
Readonly
Static
Deprecated
Gets a system instance.
Example
Use a bare-bones client and the command you need to make an API call.
Param
GetSystemInstanceCommandInput
Returns
GetSystemInstanceCommandOutput
See
input
shape.response
shape.config
shape.Throws
InternalFailureException (server fault)
Throws
InvalidRequestException (client fault)
Throws
ResourceNotFoundException (client fault)
Throws
ThrottlingException (client fault)
Throws
IoTThingsGraphServiceException
Base exception class for all service exceptions from IoTThingsGraph service.