Amazon Lookout for Equipment Lookout For Equipment Model Version API

openapi: 3.2.0
info:
  title: Amazon Lookout for Equipment Model Version API
  version: '2020-12-15'
  description: Generated from AWS's published Smithy model for Amazon Lookout for Equipment. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://lookoutequipment.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Model Version
paths:
  /#DescribeModelVersion:
    post:
      operationId: DescribeModelVersion
      summary: Describe Model Version
      description: Retrieves information about a specific machine learning model version.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DescribeModelVersionResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSLookoutEquipmentFrontendService.DescribeModelVersion
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DescribeModelVersionRequest'
      tags:
      - Model Version
  /#ImportModelVersion:
    post:
      operationId: ImportModelVersion
      summary: Import Model Version
      description: Imports a model that has been trained successfully.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ImportModelVersionResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSLookoutEquipmentFrontendService.ImportModelVersion
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ImportModelVersionRequest'
      tags:
      - Model Version
  /#ListModelVersions:
    post:
      operationId: ListModelVersions
      summary: List Model Versions
      description: Generates a list of all model versions for a given model, including the model version, model version ARN, and status. To list a subset of versions, use the MaxModelVersion and MinModelVersion fields.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListModelVersionsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSLookoutEquipmentFrontendService.ListModelVersions
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListModelVersionsRequest'
      tags:
      - Model Version
