inference_schedulers

Creates, updates, deletes or gets an inference_scheduler resource or lists inference_schedulers in a region

Overview

Name	inference_schedulers
Type	Resource
Description	Resource schema for LookoutEquipment InferenceScheduler.
Id	aws.lookoutequipment.inference_schedulers

Fields

Name	Datatype	Description
data_delay_offset_in_minutes	integer	A period of time (in minutes) by which inference on the data is delayed after the data starts.
data_input_configuration	object	Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.
data_output_configuration	object	Specifies configuration information for the output results for the inference scheduler, including the S3 location for the output.
data_upload_frequency	string	How often data is uploaded to the source S3 bucket for the input data.
inference_scheduler_name	string	The name of the inference scheduler being created.
model_name	string	The name of the previously trained ML model being used to create the inference scheduler.
role_arn	string	The Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.
server_side_kms_key_id	string	Provides the identifier of the AWS KMS customer master key (CMK) used to encrypt inference scheduler data by Amazon Lookout for Equipment.
tags	array	Any tags associated with the inference scheduler.
inference_scheduler_arn	string	The Amazon Resource Name (ARN) of the inference scheduler being created.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DataInputConfiguration, DataOutputConfiguration, DataUploadFrequency, ModelName, RoleArn, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all inference_schedulers in a region.

SELECT
region,
data_delay_offset_in_minutes,
data_input_configuration,
data_output_configuration,
data_upload_frequency,
inference_scheduler_name,
model_name,
role_arn,
server_side_kms_key_id,
tags,
inference_scheduler_arn
FROM aws.lookoutequipment.inference_schedulers
WHERE region = 'us-east-1';

Gets all properties from an individual inference_scheduler.

SELECT
region,
data_delay_offset_in_minutes,
data_input_configuration,
data_output_configuration,
data_upload_frequency,
inference_scheduler_name,
model_name,
role_arn,
server_side_kms_key_id,
tags,
inference_scheduler_arn
FROM aws.lookoutequipment.inference_schedulers
WHERE region = 'us-east-1' AND data__Identifier = '<InferenceSchedulerName>';

INSERT example

Use the following StackQL query and manifest file to create a new inference_scheduler resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.lookoutequipment.inference_schedulers (
 DataInputConfiguration,
 DataOutputConfiguration,
 DataUploadFrequency,
 ModelName,
 RoleArn,
 region
)
SELECT 
'{{ DataInputConfiguration }}',
 '{{ DataOutputConfiguration }}',
 '{{ DataUploadFrequency }}',
 '{{ ModelName }}',
 '{{ RoleArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.lookoutequipment.inference_schedulers (
 DataDelayOffsetInMinutes,
 DataInputConfiguration,
 DataOutputConfiguration,
 DataUploadFrequency,
 InferenceSchedulerName,
 ModelName,
 RoleArn,
 ServerSideKmsKeyId,
 Tags,
 region
)
SELECT 
 '{{ DataDelayOffsetInMinutes }}',
 '{{ DataInputConfiguration }}',
 '{{ DataOutputConfiguration }}',
 '{{ DataUploadFrequency }}',
 '{{ InferenceSchedulerName }}',
 '{{ ModelName }}',
 '{{ RoleArn }}',
 '{{ ServerSideKmsKeyId }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: inference_scheduler
    props:
      - name: DataDelayOffsetInMinutes
        value: '{{ DataDelayOffsetInMinutes }}'
      - name: DataInputConfiguration
        value:
          InputTimeZoneOffset: '{{ InputTimeZoneOffset }}'
          InferenceInputNameConfiguration:
            ComponentTimestampDelimiter: '{{ ComponentTimestampDelimiter }}'
            TimestampFormat: '{{ TimestampFormat }}'
          S3InputConfiguration:
            Bucket: '{{ Bucket }}'
            Prefix: '{{ Prefix }}'
      - name: DataOutputConfiguration
        value:
          KmsKeyId: '{{ KmsKeyId }}'
          S3OutputConfiguration:
            Bucket: null
            Prefix: null
      - name: DataUploadFrequency
        value: '{{ DataUploadFrequency }}'
      - name: InferenceSchedulerName
        value: '{{ InferenceSchedulerName }}'
      - name: ModelName
        value: '{{ ModelName }}'
      - name: RoleArn
        value: '{{ RoleArn }}'
      - name: ServerSideKmsKeyId
        value: '{{ ServerSideKmsKeyId }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.lookoutequipment.inference_schedulers
WHERE data__Identifier = '<InferenceSchedulerName>'
AND region = 'us-east-1';

Permissions

To operate on the inference_schedulers resource, the following permissions are required:

Create

iam:PassRole,
lookoutequipment:CreateInferenceScheduler,
lookoutequipment:DescribeInferenceScheduler

Read

lookoutequipment:DescribeInferenceScheduler

Delete

lookoutequipment:DeleteInferenceScheduler,
lookoutequipment:StopInferenceScheduler,
lookoutequipment:DescribeInferenceScheduler

Update

lookoutequipment:UpdateInferenceScheduler,
lookoutequipment:DescribeInferenceScheduler,
lookoutequipment:StopInferenceScheduler,
lookoutequipment:StartInferenceScheduler

List

lookoutequipment:ListInferenceSchedulers