com.amazonaws.services.lookoutequipment

Interface AmazonLookoutEquipment

All Known Subinterfaces:

AmazonLookoutEquipmentAsync

All Known Implementing Classes:

AbstractAmazonLookoutEquipment, AbstractAmazonLookoutEquipmentAsync, AmazonLookoutEquipmentAsyncClient, AmazonLookoutEquipmentClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonLookoutEquipment

Interface for accessing LookoutEquipment.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonLookoutEquipment instead.

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateDatasetResult	createDataset(CreateDatasetRequest createDatasetRequest) Creates a container for a collection of data being ingested for analysis.
CreateInferenceSchedulerResult	createInferenceScheduler(CreateInferenceSchedulerRequest createInferenceSchedulerRequest) Creates a scheduled inference.
CreateModelResult	createModel(CreateModelRequest createModelRequest) Creates an ML model for data inference.
DeleteDatasetResult	deleteDataset(DeleteDatasetRequest deleteDatasetRequest) Deletes a dataset and associated artifacts.
DeleteInferenceSchedulerResult	deleteInferenceScheduler(DeleteInferenceSchedulerRequest deleteInferenceSchedulerRequest) Deletes an inference scheduler that has been set up.
DeleteModelResult	deleteModel(DeleteModelRequest deleteModelRequest) Deletes an ML model currently available for Amazon Lookout for Equipment.
DescribeDataIngestionJobResult	describeDataIngestionJob(DescribeDataIngestionJobRequest describeDataIngestionJobRequest) Provides information on a specific data ingestion job such as creation time, dataset ARN, status, and so on.
DescribeDatasetResult	describeDataset(DescribeDatasetRequest describeDatasetRequest) Provides information on a specified dataset such as the schema location, status, and so on.
DescribeInferenceSchedulerResult	describeInferenceScheduler(DescribeInferenceSchedulerRequest describeInferenceSchedulerRequest) Specifies information about the inference scheduler being used, including name, model, status, and associated metadata
DescribeModelResult	describeModel(DescribeModelRequest describeModelRequest) Provides overall information about a specific ML model, including model name and ARN, dataset, training and evaluation information, status, and so on.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
ListDataIngestionJobsResult	listDataIngestionJobs(ListDataIngestionJobsRequest listDataIngestionJobsRequest) Provides a list of all data ingestion jobs, including dataset name and ARN, S3 location of the input data, status, and so on.
ListDatasetsResult	listDatasets(ListDatasetsRequest listDatasetsRequest) Lists all datasets currently available in your account, filtering on the dataset name.
ListInferenceExecutionsResult	listInferenceExecutions(ListInferenceExecutionsRequest listInferenceExecutionsRequest) Lists all inference executions that have been performed by the specified inference scheduler.
ListInferenceSchedulersResult	listInferenceSchedulers(ListInferenceSchedulersRequest listInferenceSchedulersRequest) Retrieves a list of all inference schedulers currently available for your account.
ListModelsResult	listModels(ListModelsRequest listModelsRequest) Generates a list of all models in the account, including model name and ARN, dataset, and status.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists all the tags for a specified resource, including key and value.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartDataIngestionJobResult	startDataIngestionJob(StartDataIngestionJobRequest startDataIngestionJobRequest) Starts a data ingestion job.
StartInferenceSchedulerResult	startInferenceScheduler(StartInferenceSchedulerRequest startInferenceSchedulerRequest) Starts an inference scheduler.
StopInferenceSchedulerResult	stopInferenceScheduler(StopInferenceSchedulerRequest stopInferenceSchedulerRequest) Stops an inference scheduler.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Associates a given tag to a resource in your account.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes a specific tag from a given resource.
UpdateInferenceSchedulerResult	updateInferenceScheduler(UpdateInferenceSchedulerRequest updateInferenceSchedulerRequest) Updates an inference scheduler.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createDataset

CreateDatasetResult createDataset(CreateDatasetRequest createDatasetRequest)

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. In other words, 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.

