Request Syntax Request Parameters Response Elements Errors See Also

UpdateInferenceScheduler

Updates an inference scheduler.

Request Syntax


{
   "DataDelayOffsetInMinutes": number,
   "DataInputConfiguration": { 
      "InferenceInputNameConfiguration": { 
         "ComponentTimestampDelimiter": "string",
         "TimestampFormat": "string"
      },
      "InputTimeZoneOffset": "string",
      "S3InputConfiguration": { 
         "Bucket": "string",
         "Prefix": "string"
      }
   },
   "DataOutputConfiguration": { 
      "KmsKeyId": "string",
      "S3OutputConfiguration": { 
         "Bucket": "string",
         "Prefix": "string"
      }
   },
   "DataUploadFrequency": "string",
   "InferenceSchedulerName": "string",
   "RoleArn": "string"
}

Request Parameters

The request accepts the following data in JSON format.

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.

Type: Long

Valid Range: Minimum value of 0. Maximum value of 60.

Required: No

DataInputConfiguration

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

Type: InferenceInputConfiguration object

Required: No

DataOutputConfiguration

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

Type: InferenceOutputConfiguration object

Required: No

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.

Type: String

Valid Values: PT5M | PT10M | PT15M | PT30M | PT1H

Required: No

InferenceSchedulerName

The name of the inference scheduler to be updated.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: ^[0-9a-zA-Z_-]{1,200}$

Required: Yes

RoleArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

Required: No

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

AccessDeniedException

The request could not be completed because you do not have access to the resource.

HTTP Status Code: 400

ConflictException

The request could not be completed due to a conflict with the current state of the target resource.

HTTP Status Code: 400

InternalServerException

Processing of the request has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The resource requested could not be found. Verify the resource ID and retry your request.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.

HTTP Status Code: 400