testMetricFilter method

Future<TestMetricFilterResponse> testMetricFilter({
  1. required String filterPattern,
  2. required List<String> logEventMessages,
})

Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.

May throw InvalidParameterException. May throw ServiceUnavailableException.

Parameter logEventMessages : The log event messages to test.

Implementation

Future<TestMetricFilterResponse> testMetricFilter({
  required String filterPattern,
  required List<String> logEventMessages,
}) async {
  ArgumentError.checkNotNull(filterPattern, 'filterPattern');
  _s.validateStringLength(
    'filterPattern',
    filterPattern,
    0,
    1024,
    isRequired: true,
  );
  ArgumentError.checkNotNull(logEventMessages, 'logEventMessages');
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'Logs_20140328.TestMetricFilter'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'filterPattern': filterPattern,
      'logEventMessages': logEventMessages,
    },
  );

  return TestMetricFilterResponse.fromJson(jsonResponse.body);
}