AbstractAmazonLookoutforVision (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.lookoutforvision.AbstractAmazonLookoutforVision

All Implemented Interfaces:

AmazonLookoutforVision

Direct Known Subclasses:

AbstractAmazonLookoutforVisionAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonLookoutforVision
extends Object
implements AmazonLookoutforVision
```
Abstract implementation of AmazonLookoutforVision. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.lookoutforvision.AmazonLookoutforVision
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`DescribeModelPackagingJobResult`	`describeModelPackagingJob(DescribeModelPackagingJobRequest request)` Describes an Amazon Lookout for Vision model packaging job.
`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.
`ListModelPackagingJobsResult`	`listModelPackagingJobs(ListModelPackagingJobsRequest request)` Lists the model packaging jobs created for an Amazon Lookout for Vision project.
`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 that are in the AWS Region in which you call `ListProjects`.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Returns a list of tags attached to the specified Amazon Lookout for Vision model.
`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.
`StartModelPackagingJobResult`	`startModelPackagingJob(StartModelPackagingJobRequest request)` Starts an Amazon Lookout for Vision model packaging job.
`StopModelResult`	`stopModel(StopModelRequest request)` Stops the hosting of a running model.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds one or more key-value tags to an Amazon Lookout for Vision model.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes one or more tags from an Amazon Lookout for Vision model.
`UpdateDatasetEntriesResult`	`updateDatasetEntries(UpdateDatasetEntriesRequest request)` Adds or updates one or more JSON Line entries in a dataset.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - createDataset
```
public CreateDatasetResult createDataset(CreateDatasetRequest request)
```
    Description copied from interface: AmazonLookoutforVision
    
    Creates a new dataset in an Amazon Lookout for Vision project. CreateDataset can create a training or a test dataset from a valid dataset source (DatasetSource).
    
    If you want a single dataset project, specify train for the value of DatasetType.
    
    To have a project with separate training and test datasets, call CreateDataset twice. On the first call, specify train for the value of DatasetType. On the second call, specify test for the value of DatasetType.
    
    This operation requires permissions to perform the lookoutvision:CreateDataset operation.
    
    Specified by:
    
    createDataset in interface AmazonLookoutforVision
    
    Returns:
    
    Result of the CreateDataset operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createModel
```
public CreateModelResult createModel(CreateModelRequest request)
```
    Description copied from interface: AmazonLookoutforVision
    
    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.
    
    Specified by:
    
    createModel in interface AmazonLookoutforVision
    
    Returns:
    
    Result of the CreateModel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createProject
```
public CreateProjectResult createProject(CreateProjectRequest request)
```
    Description copied from interface: AmazonLookoutforVision
    
    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.
    
    Specified by:
    
    createProject in interface AmazonLookoutforVision
    
    Returns:
    
    Result of the CreateProject operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDataset
```
public DeleteDatasetResult deleteDataset(DeleteDatasetRequest request)
```
    Description copied from interface: AmazonLookoutforVision
    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.
    Specified by:
    
    deleteDataset in interface AmazonLookoutforVision
    
    Returns:
    
    Result of the DeleteDataset operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteModel
```
public DeleteModelResult deleteModel(DeleteModelRequest request)
```
    Description copied from interface: AmazonLookoutforVision
    
    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.
    
    Specified by:
    
    deleteModel in interface AmazonLookoutforVision
    
    Returns:
    
    Result of the DeleteModel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteProject
```
public DeleteProjectResult deleteProject(DeleteProjectRequest request)
```
    Description copied from interface: AmazonLookoutforVision
    
    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.
    
    Specified by:
    
    deleteProject in interface AmazonLookoutforVision
    
    Returns:
    
    Result of the DeleteProject operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDataset
```
public DescribeDatasetResult describeDataset(DescribeDatasetRequest request)
```
    Description copied from interface: AmazonLookoutforVision
    
    Describe an Amazon Lookout for Vision dataset.
    
    This operation requires permissions to perform the lookoutvision:DescribeDataset operation.
    
    Specified by:
    
    describeDataset in interface AmazonLookoutforVision
    
    Returns:
    
    Result of the DescribeDataset operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeModel
```
public DescribeModelResult describeModel(DescribeModelRequest request)
```
    Description copied from interface: AmazonLookoutforVision
    
    Describes a version of an Amazon Lookout for Vision model.
    
    This operation requires permissions to perform the lookoutvision:DescribeModel operation.
    
    Specified by:
    
    describeModel in interface AmazonLookoutforVision
    
    Returns:
    
    Result of the DescribeModel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeModelPackagingJob
```
public DescribeModelPackagingJobResult describeModelPackagingJob(DescribeModelPackagingJobRequest request)
```
    Description copied from interface: AmazonLookoutforVision
    
    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.
    
    Specified by:
    
    describeModelPackagingJob in interface AmazonLookoutforVision
    
    Returns:
    
    Result of the DescribeModelPackagingJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeProject
```
public DescribeProjectResult describeProject(DescribeProjectRequest request)
```
    Description copied from interface: AmazonLookoutforVision
    
    Describes an Amazon Lookout for Vision project.
    
    This operation requires permissions to perform the lookoutvision:DescribeProject operation.
    
    Specified by:
    
    describeProject in interface AmazonLookoutforVision
    
    Returns:
    
    Result of the DescribeProject operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - detectAnomalies
```
public DetectAnomaliesResult detectAnomalies(DetectAnomaliesRequest request)
```
    Description copied from interface: AmazonLookoutforVision
    
    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.
    
    Specified by:
    
    detectAnomalies in interface AmazonLookoutforVision
    
    Returns:
    
    Result of the DetectAnomalies operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDatasetEntries
```
public ListDatasetEntriesResult listDatasetEntries(ListDatasetEntriesRequest request)
```
    Description copied from interface: AmazonLookoutforVision
    
    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.
    
    Specified by:
    
    listDatasetEntries in interface AmazonLookoutforVision
    
    Returns:
    
    Result of the ListDatasetEntries operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listModelPackagingJobs
```
public ListModelPackagingJobsResult listModelPackagingJobs(ListModelPackagingJobsRequest request)
```
    Description copied from interface: AmazonLookoutforVision
    
    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.
    
    Specified by:
    
    listModelPackagingJobs in interface AmazonLookoutforVision
    
    Returns:
    
    Result of the ListModelPackagingJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listModels
```
public ListModelsResult listModels(ListModelsRequest request)
```
    Description copied from interface: AmazonLookoutforVision
    
    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.
    
    Specified by:
    
    listModels in interface AmazonLookoutforVision
    
    Returns:
    
    Result of the ListModels operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listProjects
```
public ListProjectsResult listProjects(ListProjectsRequest request)
```
    Description copied from interface: AmazonLookoutforVision
    
    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.
    
    Specified by:
    
    listProjects in interface AmazonLookoutforVision
    
    Returns:
    
    Result of the ListProjects operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AmazonLookoutforVision
    
    Returns a list of tags attached to the specified Amazon Lookout for Vision model.
    
    This operation requires permissions to perform the lookoutvision:ListTagsForResource operation.
    
    Specified by:
    
    listTagsForResource in interface AmazonLookoutforVision
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startModel
```
public StartModelResult startModel(StartModelRequest request)
```
    Description copied from interface: AmazonLookoutforVision
    
    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.
    
    Specified by:
    
    startModel in interface AmazonLookoutforVision
    
    Returns:
    
    Result of the StartModel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startModelPackagingJob
```
public StartModelPackagingJobResult startModelPackagingJob(StartModelPackagingJobRequest request)
```
    Description copied from interface: AmazonLookoutforVision
    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.
    Specified by:
    
    startModelPackagingJob in interface AmazonLookoutforVision
    
    Returns:
    
    Result of the StartModelPackagingJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopModel
```
public StopModelResult stopModel(StopModelRequest request)
```
    Description copied from interface: AmazonLookoutforVision
    
    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.
    
    Specified by:
    
    stopModel in interface AmazonLookoutforVision
    
    Returns:
    
    Result of the StopModel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AmazonLookoutforVision
    
    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.
    
    Specified by:
    
    tagResource in interface AmazonLookoutforVision
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AmazonLookoutforVision
    
    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.
    
    Specified by:
    
    untagResource in interface AmazonLookoutforVision
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateDatasetEntries
```
public UpdateDatasetEntriesResult updateDatasetEntries(UpdateDatasetEntriesRequest request)
```
    Description copied from interface: AmazonLookoutforVision
    
    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.
    
    Specified by:
    
    updateDatasetEntries in interface AmazonLookoutforVision
    
    Returns:
    
    Result of the UpdateDatasetEntries operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonLookoutforVision
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonLookoutforVision
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonLookoutforVision
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    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.

AWS SDK for Java 1.x API Reference - 1.12.624

Class AbstractAmazonLookoutforVision

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createDataset

createModel

createProject

deleteDataset

deleteModel

deleteProject

describeDataset

describeModel

describeModelPackagingJob

describeProject

detectAnomalies

listDatasetEntries

listModelPackagingJobs

listModels

listProjects

listTagsForResource

startModel

startModelPackagingJob

stopModel

tagResource

untagResource

updateDatasetEntries

shutdown

getCachedResponseMetadata