How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon Lookout for Vision Projects API

The Projects API from Amazon Lookout for Vision — 12 operation(s) for projects.

Amazon Lookout for Vision Projects API is one of 2 APIs that Amazon Lookout for Vision publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Project. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, pricing, and a JSON-LD context.

This API exposes 19 operations across 12 paths, and defines 101 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 4 base URLs: http://lookoutvision.{region}.amazonaws.com, https://lookoutvision.{region}.amazonaws.com, http://lookoutvision.{region}.amazonaws.com.cn, https://lookoutvision.{region}.amazonaws.com.cn.

19 operations 12 paths 101 schemas 3 DELETE8 GET1 PATCH7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://lookoutvision.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon Lookout for Vision Projects API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 19

Across 12 paths, the API surfaces 19 operations — 3 DELETE, 8 GET, 1 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Projects 19
POST
/2020-11-20/projects/{projectName}/datasets
Amazon Lookout for Vision Create Dataset
CreateDataset 9 params body → 202480481482483484485486
POST
/2020-11-20/projects/{projectName}/models
Amazon Lookout for Vision Create Model
CreateModel 9 params body → 202480481482483484485486
GET
/2020-11-20/projects/{projectName}/models
Amazon Lookout for Vision List Models
ListModels 12 params → 200480481482483484485
POST
/2020-11-20/projects
Amazon Lookout for Vision Create Project
CreateProject 8 params body → 200480481482483484485486
GET
/2020-11-20/projects
Amazon Lookout for Vision List Projects
ListProjects 11 params → 200480481482483484485
DELETE
/2020-11-20/projects/{projectName}/datasets/{datasetType}
Amazon Lookout for Vision Delete Dataset
DeleteDataset 10 params → 202480481482483484485
GET
/2020-11-20/projects/{projectName}/datasets/{datasetType}
Amazon Lookout for Vision Describe Dataset
DescribeDataset 9 params → 200480481482483484485
DELETE
/2020-11-20/projects/{projectName}/models/{modelVersion}
Amazon Lookout for Vision Delete Model
DeleteModel 10 params → 202480481482483484485
GET
/2020-11-20/projects/{projectName}/models/{modelVersion}
Amazon Lookout for Vision Describe Model
DescribeModel 9 params → 200480481482483484485
DELETE
/2020-11-20/projects/{projectName}
Amazon Lookout for Vision Delete Project
DeleteProject 9 params → 200480481482483484485
GET
/2020-11-20/projects/{projectName}
Amazon Lookout for Vision Describe Project
DescribeProject 8 params → 200480481482483484485
GET
/2020-11-20/projects/{projectName}/modelpackagingjobs/{jobName}
Amazon Lookout for Vision Describe Model Packaging Job
DescribeModelPackagingJob 9 params → 200480481482483484
POST
/2020-11-20/projects/{projectName}/models/{modelVersion}/detect#Content-Type
Amazon Lookout for Vision Detect Anomalies
DetectAnomalies 10 params body → 200480481482483484485
GET
/2020-11-20/projects/{projectName}/datasets/{datasetType}/entries
Amazon Lookout for Vision List Dataset Entries
ListDatasetEntries 18 params → 200480481482483484485
PATCH
/2020-11-20/projects/{projectName}/datasets/{datasetType}/entries
Amazon Lookout for Vision Update Dataset Entries
UpdateDatasetEntries 10 params body → 202480481482483484485
GET
/2020-11-20/projects/{projectName}/modelpackagingjobs
Amazon Lookout for Vision List Model Packaging Jobs
ListModelPackagingJobs 12 params → 200480481482483484
POST
/2020-11-20/projects/{projectName}/modelpackagingjobs
Amazon Lookout for Vision Start Model Packaging Job
StartModelPackagingJob 9 params body → 200480481482483484485486
POST
/2020-11-20/projects/{projectName}/models/{modelVersion}/start
Amazon Lookout for Vision Start Model
StartModel 10 params body → 202480481482483484485486
POST
/2020-11-20/projects/{projectName}/models/{modelVersion}/stop
Amazon Lookout for Vision Stop Model
StopModel 10 params → 202480481482483484485

Schemas 101

The contract defines 101 schemas that model the data the API accepts and returns. The most detailed are ModelDescription (14 properties), ModelPackagingDescription (11 properties), ModelPackagingJobMetadata (9 properties), GreengrassConfiguration (8 properties). Each schema is shown below with its type and property counts.

