listSignalCatalogNodes method

Future<ListSignalCatalogNodesResponse> listSignalCatalogNodes({
  1. required String name,
  2. int? maxResults,
  3. String? nextToken,
  4. SignalNodeType? signalNodeType,
})

Lists of information about the signals (nodes) specified in a signal catalog.

May throw AccessDeniedException. May throw InternalServerException. May throw LimitExceededException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw ValidationException.

Parameter name : The name of the signal catalog to list information about.

Parameter maxResults : The maximum number of items to return, between 1 and 100, inclusive.

Parameter nextToken : A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

Parameter signalNodeType : The type of node in the signal catalog.

Implementation

Future<ListSignalCatalogNodesResponse> listSignalCatalogNodes({
  required String name,
  int? maxResults,
  String? nextToken,
  SignalNodeType? signalNodeType,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.0',
    'X-Amz-Target': 'IoTAutobahnControlPlane.ListSignalCatalogNodes'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'name': name,
      if (maxResults != null) 'maxResults': maxResults,
      if (nextToken != null) 'nextToken': nextToken,
      if (signalNodeType != null) 'signalNodeType': signalNodeType.value,
    },
  );

  return ListSignalCatalogNodesResponse.fromJson(jsonResponse.body);
}