AWS SDK for PHP 3.x (original) (raw)

You are not authorized to perform the action.

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

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

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

The resource could not be found.

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

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

CreateModel

result=result = result=client->createModel([/* ... /]); promise=promise = promise=client->createModelAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->createModel([ 'ClientToken' => '', 'Description' => '', 'KmsKeyId' => '', 'OutputConfig' => [ // REQUIRED 'S3Location' => [ // REQUIRED 'Bucket' => '', // REQUIRED 'Prefix' => '', ], ], 'ProjectName' => '', // REQUIRED 'Tags' => [ [ 'Key' => '', // REQUIRED 'Value' => '', // REQUIRED ], // ... ], ]);

Parameter Details

Members

ClientToken

ClientToken is an idempotency token that ensures a call to CreateModel completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from CreateModel. In this case, safely retry your call to CreateModel by using the same ClientToken parameter value.

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from starting multiple training jobs. You'll need to provide your own value for other use cases.

An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to CreateModel. An idempotency token is active for 8 hours.

Description

A description for the version of the model.

KmsKeyId

The identifier for your AWS KMS key. The key is used to encrypt training and test images copied into the service for model training. Your source images are unaffected. If this parameter is not specified, the copied images are encrypted by a key that AWS owns and manages.

OutputConfig

Required: Yes

Type: OutputConfig structure

The location where Amazon Lookout for Vision saves the training results.

ProjectName

Required: Yes

Type: string

The name of the project in which you want to create a model version.

Tags

Type: Array of Tag structures

A set of tags (key-value pairs) that you want to attach to the model.

Result Syntax

Result Details

Members

ModelMetadata

Type: ModelMetadata structure

The response from a call to CreateModel.

Errors

You are not authorized to perform the action.

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

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

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

The resource could not be found.

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

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

CreateProject

result=result = result=client->createProject([/* ... /]); promise=promise = promise=client->createProjectAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->createProject([ 'ClientToken' => '', 'ProjectName' => '', // REQUIRED ]);

Parameter Details

Members

ClientToken

ClientToken is an idempotency token that ensures a call to CreateProject completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from CreateProject. In this case, safely retry your call to CreateProject by using the same ClientToken parameter value.

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple project creation requests. You'll need to provide your own value for other use cases.

An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to CreateProject. An idempotency token is active for 8 hours.

ProjectName

Required: Yes

Type: string

The name for the project.

Result Syntax

[ 'ProjectMetadata' => [ 'CreationTimestamp' => , 'ProjectArn' => '', 'ProjectName' => '', ], ]

Result Details

Members

ProjectMetadata

Type: ProjectMetadata structure

Information about the project.

Errors

You are not authorized to perform the action.

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

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

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

The resource could not be found.

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

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

DeleteDataset

result=result = result=client->deleteDataset([/* ... /]); promise=promise = promise=client->deleteDatasetAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->deleteDataset([ 'ClientToken' => '', 'DatasetType' => '', // REQUIRED 'ProjectName' => '', // REQUIRED ]);

Parameter Details

Members

ClientToken

ClientToken is an idempotency token that ensures a call to DeleteDataset completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from DeleteDataset. In this case, safely retry your call to DeleteDataset by using the same ClientToken parameter value.

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple deletetion requests. You'll need to provide your own value for other use cases.

An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to DeleteDataset. An idempotency token is active for 8 hours.

DatasetType

Required: Yes

Type: string

The type of the dataset to delete. Specify train to delete the training dataset. Specify test to delete the test dataset. To delete the dataset in a single dataset project, specify train.

ProjectName

Required: Yes

Type: string

The name of the project that contains the dataset that you want to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

You are not authorized to perform the action.

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

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

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

The resource could not be found.

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

DeleteModel

result=result = result=client->deleteModel([/* ... /]); promise=promise = promise=client->deleteModelAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->deleteModel([ 'ClientToken' => '', 'ModelVersion' => '', // REQUIRED 'ProjectName' => '', // REQUIRED ]);

Parameter Details

Members

ClientToken

ClientToken is an idempotency token that ensures a call to DeleteModel completes only once. You choose the value to pass. For example, an issue might prevent you from getting a response from DeleteModel. In this case, safely retry your call to DeleteModel by using the same ClientToken parameter value.

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple model deletion requests. You'll need to provide your own value for other use cases.

An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to DeleteModel. An idempotency token is active for 8 hours.

ModelVersion

Required: Yes

Type: string

The version of the model that you want to delete.

ProjectName

Required: Yes

Type: string

The name of the project that contains the model that you want to delete.

Result Syntax

[ 'ModelArn' => '', ]

Result Details

Members

ModelArn

The Amazon Resource Name (ARN) of the model that was deleted.

Errors

You are not authorized to perform the action.

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

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

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

The resource could not be found.

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

DeleteProject

result=result = result=client->deleteProject([/* ... /]); promise=promise = promise=client->deleteProjectAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->deleteProject([ 'ClientToken' => '', 'ProjectName' => '', // REQUIRED ]);

Parameter Details

Members

ClientToken

ClientToken is an idempotency token that ensures a call to DeleteProject completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from DeleteProject. In this case, safely retry your call to DeleteProject by using the same ClientToken parameter value.

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple project deletion requests. You'll need to provide your own value for other use cases.

An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to DeleteProject. An idempotency token is active for 8 hours.

ProjectName

Required: Yes

Type: string

The name of the project to delete.

Result Syntax

[ 'ProjectArn' => '', ]

Result Details

Members

ProjectArn

The Amazon Resource Name (ARN) of the project that was deleted.

Errors

You are not authorized to perform the action.

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

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

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

The resource could not be found.

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

DescribeDataset

result=result = result=client->describeDataset([/* ... /]); promise=promise = promise=client->describeDatasetAsync([/ ... */]);

