Interface LookoutVisionClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface LookoutVisionClient
extends AwsClient

Service client for accessing Amazon Lookout for Vision. This can be created using the static builder() method.

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

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static LookoutVisionClientBuilder	builder()	Create a builder that can be used to configure and create a LookoutVisionClient.
static LookoutVisionClient	create()	Create a LookoutVisionClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateDatasetResponse	createDataset(Consumer<CreateDatasetRequest.Builder> createDatasetRequest)	Creates a new dataset in an Amazon Lookout for Vision project.
default CreateDatasetResponse	createDataset(CreateDatasetRequest createDatasetRequest)	Creates a new dataset in an Amazon Lookout for Vision project.
default CreateModelResponse	createModel(Consumer<CreateModelRequest.Builder> createModelRequest)	Creates a new version of a model within an an Amazon Lookout for Vision project.
default CreateModelResponse	createModel(CreateModelRequest createModelRequest)	Creates a new version of a model within an an Amazon Lookout for Vision project.
default CreateProjectResponse	createProject(Consumer<CreateProjectRequest.Builder> createProjectRequest)	Creates an empty Amazon Lookout for Vision project.
default CreateProjectResponse	createProject(CreateProjectRequest createProjectRequest)	Creates an empty Amazon Lookout for Vision project.
default DeleteDatasetResponse	deleteDataset(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest)	Deletes an existing Amazon Lookout for Vision dataset.
default DeleteDatasetResponse	deleteDataset(DeleteDatasetRequest deleteDatasetRequest)	Deletes an existing Amazon Lookout for Vision dataset.
default DeleteModelResponse	deleteModel(Consumer<DeleteModelRequest.Builder> deleteModelRequest)	Deletes an Amazon Lookout for Vision model.
default DeleteModelResponse	deleteModel(DeleteModelRequest deleteModelRequest)	Deletes an Amazon Lookout for Vision model.
default DeleteProjectResponse	deleteProject(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest)	Deletes an Amazon Lookout for Vision project.
default DeleteProjectResponse	deleteProject(DeleteProjectRequest deleteProjectRequest)	Deletes an Amazon Lookout for Vision project.
default DescribeDatasetResponse	describeDataset(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest)	Describe an Amazon Lookout for Vision dataset.
default DescribeDatasetResponse	describeDataset(DescribeDatasetRequest describeDatasetRequest)	Describe an Amazon Lookout for Vision dataset.
default DescribeModelResponse	describeModel(Consumer<DescribeModelRequest.Builder> describeModelRequest)	Describes a version of an Amazon Lookout for Vision model.
default DescribeModelResponse	describeModel(DescribeModelRequest describeModelRequest)	Describes a version of an Amazon Lookout for Vision model.
default DescribeModelPackagingJobResponse	describeModelPackagingJob(Consumer<DescribeModelPackagingJobRequest.Builder> describeModelPackagingJobRequest)	Describes an Amazon Lookout for Vision model packaging job.
default DescribeModelPackagingJobResponse	describeModelPackagingJob(DescribeModelPackagingJobRequest describeModelPackagingJobRequest)	Describes an Amazon Lookout for Vision model packaging job.
default DescribeProjectResponse	describeProject(Consumer<DescribeProjectRequest.Builder> describeProjectRequest)	Describes an Amazon Lookout for Vision project.
default DescribeProjectResponse	describeProject(DescribeProjectRequest describeProjectRequest)	Describes an Amazon Lookout for Vision project.
default DetectAnomaliesResponse	detectAnomalies(Consumer<DetectAnomaliesRequest.Builder> detectAnomaliesRequest, Path sourcePath)	Detects anomalies in an image that you supply.
default DetectAnomaliesResponse	detectAnomalies(Consumer<DetectAnomaliesRequest.Builder> detectAnomaliesRequest, RequestBody requestBody)	Detects anomalies in an image that you supply.
default DetectAnomaliesResponse	detectAnomalies(DetectAnomaliesRequest detectAnomaliesRequest, Path sourcePath)	Detects anomalies in an image that you supply.
default DetectAnomaliesResponse	detectAnomalies(DetectAnomaliesRequest detectAnomaliesRequest, RequestBody requestBody)	Detects anomalies in an image that you supply.
default ListDatasetEntriesResponse	listDatasetEntries(Consumer<ListDatasetEntriesRequest.Builder> listDatasetEntriesRequest)	Lists the JSON Lines within a dataset.
default ListDatasetEntriesResponse	listDatasetEntries(ListDatasetEntriesRequest listDatasetEntriesRequest)	Lists the JSON Lines within a dataset.
default ListDatasetEntriesIterable	listDatasetEntriesPaginator(Consumer<ListDatasetEntriesRequest.Builder> listDatasetEntriesRequest)	This is a variant of listDatasetEntries(software.amazon.awssdk.services.lookoutvision.model.ListDatasetEntriesRequest) operation.
default ListDatasetEntriesIterable	listDatasetEntriesPaginator(ListDatasetEntriesRequest listDatasetEntriesRequest)	This is a variant of listDatasetEntries(software.amazon.awssdk.services.lookoutvision.model.ListDatasetEntriesRequest) operation.
default ListModelPackagingJobsResponse	listModelPackagingJobs(Consumer<ListModelPackagingJobsRequest.Builder> listModelPackagingJobsRequest)	Lists the model packaging jobs created for an Amazon Lookout for Vision project.
default ListModelPackagingJobsResponse	listModelPackagingJobs(ListModelPackagingJobsRequest listModelPackagingJobsRequest)	Lists the model packaging jobs created for an Amazon Lookout for Vision project.
default ListModelPackagingJobsIterable	listModelPackagingJobsPaginator(Consumer<ListModelPackagingJobsRequest.Builder> listModelPackagingJobsRequest)	This is a variant of listModelPackagingJobs(software.amazon.awssdk.services.lookoutvision.model.ListModelPackagingJobsRequest) operation.
default ListModelPackagingJobsIterable	listModelPackagingJobsPaginator(ListModelPackagingJobsRequest listModelPackagingJobsRequest)	This is a variant of listModelPackagingJobs(software.amazon.awssdk.services.lookoutvision.model.ListModelPackagingJobsRequest) operation.
default ListModelsResponse	listModels(Consumer<ListModelsRequest.Builder> listModelsRequest)	Lists the versions of a model in an Amazon Lookout for Vision project.
default ListModelsResponse	listModels(ListModelsRequest listModelsRequest)	Lists the versions of a model in an Amazon Lookout for Vision project.
default ListModelsIterable	listModelsPaginator(Consumer<ListModelsRequest.Builder> listModelsRequest)	This is a variant of listModels(software.amazon.awssdk.services.lookoutvision.model.ListModelsRequest) operation.
default ListModelsIterable	listModelsPaginator(ListModelsRequest listModelsRequest)	This is a variant of listModels(software.amazon.awssdk.services.lookoutvision.model.ListModelsRequest) operation.
default ListProjectsResponse	listProjects(Consumer<ListProjectsRequest.Builder> listProjectsRequest)	Lists the Amazon Lookout for Vision projects in your AWS account that are in the AWS Region in which you call ListProjects.
default ListProjectsResponse	listProjects(ListProjectsRequest listProjectsRequest)	Lists the Amazon Lookout for Vision projects in your AWS account that are in the AWS Region in which you call ListProjects.
default ListProjectsIterable	listProjectsPaginator(Consumer<ListProjectsRequest.Builder> listProjectsRequest)	This is a variant of listProjects(software.amazon.awssdk.services.lookoutvision.model.ListProjectsRequest) operation.
default ListProjectsIterable	listProjectsPaginator(ListProjectsRequest listProjectsRequest)	This is a variant of listProjects(software.amazon.awssdk.services.lookoutvision.model.ListProjectsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Returns a list of tags attached to the specified Amazon Lookout for Vision model.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Returns a list of tags attached to the specified Amazon Lookout for Vision model.
default LookoutVisionServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartModelResponse	startModel(Consumer<StartModelRequest.Builder> startModelRequest)	Starts the running of the version of an Amazon Lookout for Vision model.
default StartModelResponse	startModel(StartModelRequest startModelRequest)	Starts the running of the version of an Amazon Lookout for Vision model.
default StartModelPackagingJobResponse	startModelPackagingJob(Consumer<StartModelPackagingJobRequest.Builder> startModelPackagingJobRequest)	Starts an Amazon Lookout for Vision model packaging job.
default StartModelPackagingJobResponse	startModelPackagingJob(StartModelPackagingJobRequest startModelPackagingJobRequest)	Starts an Amazon Lookout for Vision model packaging job.
default StopModelResponse	stopModel(Consumer<StopModelRequest.Builder> stopModelRequest)	Stops the hosting of a running model.
default StopModelResponse	stopModel(StopModelRequest stopModelRequest)	Stops the hosting of a running model.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds one or more key-value tags to an Amazon Lookout for Vision model.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds one or more key-value tags to an Amazon Lookout for Vision model.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes one or more tags from an Amazon Lookout for Vision model.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes one or more tags from an Amazon Lookout for Vision model.
default UpdateDatasetEntriesResponse	updateDatasetEntries(Consumer<UpdateDatasetEntriesRequest.Builder> updateDatasetEntriesRequest)	Adds or updates one or more JSON Line entries in a dataset.
default UpdateDatasetEntriesResponse	updateDatasetEntries(UpdateDatasetEntriesRequest updateDatasetEntriesRequest)	Adds or updates one or more JSON Line entries in a dataset.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createDataset

default CreateDatasetResponse createDataset(CreateDatasetRequest createDatasetRequest)
                                     throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

Parameters:

createDatasetRequest -

Returns:

Result of the CreateDataset operation returned by the service.

See Also:

• AWS API Documentation

createDataset

default CreateDatasetResponse createDataset(Consumer<CreateDatasetRequest.Builder> createDatasetRequest)
                                     throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

This is a convenience which creates an instance of the CreateDatasetRequest.Builder avoiding the need to create one manually via CreateDatasetRequest.builder()

Parameters:

createDatasetRequest - A Consumer that will call methods on CreateDatasetRequest.Builder to create a request.

Returns:

Result of the CreateDataset operation returned by the service.

See Also:

• AWS API Documentation

createModel

default CreateModelResponse createModel(CreateModelRequest createModelRequest)
                                 throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

Parameters:

createModelRequest -

Returns:

Result of the CreateModel operation returned by the service.

See Also:

• AWS API Documentation

createModel

default CreateModelResponse createModel(Consumer<CreateModelRequest.Builder> createModelRequest)
                                 throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

This is a convenience which creates an instance of the CreateModelRequest.Builder avoiding the need to create one manually via CreateModelRequest.builder()

Parameters:

createModelRequest - A Consumer that will call methods on CreateModelRequest.Builder to create a request.

Returns:

Result of the CreateModel operation returned by the service.

See Also:

• AWS API Documentation

createProject

default CreateProjectResponse createProject(CreateProjectRequest createProjectRequest)
                                     throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

Parameters:

createProjectRequest -

Returns:

Result of the CreateProject operation returned by the service.

See Also:

• AWS API Documentation

createProject

default CreateProjectResponse createProject(Consumer<CreateProjectRequest.Builder> createProjectRequest)
                                     throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

This is a convenience which creates an instance of the CreateProjectRequest.Builder avoiding the need to create one manually via CreateProjectRequest.builder()

Parameters:

createProjectRequest - A Consumer that will call methods on CreateProjectRequest.Builder to create a request.

Returns:

Result of the CreateProject operation returned by the service.

See Also:

• AWS API Documentation

deleteDataset

default DeleteDatasetResponse deleteDataset(DeleteDatasetRequest deleteDatasetRequest)
                                     throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

Parameters:

deleteDatasetRequest -

Returns:

Result of the DeleteDataset operation returned by the service.

See Also:

• AWS API Documentation

deleteDataset

default DeleteDatasetResponse deleteDataset(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest)
                                     throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

This is a convenience which creates an instance of the DeleteDatasetRequest.Builder avoiding the need to create one manually via DeleteDatasetRequest.builder()

Parameters:

deleteDatasetRequest - A Consumer that will call methods on DeleteDatasetRequest.Builder to create a request.

Returns:

Result of the DeleteDataset operation returned by the service.

See Also:

• AWS API Documentation

deleteModel

default DeleteModelResponse deleteModel(DeleteModelRequest deleteModelRequest)
                                 throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

Parameters:

deleteModelRequest -

Returns:

Result of the DeleteModel operation returned by the service.

See Also:

• AWS API Documentation

deleteModel

default DeleteModelResponse deleteModel(Consumer<DeleteModelRequest.Builder> deleteModelRequest)
                                 throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

This is a convenience which creates an instance of the DeleteModelRequest.Builder avoiding the need to create one manually via DeleteModelRequest.builder()

Parameters:

deleteModelRequest - A Consumer that will call methods on DeleteModelRequest.Builder to create a request.

Returns:

Result of the DeleteModel operation returned by the service.

See Also:

• AWS API Documentation

deleteProject

default DeleteProjectResponse deleteProject(DeleteProjectRequest deleteProjectRequest)
                                     throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

Parameters:

deleteProjectRequest -

Returns:

Result of the DeleteProject operation returned by the service.

See Also:

• AWS API Documentation

deleteProject

default DeleteProjectResponse deleteProject(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest)
                                     throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

This is a convenience which creates an instance of the DeleteProjectRequest.Builder avoiding the need to create one manually via DeleteProjectRequest.builder()

Parameters:

deleteProjectRequest - A Consumer that will call methods on DeleteProjectRequest.Builder to create a request.

Returns:

Result of the DeleteProject operation returned by the service.

See Also:

• AWS API Documentation

describeDataset

default DescribeDatasetResponse describeDataset(DescribeDatasetRequest describeDatasetRequest)
                                         throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

Describe an Amazon Lookout for Vision dataset.

This operation requires permissions to perform the lookoutvision:DescribeDataset operation.

Parameters:

describeDatasetRequest -

Returns:

Result of the DescribeDataset operation returned by the service.

See Also:

• AWS API Documentation

describeDataset

default DescribeDatasetResponse describeDataset(Consumer<DescribeDatasetRequest.Builder> describeDatasetRequest)
                                         throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

Describe an Amazon Lookout for Vision dataset.

This operation requires permissions to perform the lookoutvision:DescribeDataset operation.

This is a convenience which creates an instance of the DescribeDatasetRequest.Builder avoiding the need to create one manually via DescribeDatasetRequest.builder()

Parameters:

describeDatasetRequest - A Consumer that will call methods on DescribeDatasetRequest.Builder to create a request.

Returns:

Result of the DescribeDataset operation returned by the service.

See Also:

• AWS API Documentation

describeModel

default DescribeModelResponse describeModel(DescribeModelRequest describeModelRequest)
                                     throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

Describes a version of an Amazon Lookout for Vision model.

This operation requires permissions to perform the lookoutvision:DescribeModel operation.

Parameters:

describeModelRequest -

Returns:

Result of the DescribeModel operation returned by the service.

See Also:

• AWS API Documentation

describeModel

default DescribeModelResponse describeModel(Consumer<DescribeModelRequest.Builder> describeModelRequest)
                                     throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

Describes a version of an Amazon Lookout for Vision model.

This operation requires permissions to perform the lookoutvision:DescribeModel operation.

This is a convenience which creates an instance of the DescribeModelRequest.Builder avoiding the need to create one manually via DescribeModelRequest.builder()

Parameters:

describeModelRequest - A Consumer that will call methods on DescribeModelRequest.Builder to create a request.

Returns:

Result of the DescribeModel operation returned by the service.

See Also:

• AWS API Documentation

describeModelPackagingJob

default DescribeModelPackagingJobResponse describeModelPackagingJob(DescribeModelPackagingJobRequest describeModelPackagingJobRequest)
                                                             throws AccessDeniedException,
InternalServerException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

Parameters:

describeModelPackagingJobRequest -

Returns:

Result of the DescribeModelPackagingJob operation returned by the service.

See Also:

• AWS API Documentation

describeModelPackagingJob

default DescribeModelPackagingJobResponse describeModelPackagingJob(Consumer<DescribeModelPackagingJobRequest.Builder> describeModelPackagingJobRequest)
                                                             throws AccessDeniedException,
InternalServerException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

This is a convenience which creates an instance of the DescribeModelPackagingJobRequest.Builder avoiding the need to create one manually via DescribeModelPackagingJobRequest.builder()

Parameters:

describeModelPackagingJobRequest - A Consumer that will call methods on DescribeModelPackagingJobRequest.Builder to create a request.

Returns:

Result of the DescribeModelPackagingJob operation returned by the service.

See Also:

• AWS API Documentation

describeProject

default DescribeProjectResponse describeProject(DescribeProjectRequest describeProjectRequest)
                                         throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

Describes an Amazon Lookout for Vision project.

This operation requires permissions to perform the lookoutvision:DescribeProject operation.

Parameters:

describeProjectRequest -

Returns:

Result of the DescribeProject operation returned by the service.

See Also:

• AWS API Documentation

describeProject

default DescribeProjectResponse describeProject(Consumer<DescribeProjectRequest.Builder> describeProjectRequest)
                                         throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

Describes an Amazon Lookout for Vision project.

This operation requires permissions to perform the lookoutvision:DescribeProject operation.

This is a convenience which creates an instance of the DescribeProjectRequest.Builder avoiding the need to create one manually via DescribeProjectRequest.builder()

Parameters:

describeProjectRequest - A Consumer that will call methods on DescribeProjectRequest.Builder to create a request.

Returns:

Result of the DescribeProject operation returned by the service.

See Also:

• AWS API Documentation

detectAnomalies

default DetectAnomaliesResponse detectAnomalies(DetectAnomaliesRequest detectAnomaliesRequest,
 RequestBody requestBody)
                                         throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

Parameters:

detectAnomaliesRequest -

requestBody - The content to send to the service. A RequestBody can be created using one of several factory methods for various sources of data. For example, to create a request body from a file you can do the following.

 RequestBody.fromFile(new File("myfile.txt"))
 

See documentation in RequestBody for additional details and which sources of data are supported. The service documentation for the request content is as follows '

The unencrypted image bytes that you want to analyze.

'

Returns:

Result of the DetectAnomalies operation returned by the service.

See Also:

• AWS API Documentation

detectAnomalies

default DetectAnomaliesResponse detectAnomalies(Consumer<DetectAnomaliesRequest.Builder> detectAnomaliesRequest,
 RequestBody requestBody)
                                         throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

This is a convenience which creates an instance of the DetectAnomaliesRequest.Builder avoiding the need to create one manually via DetectAnomaliesRequest.builder()

Parameters:

detectAnomaliesRequest - A Consumer that will call methods on DetectAnomaliesRequest.Builder to create a request.

requestBody - The content to send to the service. A RequestBody can be created using one of several factory methods for various sources of data. For example, to create a request body from a file you can do the following.

 RequestBody.fromFile(new File("myfile.txt"))
 

See documentation in RequestBody for additional details and which sources of data are supported. The service documentation for the request content is as follows '

The unencrypted image bytes that you want to analyze.

'

Returns:

Result of the DetectAnomalies operation returned by the service.

See Also:

• AWS API Documentation

detectAnomalies

default DetectAnomaliesResponse detectAnomalies(DetectAnomaliesRequest detectAnomaliesRequest,
 Path sourcePath)
                                         throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

Parameters:

detectAnomaliesRequest -

sourcePath - Path to file containing data to send to the service. File will be read entirely and may be read multiple times in the event of a retry. If the file does not exist or the current user does not have access to read it then an exception will be thrown. The service documentation for the request content is as follows '

The unencrypted image bytes that you want to analyze.

'

Returns:

Result of the DetectAnomalies operation returned by the service.

See Also:

• detectAnomalies(DetectAnomaliesRequest, RequestBody)
• AWS API Documentation

detectAnomalies

default DetectAnomaliesResponse detectAnomalies(Consumer<DetectAnomaliesRequest.Builder> detectAnomaliesRequest,
 Path sourcePath)
                                         throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

This is a convenience which creates an instance of the DetectAnomaliesRequest.Builder avoiding the need to create one manually via DetectAnomaliesRequest.builder()

Parameters:

detectAnomaliesRequest - A Consumer that will call methods on DetectAnomaliesRequest.Builder to create a request.

sourcePath - Path to file containing data to send to the service. File will be read entirely and may be read multiple times in the event of a retry. If the file does not exist or the current user does not have access to read it then an exception will be thrown. The service documentation for the request content is as follows '

The unencrypted image bytes that you want to analyze.

'

Returns:

Result of the DetectAnomalies operation returned by the service.

See Also:

• detectAnomalies(DetectAnomaliesRequest, RequestBody)
• AWS API Documentation

listDatasetEntries

default ListDatasetEntriesResponse listDatasetEntries(ListDatasetEntriesRequest listDatasetEntriesRequest)
                                               throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

Parameters:

listDatasetEntriesRequest -

Returns:

Result of the ListDatasetEntries operation returned by the service.

See Also:

• AWS API Documentation

listDatasetEntries

default ListDatasetEntriesResponse listDatasetEntries(Consumer<ListDatasetEntriesRequest.Builder> listDatasetEntriesRequest)
                                               throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

This is a convenience which creates an instance of the ListDatasetEntriesRequest.Builder avoiding the need to create one manually via ListDatasetEntriesRequest.builder()

Parameters:

listDatasetEntriesRequest - A Consumer that will call methods on ListDatasetEntriesRequest.Builder to create a request.

Returns:

Result of the ListDatasetEntries operation returned by the service.

See Also:

• AWS API Documentation

listDatasetEntriesPaginator

default ListDatasetEntriesIterable listDatasetEntriesPaginator(ListDatasetEntriesRequest listDatasetEntriesRequest)
                                                        throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

This is a variant of listDatasetEntries(software.amazon.awssdk.services.lookoutvision.model.ListDatasetEntriesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.lookoutvision.paginators.ListDatasetEntriesIterable responses = client.listDatasetEntriesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.lookoutvision.paginators.ListDatasetEntriesIterable responses = client
             .listDatasetEntriesPaginator(request);
     for (software.amazon.awssdk.services.lookoutvision.model.ListDatasetEntriesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.lookoutvision.paginators.ListDatasetEntriesIterable responses = client.listDatasetEntriesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listDatasetEntries(software.amazon.awssdk.services.lookoutvision.model.ListDatasetEntriesRequest) operation.

Parameters:

listDatasetEntriesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listDatasetEntriesPaginator

default ListDatasetEntriesIterable listDatasetEntriesPaginator(Consumer<ListDatasetEntriesRequest.Builder> listDatasetEntriesRequest)
                                                        throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

This is a variant of listDatasetEntries(software.amazon.awssdk.services.lookoutvision.model.ListDatasetEntriesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.lookoutvision.paginators.ListDatasetEntriesIterable responses = client.listDatasetEntriesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.lookoutvision.paginators.ListDatasetEntriesIterable responses = client
             .listDatasetEntriesPaginator(request);
     for (software.amazon.awssdk.services.lookoutvision.model.ListDatasetEntriesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.lookoutvision.paginators.ListDatasetEntriesIterable responses = client.listDatasetEntriesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listDatasetEntries(software.amazon.awssdk.services.lookoutvision.model.ListDatasetEntriesRequest) operation.

This is a convenience which creates an instance of the ListDatasetEntriesRequest.Builder avoiding the need to create one manually via ListDatasetEntriesRequest.builder()

Parameters:

listDatasetEntriesRequest - A Consumer that will call methods on ListDatasetEntriesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listModelPackagingJobs

default ListModelPackagingJobsResponse listModelPackagingJobs(ListModelPackagingJobsRequest listModelPackagingJobsRequest)
                                                       throws AccessDeniedException,
InternalServerException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

Parameters:

listModelPackagingJobsRequest -

Returns:

Result of the ListModelPackagingJobs operation returned by the service.

See Also:

• AWS API Documentation

listModelPackagingJobs

default ListModelPackagingJobsResponse listModelPackagingJobs(Consumer<ListModelPackagingJobsRequest.Builder> listModelPackagingJobsRequest)
                                                       throws AccessDeniedException,
InternalServerException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

This is a convenience which creates an instance of the ListModelPackagingJobsRequest.Builder avoiding the need to create one manually via ListModelPackagingJobsRequest.builder()

Parameters:

listModelPackagingJobsRequest - A Consumer that will call methods on ListModelPackagingJobsRequest.Builder to create a request.

Returns:

Result of the ListModelPackagingJobs operation returned by the service.

See Also:

• AWS API Documentation

listModelPackagingJobsPaginator

default ListModelPackagingJobsIterable listModelPackagingJobsPaginator(ListModelPackagingJobsRequest listModelPackagingJobsRequest)
                                                                throws AccessDeniedException,
InternalServerException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

This is a variant of listModelPackagingJobs(software.amazon.awssdk.services.lookoutvision.model.ListModelPackagingJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.lookoutvision.paginators.ListModelPackagingJobsIterable responses = client.listModelPackagingJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.lookoutvision.paginators.ListModelPackagingJobsIterable responses = client
             .listModelPackagingJobsPaginator(request);
     for (software.amazon.awssdk.services.lookoutvision.model.ListModelPackagingJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.lookoutvision.paginators.ListModelPackagingJobsIterable responses = client.listModelPackagingJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listModelPackagingJobs(software.amazon.awssdk.services.lookoutvision.model.ListModelPackagingJobsRequest) operation.

Parameters:

listModelPackagingJobsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listModelPackagingJobsPaginator

default ListModelPackagingJobsIterable listModelPackagingJobsPaginator(Consumer<ListModelPackagingJobsRequest.Builder> listModelPackagingJobsRequest)
                                                                throws AccessDeniedException,
InternalServerException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

This is a variant of listModelPackagingJobs(software.amazon.awssdk.services.lookoutvision.model.ListModelPackagingJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.lookoutvision.paginators.ListModelPackagingJobsIterable responses = client.listModelPackagingJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.lookoutvision.paginators.ListModelPackagingJobsIterable responses = client
             .listModelPackagingJobsPaginator(request);
     for (software.amazon.awssdk.services.lookoutvision.model.ListModelPackagingJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.lookoutvision.paginators.ListModelPackagingJobsIterable responses = client.listModelPackagingJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listModelPackagingJobs(software.amazon.awssdk.services.lookoutvision.model.ListModelPackagingJobsRequest) operation.

This is a convenience which creates an instance of the ListModelPackagingJobsRequest.Builder avoiding the need to create one manually via ListModelPackagingJobsRequest.builder()

Parameters:

listModelPackagingJobsRequest - A Consumer that will call methods on ListModelPackagingJobsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listModels

default ListModelsResponse listModels(ListModelsRequest listModelsRequest)
                               throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

Parameters:

listModelsRequest -

Returns:

Result of the ListModels operation returned by the service.

See Also:

• AWS API Documentation

listModels

default ListModelsResponse listModels(Consumer<ListModelsRequest.Builder> listModelsRequest)
                               throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

This is a convenience which creates an instance of the ListModelsRequest.Builder avoiding the need to create one manually via ListModelsRequest.builder()

Parameters:

listModelsRequest - A Consumer that will call methods on ListModelsRequest.Builder to create a request.

Returns:

Result of the ListModels operation returned by the service.

See Also:

• AWS API Documentation

listModelsPaginator

default ListModelsIterable listModelsPaginator(ListModelsRequest listModelsRequest)
                                        throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

This is a variant of listModels(software.amazon.awssdk.services.lookoutvision.model.ListModelsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.lookoutvision.paginators.ListModelsIterable responses = client.listModelsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.lookoutvision.paginators.ListModelsIterable responses = client.listModelsPaginator(request);
     for (software.amazon.awssdk.services.lookoutvision.model.ListModelsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.lookoutvision.paginators.ListModelsIterable responses = client.listModelsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listModels(software.amazon.awssdk.services.lookoutvision.model.ListModelsRequest) operation.

Parameters:

listModelsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listModelsPaginator

default ListModelsIterable listModelsPaginator(Consumer<ListModelsRequest.Builder> listModelsRequest)
                                        throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

This is a variant of listModels(software.amazon.awssdk.services.lookoutvision.model.ListModelsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.lookoutvision.paginators.ListModelsIterable responses = client.listModelsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.lookoutvision.paginators.ListModelsIterable responses = client.listModelsPaginator(request);
     for (software.amazon.awssdk.services.lookoutvision.model.ListModelsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.lookoutvision.paginators.ListModelsIterable responses = client.listModelsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listModels(software.amazon.awssdk.services.lookoutvision.model.ListModelsRequest) operation.

This is a convenience which creates an instance of the ListModelsRequest.Builder avoiding the need to create one manually via ListModelsRequest.builder()

Parameters:

listModelsRequest - A Consumer that will call methods on ListModelsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listProjects

default ListProjectsResponse listProjects(ListProjectsRequest listProjectsRequest)
                                   throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

Parameters:

listProjectsRequest -

Returns:

Result of the ListProjects operation returned by the service.

See Also:

• AWS API Documentation

listProjects

default ListProjectsResponse listProjects(Consumer<ListProjectsRequest.Builder> listProjectsRequest)
                                   throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

This is a convenience which creates an instance of the ListProjectsRequest.Builder avoiding the need to create one manually via ListProjectsRequest.builder()

Parameters:

listProjectsRequest - A Consumer that will call methods on ListProjectsRequest.Builder to create a request.

Returns:

Result of the ListProjects operation returned by the service.

See Also:

• AWS API Documentation

listProjectsPaginator

default ListProjectsIterable listProjectsPaginator(ListProjectsRequest listProjectsRequest)
                                            throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

This is a variant of listProjects(software.amazon.awssdk.services.lookoutvision.model.ListProjectsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.lookoutvision.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.lookoutvision.paginators.ListProjectsIterable responses = client
             .listProjectsPaginator(request);
     for (software.amazon.awssdk.services.lookoutvision.model.ListProjectsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.lookoutvision.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listProjects(software.amazon.awssdk.services.lookoutvision.model.ListProjectsRequest) operation.

Parameters:

listProjectsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listProjectsPaginator

default ListProjectsIterable listProjectsPaginator(Consumer<ListProjectsRequest.Builder> listProjectsRequest)
                                            throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

This is a variant of listProjects(software.amazon.awssdk.services.lookoutvision.model.ListProjectsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.lookoutvision.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.lookoutvision.paginators.ListProjectsIterable responses = client
             .listProjectsPaginator(request);
     for (software.amazon.awssdk.services.lookoutvision.model.ListProjectsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.lookoutvision.paginators.ListProjectsIterable responses = client.listProjectsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listProjects(software.amazon.awssdk.services.lookoutvision.model.ListProjectsRequest) operation.

This is a convenience which creates an instance of the ListProjectsRequest.Builder avoiding the need to create one manually via ListProjectsRequest.builder()

Parameters:

listProjectsRequest - A Consumer that will call methods on ListProjectsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

Returns a list of tags attached to the specified Amazon Lookout for Vision model.

This operation requires permissions to perform the lookoutvision:ListTagsForResource operation.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

Returns a list of tags attached to the specified Amazon Lookout for Vision model.

This operation requires permissions to perform the lookoutvision:ListTagsForResource operation.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

startModel

default StartModelResponse startModel(StartModelRequest startModelRequest)
                               throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

Parameters:

startModelRequest -

Returns:

Result of the StartModel operation returned by the service.

See Also:

• AWS API Documentation

startModel

default StartModelResponse startModel(Consumer<StartModelRequest.Builder> startModelRequest)
                               throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

This is a convenience which creates an instance of the StartModelRequest.Builder avoiding the need to create one manually via StartModelRequest.builder()

Parameters:

startModelRequest - A Consumer that will call methods on StartModelRequest.Builder to create a request.

Returns:

Result of the StartModel operation returned by the service.

See Also:

• AWS API Documentation

startModelPackagingJob

default StartModelPackagingJobResponse startModelPackagingJob(StartModelPackagingJobRequest startModelPackagingJobRequest)
                                                       throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

Parameters:

startModelPackagingJobRequest -

Returns:

Result of the StartModelPackagingJob operation returned by the service.

See Also:

• AWS API Documentation

startModelPackagingJob

default StartModelPackagingJobResponse startModelPackagingJob(Consumer<StartModelPackagingJobRequest.Builder> startModelPackagingJobRequest)
                                                       throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

This is a convenience which creates an instance of the StartModelPackagingJobRequest.Builder avoiding the need to create one manually via StartModelPackagingJobRequest.builder()

Parameters:

startModelPackagingJobRequest - A Consumer that will call methods on StartModelPackagingJobRequest.Builder to create a request.

Returns:

Result of the StartModelPackagingJob operation returned by the service.

See Also:

• AWS API Documentation

stopModel

default StopModelResponse stopModel(StopModelRequest stopModelRequest)
                             throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

Parameters:

stopModelRequest -

Returns:

Result of the StopModel operation returned by the service.

See Also:

• AWS API Documentation

stopModel

default StopModelResponse stopModel(Consumer<StopModelRequest.Builder> stopModelRequest)
                             throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

This is a convenience which creates an instance of the StopModelRequest.Builder avoiding the need to create one manually via StopModelRequest.builder()

Parameters:

stopModelRequest - A Consumer that will call methods on StopModelRequest.Builder to create a request.

Returns:

Result of the StopModel operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateDatasetEntries

default UpdateDatasetEntriesResponse updateDatasetEntries(UpdateDatasetEntriesRequest updateDatasetEntriesRequest)
                                                   throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

Parameters:

updateDatasetEntriesRequest -

Returns:

Result of the UpdateDatasetEntries operation returned by the service.

See Also:

• AWS API Documentation

updateDatasetEntries

default UpdateDatasetEntriesResponse updateDatasetEntries(Consumer<UpdateDatasetEntriesRequest.Builder> updateDatasetEntriesRequest)
                                                   throws AccessDeniedException,
InternalServerException,
ValidationException,
ConflictException,
ResourceNotFoundException,
ThrottlingException,
AwsServiceException,
SdkClientException,
LookoutVisionException

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.

This is a convenience which creates an instance of the UpdateDatasetEntriesRequest.Builder avoiding the need to create one manually via UpdateDatasetEntriesRequest.builder()

Parameters:

updateDatasetEntriesRequest - A Consumer that will call methods on UpdateDatasetEntriesRequest.Builder to create a request.

Returns:

Result of the UpdateDatasetEntries operation returned by the service.

See Also:

• AWS API Documentation

create

static LookoutVisionClient create()

Create a LookoutVisionClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static LookoutVisionClientBuilder builder()

Create a builder that can be used to configure and create a LookoutVisionClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default LookoutVisionServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration