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.

Properties

Link copied to clipboard
abstract override val config: LookoutEquipmentClient.Config

LookoutEquipmentClient's configuration

Functions

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
abstract suspend fun createLabel(input: CreateLabelRequest): CreateLabelResponse

Creates a label for an event.

Link copied to clipboard

Creates a group of labels.

Link copied to clipboard
abstract suspend fun createModel(input: CreateModelRequest): CreateModelResponse

Creates a machine learning model for data inference.

Link copied to clipboard

Creates a retraining scheduler on the specified model.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun deleteLabel(input: DeleteLabelRequest): DeleteLabelResponse

Deletes a label.

Link copied to clipboard

Deletes a group of labels.

Link copied to clipboard
abstract suspend fun deleteModel(input: DeleteModelRequest): DeleteModelResponse

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.

Link copied to clipboard

Deletes the resource policy attached to the resource.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Returns the name of the label.

Link copied to clipboard

Returns information about the label group.

Link copied to clipboard

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.

Link copied to clipboard

Retrieves information about a specific machine learning model version.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Imports a dataset.

Link copied to clipboard

Imports a model that has been trained successfully.

Link copied to clipboard
abstract suspend fun listDataIngestionJobs(input: ListDataIngestionJobsRequest = ListDataIngestionJobsRequest { }): ListDataIngestionJobsResponse

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

Link copied to clipboard
abstract suspend fun listDatasets(input: ListDatasetsRequest = ListDatasetsRequest { }): ListDatasetsResponse

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun listInferenceSchedulers(input: ListInferenceSchedulersRequest = ListInferenceSchedulersRequest { }): ListInferenceSchedulersResponse

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

Link copied to clipboard
abstract suspend fun listLabelGroups(input: ListLabelGroupsRequest = ListLabelGroupsRequest { }): ListLabelGroupsResponse

Returns a list of the label groups.

Link copied to clipboard
abstract suspend fun listLabels(input: ListLabelsRequest): ListLabelsResponse

Provides a list of labels.

Link copied to clipboard
abstract suspend fun listModels(input: ListModelsRequest = ListModelsRequest { }): ListModelsResponse

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

Link copied to clipboard

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.

Link copied to clipboard
abstract suspend fun listRetrainingSchedulers(input: ListRetrainingSchedulersRequest = ListRetrainingSchedulersRequest { }): ListRetrainingSchedulersResponse

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Creates a resource control policy for a given resource.

Link copied to clipboard

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

Link copied to clipboard

Starts an inference scheduler.

Link copied to clipboard

Starts a retraining scheduler.

Link copied to clipboard

Stops an inference scheduler.

Link copied to clipboard

Stops a retraining scheduler.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Updates an inference scheduler.

Link copied to clipboard

Updates the label group.

Link copied to clipboard
abstract suspend fun updateModel(input: UpdateModelRequest): UpdateModelResponse

Updates a model in the account.

Link copied to clipboard

Updates a retraining scheduler.

Inherited functions

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Creates a label for an event.

Link copied to clipboard

Creates a group of labels.

Link copied to clipboard

Creates a machine learning model for data inference.

Link copied to clipboard

Creates a retraining scheduler on the specified model.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Deletes a label.

Link copied to clipboard

Deletes a group of labels.

Link copied to clipboard

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.

Link copied to clipboard

Deletes the resource policy attached to the resource.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Returns the name of the label.

Link copied to clipboard

Returns information about the label group.

Link copied to clipboard

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.

Link copied to clipboard

Retrieves information about a specific machine learning model version.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Imports a dataset.

Link copied to clipboard

Imports a model that has been trained successfully.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Returns a list of the label groups.

Link copied to clipboard

Provides a list of labels.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Creates a resource control policy for a given resource.

Link copied to clipboard

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

Link copied to clipboard

Starts an inference scheduler.

Link copied to clipboard
Link copied to clipboard

Stops an inference scheduler.

Link copied to clipboard

Stops a retraining scheduler.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Updates an inference scheduler.

Link copied to clipboard

Updates the label group.

Link copied to clipboard

Updates a model in the account.

Link copied to clipboard
Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.