Skip to main content

inference_schedulers

Creates, updates, deletes, gets or lists an inference_schedulers resource.

Overview​

Nameinference_schedulers
TypeResource
Idaws.lookoutequipment.inference_schedulers

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
created_atstring (date-time)Specifies the time at which the inference scheduler was created.
data_delay_offset_in_minutesinteger (int64)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.
data_input_configurationobjectSpecifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.
data_output_configurationobjectSpecifies information for the output results for the inference scheduler, including the output S3 location.
data_upload_frequencystringSpecifies how often data is uploaded to the source S3 bucket for the input data. This value 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. (PT5M, PT10M, PT15M, PT30M, PT1H)
inference_scheduler_arnstringThe Amazon Resource Name (ARN) of the inference scheduler being described. (pattern: <code>arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9-]*:[0-9]{12}:inference-scheduler/.+</code>)
inference_scheduler_namestringThe name of the inference scheduler being described. (pattern: <code>^[0-9a-zA-Z_-]{1,200}$</code>)
latest_inference_resultstringIndicates whether the latest execution for the inference scheduler was Anomalous (anomalous events found) or Normal (no anomalous events found). (ANOMALOUS, NORMAL)
model_arnstringThe Amazon Resource Name (ARN) of the machine learning model of the inference scheduler being described. (pattern: <code>arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9-]*:[0-9]{12}:model/.+</code>)
model_namestringThe name of the machine learning model of the inference scheduler being described. (pattern: <code>^[0-9a-zA-Z_-]{1,200}$</code>)
role_arnstringThe Amazon Resource Name (ARN) of a role with permission to access the data source for the inference scheduler being described. (pattern: <code>arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+</code>)
server_side_kms_key_idstringProvides the identifier of the KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment. (pattern: <code>arn:aws[a-z-]:kms:[a-z0-9-]:\d{12}:[\w-/]+</code>)
statusstringIndicates the status of the inference scheduler. (PENDING, RUNNING, STOPPING, STOPPED)
updated_atstring (date-time)Specifies the time at which the inference scheduler was last updated, if it was.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_inference_schedulerselectregionSpecifies information about the inference scheduler being used, including name, model, status, and associated metadata
list_inference_schedulersselectregionRetrieves a list of all inference schedulers currently available for your account.
create_inference_schedulerinsertregion, ModelName, InferenceSchedulerName, DataUploadFrequency, DataInputConfiguration, DataOutputConfiguration, RoleArn, ClientTokenCreates a scheduled inference. Scheduling an inference is setting up a continuous real-time inference plan to analyze new measurement data. When setting up the schedule, you provide an S3 bucket location for the input data, assign it a delimiter between separate entries in the data, set an offset delay if desired, and set the frequency of inferencing. You must also provide an S3 bucket location for the output data.
update_inference_schedulerupdateregion, InferenceSchedulerNameUpdates an inference scheduler.
delete_inference_schedulerdeleteregionDeletes an inference scheduler that has been set up. Prior inference results will not be deleted.
start_inference_schedulerexecregion, InferenceSchedulerNameStarts an inference scheduler.
stop_inference_schedulerexecregion, InferenceSchedulerNameStops an inference scheduler.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples​

Specifies information about the inference scheduler being used, including name, model, status, and associated metadata

SELECT
created_at,
data_delay_offset_in_minutes,
data_input_configuration,
data_output_configuration,
data_upload_frequency,
inference_scheduler_arn,
inference_scheduler_name,
latest_inference_result,
model_arn,
model_name,
role_arn,
server_side_kms_key_id,
status,
updated_at
FROM aws.lookoutequipment.inference_schedulers
WHERE region = '{{ region }}' -- required
;

INSERT examples​

Creates a scheduled inference. Scheduling an inference is setting up a continuous real-time inference plan to analyze new measurement data. When setting up the schedule, you provide an S3 bucket location for the input data, assign it a delimiter between separate entries in the data, set an offset delay if desired, and set the frequency of inferencing. You must also provide an S3 bucket location for the output data.

INSERT INTO aws.lookoutequipment.inference_schedulers (
ModelName,
InferenceSchedulerName,
DataDelayOffsetInMinutes,
DataUploadFrequency,
DataInputConfiguration,
DataOutputConfiguration,
RoleArn,
ServerSideKmsKeyId,
ClientToken,
Tags,
region
)
SELECT 
'{{ ModelName }}' /* required */,
'{{ InferenceSchedulerName }}' /* required */,
{{ DataDelayOffsetInMinutes }},
'{{ DataUploadFrequency }}' /* required */,
'{{ DataInputConfiguration }}' /* required */,
'{{ DataOutputConfiguration }}' /* required */,
'{{ RoleArn }}' /* required */,
'{{ ServerSideKmsKeyId }}',
'{{ ClientToken }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
inference_scheduler_arn,
inference_scheduler_name,
model_quality,
status
;

UPDATE examples​

Updates an inference scheduler.

UPDATE aws.lookoutequipment.inference_schedulers
SET 
InferenceSchedulerName = '{{ InferenceSchedulerName }}',
DataDelayOffsetInMinutes = {{ DataDelayOffsetInMinutes }},
DataUploadFrequency = '{{ DataUploadFrequency }}',
DataInputConfiguration = '{{ DataInputConfiguration }}',
DataOutputConfiguration = '{{ DataOutputConfiguration }}',
RoleArn = '{{ RoleArn }}'
WHERE 
region = '{{ region }}' --required
AND InferenceSchedulerName = '{{ InferenceSchedulerName }}' --required;

DELETE examples​

Deletes an inference scheduler that has been set up. Prior inference results will not be deleted.

DELETE FROM aws.lookoutequipment.inference_schedulers
WHERE region = '{{ region }}' --required
;

Lifecycle Methods​

Starts an inference scheduler.

EXEC aws.lookoutequipment.inference_schedulers.start_inference_scheduler 
@region='{{ region }}' --required 
@@json=
'{
"InferenceSchedulerName": "{{ InferenceSchedulerName }}"
}'
;
Last updated on