getSystemInstance method

Future<GetSystemInstanceResponse> getSystemInstance({
  1. required String id,
})

Gets a system instance.

May throw InvalidRequestException. May throw ThrottlingException. May throw InternalFailureException. May throw ResourceNotFoundException.

Parameter 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

Implementation

Future<GetSystemInstanceResponse> getSystemInstance({
  required String id,
}) async {
  ArgumentError.checkNotNull(id, 'id');
  _s.validateStringLength(
    'id',
    id,
    0,
    160,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'IotThingsGraphFrontEndService.GetSystemInstance'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'id': id,
    },
  );

  return GetSystemInstanceResponse.fromJson(jsonResponse.body);
}