Parameters:

createDatasetRequest -

Returns:

Result of the CreateDataset operation returned by the service.

Throws:

ValidationException - The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.

ConflictException - The request could not be completed due to a conflict with the current state of the target resource.

ThrottlingException - The request was denied due to request throttling.

ServiceQuotaExceededException - Resource limitations have been exceeded.

AccessDeniedException - The request could not be completed because you do not have access to the resource.

InternalServerException - Processing of the request has failed because of an unknown error, exception or failure.

See Also:

AWS API Documentation

createInferenceScheduler

CreateInferenceSchedulerResult createInferenceScheduler(CreateInferenceSchedulerRequest createInferenceSchedulerRequest)

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.

Parameters:

createInferenceSchedulerRequest -

Returns:

Result of the CreateInferenceScheduler operation returned by the service.

Throws:

ConflictException - The request could not be completed due to a conflict with the current state of the target resource.

ResourceNotFoundException - The resource requested could not be found. Verify the resource ID and retry your request.

ValidationException - The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.

ServiceQuotaExceededException - Resource limitations have been exceeded.

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - The request could not be completed because you do not have access to the resource.

InternalServerException - Processing of the request has failed because of an unknown error, exception or failure.

See Also:

AWS API Documentation

createModel

CreateModelResult createModel(CreateModelRequest createModelRequest)

Creates an ML 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.

Parameters:

createModelRequest -

Returns:

Result of the CreateModel operation returned by the service.

Throws:

ValidationException - The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.

ConflictException - The request could not be completed due to a conflict with the current state of the target resource.

ThrottlingException - The request was denied due to request throttling.

ServiceQuotaExceededException - Resource limitations have been exceeded.

InternalServerException - Processing of the request has failed because of an unknown error, exception or failure.

ResourceNotFoundException - The resource requested could not be found. Verify the resource ID and retry your request.

AccessDeniedException - The request could not be completed because you do not have access to the resource.

See Also:

AWS API Documentation

deleteDataset

DeleteDatasetResult deleteDataset(DeleteDatasetRequest deleteDatasetRequest)

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.

Parameters:

deleteDatasetRequest -

Returns:

Result of the DeleteDataset operation returned by the service.

Throws:

ResourceNotFoundException - The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException - The request was denied due to request throttling.

InternalServerException - Processing of the request has failed because of an unknown error, exception or failure.

AccessDeniedException - The request could not be completed because you do not have access to the resource.

ConflictException - The request could not be completed due to a conflict with the current state of the target resource.

See Also:

AWS API Documentation

deleteInferenceScheduler

DeleteInferenceSchedulerResult deleteInferenceScheduler(DeleteInferenceSchedulerRequest deleteInferenceSchedulerRequest)

Deletes an inference scheduler that has been set up. Already processed output results are not affected.

Parameters:

deleteInferenceSchedulerRequest -

Returns:

Result of the DeleteInferenceScheduler operation returned by the service.

Throws:

ValidationException - The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.

ResourceNotFoundException - The resource requested could not be found. Verify the resource ID and retry your request.

ConflictException - The request could not be completed due to a conflict with the current state of the target resource.

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - The request could not be completed because you do not have access to the resource.

InternalServerException - Processing of the request has failed because of an unknown error, exception or failure.

See Also:

AWS API Documentation

deleteModel

DeleteModelResult deleteModel(DeleteModelRequest deleteModelRequest)

Deletes an ML 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.

Parameters:

deleteModelRequest -

Returns:

Result of the DeleteModel operation returned by the service.

Throws:

ResourceNotFoundException - The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException - The request was denied due to request throttling.

InternalServerException - Processing of the request has failed because of an unknown error, exception or failure.

ConflictException - The request could not be completed due to a conflict with the current state of the target resource.

AccessDeniedException - The request could not be completed because you do not have access to the resource.

See Also:

AWS API Documentation

