Amazon Lookout for Vision API

The Amazon Lookout for Vision API provides programmatic access to create and manage projects, datasets, models, and anomaly detection jobs for visual quality inspection using computer vision. Supports 22 operations covering the full model lifecycle from dataset management through real-time anomaly detection.

OpenAPI Specification

amazon-lookout-for-vision-openapi-original.yaml Raw ↑
openapi: 3.0.0
info:
  version: 2020-11-20
  x-release: v4
  title: Amazon Lookout for Vision
  description: <p>This is the Amazon Lookout for Vision API Reference. It provides descriptions of actions, data types, common parameters, and common errors.</p> <p>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.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: "#FFFFFF"
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: [email protected]
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: lookoutvision
  x-aws-signingName: lookoutvision
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/lookoutvision-2020-11-20.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/lookoutvision/
servers:
- url: http://lookoutvision.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon Lookout for Vision multi-region endpoint
- url: https://lookoutvision.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon Lookout for Vision multi-region endpoint
- url: http://lookoutvision.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon Lookout for Vision endpoint for China (Beijing) and China (Ningxia)
- url: https://lookoutvision.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon Lookout for Vision endpoint for China (Beijing) and China (Ningxia)
x-hasEquivalentPaths: true
paths:
  "/2020-11-20/projects/{projectName}/datasets":
    post:
      operationId: CreateDataset
      description: <p>Creates a new dataset in an Amazon Lookout for Vision project. <code>CreateDataset</code> can create a training or a test dataset from a valid dataset source 
        (<code>DatasetSource</code>).</p> <p>If you want a single dataset project, specify <code>train</code> for the value of <code>DatasetType</code>.</p> <p>To have a project with separate training
        and test datasets, call <code>CreateDataset</code> twice. On the first call, specify <code>train</code> for the value of <code>DatasetType</code>. On the second call, specify <code>test</code>
        for the value of <code>DatasetType</code>. </p> <p>This operation requires permissions to perform the <code>lookoutvision:CreateDataset</code> operation.</p>
      responses:
        "202":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateDatasetResponse"
        "480":
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AccessDeniedException"
        "481":
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/InternalServerException"
        "482":
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ValidationException"
        "483":
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ConflictException"
        "484":
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResourceNotFoundException"
        "485":
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ThrottlingException"
        "486":
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceQuotaExceededException"
      parameters:
      - name: projectName
        in: path
        required: true
        description: The name of the project in which you want to create a dataset.
        schema:
          type: string
          pattern: "[a-zA-Z0-9][a-zA-Z0-9_\\-]*"
          minLength: 1
          maxLength: 255
      - name: X-Amzn-Client-Token
        in: header
        required: false
        description: <p>ClientToken is an idempotency token that ensures a call to <code>CreateDataset</code> completes only once. You choose the value to pass. For example, An issue might prevent you
          from getting a response from <code>CreateDataset</code>. In this case, safely retry your call to <code>CreateDataset</code> by using the same <code>ClientToken</code> parameter value.</p> 
          <p>If you don't supply a value for <code>ClientToken</code>, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple dataset 
          creation requests. You'll need to provide your own value for other use cases. </p> <p>An error occurs if the other input parameters are not the same as in the first request. Using a 
          different value for <code>ClientToken</code> is considered a new call to <code>CreateDataset</code>. An idempotency token is active for 8 hours. </p>
        schema:
          type: string
          pattern: ^[a-zA-Z0-9-]+$
          minLength: 1
          maxLength: 64
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - DatasetType
              properties:
                DatasetType:
                  description: The type of the dataset. Specify <code>train</code> for a training dataset. Specify <code>test</code> for a test dataset.
                  type: string
                  pattern: train|test
                  minLength: 1
                  maxLength: 10
                DatasetSource:
                  description: Information about the location of a manifest file that Amazon Lookout for Vision uses to to create a dataset.
                  type: object
                  properties:
                    GroundTruthManifest:
                      allOf:
                      - $ref: "#/components/schemas/DatasetGroundTruthManifest"
                      - description: Location information for the manifest file.
      summary: Amazon Lookout for Vision Create Dataset
    parameters:
    - $ref: "#/components/parameters/X-Amz-Content-Sha256"
    - $ref: "#/components/parameters/X-Amz-Date"
    - $ref: "#/components/parameters/X-Amz-Algorithm"
    - $ref: "#/components/parameters/X-Amz-Credential"
    - $ref: "#/components/parameters/X-Amz-Security-Token"
    - $ref: "#/components/parameters/X-Amz-Signature"
    - $ref: "#/components/parameters/X-Amz-SignedHeaders"
  "/2020-11-20/projects/{projectName}/models":
    post:
      operationId: CreateModel
      description: <p>Creates a new version of a model within an an Amazon Lookout for Vision project. <code>CreateModel</code> is an asynchronous operation in which Amazon Lookout for Vision trains, 
        tests, and evaluates a new version of a model. </p> <p>To get the current status, check the <code>Status</code> field returned in the response from <a>DescribeModel</a>.</p> <p>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. </p> <p>After training completes, the evaluation metrics are stored at the location specified in <code>OutputConfig</code>. </p> <p>This 
        operation requires permissions to perform the <code>lookoutvision:CreateModel</code> operation. If you want to tag your model, you also require permission to the 
        <code>lookoutvision:TagResource</code> operation.</p>
      responses:
        "202":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateModelResponse"
        "480":
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AccessDeniedException"
        "481":
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/InternalServerException"
        "482":
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ValidationException"
        "483":
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ConflictException"
        "484":
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResourceNotFoundException"
        "485":
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ThrottlingException"
        "486":
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceQuotaExceededException"
      parameters:
      - name: projectName
        in: path
        required: true
        description: The name of the project in which you want to create a model version.
        schema:
          type: string
          pattern: "[a-zA-Z0-9][a-zA-Z0-9_\\-]*"
          minLength: 1
          maxLength: 255
      - name: X-Amzn-Client-Token
        in: header
        required: false
        description: <p>ClientToken is an idempotency token that ensures a call to <code>CreateModel</code> completes only once. You choose the value to pass. For example, An issue might prevent you 
          from getting a response from <code>CreateModel</code>. In this case, safely retry your call to <code>CreateModel</code> by using the same <code>ClientToken</code> parameter value. </p> <p>If
          you don't supply a value for <code>ClientToken</code>, 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. </p> <p>An error occurs if the other input parameters are not the same as in the first request. Using a different value for 
          <code>ClientToken</code> is considered a new call to <code>CreateModel</code>. An idempotency token is active for 8 hours.</p>
        schema:
          type: string
          pattern: ^[a-zA-Z0-9-]+$
          minLength: 1
          maxLength: 64
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - OutputConfig
              properties:
                Description:
                  description: A description for the version of the model.
                  type: string
                  pattern: "[0-9A-Za-z\\.\\-_]*"
                  minLength: 1
                  maxLength: 500
                OutputConfig:
                  description: The S3 location where Amazon Lookout for Vision saves model training files.
                  type: object
                  properties:
                    S3Location:
                      allOf:
                      - $ref: "#/components/schemas/S3Location"
                      - description: The S3 location for the output.
                KmsKeyId:
                  description: 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.
                  type: string
                  pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$
                  minLength: 1
                  maxLength: 2048
                Tags:
                  description: A set of tags (key-value pairs) that you want to attach to the model.
                  type: array
                  items:
                    $ref: "#/components/schemas/Tag"
                  minItems: 0
                  maxItems: 200
      summary: Amazon Lookout for Vision Create Model
    parameters:
    - $ref: "#/components/parameters/X-Amz-Content-Sha256"
    - $ref: "#/components/parameters/X-Amz-Date"
    - $ref: "#/components/parameters/X-Amz-Algorithm"
    - $ref: "#/components/parameters/X-Amz-Credential"
    - $ref: "#/components/parameters/X-Amz-Security-Token"
    - $ref: "#/components/parameters/X-Amz-Signature"
    - $ref: "#/components/parameters/X-Amz-SignedHeaders"
    get:
      operationId: ListModels
      description: <p>Lists the versions of a model in an Amazon Lookout for Vision project.</p> <p>The <code>ListModels</code> operation is eventually consistent. Recent calls to 
        <code>CreateModel</code> might take a while to appear in the response from <code>ListProjects</code>.</p> <p>This operation requires permissions to perform the 
        <code>lookoutvision:ListModels</code> operation.</p>
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListModelsResponse"
        "480":
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AccessDeniedException"
        "481":
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/InternalServerException"
        "482":
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ValidationException"
        "483":
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ConflictException"
        "484":
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResourceNotFoundException"
        "485":
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ThrottlingException"
      parameters:
      - name: projectName
        in: path
        required: true
        description: The name of the project that contains the model versions that you want to list.
        schema:
          type: string
          pattern: "[a-zA-Z0-9][a-zA-Z0-9_\\-]*"
          minLength: 1
          maxLength: 255
      - name: nextToken
        in: query
        required: false
        description: 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 models.
        schema:
          type: string
          pattern: ^[a-zA-Z0-9\/\+\=]{0,2048}$
          maxLength: 2048
      - name: maxResults
        in: query
        required: false
        description: 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.
        schema:
          type: integer
          minimum: 1
          maximum: 100
      - name: MaxResults
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: NextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      summary: Amazon Lookout for Vision List Models
  /2020-11-20/projects:
    post:
      operationId: CreateProject
      description: <p>Creates an empty Amazon Lookout for Vision project. After you create the project, add a dataset by calling <a>CreateDataset</a>.</p> <p>This operation requires permissions to 
        perform the <code>lookoutvision:CreateProject</code> operation.</p>
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateProjectResponse"
        "480":
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AccessDeniedException"
        "481":
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/InternalServerException"
        "482":
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ValidationException"
        "483":
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ConflictException"
        "484":
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResourceNotFoundException"
        "485":
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ThrottlingException"
        "486":
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceQuotaExceededException"
      parameters:
      - name: X-Amzn-Client-Token
        in: header
        required: false
        description: <p>ClientToken is an idempotency token that ensures a call to <code>CreateProject</code> completes only once. You choose the value to pass. For example, An issue might prevent you
          from getting a response from <code>CreateProject</code>. In this case, safely retry your call to <code>CreateProject</code> by using the same <code>ClientToken</code> parameter value. </p> 
          <p>If you don't supply a value for <code>ClientToken</code>, 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. </p> <p>An error occurs if the other input parameters are not the same as in the first request. Using a 
          different value for <code>ClientToken</code> is considered a new call to <code>CreateProject</code>. An idempotency token is active for 8 hours.</p>
        schema:
          type: string
          pattern: ^[a-zA-Z0-9-]+$
          minLength: 1
          maxLength: 64
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - ProjectName
              properties:
                ProjectName:
                  description: The name for the project.
                  type: string
                  pattern: "[a-zA-Z0-9][a-zA-Z0-9_\\-]*"
                  minLength: 1
                  maxLength: 255
      summary: Amazon Lookout for Vision Create Project
    parameters:
    - $ref: "#/components/parameters/X-Amz-Content-Sha256"
    - $ref: "#/components/parameters/X-Amz-Date"
    - $ref: "#/components/parameters/X-Amz-Algorithm"
    - $ref: "#/components/parameters/X-Amz-Credential"
    - $ref: "#/components/parameters/X-Amz-Security-Token"
    - $ref: "#/components/parameters/X-Amz-Signature"
    - $ref: "#/components/parameters/X-Amz-SignedHeaders"
    get:
      operationId: ListProjects
      description: <p>Lists the Amazon Lookout for Vision projects in your AWS account that are in the AWS Region in which you call <code>ListProjects</code>.</p> <p>The <code>ListProjects</code> 
        operation is eventually consistent. Recent calls to <code>CreateProject</code> and <code>DeleteProject</code> might take a while to appear in the response from <code>ListProjects</code>.</p> 
        <p>This operation requires permissions to perform the <code>lookoutvision:ListProjects</code> operation.</p>
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListProjectsResponse"
        "480":
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AccessDeniedException"
        "481":
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/InternalServerException"
        "482":
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ValidationException"
        "483":
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ConflictException"
        "484":
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResourceNotFoundException"
        "485":
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ThrottlingException"
      parameters:
      - name: nextToken
        in: query
        required: false
        description: 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 projects.
        schema:
          type: string
          pattern: ^[a-zA-Z0-9\/\+\=]{0,2048}$
          maxLength: 2048
      - name: maxResults
        in: query
        required: false
        description: 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.
        schema:
          type: integer
          minimum: 1
          maximum: 100
      - name: MaxResults
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: NextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      summary: Amazon Lookout for Vision List Projects
  "/2020-11-20/projects/{projectName}/datasets/{datasetType}":
    delete:
      operationId: DeleteDataset
      description: <p>Deletes an existing Amazon Lookout for Vision <code>dataset</code>. </p> <p>If your the project has a single dataset, you must create a new dataset before you can create a 
        model.</p> <p>If you project has a training dataset and a test dataset consider the following. </p> <ul> <li> <p>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.</p> </li> <li> <p>If you delete the training dataset, 
        you must create a training dataset before you can create a model.</p> </li> </ul> <p>This operation requires permissions to perform the <code>lookoutvision:DeleteDataset</code> operation.</p>
      responses:
        "202":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DeleteDatasetResponse"
        "480":
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AccessDeniedException"
        "481":
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/InternalServerException"
        "482":
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ValidationException"
        "483":
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ConflictException"
        "484":
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResourceNotFoundException"
        "485":
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ThrottlingException"
      parameters:
      - name: projectName
        in: path
        required: true
        description: The name of the project that contains the dataset that you want to delete.
        schema:
          type: string
          pattern: "[a-zA-Z0-9][a-zA-Z0-9_\\-]*"
          minLength: 1
          maxLength: 255
      - name: datasetType
        in: path
        required: true
        description: The type of the dataset to delete. Specify <code>train</code> to delete the training dataset. Specify <code>test</code> to delete the test dataset. To delete the dataset in a 
          single dataset project, specify <code>train</code>.
        schema:
          type: string
          pattern: train|test
          minLength: 1
          maxLength: 10
      - name: X-Amzn-Client-Token
        in: header
        required: false
        description: <p>ClientToken is an idempotency token that ensures a call to <code>DeleteDataset</code> completes only once. You choose the value to pass. For example, An issue might prevent you
          from getting a response from <code>DeleteDataset</code>. In this case, safely retry your call to <code>DeleteDataset</code> by using the same <code>ClientToken</code> parameter value. </p> 
          <p>If you don't supply a value for <code>ClientToken</code>, 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. </p> <p>An error occurs if the other input parameters are not the same as in the first request. Using a different value 
          for <code>ClientToken</code> is considered a new call to <code>DeleteDataset</code>. An idempotency token is active for 8 hours.</p>
        schema:
          type: string
          pattern: ^[a-zA-Z0-9-]+$
          minLength: 1
          maxLength: 64
      summary: Amazon Lookout for Vision Delete Dataset
    parameters:
    - $ref: "#/components/parameters/X-Amz-Content-Sha256"
    - $ref: "#/components/parameters/X-Amz-Date"
    - $ref: "#/components/parameters/X-Amz-Algorithm"
    - $ref: "#/components/parameters/X-Amz-Credential"
    - $ref: "#/components/parameters/X-Amz-Security-Token"
    - $ref: "#/components/parameters/X-Amz-Signature"
    - $ref: "#/components/parameters/X-Amz-SignedHeaders"
    get:
      operationId: DescribeDataset
      description: <p>Describe an Amazon Lookout for Vision dataset.</p> <p>This operation requires permissions to perform the <code>lookoutvision:DescribeDataset</code> operation.</p>
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DescribeDatasetResponse"
        "480":
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AccessDeniedException"
        "481":
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/InternalServerException"
        "482":
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ValidationException"
        "483":
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ConflictException"
        "484":
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResourceNotFoundException"
        "485":
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ThrottlingException"
      parameters:
      - name: projectName
        in: path
        required: true
        description: The name of the project that contains the dataset that you want to describe.
        schema:
          type: string
          pattern: "[a-zA-Z0-9][a-zA-Z0-9_\\-]*"
          minLength: 1
          maxLength: 255
      - name: datasetType
        in: path
        required: true
        description: "The type of the dataset to describe. Specify <code>train</code> to describe the training dataset. Specify <code>test</code> to describe the test dataset. If you have a single dataset
          project, specify <code>train</code> "
        schema:
          type: string
          pattern: train|test
          minLen

# --- truncated at 32 KB (134 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-lookout-for-vision/refs/heads/main/openapi/amazon-lookout-for-vision-openapi-original.yaml