com.amazonaws.services.lookoutforvision

Class AmazonLookoutforVisionClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.lookoutforvision.AmazonLookoutforVisionClient

All Implemented Interfaces:

AmazonLookoutforVision

Direct Known Subclasses:

AmazonLookoutforVisionAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonLookoutforVisionClient
extends AmazonWebServiceClient
implements AmazonLookoutforVision

Client for accessing Amazon Lookout for Vision. All service calls made using this client are blocking, and will not return until the service call completes.

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.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.lookoutforvision.AmazonLookoutforVision

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonLookoutforVisionClientBuilder	builder()
CreateDatasetResult	createDataset(CreateDatasetRequest request) Creates a new dataset in an Amazon Lookout for Vision project.
CreateModelResult	createModel(CreateModelRequest request) Creates a new version of a model within an an Amazon Lookout for Vision project.
CreateProjectResult	createProject(CreateProjectRequest request) Creates an empty Amazon Lookout for Vision project.
DeleteDatasetResult	deleteDataset(DeleteDatasetRequest request) Deletes an existing Amazon Lookout for Vision dataset.
DeleteModelResult	deleteModel(DeleteModelRequest request) Deletes an Amazon Lookout for Vision model.
DeleteProjectResult	deleteProject(DeleteProjectRequest request) Deletes an Amazon Lookout for Vision project.
DescribeDatasetResult	describeDataset(DescribeDatasetRequest request) Describe an Amazon Lookout for Vision dataset.
DescribeModelResult	describeModel(DescribeModelRequest request) Describes a version of an Amazon Lookout for Vision model.
DescribeProjectResult	describeProject(DescribeProjectRequest request) Describes an Amazon Lookout for Vision project.
DetectAnomaliesResult	detectAnomalies(DetectAnomaliesRequest request) Detects anomalies in an image that you supply.
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.
ListDatasetEntriesResult	listDatasetEntries(ListDatasetEntriesRequest request) Lists the JSON Lines within a dataset.
ListModelsResult	listModels(ListModelsRequest request) Lists the versions of a model in an Amazon Lookout for Vision project.
ListProjectsResult	listProjects(ListProjectsRequest request) Lists the Amazon Lookout for Vision projects in your AWS account.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartModelResult	startModel(StartModelRequest request) Starts the running of the version of an Amazon Lookout for Vision model.
StopModelResult	stopModel(StopModelRequest request) Stops a running model.
UpdateDatasetEntriesResult	updateDatasetEntries(UpdateDatasetEntriesRequest request) Adds one or more JSON Line entries to a dataset.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonLookoutforVisionClientBuilder builder()

createDataset

public CreateDatasetResult createDataset(CreateDatasetRequest request)

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. of dataset with

Specified by:

createDataset in interface AmazonLookoutforVision

Parameters:

createDatasetRequest -

Returns:

Result of the CreateDataset operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

InternalServerException - Amazon Lookout for Vision experienced a service issue. Try your call again.

ValidationException - An input validation error occured. For example, invalid characters in a project name, or if a pagination token is invalid.

ConflictException - The update or deletion of a resource caused an inconsistent state.

ResourceNotFoundException - The resource could not be found.

ThrottlingException - Amazon Lookout for Vision is temporarily unable to process the request. Try your call again.

ServiceQuotaExceededException - A service quota was exceeded the allowed limit. For more information, see Limits in Amazon Lookout for Vision in the Amazon Lookout for Vision Developer Guide.

See Also:

AWS API Documentation

createModel

public CreateModelResult createModel(CreateModelRequest request)

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.

Specified by:

createModel in interface AmazonLookoutforVision

Parameters:

createModelRequest -

Returns:

Result of the CreateModel operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

InternalServerException - Amazon Lookout for Vision experienced a service issue. Try your call again.

ValidationException - An input validation error occured. For example, invalid characters in a project name, or if a pagination token is invalid.

ConflictException - The update or deletion of a resource caused an inconsistent state.

ResourceNotFoundException - The resource could not be found.

ThrottlingException - Amazon Lookout for Vision is temporarily unable to process the request. Try your call again.

ServiceQuotaExceededException - A service quota was exceeded the allowed limit. For more information, see Limits in Amazon Lookout for Vision in the Amazon Lookout for Vision Developer Guide.

See Also:

AWS API Documentation

createProject

public CreateProjectResult createProject(CreateProjectRequest request)

Creates an empty Amazon Lookout for Vision project. After you create the project, add a dataset by calling CreateDataset.

Specified by:

createProject in interface AmazonLookoutforVision

Parameters:

createProjectRequest -

Returns:

Result of the CreateProject operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

InternalServerException - Amazon Lookout for Vision experienced a service issue. Try your call again.

ValidationException - An input validation error occured. For example, invalid characters in a project name, or if a pagination token is invalid.

ConflictException - The update or deletion of a resource caused an inconsistent state.

ResourceNotFoundException - The resource could not be found.

ThrottlingException - Amazon Lookout for Vision is temporarily unable to process the request. Try your call again.

ServiceQuotaExceededException - A service quota was exceeded the allowed limit. For more information, see Limits in Amazon Lookout for Vision in the Amazon Lookout for Vision Developer Guide.