describeDataIngestionJob

DescribeDataIngestionJobResult describeDataIngestionJob(DescribeDataIngestionJobRequest describeDataIngestionJobRequest)

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

Parameters:

describeDataIngestionJobRequest -

Returns:

Result of the DescribeDataIngestionJob operation returned by the service.

Throws:

ValidationException - The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.

ResourceNotFoundException - The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - The request could not be completed because you do not have access to the resource.

InternalServerException - Processing of the request has failed because of an unknown error, exception or failure.

See Also:

AWS API Documentation

describeDataset

DescribeDatasetResult describeDataset(DescribeDatasetRequest describeDatasetRequest)

Provides information on a specified dataset such as the schema location, status, and so on.

Parameters:

describeDatasetRequest -

Returns:

Result of the DescribeDataset operation returned by the service.

Throws:

ValidationException - The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.

ResourceNotFoundException - The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - The request could not be completed because you do not have access to the resource.

InternalServerException - Processing of the request has failed because of an unknown error, exception or failure.

See Also:

AWS API Documentation

describeInferenceScheduler

DescribeInferenceSchedulerResult describeInferenceScheduler(DescribeInferenceSchedulerRequest describeInferenceSchedulerRequest)

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

Parameters:

describeInferenceSchedulerRequest -

Returns:

Result of the DescribeInferenceScheduler operation returned by the service.

Throws:

ValidationException - The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.

ResourceNotFoundException - The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - The request could not be completed because you do not have access to the resource.

InternalServerException - Processing of the request has failed because of an unknown error, exception or failure.

See Also:

AWS API Documentation

describeModel

DescribeModelResult describeModel(DescribeModelRequest describeModelRequest)

Provides overall information about a specific ML model, including model name and ARN, dataset, training and evaluation information, status, and so on.

Parameters:

describeModelRequest -

Returns:

Result of the DescribeModel operation returned by the service.

Throws:

ValidationException - The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.

ResourceNotFoundException - The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - The request could not be completed because you do not have access to the resource.

InternalServerException - Processing of the request has failed because of an unknown error, exception or failure.

See Also:

AWS API Documentation

listDataIngestionJobs

ListDataIngestionJobsResult listDataIngestionJobs(ListDataIngestionJobsRequest listDataIngestionJobsRequest)

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

Parameters:

listDataIngestionJobsRequest -

Returns:

Result of the ListDataIngestionJobs operation returned by the service.

Throws:

ValidationException - The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - The request could not be completed because you do not have access to the resource.

InternalServerException - Processing of the request has failed because of an unknown error, exception or failure.

See Also:

AWS API Documentation

listDatasets

ListDatasetsResult listDatasets(ListDatasetsRequest listDatasetsRequest)

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

Parameters:

listDatasetsRequest -

Returns:

Result of the ListDatasets operation returned by the service.

Throws:

ValidationException - The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - The request could not be completed because you do not have access to the resource.

InternalServerException - Processing of the request has failed because of an unknown error, exception or failure.

See Also:

AWS API Documentation

listInferenceExecutions

ListInferenceExecutionsResult listInferenceExecutions(ListInferenceExecutionsRequest listInferenceExecutionsRequest)

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

Parameters:

listInferenceExecutionsRequest -

Returns:

Result of the ListInferenceExecutions operation returned by the service.

Throws:

ValidationException - The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The resource requested could not be found. Verify the resource ID and retry your request.

AccessDeniedException - The request could not be completed because you do not have access to the resource.

InternalServerException - Processing of the request has failed because of an unknown error, exception or failure.

See Also:

AWS API Documentation

listInferenceSchedulers

ListInferenceSchedulersResult listInferenceSchedulers(ListInferenceSchedulersRequest listInferenceSchedulersRequest)

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

Parameters:

listInferenceSchedulersRequest -

Returns:

Result of the ListInferenceSchedulers operation returned by the service.

Throws:

ValidationException - The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - The request could not be completed because you do not have access to the resource.

