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	awscc.lookoutequipment.inference_schedulers

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
inference_scheduler_name	string	The name of the inference scheduler being created.
region	string	AWS region.

For more information, see AWS::LookoutEquipment::InferenceScheduler.

Methods

Name	Resource	Accessible by	Required Params
create_resource	inference_schedulers	INSERT	DataInputConfiguration, DataOutputConfiguration, DataUploadFrequency, ModelName, RoleArn, region
delete_resource	inference_schedulers	DELETE	Identifier, region
update_resource	inference_schedulers	UPDATE	Identifier, PatchDocument, region
list_resources	inference_schedulers_list_only	SELECT	region
get_resource	inference_schedulers	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.lookoutequipment.inference_schedulers
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ inference_scheduler_name }}';

list (identifiers only)

Lists all inference_schedulers in a region.

SELECT
  region,
  inference_scheduler_name
FROM awscc.lookoutequipment.inference_schedulers_list_only
WHERE
  region = '{{ region }}';

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 awscc.lookoutequipment.inference_schedulers (
  DataInputConfiguration,
  DataOutputConfiguration,
  DataUploadFrequency,
  ModelName,
  RoleArn,
  region
)
SELECT
  '{{ data_input_configuration }}',
  '{{ data_output_configuration }}',
  '{{ data_upload_frequency }}',
  '{{ model_name }}',
  '{{ role_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.lookoutequipment.inference_schedulers (
  DataDelayOffsetInMinutes,
  DataInputConfiguration,
  DataOutputConfiguration,
  DataUploadFrequency,
  InferenceSchedulerName,
  ModelName,
  RoleArn,
  ServerSideKmsKeyId,
  Tags,
  region
)
SELECT
  '{{ 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 }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: inference_scheduler
  props:
    - name: data_delay_offset_in_minutes
      value: '{{ data_delay_offset_in_minutes }}'
    - name: data_input_configuration
      value:
        input_time_zone_offset: '{{ input_time_zone_offset }}'
        inference_input_name_configuration:
          component_timestamp_delimiter: '{{ component_timestamp_delimiter }}'
          timestamp_format: '{{ timestamp_format }}'
        s3_input_configuration:
          bucket: '{{ bucket }}'
          prefix: '{{ prefix }}'
    - name: data_output_configuration
      value:
        kms_key_id: '{{ kms_key_id }}'
        s3_output_configuration:
          bucket: null
          prefix: null
    - name: data_upload_frequency
      value: '{{ data_upload_frequency }}'
    - name: inference_scheduler_name
      value: '{{ inference_scheduler_name }}'
    - name: model_name
      value: '{{ model_name }}'
    - name: role_arn
      value: '{{ role_arn }}'
    - name: server_side_kms_key_id
      value: '{{ server_side_kms_key_id }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.lookoutequipment.inference_schedulers
SET PatchDocument = string('{{ {
    "DataDelayOffsetInMinutes": data_delay_offset_in_minutes,
    "DataInputConfiguration": data_input_configuration,
    "DataOutputConfiguration": data_output_configuration,
    "DataUploadFrequency": data_upload_frequency,
    "RoleArn": role_arn,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ inference_scheduler_name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.lookoutequipment.inference_schedulers
WHERE
  Identifier = '{{ inference_scheduler_name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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