startAvailabilityMonitorTest method

Future<StartAvailabilityMonitorTestOutput> startAvailabilityMonitorTest({
  1. required String gatewayARN,
})

Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment. This request only initiates the test and that a successful response only indicates that the test was started. It doesn't indicate that the test passed. For the status of the test, invoke the DescribeAvailabilityMonitorTest API.

May throw InvalidGatewayRequestException. May throw InternalServerError.

Implementation

Future<StartAvailabilityMonitorTestOutput> startAvailabilityMonitorTest({
  required String gatewayARN,
}) async {
  ArgumentError.checkNotNull(gatewayARN, 'gatewayARN');
  _s.validateStringLength(
    'gatewayARN',
    gatewayARN,
    50,
    500,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'StorageGateway_20130630.StartAvailabilityMonitorTest'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'GatewayARN': gatewayARN,
    },
  );

  return StartAvailabilityMonitorTestOutput.fromJson(jsonResponse.body);
}