NAME

Paws::LookoutVision - Perl Interface to AWS Amazon Lookout for Vision

SYNOPSIS

  use Paws;
  my $obj = Paws->service('LookoutVision');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

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.

For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20>

METHODS

CreateDataset

DatasetType => Str
ProjectName => Str
[ClientToken => Str]
[DatasetSource => Paws::LookoutVision::DatasetSource]

Each argument is described in detail in: Paws::LookoutVision::CreateDataset

Returns: a Paws::LookoutVision::CreateDatasetResponse instance

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.

CreateModel

OutputConfig => Paws::LookoutVision::OutputConfig
ProjectName => Str
[ClientToken => Str]
[Description => Str]
[KmsKeyId => Str]
[Tags => ArrayRef[Paws::LookoutVision::Tag]]

Each argument is described in detail in: Paws::LookoutVision::CreateModel

Returns: a Paws::LookoutVision::CreateModelResponse instance

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.

CreateProject

ProjectName => Str
[ClientToken => Str]

Each argument is described in detail in: Paws::LookoutVision::CreateProject

Returns: a Paws::LookoutVision::CreateProjectResponse instance

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.

DeleteDataset

DatasetType => Str
ProjectName => Str
[ClientToken => Str]

Each argument is described in detail in: Paws::LookoutVision::DeleteDataset

Returns: a Paws::LookoutVision::DeleteDatasetResponse instance

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.

DeleteModel

ModelVersion => Str
ProjectName => Str
[ClientToken => Str]

Each argument is described in detail in: Paws::LookoutVision::DeleteModel

Returns: a Paws::LookoutVision::DeleteModelResponse instance

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 ListProjects and check if the version of the model ("ModelVersion") is in the "Models" array.

This operation requires permissions to perform the "lookoutvision:DeleteModel" operation.

DeleteProject

ProjectName => Str
[ClientToken => Str]

Each argument is described in detail in: Paws::LookoutVision::DeleteProject

Returns: a Paws::LookoutVision::DeleteProjectResponse instance

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.

Each argument is described in detail in: Paws::LookoutVision::DescribeDataset

Returns: a Paws::LookoutVision::DescribeDatasetResponse instance

Describe an Amazon Lookout for Vision dataset.

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

DescribeModel

ModelVersion => Str
ProjectName => Str

Each argument is described in detail in: Paws::LookoutVision::DescribeModel

Returns: a Paws::LookoutVision::DescribeModelResponse instance

Describes a version of an Amazon Lookout for Vision model.

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

DescribeProject

ProjectName => Str

Each argument is described in detail in: Paws::LookoutVision::DescribeProject

Returns: a Paws::LookoutVision::DescribeProjectResponse instance

Describes an Amazon Lookout for Vision project.

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

DetectAnomalies

Body => Str
ContentType => Str
ModelVersion => Str
ProjectName => Str

Each argument is described in detail in: Paws::LookoutVision::DetectAnomalies

Returns: a Paws::LookoutVision::DetectAnomaliesResponse instance

Detects anomalies in an image that you supply.

The response from "DetectAnomalies" includes a boolean prediction that the image contains one or more anomalies and a confidence value for the prediction.

Before calling "DetectAnomalies", you must first start your model with the StartModel operation. You are charged for the amount of time, in minutes, that a model runs and for the number of anomaly detection units that your model uses. If you are not using a model, use the StopModel operation to stop your model.

This operation requires permissions to perform the "lookoutvision:DetectAnomalies" operation.

ListDatasetEntries

DatasetType => Str
ProjectName => Str
[AfterCreationDate => Str]
[AnomalyClass => Str]
[BeforeCreationDate => Str]
[Labeled => Bool]
[MaxResults => Int]
[NextToken => Str]
[SourceRefContains => Str]

Each argument is described in detail in: Paws::LookoutVision::ListDatasetEntries

Returns: a Paws::LookoutVision::ListDatasetEntriesResponse instance

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.

ListModels

ProjectName => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::LookoutVision::ListModels

Returns: a Paws::LookoutVision::ListModelsResponse instance

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

This operation requires permissions to perform the "lookoutvision:ListModels" operation.

ListProjects

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::LookoutVision::ListProjects

Returns: a Paws::LookoutVision::ListProjectsResponse instance

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

This operation requires permissions to perform the "lookoutvision:ListProjects" operation.

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::LookoutVision::ListTagsForResource

Returns: a Paws::LookoutVision::ListTagsForResourceResponse instance

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

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

StartModel

MinInferenceUnits => Int
ModelVersion => Str
ProjectName => Str
[ClientToken => Str]

Each argument is described in detail in: Paws::LookoutVision::StartModel

Returns: a Paws::LookoutVision::StartModelResponse instance

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.

StopModel

ModelVersion => Str
ProjectName => Str
[ClientToken => Str]

Each argument is described in detail in: Paws::LookoutVision::StopModel

Returns: a Paws::LookoutVision::StopModelResponse instance

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.

TagResource

ResourceArn => Str
Tags => ArrayRef[Paws::LookoutVision::Tag]

Each argument is described in detail in: Paws::LookoutVision::TagResource

Returns: a Paws::LookoutVision::TagResourceResponse instance

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.

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::LookoutVision::UntagResource

Returns: a Paws::LookoutVision::UntagResourceResponse instance

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.

UpdateDatasetEntries

Changes => Str
DatasetType => Str
ProjectName => Str
[ClientToken => Str]

Each argument is described in detail in: Paws::LookoutVision::UpdateDatasetEntries

Returns: a Paws::LookoutVision::UpdateDatasetEntriesResponse instance

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

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

This operation requires permissions to perform the "lookoutvision:UpdateDatasetEntries" operation.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllDatasetEntries(sub { },DatasetType => Str, ProjectName => Str, [AfterCreationDate => Str, AnomalyClass => Str, BeforeCreationDate => Str, Labeled => Bool, MaxResults => Int, NextToken => Str, SourceRefContains => Str])

ListAllDatasetEntries(DatasetType => Str, ProjectName => Str, [AfterCreationDate => Str, AnomalyClass => Str, BeforeCreationDate => Str, Labeled => Bool, MaxResults => Int, NextToken => Str, SourceRefContains => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - DatasetEntries, passing the object as the first parameter, and the string 'DatasetEntries' as the second parameter

If not, it will return a a Paws::LookoutVision::ListDatasetEntriesResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllModels(sub { },ProjectName => Str, [MaxResults => Int, NextToken => Str])

ListAllModels(ProjectName => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Models, passing the object as the first parameter, and the string 'Models' as the second parameter

If not, it will return a a Paws::LookoutVision::ListModelsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllProjects(sub { },[MaxResults => Int, NextToken => Str])

ListAllProjects([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Projects, passing the object as the first parameter, and the string 'Projects' as the second parameter

If not, it will return a a Paws::LookoutVision::ListProjectsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>