See Also:

AWS API Documentation

deleteDataset

public DeleteDatasetResult deleteDataset(DeleteDatasetRequest request)

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.

It might take a while to delete the dataset. To check the current status, check the Status field in the response from a call to DescribeDataset.

Specified by:

deleteDataset in interface AmazonLookoutforVision

Parameters:

deleteDatasetRequest -

Returns:

Result of the DeleteDataset operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

InternalServerException - Amazon Lookout for Vision experienced a service issue. Try your call again.

ValidationException - An input validation error occured. For example, invalid characters in a project name, or if a pagination token is invalid.

ConflictException - The update or deletion of a resource caused an inconsistent state.

ResourceNotFoundException - The resource could not be found.

ThrottlingException - Amazon Lookout for Vision is temporarily unable to process the request. Try your call again.

See Also:

AWS API Documentation

deleteModel

public DeleteModelResult deleteModel(DeleteModelRequest request)

Deletes an Amazon Lookout for Vision model. You can't delete a running model. To stop a running model, use the StopModel operation.

Specified by:

deleteModel in interface AmazonLookoutforVision

Parameters:

deleteModelRequest -

Returns:

Result of the DeleteModel operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

InternalServerException - Amazon Lookout for Vision experienced a service issue. Try your call again.

ValidationException - An input validation error occured. For example, invalid characters in a project name, or if a pagination token is invalid.

ConflictException - The update or deletion of a resource caused an inconsistent state.

ResourceNotFoundException - The resource could not be found.

ThrottlingException - Amazon Lookout for Vision is temporarily unable to process the request. Try your call again.

See Also:

AWS API Documentation

deleteProject

public DeleteProjectResult deleteProject(DeleteProjectRequest request)

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.

The training and test datasets are deleted automatically for you. The images referenced by the training and test datasets aren't deleted.

Specified by:

deleteProject in interface AmazonLookoutforVision

Parameters:

deleteProjectRequest -

Returns:

Result of the DeleteProject operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

InternalServerException - Amazon Lookout for Vision experienced a service issue. Try your call again.

ValidationException - An input validation error occured. For example, invalid characters in a project name, or if a pagination token is invalid.

ConflictException - The update or deletion of a resource caused an inconsistent state.

ResourceNotFoundException - The resource could not be found.

ThrottlingException - Amazon Lookout for Vision is temporarily unable to process the request. Try your call again.

See Also:

AWS API Documentation

describeDataset

public DescribeDatasetResult describeDataset(DescribeDatasetRequest request)

Describe an Amazon Lookout for Vision dataset.

Specified by:

describeDataset in interface AmazonLookoutforVision

Parameters:

describeDatasetRequest -

Returns:

Result of the DescribeDataset operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

InternalServerException - Amazon Lookout for Vision experienced a service issue. Try your call again.

ValidationException - An input validation error occured. For example, invalid characters in a project name, or if a pagination token is invalid.

ConflictException - The update or deletion of a resource caused an inconsistent state.

ResourceNotFoundException - The resource could not be found.

ThrottlingException - Amazon Lookout for Vision is temporarily unable to process the request. Try your call again.

See Also:

AWS API Documentation

describeModel

public DescribeModelResult describeModel(DescribeModelRequest request)

Describes a version of an Amazon Lookout for Vision model.

Specified by:

describeModel in interface AmazonLookoutforVision

Parameters:

describeModelRequest -

Returns:

Result of the DescribeModel operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

InternalServerException - Amazon Lookout for Vision experienced a service issue. Try your call again.

ValidationException - An input validation error occured. For example, invalid characters in a project name, or if a pagination token is invalid.

ConflictException - The update or deletion of a resource caused an inconsistent state.

ResourceNotFoundException - The resource could not be found.

ThrottlingException - Amazon Lookout for Vision is temporarily unable to process the request. Try your call again.

See Also:

AWS API Documentation

describeProject

public DescribeProjectResult describeProject(DescribeProjectRequest request)

Describes an Amazon Lookout for Vision project.

Specified by:

describeProject in interface AmazonLookoutforVision

Parameters:

describeProjectRequest -

Returns:

Result of the DescribeProject operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

InternalServerException - Amazon Lookout for Vision experienced a service issue. Try your call again.

ValidationException - An input validation error occured. For example, invalid characters in a project name, or if a pagination token is invalid.

ConflictException - The update or deletion of a resource caused an inconsistent state.

ResourceNotFoundException - The resource could not be found.

ThrottlingException - Amazon Lookout for Vision is temporarily unable to process the request. Try your call again.

See Also:

AWS API Documentation

detectAnomalies

public DetectAnomaliesResult detectAnomalies(DetectAnomaliesRequest request)

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.

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.

Specified by:

detectAnomalies in interface AmazonLookoutforVision

Parameters:

detectAnomaliesRequest -

Returns:

Result of the DetectAnomalies operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

InternalServerException - Amazon Lookout for Vision experienced a service issue. Try your call again.

ValidationException - An input validation error occured. For example, invalid characters in a project name, or if a pagination token is invalid.

