com.amazonaws.services.lookoutforvision.AmazonLookoutforVisionAsync Maven / Gradle / Ivy
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.lookoutforvision;
import javax.annotation.Generated;
import com.amazonaws.services.lookoutforvision.model.*;
/**
* Interface for accessing Amazon Lookout for Vision asynchronously. Each asynchronous method will return a Java Future
* object representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive
* notification when an asynchronous operation completes.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.lookoutforvision.AbstractAmazonLookoutforVisionAsync} instead.
*
*
*
* This is the Amazon Lookout for Vision API Reference. It provides descriptions of actions, data types, common
* parameters, and common errors.
*
*
* Amazon Lookout for Vision enables you to find visual defects in industrial products, accurately and at scale. It uses
* computer vision to identify missing components in an industrial product, damage to vehicles or structures,
* irregularities in production lines, and even minuscule defects in silicon wafers — or any other physical item where
* quality is important such as a missing capacitor on printed circuit boards.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonLookoutforVisionAsync extends AmazonLookoutforVision {
/**
*
* Creates a new dataset in an Amazon Lookout for Vision project. CreateDataset can create a training
* or a test dataset from a valid dataset source (DatasetSource).
*
*
* If you want a single dataset project, specify train for the value of DatasetType.
*
*
* To have a project with separate training and test datasets, call CreateDataset twice. On the first
* call, specify train for the value of DatasetType. On the second call, specify
* test for the value of DatasetType.
*
*
* This operation requires permissions to perform the lookoutvision:CreateDataset operation.
*
*
* @param createDatasetRequest
* @return A Java Future containing the result of the CreateDataset operation returned by the service.
* @sample AmazonLookoutforVisionAsync.CreateDataset
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createDatasetAsync(CreateDatasetRequest createDatasetRequest);
/**
*
* Creates a new dataset in an Amazon Lookout for Vision project. CreateDataset can create a training
* or a test dataset from a valid dataset source (DatasetSource).
*
*
* If you want a single dataset project, specify train for the value of DatasetType.
*
*
* To have a project with separate training and test datasets, call CreateDataset twice. On the first
* call, specify train for the value of DatasetType. On the second call, specify
* test for the value of DatasetType.
*
*
* This operation requires permissions to perform the lookoutvision:CreateDataset operation.
*
*
* @param createDatasetRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateDataset operation returned by the service.
* @sample AmazonLookoutforVisionAsyncHandler.CreateDataset
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createDatasetAsync(CreateDatasetRequest createDatasetRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates a new version of a model within an an Amazon Lookout for Vision project. CreateModel is an
* asynchronous operation in which Amazon Lookout for Vision trains, tests, and evaluates a new version of a model.
*
*
* To get the current status, check the Status field returned in the response from
* DescribeModel.
*
*
* If the project has a single dataset, Amazon Lookout for Vision internally splits the dataset to create a training
* and a test dataset. If the project has a training and a test dataset, Lookout for Vision uses the respective
* datasets to train and test the model.
*
*
* After training completes, the evaluation metrics are stored at the location specified in
* OutputConfig.
*
*
* This operation requires permissions to perform the lookoutvision:CreateModel operation. If you want
* to tag your model, you also require permission to the lookoutvision:TagResource operation.
*
*
* @param createModelRequest
* @return A Java Future containing the result of the CreateModel operation returned by the service.
* @sample AmazonLookoutforVisionAsync.CreateModel
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createModelAsync(CreateModelRequest createModelRequest);
/**
*
* Creates a new version of a model within an an Amazon Lookout for Vision project. CreateModel is an
* asynchronous operation in which Amazon Lookout for Vision trains, tests, and evaluates a new version of a model.
*
*
* To get the current status, check the Status field returned in the response from
* DescribeModel.
*
*
* If the project has a single dataset, Amazon Lookout for Vision internally splits the dataset to create a training
* and a test dataset. If the project has a training and a test dataset, Lookout for Vision uses the respective
* datasets to train and test the model.
*
*
* After training completes, the evaluation metrics are stored at the location specified in
* OutputConfig.
*
*
* This operation requires permissions to perform the lookoutvision:CreateModel operation. If you want
* to tag your model, you also require permission to the lookoutvision:TagResource operation.
*
*
* @param createModelRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateModel operation returned by the service.
* @sample AmazonLookoutforVisionAsyncHandler.CreateModel
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createModelAsync(CreateModelRequest createModelRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates an empty Amazon Lookout for Vision project. After you create the project, add a dataset by calling
* CreateDataset.
*
*
* This operation requires permissions to perform the lookoutvision:CreateProject operation.
*
*
* @param createProjectRequest
* @return A Java Future containing the result of the CreateProject operation returned by the service.
* @sample AmazonLookoutforVisionAsync.CreateProject
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createProjectAsync(CreateProjectRequest createProjectRequest);
/**
*
* Creates an empty Amazon Lookout for Vision project. After you create the project, add a dataset by calling
* CreateDataset.
*
*
* This operation requires permissions to perform the lookoutvision:CreateProject operation.
*
*
* @param createProjectRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateProject operation returned by the service.
* @sample AmazonLookoutforVisionAsyncHandler.CreateProject
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createProjectAsync(CreateProjectRequest createProjectRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes an existing Amazon Lookout for Vision dataset.
*
*
* If your the project has a single dataset, you must create a new dataset before you can create a model.
*
*
* If you project has a training dataset and a test dataset consider the following.
*
*
* -
*
* If you delete the test dataset, your project reverts to a single dataset project. If you then train the model,
* Amazon Lookout for Vision internally splits the remaining dataset into a training and test dataset.
*
*
* -
*
* If you delete the training dataset, you must create a training dataset before you can create a model.
*
*
*
*
* This operation requires permissions to perform the lookoutvision:DeleteDataset operation.
*
*
* @param deleteDatasetRequest
* @return A Java Future containing the result of the DeleteDataset operation returned by the service.
* @sample AmazonLookoutforVisionAsync.DeleteDataset
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteDatasetAsync(DeleteDatasetRequest deleteDatasetRequest);
/**
*
* Deletes an existing Amazon Lookout for Vision dataset.
*
*
* If your the project has a single dataset, you must create a new dataset before you can create a model.
*
*
* If you project has a training dataset and a test dataset consider the following.
*
*
* -
*
* If you delete the test dataset, your project reverts to a single dataset project. If you then train the model,
* Amazon Lookout for Vision internally splits the remaining dataset into a training and test dataset.
*
*
* -
*
* If you delete the training dataset, you must create a training dataset before you can create a model.
*
*
*
*
* This operation requires permissions to perform the lookoutvision:DeleteDataset operation.
*
*
* @param deleteDatasetRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteDataset operation returned by the service.
* @sample AmazonLookoutforVisionAsyncHandler.DeleteDataset
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteDatasetAsync(DeleteDatasetRequest deleteDatasetRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes an Amazon Lookout for Vision model. You can't delete a running model. To stop a running model, use the
* StopModel operation.
*
*
* It might take a few seconds to delete a model. To determine if a model has been deleted, call ListModels
* and check if the version of the model (ModelVersion) is in the Models array.
*
*
*
* This operation requires permissions to perform the lookoutvision:DeleteModel operation.
*
*
* @param deleteModelRequest
* @return A Java Future containing the result of the DeleteModel operation returned by the service.
* @sample AmazonLookoutforVisionAsync.DeleteModel
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteModelAsync(DeleteModelRequest deleteModelRequest);
/**
*
* Deletes an Amazon Lookout for Vision model. You can't delete a running model. To stop a running model, use the
* StopModel operation.
*
*
* It might take a few seconds to delete a model. To determine if a model has been deleted, call ListModels
* and check if the version of the model (ModelVersion) is in the Models array.
*
*
*
* This operation requires permissions to perform the lookoutvision:DeleteModel operation.
*
*
* @param deleteModelRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteModel operation returned by the service.
* @sample AmazonLookoutforVisionAsyncHandler.DeleteModel
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteModelAsync(DeleteModelRequest deleteModelRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes an Amazon Lookout for Vision project.
*
*
* To delete a project, you must first delete each version of the model associated with the project. To delete a
* model use the DeleteModel operation.
*
*
* You also have to delete the dataset(s) associated with the model. For more information, see DeleteDataset.
* The images referenced by the training and test datasets aren't deleted.
*
*
* This operation requires permissions to perform the lookoutvision:DeleteProject operation.
*
*
* @param deleteProjectRequest
* @return A Java Future containing the result of the DeleteProject operation returned by the service.
* @sample AmazonLookoutforVisionAsync.DeleteProject
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteProjectAsync(DeleteProjectRequest deleteProjectRequest);
/**
*
* Deletes an Amazon Lookout for Vision project.
*
*
* To delete a project, you must first delete each version of the model associated with the project. To delete a
* model use the DeleteModel operation.
*
*
* You also have to delete the dataset(s) associated with the model. For more information, see DeleteDataset.
* The images referenced by the training and test datasets aren't deleted.
*
*
* This operation requires permissions to perform the lookoutvision:DeleteProject operation.
*
*
* @param deleteProjectRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteProject operation returned by the service.
* @sample AmazonLookoutforVisionAsyncHandler.DeleteProject
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteProjectAsync(DeleteProjectRequest deleteProjectRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describe an Amazon Lookout for Vision dataset.
*
*
* This operation requires permissions to perform the lookoutvision:DescribeDataset operation.
*
*
* @param describeDatasetRequest
* @return A Java Future containing the result of the DescribeDataset operation returned by the service.
* @sample AmazonLookoutforVisionAsync.DescribeDataset
* @see AWS
* API Documentation
*/
java.util.concurrent.Future describeDatasetAsync(DescribeDatasetRequest describeDatasetRequest);
/**
*
* Describe an Amazon Lookout for Vision dataset.
*
*
* This operation requires permissions to perform the lookoutvision:DescribeDataset operation.
*
*
* @param describeDatasetRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeDataset operation returned by the service.
* @sample AmazonLookoutforVisionAsyncHandler.DescribeDataset
* @see AWS
* API Documentation
*/
java.util.concurrent.Future describeDatasetAsync(DescribeDatasetRequest describeDatasetRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describes a version of an Amazon Lookout for Vision model.
*
*
* This operation requires permissions to perform the lookoutvision:DescribeModel operation.
*
*
* @param describeModelRequest
* @return A Java Future containing the result of the DescribeModel operation returned by the service.
* @sample AmazonLookoutforVisionAsync.DescribeModel
* @see AWS
* API Documentation
*/
java.util.concurrent.Future describeModelAsync(DescribeModelRequest describeModelRequest);
/**
*
* Describes a version of an Amazon Lookout for Vision model.
*
*
* This operation requires permissions to perform the lookoutvision:DescribeModel operation.
*
*
* @param describeModelRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeModel operation returned by the service.
* @sample AmazonLookoutforVisionAsyncHandler.DescribeModel
* @see AWS
* API Documentation
*/
java.util.concurrent.Future describeModelAsync(DescribeModelRequest describeModelRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describes an Amazon Lookout for Vision model packaging job.
*
*
* This operation requires permissions to perform the lookoutvision:DescribeModelPackagingJob
* operation.
*
*
* For more information, see Using your Amazon Lookout for Vision model on an edge device in the Amazon
* Lookout for Vision Developer Guide.
*
*
* @param describeModelPackagingJobRequest
* @return A Java Future containing the result of the DescribeModelPackagingJob operation returned by the service.
* @sample AmazonLookoutforVisionAsync.DescribeModelPackagingJob
* @see AWS API Documentation
*/
java.util.concurrent.Future describeModelPackagingJobAsync(
DescribeModelPackagingJobRequest describeModelPackagingJobRequest);
/**
*
* Describes an Amazon Lookout for Vision model packaging job.
*
*
* This operation requires permissions to perform the lookoutvision:DescribeModelPackagingJob
* operation.
*
*
* For more information, see Using your Amazon Lookout for Vision model on an edge device in the Amazon
* Lookout for Vision Developer Guide.
*
*
* @param describeModelPackagingJobRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeModelPackagingJob operation returned by the service.
* @sample AmazonLookoutforVisionAsyncHandler.DescribeModelPackagingJob
* @see AWS API Documentation
*/
java.util.concurrent.Future describeModelPackagingJobAsync(
DescribeModelPackagingJobRequest describeModelPackagingJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describes an Amazon Lookout for Vision project.
*
*
* This operation requires permissions to perform the lookoutvision:DescribeProject operation.
*
*
* @param describeProjectRequest
* @return A Java Future containing the result of the DescribeProject operation returned by the service.
* @sample AmazonLookoutforVisionAsync.DescribeProject
* @see AWS
* API Documentation
*/
java.util.concurrent.Future describeProjectAsync(DescribeProjectRequest describeProjectRequest);
/**
*
* Describes an Amazon Lookout for Vision project.
*
*
* This operation requires permissions to perform the lookoutvision:DescribeProject operation.
*
*
* @param describeProjectRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeProject operation returned by the service.
* @sample AmazonLookoutforVisionAsyncHandler.DescribeProject
* @see AWS
* API Documentation
*/
java.util.concurrent.Future describeProjectAsync(DescribeProjectRequest describeProjectRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Detects anomalies in an image that you supply.
*
*
* The response from DetectAnomalies includes a boolean prediction that the image contains one or more
* anomalies and a confidence value for the prediction. If the model is an image segmentation model, the response
* also includes segmentation information for each type of anomaly found in the image.
*
*
*
* Before calling DetectAnomalies, you must first start your model with the StartModel
* operation. You are charged for the amount of time, in minutes, that a model runs and for the number of anomaly
* detection units that your model uses. If you are not using a model, use the StopModel operation to stop
* your model.
*
*
*
* For more information, see Detecting anomalies in an image in the Amazon Lookout for Vision developer
* guide.
*
*
* This operation requires permissions to perform the lookoutvision:DetectAnomalies operation.
*
*
* @param detectAnomaliesRequest
* @return A Java Future containing the result of the DetectAnomalies operation returned by the service.
* @sample AmazonLookoutforVisionAsync.DetectAnomalies
* @see AWS
* API Documentation
*/
java.util.concurrent.Future detectAnomaliesAsync(DetectAnomaliesRequest detectAnomaliesRequest);
/**
*
* Detects anomalies in an image that you supply.
*
*
* The response from DetectAnomalies includes a boolean prediction that the image contains one or more
* anomalies and a confidence value for the prediction. If the model is an image segmentation model, the response
* also includes segmentation information for each type of anomaly found in the image.
*
*
*
* Before calling DetectAnomalies, you must first start your model with the StartModel
* operation. You are charged for the amount of time, in minutes, that a model runs and for the number of anomaly
* detection units that your model uses. If you are not using a model, use the StopModel operation to stop
* your model.
*
*
*
* For more information, see Detecting anomalies in an image in the Amazon Lookout for Vision developer
* guide.
*
*
* This operation requires permissions to perform the lookoutvision:DetectAnomalies operation.
*
*
* @param detectAnomaliesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DetectAnomalies operation returned by the service.
* @sample AmazonLookoutforVisionAsyncHandler.DetectAnomalies
* @see AWS
* API Documentation
*/
java.util.concurrent.Future detectAnomaliesAsync(DetectAnomaliesRequest detectAnomaliesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the JSON Lines within a dataset. An Amazon Lookout for Vision JSON Line contains the anomaly information
* for a single image, including the image location and the assigned label.
*
*
* This operation requires permissions to perform the lookoutvision:ListDatasetEntries operation.
*
*
* @param listDatasetEntriesRequest
* @return A Java Future containing the result of the ListDatasetEntries operation returned by the service.
* @sample AmazonLookoutforVisionAsync.ListDatasetEntries
* @see AWS API Documentation
*/
java.util.concurrent.Future listDatasetEntriesAsync(ListDatasetEntriesRequest listDatasetEntriesRequest);
/**
*
* Lists the JSON Lines within a dataset. An Amazon Lookout for Vision JSON Line contains the anomaly information
* for a single image, including the image location and the assigned label.
*
*
* This operation requires permissions to perform the lookoutvision:ListDatasetEntries operation.
*
*
* @param listDatasetEntriesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListDatasetEntries operation returned by the service.
* @sample AmazonLookoutforVisionAsyncHandler.ListDatasetEntries
* @see AWS API Documentation
*/
java.util.concurrent.Future listDatasetEntriesAsync(ListDatasetEntriesRequest listDatasetEntriesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the model packaging jobs created for an Amazon Lookout for Vision project.
*
*
* This operation requires permissions to perform the lookoutvision:ListModelPackagingJobs operation.
*
*
* For more information, see Using your Amazon Lookout for Vision model on an edge device in the Amazon
* Lookout for Vision Developer Guide.
*
*
* @param listModelPackagingJobsRequest
* @return A Java Future containing the result of the ListModelPackagingJobs operation returned by the service.
* @sample AmazonLookoutforVisionAsync.ListModelPackagingJobs
* @see AWS API Documentation
*/
java.util.concurrent.Future listModelPackagingJobsAsync(ListModelPackagingJobsRequest listModelPackagingJobsRequest);
/**
*
* Lists the model packaging jobs created for an Amazon Lookout for Vision project.
*
*
* This operation requires permissions to perform the lookoutvision:ListModelPackagingJobs operation.
*
*
* For more information, see Using your Amazon Lookout for Vision model on an edge device in the Amazon
* Lookout for Vision Developer Guide.
*
*
* @param listModelPackagingJobsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListModelPackagingJobs operation returned by the service.
* @sample AmazonLookoutforVisionAsyncHandler.ListModelPackagingJobs
* @see AWS API Documentation
*/
java.util.concurrent.Future listModelPackagingJobsAsync(ListModelPackagingJobsRequest listModelPackagingJobsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the versions of a model in an Amazon Lookout for Vision project.
*
*
* The ListModels operation is eventually consistent. Recent calls to CreateModel might
* take a while to appear in the response from ListProjects.
*
*
* This operation requires permissions to perform the lookoutvision:ListModels operation.
*
*
* @param listModelsRequest
* @return A Java Future containing the result of the ListModels operation returned by the service.
* @sample AmazonLookoutforVisionAsync.ListModels
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listModelsAsync(ListModelsRequest listModelsRequest);
/**
*
* Lists the versions of a model in an Amazon Lookout for Vision project.
*
*
* The ListModels operation is eventually consistent. Recent calls to CreateModel might
* take a while to appear in the response from ListProjects.
*
*
* This operation requires permissions to perform the lookoutvision:ListModels operation.
*
*
* @param listModelsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListModels operation returned by the service.
* @sample AmazonLookoutforVisionAsyncHandler.ListModels
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listModelsAsync(ListModelsRequest listModelsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the Amazon Lookout for Vision projects in your AWS account that are in the AWS Region in which you call
* ListProjects.
*
*
* The ListProjects operation is eventually consistent. Recent calls to CreateProject and
* DeleteProject might take a while to appear in the response from ListProjects.
*
*
* This operation requires permissions to perform the lookoutvision:ListProjects operation.
*
*
* @param listProjectsRequest
* @return A Java Future containing the result of the ListProjects operation returned by the service.
* @sample AmazonLookoutforVisionAsync.ListProjects
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listProjectsAsync(ListProjectsRequest listProjectsRequest);
/**
*
* Lists the Amazon Lookout for Vision projects in your AWS account that are in the AWS Region in which you call
* ListProjects.
*
*
* The ListProjects operation is eventually consistent. Recent calls to CreateProject and
* DeleteProject might take a while to appear in the response from ListProjects.
*
*
* This operation requires permissions to perform the lookoutvision:ListProjects operation.
*
*
* @param listProjectsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListProjects operation returned by the service.
* @sample AmazonLookoutforVisionAsyncHandler.ListProjects
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listProjectsAsync(ListProjectsRequest listProjectsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns a list of tags attached to the specified Amazon Lookout for Vision model.
*
*
* This operation requires permissions to perform the lookoutvision:ListTagsForResource operation.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AmazonLookoutforVisionAsync.ListTagsForResource
* @see AWS API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Returns a list of tags attached to the specified Amazon Lookout for Vision model.
*
*
* This operation requires permissions to perform the lookoutvision:ListTagsForResource operation.
*
*
* @param listTagsForResourceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AmazonLookoutforVisionAsyncHandler.ListTagsForResource
* @see AWS API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Starts the running of the version of an Amazon Lookout for Vision model. Starting a model takes a while to
* complete. To check the current state of the model, use DescribeModel.
*
*
* A model is ready to use when its status is HOSTED.
*
*
* Once the model is running, you can detect custom labels in new images by calling DetectAnomalies.
*
*
*
* You are charged for the amount of time that the model is running. To stop a running model, call StopModel.
*
*
*
* This operation requires permissions to perform the lookoutvision:StartModel operation.
*
*
* @param startModelRequest
* @return A Java Future containing the result of the StartModel operation returned by the service.
* @sample AmazonLookoutforVisionAsync.StartModel
* @see AWS API
* Documentation
*/
java.util.concurrent.Future startModelAsync(StartModelRequest startModelRequest);
/**
*
* Starts the running of the version of an Amazon Lookout for Vision model. Starting a model takes a while to
* complete. To check the current state of the model, use DescribeModel.
*
*
* A model is ready to use when its status is HOSTED.
*
*
* Once the model is running, you can detect custom labels in new images by calling DetectAnomalies.
*
*
*
* You are charged for the amount of time that the model is running. To stop a running model, call StopModel.
*
*
*
* This operation requires permissions to perform the lookoutvision:StartModel operation.
*
*
* @param startModelRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the StartModel operation returned by the service.
* @sample AmazonLookoutforVisionAsyncHandler.StartModel
* @see AWS API
* Documentation
*/
java.util.concurrent.Future startModelAsync(StartModelRequest startModelRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Starts an Amazon Lookout for Vision model packaging job. A model packaging job creates an AWS IoT Greengrass
* component for a Lookout for Vision model. You can use the component to deploy your model to an edge device
* managed by Greengrass.
*
*
* Use the DescribeModelPackagingJob API to determine the current status of the job. The model packaging job
* is complete if the value of Status is SUCCEEDED.
*
*
* To deploy the component to the target device, use the component name and component version with the AWS IoT
* Greengrass CreateDeployment API.
*
*
* This operation requires the following permissions:
*
*
* -
*
* lookoutvision:StartModelPackagingJob
*
*
* -
*
* s3:PutObject
*
*
* -
*
* s3:GetBucketLocation
*
*
* -
*
* kms:GenerateDataKey
*
*
* -
*
* greengrass:CreateComponentVersion
*
*
* -
*
* greengrass:DescribeComponent
*
*
* -
*
* (Optional) greengrass:TagResource. Only required if you want to tag the component.
*
*
*
*
* For more information, see Using your Amazon Lookout for Vision model on an edge device in the Amazon
* Lookout for Vision Developer Guide.
*
*
* @param startModelPackagingJobRequest
* @return A Java Future containing the result of the StartModelPackagingJob operation returned by the service.
* @sample AmazonLookoutforVisionAsync.StartModelPackagingJob
* @see AWS API Documentation
*/
java.util.concurrent.Future startModelPackagingJobAsync(StartModelPackagingJobRequest startModelPackagingJobRequest);
/**
*
* Starts an Amazon Lookout for Vision model packaging job. A model packaging job creates an AWS IoT Greengrass
* component for a Lookout for Vision model. You can use the component to deploy your model to an edge device
* managed by Greengrass.
*
*
* Use the DescribeModelPackagingJob API to determine the current status of the job. The model packaging job
* is complete if the value of Status is SUCCEEDED.
*
*
* To deploy the component to the target device, use the component name and component version with the AWS IoT
* Greengrass CreateDeployment API.
*
*
* This operation requires the following permissions:
*
*
* -
*
* lookoutvision:StartModelPackagingJob
*
*
* -
*
* s3:PutObject
*
*
* -
*
* s3:GetBucketLocation
*
*
* -
*
* kms:GenerateDataKey
*
*
* -
*
* greengrass:CreateComponentVersion
*
*
* -
*
* greengrass:DescribeComponent
*
*
* -
*
* (Optional) greengrass:TagResource. Only required if you want to tag the component.
*
*
*
*
* For more information, see Using your Amazon Lookout for Vision model on an edge device in the Amazon
* Lookout for Vision Developer Guide.
*
*
* @param startModelPackagingJobRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the StartModelPackagingJob operation returned by the service.
* @sample AmazonLookoutforVisionAsyncHandler.StartModelPackagingJob
* @see AWS API Documentation
*/
java.util.concurrent.Future startModelPackagingJobAsync(StartModelPackagingJobRequest startModelPackagingJobRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Stops the hosting of a running model. The operation might take a while to complete. To check the current status,
* call DescribeModel.
*
*
* After the model hosting stops, the Status of the model is TRAINED.
*
*
* This operation requires permissions to perform the lookoutvision:StopModel operation.
*
*
* @param stopModelRequest
* @return A Java Future containing the result of the StopModel operation returned by the service.
* @sample AmazonLookoutforVisionAsync.StopModel
* @see AWS API
* Documentation
*/
java.util.concurrent.Future stopModelAsync(StopModelRequest stopModelRequest);
/**
*
* Stops the hosting of a running model. The operation might take a while to complete. To check the current status,
* call DescribeModel.
*
*
* After the model hosting stops, the Status of the model is TRAINED.
*
*
* This operation requires permissions to perform the lookoutvision:StopModel operation.
*
*
* @param stopModelRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the StopModel operation returned by the service.
* @sample AmazonLookoutforVisionAsyncHandler.StopModel
* @see AWS API
* Documentation
*/
java.util.concurrent.Future stopModelAsync(StopModelRequest stopModelRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Adds one or more key-value tags to an Amazon Lookout for Vision model. For more information, see Tagging a
* model in the Amazon Lookout for Vision Developer Guide.
*
*
* This operation requires permissions to perform the lookoutvision:TagResource operation.
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AmazonLookoutforVisionAsync.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest);
/**
*
* Adds one or more key-value tags to an Amazon Lookout for Vision model. For more information, see Tagging a
* model in the Amazon Lookout for Vision Developer Guide.
*
*
* This operation requires permissions to perform the lookoutvision:TagResource operation.
*
*
* @param tagResourceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AmazonLookoutforVisionAsyncHandler.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Removes one or more tags from an Amazon Lookout for Vision model. For more information, see Tagging a
* model in the Amazon Lookout for Vision Developer Guide.
*
*
* This operation requires permissions to perform the lookoutvision:UntagResource operation.
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AmazonLookoutforVisionAsync.UntagResource
* @see AWS
* API Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest);
/**
*
* Removes one or more tags from an Amazon Lookout for Vision model. For more information, see Tagging a
* model in the Amazon Lookout for Vision Developer Guide.
*
*
* This operation requires permissions to perform the lookoutvision:UntagResource operation.
*
*
* @param untagResourceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AmazonLookoutforVisionAsyncHandler.UntagResource
* @see AWS
* API Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Adds or updates one or more JSON Line entries in a dataset. A JSON Line includes information about an image used
* for training or testing an Amazon Lookout for Vision model.
*
*
* To update an existing JSON Line, use the source-ref field to identify the JSON Line. The JSON line
* that you supply replaces the existing JSON line. Any existing annotations that are not in the new JSON line are
* removed from the dataset.
*
*
* For more information, see Defining JSON lines for anomaly classification in the Amazon Lookout for Vision
* Developer Guide.
*
*
*
* The images you reference in the source-ref field of a JSON line, must be in the same S3 bucket as
* the existing images in the dataset.
*
*
*
* Updating a dataset might take a while to complete. To check the current status, call DescribeDataset and
* check the Status field in the response.
*
*
* This operation requires permissions to perform the lookoutvision:UpdateDatasetEntries operation.
*
*
* @param updateDatasetEntriesRequest
* @return A Java Future containing the result of the UpdateDatasetEntries operation returned by the service.
* @sample AmazonLookoutforVisionAsync.UpdateDatasetEntries
* @see AWS API Documentation
*/
java.util.concurrent.Future updateDatasetEntriesAsync(UpdateDatasetEntriesRequest updateDatasetEntriesRequest);
/**
*
* Adds or updates one or more JSON Line entries in a dataset. A JSON Line includes information about an image used
* for training or testing an Amazon Lookout for Vision model.
*
*
* To update an existing JSON Line, use the source-ref field to identify the JSON Line. The JSON line
* that you supply replaces the existing JSON line. Any existing annotations that are not in the new JSON line are
* removed from the dataset.
*
*
* For more information, see Defining JSON lines for anomaly classification in the Amazon Lookout for Vision
* Developer Guide.
*
*
*
* The images you reference in the source-ref field of a JSON line, must be in the same S3 bucket as
* the existing images in the dataset.
*
*
*
* Updating a dataset might take a while to complete. To check the current status, call DescribeDataset and
* check the Status field in the response.
*
*
* This operation requires permissions to perform the lookoutvision:UpdateDatasetEntries operation.
*
*
* @param updateDatasetEntriesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UpdateDatasetEntries operation returned by the service.
* @sample AmazonLookoutforVisionAsyncHandler.UpdateDatasetEntries
* @see AWS API Documentation
*/
java.util.concurrent.Future updateDatasetEntriesAsync(UpdateDatasetEntriesRequest updateDatasetEntriesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}