components:
  schemas:
    LabelsInputConfiguration:
      type: object
      properties:
        S3InputConfiguration:
          $ref: '#/components/schemas/LabelsS3InputConfiguration'
        LabelGroupName:
          type: string
          description: The name of the label group to be used for label data.
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    DataPreProcessingConfiguration:
      type: object
      properties:
        TargetSamplingRate:
          type: string
          enum:
          - PT1S
          - PT5S
          - PT10S
          - PT15S
          - PT30S
          - PT1M
          - PT5M
          - PT10M
          - PT15M
          - PT30M
          - PT1H
          description: The sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the TargetSamplingRate is 1 minute. When providing a value for the TargetSamplingRate, you must attach the prefix "PT" to the rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and the value for a 1 hour rate is PT1H
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ListModelVersionsResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: If the total number of results exceeds the limit that the response can display, the response returns an opaque pagination token indicating where to continue the listing of machine learning model versions. Use this token in the NextToken field in the request to list the next page of results.
        ModelVersionSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ModelVersionSummary'
          description: Provides information on the specified model version, including the created time, model and dataset ARNs, and status. If you don't supply the ModelName request parameter, or if you supply the name of a model that doesn't exist, ListModelVersions returns an empty array in ModelVersionSummaries.
    ConflictException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ValidationException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ImportModelVersionResponse:
      type: object
      properties:
        ModelName:
          type: string
          description: The name for the machine learning model.
        ModelArn:
          type: string
          description: The Amazon Resource Name (ARN) of the model being created.
        ModelVersionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the model version being created.
        ModelVersion:
          type: integer
          description: The version of the model being created.
        Status:
          type: string
          enum:
          - IN_PROGRESS
          - SUCCESS
          - FAILED
          - IMPORT_IN_PROGRESS
          - CANCELED
          description: The status of the ImportModelVersion operation.
    DescribeModelVersionResponse:
      type: object
      properties:
        ModelName:
          type: string
          description: The name of the machine learning model that this version belongs to.
        ModelArn:
          type: string
          description: The Amazon Resource Name (ARN) of the parent machine learning model that this version belong to.
        ModelVersion:
          type: integer
          description: The version of the machine learning model.
        ModelVersionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the model version.
        Status:
          type: string
          enum:
          - IN_PROGRESS
          - SUCCESS
          - FAILED
          - IMPORT_IN_PROGRESS
          - CANCELED
          description: The current status of the model version.
        SourceType:
          type: string
          enum:
          - TRAINING
          - RETRAINING
          - IMPORT
          description: Indicates whether this model version was created by training or by importing.
        DatasetName:
          type: string
          description: The name of the dataset used to train the model version.
        DatasetArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset used to train the model version.
        Schema:
          type: string
          description: The schema of the data used to train the model version.
        LabelsInputConfiguration:
          $ref: '#/components/schemas/LabelsInputConfiguration'
        TrainingDataStartTime:
          type: string
          format: date-time
          description: The date on which the training data began being gathered. If you imported the version, this is the date that the training data in the source version began being gathered.
        TrainingDataEndTime:
          type: string
          format: date-time
          description: The date on which the training data finished being gathered. If you imported the version, this is the date that the training data in the source version finished being gathered.
        EvaluationDataStartTime:
          type: string
          format: date-time
          description: The date on which the data in the evaluation set began being gathered. If you imported the version, this is the date that the evaluation set data in the source version began being gathered.
        EvaluationDataEndTime:
          type: string
          format: date-time
          description: The date on which the data in the evaluation set began being gathered. If you imported the version, this is the date that the evaluation set data in the source version finished being gathered.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the role that was used to train the model version.
        DataPreProcessingConfiguration:
          $ref: '#/components/schemas/DataPreProcessingConfiguration'
        TrainingExecutionStartTime:
          type: string
          format: date-time
          description: The time when the training of the version began.
        TrainingExecutionEndTime:
          type: string
          format: date-time
          description: The time when the training of the version completed.
        FailedReason:
          type: string
          description: The failure message if the training of the model version failed.
        ModelMetrics:
          type: string
          description: Shows an aggregated summary, in JSON format, of the model's performance within the evaluation time range. These metrics are created when evaluating the model.
        LastUpdatedTime:
          type: string
          format: date-time
          description: Indicates the last time the machine learning model version was updated.
        CreatedAt:
          type: string
          format: date-time
          description: Indicates the time and date at which the machine learning model version was created.
        ServerSideKmsKeyId:
          type: string
          description: The identifier of the KMS key key used to encrypt model version data by Amazon Lookout for Equipment.
        OffCondition:
          type: string
          description: Indicates that the asset associated with this sensor has been shut off. As long as this condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or inference.
        SourceModelVersionArn:
          type: string
          description: If model version was imported, then this field is the arn of the source model version.
        ImportJobStartTime:
          type: string
          format: date-time
          description: The date and time when the import job began. This field appears if the model version was imported.
        ImportJobEndTime:
          type: string
          format: date-time
          description: The date and time when the import job completed. This field appears if the model version was imported.
        ImportedDataSizeInBytes:
          type: integer
          description: The size in bytes of the imported data. This field appears if the model version was imported.
        PriorModelMetrics:
          type: string
          description: If the model version was retrained, this field shows a summary of the performance of the prior model on the new training range. You can use the information in this JSON-formatted object to compare the new model version and the prior model version.
        RetrainingAvailableDataInDays:
          type: integer
          description: Indicates the number of days of data used in the most recent scheduled retraining run.
        AutoPromotionResult:
          type: string
          enum:
          - MODEL_PROMOTED
          - MODEL_NOT_PROMOTED
          - RETRAINING_INTERNAL_ERROR
          - RETRAINING_CUSTOMER_ERROR
          - RETRAINING_CANCELLED
          description: Indicates whether the model version was promoted to be the active version after retraining or if there was an error with or cancellation of the retraining.
        AutoPromotionResultReason:
          type: string
          description: Indicates the reason for the AutoPromotionResult. For example, a model might not be promoted if its performance was worse than the active version, if there was an error during training, or if the retraining scheduler was using MANUAL promote mode. The model will be promoted in MANAGED promote mode if the performance is better than the previous model.
        ModelDiagnosticsOutputConfiguration:
          $ref: '#/components/schemas/ModelDiagnosticsOutputConfiguration'
        ModelDiagnosticsResultsObject:
          $ref: '#/components/schemas/S3Object'
        ModelQuality:
          type: string
          enum:
          - QUALITY_THRESHOLD_MET
          - CANNOT_DETERMINE_QUALITY
          - POOR_QUALITY_DETECTED
          description: Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the model quality is poor based on training metrics, the value is POOR_QUALITY_DETECTED. Otherwise, the value is QUALITY_THRESHOLD_MET. If the model is unlabeled, the model quality can't be assessed and the value of ModelQuality is CANNOT_DETERMINE_QUALITY. In this situation, you can get a model quality assessment by adding labels to the input dataset and retraining the model. For information about using labels with your models, see Understanding labeling. For information about improving the qu
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    S3Object:
      type: object
      properties:
        Bucket:
          type: string
          description: The name of the specific S3 bucket.
        Key:
          type: string
          description: The Amazon Web Services Key Management Service (KMS key) key being used to encrypt the S3 object. Without this key, data in the bucket is not accessible.
      required:
      - Bucket
      - Key
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ListModelVersionsRequest:
      type: object
      properties:
        ModelName:
          type: string
          description: Then name of the machine learning model for which the model versions are to be listed.
        NextToken:
          type: string
          description: If the total number of results exceeds the limit that the response can display, the response returns an opaque pagination token indicating where to continue the listing of machine learning model versions. Use this token in the NextToken field in the request to list the next page of results.
        MaxResults:
          type: integer
          description: Specifies the maximum number of machine learning model versions to list.
        Status:
          type: string
          enum:
          - IN_PROGRESS
          - SUCCESS
          - FAILED
          - IMPORT_IN_PROGRESS
          - CANCELED
          description: Filter the results based on the current status of the model version.
        SourceType:
          type: string
          enum:
          - TRAINING
          - RETRAINING
          - IMPORT
          description: Filter the results based on the way the model version was generated.
        CreatedAtEndTime:
          type: string
          format: date-time
          description: Filter results to return all the model versions created before this time.
        CreatedAtStartTime:
          type: string
          format: date-time
          description: Filter results to return all the model versions created after this time.
        MaxModelVersion:
          type: integer
          description: Specifies the highest version of the model to return in the list.
        MinModelVersion:
          type: integer
          description: Specifies the lowest version of the model to return in the list.
      required:
      - ModelName
    ImportModelVersionRequest:
      type: object
      properties:
        SourceModelVersionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the model version to import.
        ModelName:
          type: string
          description: The name for the machine learning model to be created. If the model already exists, Amazon Lookout for Equipment creates a new version. If you do not specify this field, it is filled with the name of the source model.
        DatasetName:
          type: string
          description: The name of the dataset for the machine learning model being imported.
        LabelsInputConfiguration:
          $ref: '#/components/schemas/LabelsInputConfiguration'
        ClientToken:
          type: string
          description: A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of a role with permission to access the data source being used to create the machine learning model.
        ServerSideKmsKeyId:
          type: string
          description: Provides the identifier of the KMS key key used to encrypt model data by Amazon Lookout for Equipment.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags associated with the machine learning model to be created.
        InferenceDataImportStrategy:
          type: string
          enum:
          - NO_IMPORT
          - ADD_WHEN_EMPTY
          - OVERWRITE
          description: 'Indicates how to import the accumulated inference data when a model version is imported. The possible values are as follows: NO_IMPORT – Don''t import the data. ADD_WHEN_EMPTY – Only import the data from the source model if there is no existing data in the target model. OVERWRITE – Import the data from the source model and overwrite the existing data in the target model.'
      required:
      - SourceModelVersionArn
      - DatasetName
      - ClientToken
    ModelDiagnosticsOutputConfiguration:
      type: object
      properties:
        S3OutputConfiguration:
          $ref: '#/components/schemas/ModelDiagnosticsS3OutputConfiguration'
        KmsKeyId:
          type: string
          description: The Amazon Web Services Key Management Service (KMS) key identifier to encrypt the pointwise model diagnostics files.
      required:
      - S3OutputConfiguration
    ModelVersionSummary:
      type: object
      properties:
        ModelName:
          type: string
          description: The name of the model that this model version is a version of.
        ModelArn:
          type: string
          description: The Amazon Resource Name (ARN) of the model that this model version is a version of.
        ModelVersion:
          type: integer
          description: The version of the model.
        ModelVersionArn:
          type: string
          description: The Amazon Resource Name (ARN) of the model version.
        CreatedAt:
          type: string
          format: date-time
          description: The time when this model version was created.
        Status:
          type: string
          enum:
          - IN_PROGRESS
          - SUCCESS
          - FAILED
          - IMPORT_IN_PROGRESS
          - CANCELED
          description: The current status of the model version.
        SourceType:
          type: string
          enum:
          - TRAINING
          - RETRAINING
          - IMPORT
          description: Indicates how this model version was generated.
        ModelQuality:
          type: string
          enum:
          - QUALITY_THRESHOLD_MET
          - CANNOT_DETERMINE_QUALITY
          - POOR_QUALITY_DETECTED
          description: Provides a quality assessment for a model that uses labels. If Lookout for Equipment determines that the model quality is poor based on training metrics, the value is POOR_QUALITY_DETECTED. Otherwise, the value is QUALITY_THRESHOLD_MET. If the model is unlabeled, the model quality can't be assessed and the value of ModelQuality is CANNOT_DETERMINE_QUALITY. In this situation, you can get a model quality assessment by adding labels to the input dataset and retraining the model. For information about improving the quality of a model, see Best practices with Amazon Lookout for Equipment.
    ServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    DescribeModelVersionRequest:
      type: object
      properties:
        ModelName:
          type: string
          description: The name of the machine learning model that this version belongs to.
        ModelVersion:
          type: integer
          description: The version of the machine learning model.
      required:
      - ModelName
      - ModelVersion
    ModelDiagnosticsS3OutputConfiguration:
      type: object
      properties:
        Bucket:
          type: string
          description: The name of the Amazon S3 bucket where the pointwise model diagnostics are located. You must be the owner of the Amazon S3 bucket.
        Prefix:
          type: string
          description: The Amazon S3 prefix for the location of the pointwise model diagnostics. The prefix specifies the folder and evaluation result file name. (bucket). When you call CreateModel or UpdateModel, specify the path within the bucket that you want Lookout for Equipment to save the model to. During training, Lookout for Equipment creates the model evaluation model as a compressed JSON file with the name model_diagnostics_results.json.gz. When you call DescribeModel or DescribeModelVersion, prefix contains the file path and filename of the model evaluation file.
      required:
      - Bucket
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The key for the specified tag.
        Value:
          type: string
          description: The value for the specified tag.
      required:
      - Key
      - Value
    LabelsS3InputConfiguration:
      type: object
      properties:
        Bucket:
          type: string
          description: The name of the S3 bucket holding the label data.
        Prefix:
          type: string
          description: The prefix for the S3 bucket used for the label data.
      required:
      - Bucket
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: lookoutequipment
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/lookoutequipment/service/2020-12-15/lookoutequipment-2020-12-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)