updateSignalCatalog method

Future<UpdateSignalCatalogResponse> updateSignalCatalog({
  1. required String name,
  2. String? description,
  3. List<Node>? nodesToAdd,
  4. List<String>? nodesToRemove,
  5. List<Node>? nodesToUpdate,
})

Updates a signal catalog.

May throw AccessDeniedException. May throw ConflictException. May throw InternalServerException. May throw InvalidNodeException. May throw InvalidSignalsException. May throw LimitExceededException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw ValidationException.

Parameter name : The name of the signal catalog to update.

Parameter description : A brief description of the signal catalog to update.

Parameter nodesToAdd : A list of information about nodes to add to the signal catalog.

Parameter nodesToRemove : A list of fullyQualifiedName of nodes to remove from the signal catalog.

Parameter nodesToUpdate : A list of information about nodes to update in the signal catalog.

Implementation

Future<UpdateSignalCatalogResponse> updateSignalCatalog({
  required String name,
  String? description,
  List<Node>? nodesToAdd,
  List<String>? nodesToRemove,
  List<Node>? nodesToUpdate,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.0',
    'X-Amz-Target': 'IoTAutobahnControlPlane.UpdateSignalCatalog'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'name': name,
      if (description != null) 'description': description,
      if (nodesToAdd != null) 'nodesToAdd': nodesToAdd,
      if (nodesToRemove != null) 'nodesToRemove': nodesToRemove,
      if (nodesToUpdate != null) 'nodesToUpdate': nodesToUpdate,
    },
  );

  return UpdateSignalCatalogResponse.fromJson(jsonResponse.body);
}