LookoutEquipmentClient

Amazon Lookout for Equipment is a machine learning service that uses advanced analytics to identify anomalies in machines from sensor data for use in predictive maintenance.

Installation

NPM
npm install @aws-sdk/client-lookoutequipment
Yarn
yarn add @aws-sdk/client-lookoutequipment
pnpm
pnpm add @aws-sdk/client-lookoutequipment

LookoutEquipmentClient Operations

Command
Summary
CreateDatasetCommand

Creates a container for a collection of data being ingested for analysis. The dataset contains the metadata describing where the data is and what the data actually looks like. For example, it contains the location of the data source, the data schema, and other information. A dataset also contains any tags associated with the ingested data.

CreateInferenceSchedulerCommand

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.

CreateLabelCommand

Creates a label for an event.

CreateLabelGroupCommand

Creates a group of labels.

CreateModelCommand

Creates a machine learning model for data inference.

A machine-learning (ML) model is a mathematical model that finds patterns in your data. In Amazon Lookout for Equipment, the model learns the patterns of normal behavior and detects abnormal behavior that could be potential equipment failure (or maintenance events). The models are made by analyzing normal data and abnormalities in machine behavior that have already occurred.

Your model is trained using a portion of the data from your dataset and uses that data to learn patterns of normal behavior and abnormal patterns that lead to equipment failure. Another portion of the data is used to evaluate the model's accuracy.

CreateRetrainingSchedulerCommand

Creates a retraining scheduler on the specified model.

DeleteDatasetCommand

Deletes a dataset and associated artifacts. The operation will check to see if any inference scheduler or data ingestion job is currently using the dataset, and if there isn't, the dataset, its metadata, and any associated data stored in S3 will be deleted. This does not affect any models that used this dataset for training and evaluation, but does prevent it from being used in the future.

DeleteInferenceSchedulerCommand

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

DeleteLabelCommand

Deletes a label.

DeleteLabelGroupCommand

Deletes a group of labels.

DeleteModelCommand

Deletes a machine learning model currently available for Amazon Lookout for Equipment. This will prevent it from being used with an inference scheduler, even one that is already set up.

DeleteResourcePolicyCommand

Deletes the resource policy attached to the resource.

DeleteRetrainingSchedulerCommand

Deletes a retraining scheduler from a model. The retraining scheduler must be in the STOPPED status.

DescribeDataIngestionJobCommand

Provides information on a specific data ingestion job such as creation time, dataset ARN, and status.

DescribeDatasetCommand

Provides a JSON description of the data in each time series dataset, including names, column names, and data types.

DescribeInferenceSchedulerCommand

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

DescribeLabelCommand

Returns the name of the label.

DescribeLabelGroupCommand

Returns information about the label group.

DescribeModelCommand

Provides a JSON containing the overall information about a specific machine learning model, including model name and ARN, dataset, training and evaluation information, status, and so on.

DescribeModelVersionCommand

Retrieves information about a specific machine learning model version.

DescribeResourcePolicyCommand

Provides the details of a resource policy attached to a resource.

DescribeRetrainingSchedulerCommand

Provides a description of the retraining scheduler, including information such as the model name and retraining parameters.

ImportDatasetCommand

Imports a dataset.

ImportModelVersionCommand

Imports a model that has been trained successfully.

ListDataIngestionJobsCommand

Provides a list of all data ingestion jobs, including dataset name and ARN, S3 location of the input data, status, and so on.

ListDatasetsCommand

Lists all datasets currently available in your account, filtering on the dataset name.

ListInferenceEventsCommand

Lists all inference events that have been found for the specified inference scheduler.

ListInferenceExecutionsCommand

Lists all inference executions that have been performed by the specified inference scheduler.

ListInferenceSchedulersCommand

Retrieves a list of all inference schedulers currently available for your account.

ListLabelGroupsCommand

Returns a list of the label groups.

ListLabelsCommand

Provides a list of labels.

ListModelVersionsCommand

Generates a list of all model versions for a given model, including the model version, model version ARN, and status. To list a subset of versions, use the MaxModelVersion and MinModelVersion fields.

ListModelsCommand

Generates a list of all models in the account, including model name and ARN, dataset, and status.

ListRetrainingSchedulersCommand

Lists all retraining schedulers in your account, filtering by model name prefix and status.

ListSensorStatisticsCommand

Lists statistics about the data collected for each of the sensors that have been successfully ingested in the particular dataset. Can also be used to retreive Sensor Statistics for a previous ingestion job.

ListTagsForResourceCommand

Lists all the tags for a specified resource, including key and value.

PutResourcePolicyCommand

Creates a resource control policy for a given resource.

StartDataIngestionJobCommand

Starts a data ingestion job. Amazon Lookout for Equipment returns the job status.

StartInferenceSchedulerCommand

Starts an inference scheduler.

StartRetrainingSchedulerCommand

Starts a retraining scheduler.

StopInferenceSchedulerCommand

Stops an inference scheduler.

StopRetrainingSchedulerCommand

Stops a retraining scheduler.

TagResourceCommand

Associates a given tag to a resource in your account. A tag is a key-value pair which can be added to an Amazon Lookout for Equipment resource as metadata. Tags can be used for organizing your resources as well as helping you to search and filter by tag. Multiple tags can be added to a resource, either when you create it, or later. Up to 50 tags can be associated with each resource.

UntagResourceCommand

Removes a specific tag from a given resource. The tag is specified by its key.

UpdateActiveModelVersionCommand

Sets the active model version for a given machine learning model.

UpdateInferenceSchedulerCommand

Updates an inference scheduler.

UpdateLabelGroupCommand

Updates the label group.

UpdateModelCommand

Updates a model in the account.

UpdateRetrainingSchedulerCommand

Updates a retraining scheduler.

LookoutEquipmentClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: LookoutEquipmentClientConfig