ConflictException - The update or deletion of a resource caused an inconsistent state.

ResourceNotFoundException - The resource could not be found.

ThrottlingException - Amazon Lookout for Vision is temporarily unable to process the request. Try your call again.

See Also:

AWS API Documentation

listDatasetEntries

public ListDatasetEntriesResult listDatasetEntries(ListDatasetEntriesRequest request)

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.

Specified by:

listDatasetEntries in interface AmazonLookoutforVision

Parameters:

listDatasetEntriesRequest -

Returns:

Result of the ListDatasetEntries operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

InternalServerException - Amazon Lookout for Vision experienced a service issue. Try your call again.

ValidationException - An input validation error occured. For example, invalid characters in a project name, or if a pagination token is invalid.

ConflictException - The update or deletion of a resource caused an inconsistent state.

ResourceNotFoundException - The resource could not be found.

ThrottlingException - Amazon Lookout for Vision is temporarily unable to process the request. Try your call again.

See Also:

AWS API Documentation

listModels

public ListModelsResult listModels(ListModelsRequest request)

Lists the versions of a model in an Amazon Lookout for Vision project.

Specified by:

listModels in interface AmazonLookoutforVision

Parameters:

listModelsRequest -

Returns:

Result of the ListModels operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

InternalServerException - Amazon Lookout for Vision experienced a service issue. Try your call again.

ValidationException - An input validation error occured. For example, invalid characters in a project name, or if a pagination token is invalid.

ConflictException - The update or deletion of a resource caused an inconsistent state.

ResourceNotFoundException - The resource could not be found.

ThrottlingException - Amazon Lookout for Vision is temporarily unable to process the request. Try your call again.

See Also:

AWS API Documentation

listProjects

public ListProjectsResult listProjects(ListProjectsRequest request)

Lists the Amazon Lookout for Vision projects in your AWS account.

Specified by:

listProjects in interface AmazonLookoutforVision

Parameters:

listProjectsRequest -

Returns:

Result of the ListProjects operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

InternalServerException - Amazon Lookout for Vision experienced a service issue. Try your call again.

ValidationException - An input validation error occured. For example, invalid characters in a project name, or if a pagination token is invalid.

ConflictException - The update or deletion of a resource caused an inconsistent state.

ResourceNotFoundException - The resource could not be found.

ThrottlingException - Amazon Lookout for Vision is temporarily unable to process the request. Try your call again.

See Also:

AWS API Documentation

startModel

public StartModelResult startModel(StartModelRequest request)

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.

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.

Specified by:

startModel in interface AmazonLookoutforVision

Parameters:

startModelRequest -

Returns:

Result of the StartModel operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

InternalServerException - Amazon Lookout for Vision experienced a service issue. Try your call again.

ValidationException - An input validation error occured. For example, invalid characters in a project name, or if a pagination token is invalid.

ConflictException - The update or deletion of a resource caused an inconsistent state.

ResourceNotFoundException - The resource could not be found.

ThrottlingException - Amazon Lookout for Vision is temporarily unable to process the request. Try your call again.

ServiceQuotaExceededException - A service quota was exceeded the allowed limit. For more information, see Limits in Amazon Lookout for Vision in the Amazon Lookout for Vision Developer Guide.

See Also:

AWS API Documentation

stopModel

public StopModelResult stopModel(StopModelRequest request)

Stops a running model. The operation might take a while to complete. To check the current status, call DescribeModel.

Specified by:

stopModel in interface AmazonLookoutforVision

Parameters:

stopModelRequest -

Returns:

Result of the StopModel operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

InternalServerException - Amazon Lookout for Vision experienced a service issue. Try your call again.

ValidationException - An input validation error occured. For example, invalid characters in a project name, or if a pagination token is invalid.

ConflictException - The update or deletion of a resource caused an inconsistent state.

ResourceNotFoundException - The resource could not be found.

ThrottlingException - Amazon Lookout for Vision is temporarily unable to process the request. Try your call again.

See Also:

AWS API Documentation

updateDatasetEntries

public UpdateDatasetEntriesResult updateDatasetEntries(UpdateDatasetEntriesRequest request)

Adds one or more JSON Line entries to a dataset. A JSON Line includes information about an image used for training or testing an Amazon Lookout for Vision model. The following is an example JSON Line.

Updating a dataset might take a while to complete. To check the current status, call DescribeDataset and check the Status field in the response.

Specified by:

updateDatasetEntries in interface AmazonLookoutforVision

Parameters:

updateDatasetEntriesRequest -

Returns:

Result of the UpdateDatasetEntries operation returned by the service.

Throws:

AccessDeniedException - You are not authorized to perform the action.

InternalServerException - Amazon Lookout for Vision experienced a service issue. Try your call again.

ValidationException - An input validation error occured. For example, invalid characters in a project name, or if a pagination token is invalid.

ConflictException - The update or deletion of a resource caused an inconsistent state.

ResourceNotFoundException - The resource could not be found.

ThrottlingException - Amazon Lookout for Vision is temporarily unable to process the request. Try your call again.

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonLookoutforVision

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonLookoutforVision

Overrides:

shutdown in class AmazonWebServiceClient