ModelDescriptionMessage
string
DatasetEntry
string
AnomalyName
string
ModelPackagingMethod
string
AnomalyMask
string
DatasetGroundTruthManifest
object
Location information about a manifest file. You can use a manifest file to create a dataset.
1 property
CreateDatasetResponse
object
1 property
StopModelResponse
object
1 property
TargetPlatformOs
string
ProjectName
string
DescribeModelResponse
object
1 property
ListProjectsResponse
object
2 properties
Anomaly
object
Information about an anomaly type found on an image by an image segmentation model. For more information, see DetectAnomalies .
2 properties
ResourceNotFoundException
ModelPackagingJobDescription
string
DescribeProjectResponse
object
1 property
ModelPackagingDescription
object
Information about a model packaging job. For more information, see DescribeModelPackagingJob .
11 properties
ListDatasetEntriesResponse
object
2 properties
ModelMetadata
object
Describes an Amazon Lookout for Vision model.
7 properties
ComponentName
string
ModelStatus
string
TagValue
string
ComponentVersion
string
DetectAnomalyResult
object
The prediction results from a call to DetectAnomalies . DetectAnomalyResult includes classification information for the prediction ( IsAnomalous and Confidence…
5 properties
InternalServerException
ComponentDescription
string
DatasetMetadataList
array
DeleteProjectResponse
object
1 property
ModelPackagingJobName
string
AnomalyList
array
TagKey
string
S3ObjectVersion
string
OutputConfig
object
The S3 location where Amazon Lookout for Vision saves model training files.
1 property 1 required
StartModelResponse
object
1 property
DetectAnomaliesResponse
object
1 property
ModelPackagingJobStatus
string
ModelPackagingOutputDetails
object
Information about the output from a model packaging job.
1 property
CreateProjectResponse
object
1 property
CompilerOptions
string
Integer
integer
ImageSourceType
string
InputS3Object
object
Amazon S3 Location information for an input manifest file.
3 properties 2 required
Boolean
boolean
TagList
array
DatasetType
string
CreateModelResponse
object
1 property
ProjectMetadataList
array
DatasetEntryList
array
DateTime
string
ProjectArn
string
DeleteModelResponse
object
1 property
TargetDevice
string
S3Location
object
Information about the location of training output or the output of a model packaging job.
2 properties 1 required
ModelVersion
string
ModelStatusMessage
string
DatasetImageStats
object
Statistics about the images in a dataset.
4 properties
ModelArn
string
Tag
object
A key and value pair that is attached to the specified Amazon Lookout for Vision model.
2 properties 2 required
ModelPackagingJobsList
array
ModelPerformance
object
Information about the evaluation performance of a trained model.
3 properties
Color
string
Float
number
ModelHostingStatus
string
UpdateDatasetEntriesResponse
object
1 property
ModelPackagingJobMetadata
object
Metadata for a model packaging job. For more information, see ListModelPackagingJobs .
9 properties
ListModelsResponse
object
2 properties
GreengrassConfiguration
object
Configuration information for the AWS IoT Greengrass component created in a model packaging job. For more information, see StartModelPackagingJob . You can't s…
8 properties 2 required
DatasetStatus
string
S3KeyPrefix
string
ProjectDescription
object
Describe an Amazon Lookout for Vision project. For more information, see DescribeProject .
4 properties
TargetPlatformArch
string
ImageSource
object
The source for an image.
1 property
InferenceUnits
integer
DatasetMetadata
object
Summary information for an Amazon Lookout for Vision dataset. For more information, see DescribeDataset and ProjectDescription .
4 properties
TargetPlatform
object
The platform on which a model runs on an AWS IoT Greengrass core device.
3 properties 2 required
OutputS3Object
object
The S3 location where Amazon Lookout for Vision saves training output.
2 properties 2 required
PixelAnomaly
object
Information about the pixels in an anomaly mask. For more information, see Anomaly . PixelAnomaly is only returned by image segmentation models.
2 properties
ConflictException
ListModelPackagingJobsResponse
object
2 properties
PaginationToken
string
DatasetDescription
object
The description for a dataset. For more information, see DescribeDataset .
7 properties
ThrottlingException
ProjectMetadata
object
Metadata about an Amazon Lookout for Vision project.
3 properties
TargetPlatformAccelerator
string
ServiceQuotaExceededException
ModelMetadataList
array
StartModelPackagingJobResponse
object
1 property
S3ObjectKey
string
ComponentVersionArn
string
ModelPackagingConfiguration
object
Configuration information for a Amazon Lookout for Vision model packaging job. For more information, see StartModelPackagingJob .
1 property 1 required
GreengrassOutputDetails
object
Information about the AWS IoT Greengrass component created by a model packaging job.
3 properties
DescribeModelPackagingJobResponse
object
1 property
ModelDescription
object
Describes an Amazon Lookout for Vision model.
14 properties
DescribeDatasetResponse
object
1 property
KmsKeyId
string
AccessDeniedException
ValidationException
ModelPackagingStatusMessage
string
S3BucketName
string
DatasetStatusMessage
string
DeleteDatasetResponse
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-lookout-for-vision-projects-api-openapi.yml Raw ↑

Other APIs Amazon Lookout for Vision publishes across the network.

Amazon Lookout for Vision Tags API
Where this information came from

This is an independent, third-party profile of Amazon Lookout for Vision Projects API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.