InternalServerException - Processing of the request has failed because of an unknown error, exception or failure.

See Also:

AWS API Documentation

listModels

ListModelsResult listModels(ListModelsRequest listModelsRequest)

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

Parameters:

listModelsRequest -

Returns:

Result of the ListModels operation returned by the service.

Throws:

ValidationException - The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - The request could not be completed because you do not have access to the resource.

InternalServerException - Processing of the request has failed because of an unknown error, exception or failure.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

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

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ValidationException - The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.

ResourceNotFoundException - The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - The request could not be completed because you do not have access to the resource.

InternalServerException - Processing of the request has failed because of an unknown error, exception or failure.

See Also:

AWS API Documentation

startDataIngestionJob

StartDataIngestionJobResult startDataIngestionJob(StartDataIngestionJobRequest startDataIngestionJobRequest)

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

Parameters:

startDataIngestionJobRequest -

Returns:

Result of the StartDataIngestionJob operation returned by the service.

Throws:

ValidationException - The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.

ResourceNotFoundException - The resource requested could not be found. Verify the resource ID and retry your request.

ConflictException - The request could not be completed due to a conflict with the current state of the target resource.

ThrottlingException - The request was denied due to request throttling.

ServiceQuotaExceededException - Resource limitations have been exceeded.

AccessDeniedException - The request could not be completed because you do not have access to the resource.

InternalServerException - Processing of the request has failed because of an unknown error, exception or failure.

See Also:

AWS API Documentation

startInferenceScheduler

StartInferenceSchedulerResult startInferenceScheduler(StartInferenceSchedulerRequest startInferenceSchedulerRequest)

Starts an inference scheduler.

Parameters:

startInferenceSchedulerRequest -

Returns:

Result of the StartInferenceScheduler operation returned by the service.

Throws:

ValidationException - The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.

ConflictException - The request could not be completed due to a conflict with the current state of the target resource.

ResourceNotFoundException - The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - The request could not be completed because you do not have access to the resource.

InternalServerException - Processing of the request has failed because of an unknown error, exception or failure.

See Also:

AWS API Documentation

stopInferenceScheduler

StopInferenceSchedulerResult stopInferenceScheduler(StopInferenceSchedulerRequest stopInferenceSchedulerRequest)

Stops an inference scheduler.

Parameters:

stopInferenceSchedulerRequest -

Returns:

Result of the StopInferenceScheduler operation returned by the service.

Throws:

ValidationException - The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.

ConflictException - The request could not be completed due to a conflict with the current state of the target resource.

ResourceNotFoundException - The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - The request could not be completed because you do not have access to the resource.

InternalServerException - Processing of the request has failed because of an unknown error, exception or failure.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ValidationException - The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.

ResourceNotFoundException - The resource requested could not be found. Verify the resource ID and retry your request.

ServiceQuotaExceededException - Resource limitations have been exceeded.

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - The request could not be completed because you do not have access to the resource.

InternalServerException - Processing of the request has failed because of an unknown error, exception or failure.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

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

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ValidationException - The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.

ResourceNotFoundException - The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - The request could not be completed because you do not have access to the resource.

InternalServerException - Processing of the request has failed because of an unknown error, exception or failure.

See Also:

AWS API Documentation

updateInferenceScheduler

UpdateInferenceSchedulerResult updateInferenceScheduler(UpdateInferenceSchedulerRequest updateInferenceSchedulerRequest)

Updates an inference scheduler.

Parameters:

updateInferenceSchedulerRequest -

Returns:

Result of the UpdateInferenceScheduler operation returned by the service.

Throws:

ConflictException - The request could not be completed due to a conflict with the current state of the target resource.

ResourceNotFoundException - The resource requested could not be found. Verify the resource ID and retry your request.

ValidationException - The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - The request could not be completed because you do not have access to the resource.

InternalServerException - Processing of the request has failed because of an unknown error, exception or failure.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.