Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetSystemInstance

Gets a system instance.

Request Syntax


{
   "id": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

id

The ID of the system deployment instance. This value is returned by CreateSystemInstance.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME

Type: String

Length Constraints: Maximum length of 160.

Pattern: ^urn:tdm:(([a-z]{2}-(gov-)?[a-z]{4,9}-[0-9]{1,3}/[0-9]+/)*[\p{Alnum}_]+(/[\p{Alnum}_]+)*):([\p{Alpha}]*):([\p{Alnum}_]+(/[\p{Alnum}_]+)*)$

Required: Yes

Response Syntax


{
   "description": { 
      "definition": { 
         "language": "string",
         "text": "string"
      },
      "flowActionsRoleArn": "string",
      "metricsConfiguration": { 
         "cloudMetricEnabled": boolean,
         "metricRuleRoleArn": "string"
      },
      "s3BucketName": "string",
      "summary": { 
         "arn": "string",
         "createdAt": number,
         "greengrassGroupId": "string",
         "greengrassGroupName": "string",
         "greengrassGroupVersionId": "string",
         "id": "string",
         "status": "string",
         "target": "string",
         "updatedAt": number
      },
      "validatedDependencyRevisions": [ 
         { 
            "id": "string",
            "revisionNumber": number
         }
      ],
      "validatedNamespaceVersion": number
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

description

An object that describes the system instance.

Type: SystemInstanceDescription object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalFailureException: HTTP Status Code: 500
InvalidRequestException: HTTP Status Code: 400
ResourceNotFoundException: HTTP Status Code: 400
ThrottlingException: HTTP Status Code: 400