updateInferenceScheduler method

Future<void> updateInferenceScheduler({
  1. required String inferenceSchedulerName,
  2. int? dataDelayOffsetInMinutes,
  3. InferenceInputConfiguration? dataInputConfiguration,
  4. InferenceOutputConfiguration? dataOutputConfiguration,
  5. DataUploadFrequency? dataUploadFrequency,
  6. String? roleArn,
})

Updates an inference scheduler.

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

Parameter inferenceSchedulerName : The name of the inference scheduler to be updated.

Parameter dataDelayOffsetInMinutes : A period of time (in minutes) by which inference on the data is delayed after the data starts. For instance, if you select an offset delay time of five minutes, inference will not begin on the data until the first data measurement after the five minute mark. For example, if five minutes is selected, the inference scheduler will wake up at the configured frequency with the additional five minute delay time to check the customer S3 bucket. The customer can upload data at the same frequency and they don't need to stop and restart the scheduler when uploading new data.

Parameter dataInputConfiguration : Specifies information for the input data for the inference scheduler, including delimiter, format, and dataset location.

Parameter dataOutputConfiguration : Specifies information for the output results from the inference scheduler, including the output S3 location.

Parameter dataUploadFrequency : How often data is uploaded to the source S3 bucket for the input data. The value chosen is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your data. In this example, it starts once every 5 minutes.

Parameter roleArn : The Amazon Resource Name (ARN) of a role with permission to access the data source for the inference scheduler.

Implementation

Future<void> updateInferenceScheduler({
  required String inferenceSchedulerName,
  int? dataDelayOffsetInMinutes,
  InferenceInputConfiguration? dataInputConfiguration,
  InferenceOutputConfiguration? dataOutputConfiguration,
  DataUploadFrequency? dataUploadFrequency,
  String? roleArn,
}) async {
  _s.validateNumRange(
    'dataDelayOffsetInMinutes',
    dataDelayOffsetInMinutes,
    0,
    60,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.0',
    'X-Amz-Target':
        'AWSLookoutEquipmentFrontendService.UpdateInferenceScheduler'
  };
  await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'InferenceSchedulerName': inferenceSchedulerName,
      if (dataDelayOffsetInMinutes != null)
        'DataDelayOffsetInMinutes': dataDelayOffsetInMinutes,
      if (dataInputConfiguration != null)
        'DataInputConfiguration': dataInputConfiguration,
      if (dataOutputConfiguration != null)
        'DataOutputConfiguration': dataOutputConfiguration,
      if (dataUploadFrequency != null)
        'DataUploadFrequency': dataUploadFrequency.value,
      if (roleArn != null) 'RoleArn': roleArn,
    },
  );
}