describeDetector method

Future<DescribeDetectorResponse> describeDetector({ required String detectorModelName, String? keyValue, })

Returns information about the specified detector (instance).

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

Parameter detectorModelName : The name of the detector model whose detectors (instances) you want information about.

Parameter keyValue : A filter used to limit results to detectors (instances) created because of the given key ID.

Implementation

Future<DescribeDetectorResponse> describeDetector({
  required String detectorModelName,
  String? keyValue,
}) async {
  final $query = <String, List<String>>{
    if (keyValue != null) 'keyValue': [keyValue],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/detectors/${Uri.encodeComponent(detectorModelName)}/keyValues',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return DescribeDetectorResponse.fromJson(response);
}