Amazon Lookout for Equipment Lookout For Equipment Inference Scheduler API
The Lookout For Equipment Inference Scheduler API from Amazon Lookout for Equipment — 6 operation(s) for lookout for equipment inference scheduler.
The Lookout For Equipment Inference Scheduler API from Amazon Lookout for Equipment — 6 operation(s) for lookout for equipment inference scheduler.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/amazon-lookout-for-equipment:amazon-lookout-for-equipment-inference-scheduler-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Amazon Lookout for Equipment Inference Scheduler API
version: '2020-12-15'
description: Generated from AWS's published Smithy model for Amazon Lookout for Equipment. 6 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://lookoutequipment.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
tags:
- name: Inference Scheduler
paths:
/#CreateInferenceScheduler:
post:
operationId: CreateInferenceScheduler
summary: Create Inference Scheduler
description: 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.
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/CreateInferenceSchedulerResponse'
'403':
description: AccessDeniedException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'402':
description: ServiceQuotaExceededException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'429':
description: ThrottlingException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ValidationException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSLookoutEquipmentFrontendService.CreateInferenceScheduler
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/CreateInferenceSchedulerRequest'
tags:
- Inference Scheduler
/#DeleteInferenceScheduler:
post:
operationId: DeleteInferenceScheduler
summary: Delete Inference Scheduler
description: Deletes an inference scheduler that has been set up. Prior inference results will not be deleted.
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
type: string
'403':
description: AccessDeniedException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ValidationException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSLookoutEquipmentFrontendService.DeleteInferenceScheduler
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/DeleteInferenceSchedulerRequest'
tags:
- Inference Scheduler
/#DescribeInferenceScheduler:
post:
operationId: DescribeInferenceScheduler
summary: Describe Inference Scheduler
description: Specifies information about the inference scheduler being used, including name, model, status, and associated metadata
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/DescribeInferenceSchedulerResponse'
'403':
description: AccessDeniedException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalServerException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ValidationException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSLookoutEquipmentFrontendService.DescribeInferenceScheduler
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/DescribeInferenceSchedulerRequest'
tags:
- Inference Scheduler
/#ListInferenceSchedulers:
post:
operationId: ListInferenceSchedulers
summary: List Inference Schedulers
description: Retrieves a list of all inference schedulers currently available for your account.
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ListInferenceSchedulersResponse'
'403':
description: AccessDeniedException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalServerException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/InternalServerException'
'429':
description: ThrottlingException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ValidationException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSLookoutEquipmentFrontendService.ListInferenceSchedulers
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ListInferenceSchedulersRequest'
tags:
- Inference Scheduler
/#StopInferenceScheduler:
post:
operationId: StopInferenceScheduler
summary: Stop Inference Scheduler
description: Stops an inference scheduler.
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/StopInferenceSchedulerResponse'
'403':
description: AccessDeniedException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ValidationException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSLookoutEquipmentFrontendService.StopInferenceScheduler
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/StopInferenceSchedulerRequest'
tags:
- Inference Scheduler
/#UpdateInferenceScheduler:
post:
operationId: UpdateInferenceScheduler
summary: Update Inference Scheduler
description: Updates an inference scheduler.
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
type: string
'403':
description: AccessDeniedException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ThrottlingException'
'400':
description: ValidationException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ValidationException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AWSLookoutEquipmentFrontendService.UpdateInferenceScheduler
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/UpdateInferenceSchedulerRequest'
tags:
- Inference Scheduler
components:
schemas:
InferenceSchedulerSummary:
type: object
properties:
ModelName:
type: string
description: The name of the machine learning model used for the inference scheduler.
ModelArn:
type: string
description: The Amazon Resource Name (ARN) of the machine learning model used by the inference scheduler.
InferenceSchedulerName:
type: string
description: The name of the inference scheduler.
InferenceSchedulerArn:
type: string
description: The Amazon Resource Name (ARN) of the inference scheduler.
Status:
type: string
enum:
- PENDING
- RUNNING
- STOPPING
- STOPPED
description: Indicates the status of the inference scheduler.
DataDelayOffsetInMinutes:
type: integer
description: A period of time (in minutes) by which inference on the data is delayed after the data starts. For instance, if an offset delay time of five minutes was selected, 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.
DataUploadFrequency:
type: string
enum:
- PT5M
- PT10M
- PT15M
- PT30M
- PT1H
description: 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.
LatestInferenceResult:
type: string
enum:
- ANOMALOUS
- NORMAL
description: Indicates whether the latest execution for the inference scheduler was Anomalous (anomalous events found) or Normal (no anomalous events found).
ResourceNotFoundException:
type: object
properties:
Message:
type: string
required:
- Message
StopInferenceSchedulerRequest:
type: object
properties:
InferenceSchedulerName:
type: string
description: The name of the inference scheduler to be stopped.
required:
- InferenceSchedulerName
InternalServerException:
type: object
properties:
Message:
type: string
required:
- Message
InferenceS3InputConfiguration:
type: object
properties:
Bucket:
type: string
description: The bucket containing the input dataset for the inference.
Prefix:
type: string
description: The prefix for the S3 bucket used for the input data for the inference.
required:
- Bucket
UpdateInferenceSchedulerRequest:
type: object
properties:
InferenceSchedulerName:
type: string
description: The name of the inference scheduler to be updated.
DataDelayOffsetInMinutes:
type: integer
description: 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.
DataUploadFrequency:
type: string
enum:
- PT5M
- PT10M
- PT15M
- PT30M
- PT1H
description: 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.
DataInputConfiguration:
$ref: '#/components/schemas/InferenceInputConfiguration'
DataOutputConfiguration:
$ref: '#/components/schemas/InferenceOutputConfiguration'
RoleArn:
type: string
description: The Amazon Resource Name (ARN) of a role with permission to access the data source for the inference scheduler.
required:
- InferenceSchedulerName
ConflictException:
type: object
properties:
Message:
type: string
required:
- Message
DescribeInferenceSchedulerRequest:
type: object
properties:
InferenceSchedulerName:
type: string
description: The name of the inference scheduler being described.
required:
- InferenceSchedulerName
DescribeInferenceSchedulerResponse:
type: object
properties:
ModelArn:
type: string
description: The Amazon Resource Name (ARN) of the machine learning model of the inference scheduler being described.
ModelName:
type: string
description: The name of the machine learning model of the inference scheduler being described.
InferenceSchedulerName:
type: string
description: The name of the inference scheduler being described.
InferenceSchedulerArn:
type: string
description: The Amazon Resource Name (ARN) of the inference scheduler being described.
Status:
type: string
enum:
- PENDING
- RUNNING
- STOPPING
- STOPPED
description: Indicates the status of the inference scheduler.
DataDelayOffsetInMinutes:
type: integer
description: 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.
DataUploadFrequency:
type: string
enum:
- PT5M
- PT10M
- PT15M
- PT30M
- PT1H
description: Specifies 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.
CreatedAt:
type: string
format: date-time
description: Specifies the time at which the inference scheduler was created.
UpdatedAt:
type: string
format: date-time
description: Specifies the time at which the inference scheduler was last updated, if it was.
DataInputConfiguration:
$ref: '#/components/schemas/InferenceInputConfiguration'
DataOutputConfiguration:
$ref: '#/components/schemas/InferenceOutputConfiguration'
RoleArn:
type: string
description: The Amazon Resource Name (ARN) of a role with permission to access the data source for the inference scheduler being described.
ServerSideKmsKeyId:
type: string
description: Provides the identifier of the KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment.
LatestInferenceResult:
type: string
enum:
- ANOMALOUS
- NORMAL
description: Indicates whether the latest execution for the inference scheduler was Anomalous (anomalous events found) or Normal (no anomalous events found).
CreateInferenceSchedulerResponse:
type: object
properties:
InferenceSchedulerArn:
type: string
description: The Amazon Resource Name (ARN) of the inference scheduler being created.
InferenceSchedulerName:
type: string
description: The name of inference scheduler being created.
Status:
type: string
enum:
- PENDING
- RUNNING
- STOPPING
- STOPPED
description: Indicates the status of the CreateInferenceScheduler operation.
ModelQuality:
type: string
enum:
- QUALITY_THRESHOLD_MET
- CANNOT_DETERMINE_QUALITY
- POOR_QUALITY_DETECTED
description: Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the model quality is poor based on training metrics, the value is POOR_QUALITY_DETECTED. Otherwise, the value is QUALITY_THRESHOLD_MET. If the model is unlabeled, the model quality can't be assessed and the value of ModelQuality is CANNOT_DETERMINE_QUALITY. In this situation, you can get a model quality assessment by adding labels to the input dataset and retraining the model. For information about using labels with your models, see Understanding labeling. For information about improving the qu
InferenceOutputConfiguration:
type: object
properties:
S3OutputConfiguration:
$ref: '#/components/schemas/InferenceS3OutputConfiguration'
KmsKeyId:
type: string
description: The ID number for the KMS key key used to encrypt the inference output.
required:
- S3OutputConfiguration
ValidationException:
type: object
properties:
Message:
type: string
required:
- Message
InferenceInputNameConfiguration:
type: object
properties:
TimestampFormat:
type: string
description: The format of the timestamp, whether Epoch time, or standard, with or without hyphens (-).
ComponentTimestampDelimiter:
type: string
description: Indicates the delimiter character used between items in the data.
CreateInferenceSchedulerRequest:
type: object
properties:
ModelName:
type: string
description: The name of the previously trained machine learning model being used to create the inference scheduler.
InferenceSchedulerName:
type: string
description: The name of the inference scheduler being created.
DataDelayOffsetInMinutes:
type: integer
description: 'The interval (in minutes) of planned delay at the start of each inference segment. For example, if inference is set to run every ten minutes, the delay is set to five minutes and the time is 09:08. The inference scheduler will wake up at the configured interval (which, without a delay configured, would be 09:10) plus the additional five minute delay time (so 09:15) to check your Amazon S3 bucket. The delay provides a buffer for you to upload data at the same frequency, so that you don''t have to stop and restart the scheduler when uploading new data. For more information, see Understanding the '
DataUploadFrequency:
type: string
enum:
- PT5M
- PT10M
- PT15M
- PT30M
- PT1H
description: How often data is uploaded to the source Amazon 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 runs inference on your data. For more information, see Understanding the inference process.
DataInputConfiguration:
$ref: '#/components/schemas/InferenceInputConfiguration'
DataOutputConfiguration:
$ref: '#/components/schemas/InferenceOutputConfiguration'
RoleArn:
type: string
description: The Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.
ServerSideKmsKeyId:
type: string
description: Provides the identifier of the KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment.
ClientToken:
type: string
description: A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: Any tags associated with the inference scheduler.
required:
- ModelName
- InferenceSchedulerName
- DataUploadFrequency
- DataInputConfiguration
- DataOutputConfiguration
- RoleArn
- ClientToken
ListInferenceSchedulersResponse:
type: object
properties:
NextToken:
type: string
description: An opaque pagination token indicating where to continue the listing of inference schedulers.
InferenceSchedulerSummaries:
type: array
items:
$ref: '#/components/schemas/InferenceSchedulerSummary'
description: Provides information about the specified inference scheduler, including data upload frequency, model name and ARN, and status.
ListInferenceSchedulersRequest:
type: object
properties:
NextToken:
type: string
description: An opaque pagination token indicating where to continue the listing of inference schedulers.
MaxResults:
type: integer
description: Specifies the maximum number of inference schedulers to list.
InferenceSchedulerNameBeginsWith:
type: string
description: The beginning of the name of the inference schedulers to be listed.
ModelName:
type: string
description: The name of the machine learning model used by the inference scheduler to be listed.
Status:
type: string
enum:
- PENDING
- RUNNING
- STOPPING
- STOPPED
description: Specifies the current status of the inference schedulers.
AccessDeniedException:
type: object
properties:
Message:
type: string
required:
- Message
StopInferenceSchedulerResponse:
type: object
properties:
ModelArn:
type: string
description: The Amazon Resource Name (ARN) of the machine learning model used by the inference scheduler being stopped.
ModelName:
type: string
description: The name of the machine learning model used by the inference scheduler being stopped.
InferenceSchedulerName:
type: string
description: The name of the inference scheduler being stopped.
InferenceSchedulerArn:
type: string
description: The Amazon Resource Name (ARN) of the inference schedule being stopped.
Status:
type: string
enum:
- PENDING
- RUNNING
- STOPPING
- STOPPED
description: Indicates the status of the inference scheduler.
InferenceInputConfiguration:
type: object
properties:
S3InputConfiguration:
$ref: '#/components/schemas/InferenceS3InputConfiguration'
InputTimeZoneOffset:
type: string
description: Indicates the difference between your time zone and Coordinated Universal Time (UTC).
InferenceInputNameConfiguration:
$ref: '#/components/schemas/InferenceInputNameConfiguration'
ThrottlingException:
type: object
properties:
Message:
type: string
required:
- Message
DeleteInferenceSchedulerRequest:
type: object
properties:
InferenceSchedulerName:
type: string
description: The name of the inference scheduler to be deleted.
required:
- InferenceSchedulerName
ServiceQuotaExceededException:
type: object
properties:
Message:
type: string
required:
- Message
Tag:
type: object
properties:
Key:
type: string
description: The key for the specified tag.
Value:
type: string
description: The value for the specified tag.
required:
- Key
- Value
InferenceS3OutputConfiguration:
type: object
properties:
Bucket:
type: string
description: The bucket containing the output results from the inference
Prefix:
type: string
description: The prefix for the S3 bucket used for the output results from the inference.
required:
- Bucket
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: lookoutequipment
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/lookoutequipment/service/2020-12-15/lookoutequipment-2020-12-15.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)