Describe an Amazon Lookout for Vision dataset.

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

Parameter Syntax

result=result = result=client->describeDataset([ 'DatasetType' => '', // REQUIRED 'ProjectName' => '', // REQUIRED ]);

Parameter Details

Members

DatasetType

Required: Yes

Type: string

The type of the dataset to describe. Specify train to describe the training dataset. Specify test to describe the test dataset. If you have a single dataset project, specify train

ProjectName

Required: Yes

Type: string

The name of the project that contains the dataset that you want to describe.

Result Syntax

[ 'DatasetDescription' => [ 'CreationTimestamp' => , 'DatasetType' => '', 'ImageStats' => [ 'Anomaly' => , 'Labeled' => , 'Normal' => , 'Total' => , ], 'LastUpdatedTimestamp' => , 'ProjectName' => '', 'Status' => 'CREATE_IN_PROGRESS|CREATE_COMPLETE|CREATE_FAILED|UPDATE_IN_PROGRESS|UPDATE_COMPLETE|UPDATE_FAILED_ROLLBACK_IN_PROGRESS|UPDATE_FAILED_ROLLBACK_COMPLETE|DELETE_IN_PROGRESS|DELETE_COMPLETE|DELETE_FAILED', 'StatusMessage' => '', ], ]

Result Details

Members

DatasetDescription

Type: DatasetDescription structure

The description of the requested dataset.

Errors

You are not authorized to perform the action.

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

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

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

The resource could not be found.

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

DescribeModel

result=result = result=client->describeModel([/* ... /]); promise=promise = promise=client->describeModelAsync([/ ... */]);

Describes a version of an Amazon Lookout for Vision model.

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

Parameter Syntax

result=result = result=client->describeModel([ 'ModelVersion' => '', // REQUIRED 'ProjectName' => '', // REQUIRED ]);

Parameter Details

Members

ModelVersion

Required: Yes

Type: string

The version of the model that you want to describe.

ProjectName

Required: Yes

Type: string

The project that contains the version of a model that you want to describe.

Result Syntax

[ 'ModelDescription' => [ 'CreationTimestamp' => , 'Description' => '', 'EvaluationEndTimestamp' => , 'EvaluationManifest' => [ 'Bucket' => '', 'Key' => '', ], 'EvaluationResult' => [ 'Bucket' => '', 'Key' => '', ], 'KmsKeyId' => '', 'MaxInferenceUnits' => , 'MinInferenceUnits' => , 'ModelArn' => '', 'ModelVersion' => '', 'OutputConfig' => [ 'S3Location' => [ 'Bucket' => '', 'Prefix' => '', ], ], 'Performance' => [ 'F1Score' => , 'Precision' => , 'Recall' => , ], 'Status' => 'TRAINING|TRAINED|TRAINING_FAILED|STARTING_HOSTING|HOSTED|HOSTING_FAILED|STOPPING_HOSTING|SYSTEM_UPDATING|DELETING', 'StatusMessage' => '', ], ]

Result Details

Members

ModelDescription

Type: ModelDescription structure

Contains the description of the model.

Errors

You are not authorized to perform the action.

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

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

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

The resource could not be found.

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

DescribeModelPackagingJob

result=result = result=client->describeModelPackagingJob([/* ... /]); promise=promise = promise=client->describeModelPackagingJobAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->describeModelPackagingJob([ 'JobName' => '', // REQUIRED 'ProjectName' => '', // REQUIRED ]);

Parameter Details

Members

JobName

Required: Yes

Type: string

The job name for the model packaging job.

ProjectName

Required: Yes

Type: string

The name of the project that contains the model packaging job that you want to describe.

Result Syntax

[ 'ModelPackagingDescription' => [ 'CreationTimestamp' => , 'JobName' => '', 'LastUpdatedTimestamp' => , 'ModelPackagingConfiguration' => [ 'Greengrass' => [ 'CompilerOptions' => '', 'ComponentDescription' => '', 'ComponentName' => '', 'ComponentVersion' => '', 'S3OutputLocation' => [ 'Bucket' => '', 'Prefix' => '', ], 'Tags' => [ [ 'Key' => '', 'Value' => '', ], // ... ], 'TargetDevice' => 'jetson_xavier', 'TargetPlatform' => [ 'Accelerator' => 'NVIDIA', 'Arch' => 'ARM64|X86_64', 'Os' => 'LINUX', ], ], ], 'ModelPackagingJobDescription' => '', 'ModelPackagingMethod' => '', 'ModelPackagingOutputDetails' => [ 'Greengrass' => [ 'ComponentName' => '', 'ComponentVersion' => '', 'ComponentVersionArn' => '', ], ], 'ModelVersion' => '', 'ProjectName' => '', 'Status' => 'CREATED|RUNNING|SUCCEEDED|FAILED', 'StatusMessage' => '', ], ]

Result Details

Members

ModelPackagingDescription

Type: ModelPackagingDescription structure

The description of the model packaging job.

Errors

You are not authorized to perform the action.

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

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

The resource could not be found.

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

DescribeProject

result=result = result=client->describeProject([/* ... /]); promise=promise = promise=client->describeProjectAsync([/ ... */]);

Describes an Amazon Lookout for Vision project.

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

Parameter Syntax

result=result = result=client->describeProject([ 'ProjectName' => '', // REQUIRED ]);

Parameter Details

Members

ProjectName

Required: Yes

Type: string

The name of the project that you want to describe.

Result Syntax

Result Details

Members

ProjectDescription

Type: ProjectDescription structure

The description of the project.

Errors

You are not authorized to perform the action.

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

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

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

The resource could not be found.

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

DetectAnomalies

result=result = result=client->detectAnomalies([/* ... /]); promise=promise = promise=client->detectAnomaliesAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->detectAnomalies([ 'Body' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED 'ContentType' => '', // REQUIRED 'ModelVersion' => '', // REQUIRED 'ProjectName' => '', // REQUIRED ]);

Parameter Details

Members

Body

Required: Yes

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The unencrypted image bytes that you want to analyze.

ContentType

Required: Yes

Type: string

The type of the image passed in Body. Valid values are image/png (PNG format images) and image/jpeg (JPG format images).

ModelVersion

Required: Yes

Type: string

The version of the model that you want to use.

ProjectName

Required: Yes

Type: string

The name of the project that contains the model version that you want to use.

Result Syntax

[ 'DetectAnomalyResult' => [ 'Anomalies' => [ [ 'Name' => '', 'PixelAnomaly' => [ 'Color' => '', 'TotalPercentageArea' => , ], ], // ... ], 'AnomalyMask' => <string || resource || Psr\Http\Message\StreamInterface>, 'Confidence' => , 'IsAnomalous' => true || false, 'Source' => [ 'Type' => '', ], ], ]

Result Details

Members

DetectAnomalyResult

Type: DetectAnomalyResult structure

The results of the DetectAnomalies operation.

Errors

You are not authorized to perform the action.

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

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

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

The resource could not be found.

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

ListDatasetEntries

result=result = result=client->listDatasetEntries([/* ... /]); promise=promise = promise=client->listDatasetEntriesAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->listDatasetEntries([ 'AfterCreationDate' => <integer || string || DateTime>, 'AnomalyClass' => '', 'BeforeCreationDate' => <integer || string || DateTime>, 'DatasetType' => '', // REQUIRED 'Labeled' => true || false, 'MaxResults' => , 'NextToken' => '', 'ProjectName' => '', // REQUIRED 'SourceRefContains' => '', ]);

Parameter Details

Members

AfterCreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

Only includes entries after the specified date in the response. For example, 2020-06-23T00:00:00.

AnomalyClass

Specify normal to include only normal images. Specify anomaly to only include anomalous entries. If you don't specify a value, Amazon Lookout for Vision returns normal and anomalous images.

BeforeCreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

Only includes entries before the specified date in the response. For example, 2020-06-23T00:00:00.

DatasetType

Required: Yes

Type: string

The type of the dataset that you want to list. Specify train to list the training dataset. Specify test to list the test dataset. If you have a single dataset project, specify train.

Labeled

Specify true to include labeled entries, otherwise specify false. If you don't specify a value, Lookout for Vision returns all entries.

MaxResults

The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

NextToken

If the previous response was incomplete (because there is more data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of dataset entries.

ProjectName

Required: Yes

Type: string

The name of the project that contains the dataset that you want to list.

SourceRefContains

Perform a "contains" search on the values of the source-ref key within the dataset. For example a value of "IMG_17" returns all JSON Lines where the source-ref key value matches *IMG_17*.

Result Syntax

[ 'DatasetEntries' => ['', ...], 'NextToken' => '', ]

Result Details

Members

DatasetEntries

A list of the entries (JSON Lines) within the dataset.

NextToken

If the response is truncated, Amazon Lookout for Vision returns this token that you can use in the subsequent request to retrieve the next set ofdataset entries.

Errors

You are not authorized to perform the action.

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

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

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

The resource could not be found.

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

ListModelPackagingJobs

result=result = result=client->listModelPackagingJobs([/* ... /]); promise=promise = promise=client->listModelPackagingJobsAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->listModelPackagingJobs([ 'MaxResults' => , 'NextToken' => '', 'ProjectName' => '', // REQUIRED ]);

Parameter Details

Members

MaxResults

NextToken

If the previous response was incomplete (because there is more results to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

ProjectName

Required: Yes

Type: string

The name of the project for which you want to list the model packaging jobs.

Result Syntax

[ 'ModelPackagingJobs' => [ [ 'CreationTimestamp' => , 'JobName' => '', 'LastUpdatedTimestamp' => , 'ModelPackagingJobDescription' => '', 'ModelPackagingMethod' => '', 'ModelVersion' => '', 'ProjectName' => '', 'Status' => 'CREATED|RUNNING|SUCCEEDED|FAILED', 'StatusMessage' => '', ], // ... ], 'NextToken' => '', ]

Result Details

Members

ModelPackagingJobs

Type: Array of ModelPackagingJobMetadata structures

A list of the model packaging jobs created for the specified Amazon Lookout for Vision project.

NextToken

Errors

You are not authorized to perform the action.

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

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

The resource could not be found.

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

ListModels

result=result = result=client->listModels([/* ... /]); promise=promise = promise=client->listModelsAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->listModels([ 'MaxResults' => , 'NextToken' => '', 'ProjectName' => '', // REQUIRED ]);

Parameter Details

Members

MaxResults

NextToken

ProjectName

Required: Yes

Type: string

The name of the project that contains the model versions that you want to list.

Result Syntax

Result Details

Members

Models

Type: Array of ModelMetadata structures

A list of model versions in the specified project.

NextToken

If the response is truncated, Amazon Lookout for Vision returns this token that you can use in the subsequent request to retrieve the next set of models.

Errors

You are not authorized to perform the action.

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

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

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

The resource could not be found.

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

ListProjects

result=result = result=client->listProjects([/* ... /]); promise=promise = promise=client->listProjectsAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->listProjects([ 'MaxResults' => , 'NextToken' => '', ]);

Parameter Details

Members

MaxResults

NextToken

Result Syntax

[ 'NextToken' => '', 'Projects' => [ [ 'CreationTimestamp' => , 'ProjectArn' => '', 'ProjectName' => '', ], // ... ], ]

Result Details

Members

NextToken

If the response is truncated, Amazon Lookout for Vision returns this token that you can use in the subsequent request to retrieve the next set of projects.

Projects

Type: Array of ProjectMetadata structures

A list of projects in your AWS account.

Errors

You are not authorized to perform the action.

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

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

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

The resource could not be found.

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

ListTagsForResource

result=result = result=client->listTagsForResource([/* ... /]); promise=promise = promise=client->listTagsForResourceAsync([/ ... */]);

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

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

Parameter Syntax

result=result = result=client->listTagsForResource([ 'ResourceArn' => '', // REQUIRED ]);

Parameter Details

Members

ResourceArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the model for which you want to list tags.

Result Syntax

[ 'Tags' => [ [ 'Key' => '', 'Value' => '', ], // ... ], ]

Result Details

Members

Tags

Type: Array of Tag structures

A map of tag keys and values attached to the specified model.

Errors

You are not authorized to perform the action.

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

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

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

The resource could not be found.

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

StartModel

result=result = result=client->startModel([/* ... /]); promise=promise = promise=client->startModelAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->startModel([ 'ClientToken' => '', 'MaxInferenceUnits' => , 'MinInferenceUnits' => , // REQUIRED 'ModelVersion' => '', // REQUIRED 'ProjectName' => '', // REQUIRED ]);

Parameter Details

Members

ClientToken

ClientToken is an idempotency token that ensures a call to StartModel completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from StartModel. In this case, safely retry your call to StartModel by using the same ClientToken parameter value.

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple start requests. You'll need to provide your own value for other use cases.

An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to StartModel. An idempotency token is active for 8 hours.

MaxInferenceUnits

The maximum number of inference units to use for auto-scaling the model. If you don't specify a value, Amazon Lookout for Vision doesn't auto-scale the model.

MinInferenceUnits

The minimum number of inference units to use. A single inference unit represents 1 hour of processing. Use a higher number to increase the TPS throughput of your model. You are charged for the number of inference units that you use.

ModelVersion

Required: Yes

Type: string

The version of the model that you want to start.

ProjectName

Required: Yes

Type: string

The name of the project that contains the model that you want to start.

Result Syntax

[ 'Status' => 'STARTING_HOSTING|HOSTED|HOSTING_FAILED|STOPPING_HOSTING|SYSTEM_UPDATING', ]

Result Details

Members

Status

The current running status of the model.

Errors

You are not authorized to perform the action.

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

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

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

The resource could not be found.

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

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

StartModelPackagingJob

result=result = result=client->startModelPackagingJob([/* ... /]); promise=promise = promise=client->startModelPackagingJobAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->startModelPackagingJob([ 'ClientToken' => '', 'Configuration' => [ // REQUIRED 'Greengrass' => [ // REQUIRED 'CompilerOptions' => '', 'ComponentDescription' => '', 'ComponentName' => '', // REQUIRED 'ComponentVersion' => '', 'S3OutputLocation' => [ // REQUIRED 'Bucket' => '', // REQUIRED 'Prefix' => '', ], 'Tags' => [ [ 'Key' => '', // REQUIRED 'Value' => '', // REQUIRED ], // ... ], 'TargetDevice' => 'jetson_xavier', 'TargetPlatform' => [ 'Accelerator' => 'NVIDIA', 'Arch' => 'ARM64|X86_64', // REQUIRED 'Os' => 'LINUX', // REQUIRED ], ], ], 'Description' => '', 'JobName' => '', 'ModelVersion' => '', // REQUIRED 'ProjectName' => '', // REQUIRED ]);

Parameter Details

Members

ClientToken

ClientToken is an idempotency token that ensures a call to StartModelPackagingJob completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from StartModelPackagingJob. In this case, safely retry your call to StartModelPackagingJob by using the same ClientToken parameter value.

An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to StartModelPackagingJob. An idempotency token is active for 8 hours.

Configuration

Required: Yes

Type: ModelPackagingConfiguration structure

The configuration for the model packaging job.

Description

A description for the model packaging job.

JobName

A name for the model packaging job. If you don't supply a value, the service creates a job name for you.

ModelVersion

Required: Yes

Type: string

The version of the model within the project that you want to package.

ProjectName

Required: Yes

Type: string

The name of the project which contains the version of the model that you want to package.

Result Syntax

[ 'JobName' => '', ]

Result Details

Members

JobName

The job name for the model packaging job. If you don't supply a job name in the JobName input parameter, the service creates a job name for you.

Errors

You are not authorized to perform the action.

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

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

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

The resource could not be found.

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

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

StopModel

result=result = result=client->stopModel([/* ... /]); promise=promise = promise=client->stopModelAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->stopModel([ 'ClientToken' => '', 'ModelVersion' => '', // REQUIRED 'ProjectName' => '', // REQUIRED ]);

Parameter Details

Members

ClientToken

ClientToken is an idempotency token that ensures a call to StopModel completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from StopModel. In this case, safely retry your call to StopModel by using the same ClientToken parameter value.

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple stop requests. You'll need to provide your own value for other use cases.

An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to StopModel. An idempotency token is active for 8 hours.

ModelVersion

Required: Yes

Type: string

The version of the model that you want to stop.

ProjectName

Required: Yes

Type: string

The name of the project that contains the model that you want to stop.

Result Syntax

[ 'Status' => 'STARTING_HOSTING|HOSTED|HOSTING_FAILED|STOPPING_HOSTING|SYSTEM_UPDATING', ]

Result Details

Members

Status

The status of the model.

Errors

You are not authorized to perform the action.

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

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

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

The resource could not be found.

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

TagResource

result=result = result=client->tagResource([/* ... /]); promise=promise = promise=client->tagResourceAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->tagResource([ 'ResourceArn' => '', // REQUIRED 'Tags' => [ // REQUIRED [ 'Key' => '', // REQUIRED 'Value' => '', // REQUIRED ], // ... ], ]);

Parameter Details

Members

ResourceArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the model to assign the tags.

Tags

Required: Yes

Type: Array of Tag structures

The key-value tags to assign to the model.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

You are not authorized to perform the action.

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

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

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

The resource could not be found.

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

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

UntagResource

result=result = result=client->untagResource([/* ... /]); promise=promise = promise=client->untagResourceAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->untagResource([ 'ResourceArn' => '', // REQUIRED 'TagKeys' => ['', ...], // REQUIRED ]);

Parameter Details

Members

ResourceArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the model from which you want to remove tags.

TagKeys

Required: Yes

Type: Array of strings

A list of the keys of the tags that you want to remove.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

You are not authorized to perform the action.

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

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

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

The resource could not be found.

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

UpdateDatasetEntries

result=result = result=client->updateDatasetEntries([/* ... /]); promise=promise = promise=client->updateDatasetEntriesAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->updateDatasetEntries([ 'Changes' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED 'ClientToken' => '', 'DatasetType' => '', // REQUIRED 'ProjectName' => '', // REQUIRED ]);

Parameter Details

Members

Changes

Required: Yes

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The entries to add to the dataset.

ClientToken

ClientToken is an idempotency token that ensures a call to UpdateDatasetEntries completes only once. You choose the value to pass. For example, An issue might prevent you from getting a response from UpdateDatasetEntries. In this case, safely retry your call to UpdateDatasetEntries by using the same ClientToken parameter value.

If you don't supply a value for ClientToken, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple updates with the same dataset entries. You'll need to provide your own value for other use cases.

An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to UpdateDatasetEntries. An idempotency token is active for 8 hours.

DatasetType

Required: Yes

Type: string

The type of the dataset that you want to update. Specify train to update the training dataset. Specify test to update the test dataset. If you have a single dataset project, specify train.

ProjectName

Required: Yes

Type: string

The name of the project that contains the dataset that you want to update.

Result Syntax

Result Details

Members

Status

The status of the dataset update.

Errors

You are not authorized to perform the action.

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

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

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

The resource could not be found.