Amazon Lookout for Equipment Lookout For Equipment Retraining Scheduler API

openapi: 3.2.0
info:
  title: Amazon Lookout for Equipment Retraining Scheduler API
  version: '2020-12-15'
  description: Generated from AWS's published Smithy model for Amazon Lookout for Equipment. 7 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: Retraining Scheduler
paths:
  /#CreateRetrainingScheduler:
    post:
      operationId: CreateRetrainingScheduler
      summary: Create Retraining Scheduler
      description: Creates a retraining scheduler on the specified model.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/CreateRetrainingSchedulerResponse'
              example:
                ModelName: sample-model
                ModelArn: arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
                Status: PENDING
        '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'
        '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.CreateRetrainingScheduler
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/CreateRetrainingSchedulerRequest'
            example:
              ModelName: sample-model
              RetrainingStartDate: '2024-01-01T00:00:00Z'
              RetrainingFrequency: P1M
              LookbackWindow: P360D
              ClientToken: sample-client-token
      tags:
      - Retraining Scheduler
  /#DeleteRetrainingScheduler:
    post:
      operationId: DeleteRetrainingScheduler
      summary: Delete Retraining Scheduler
      description: Deletes a retraining scheduler from a model. The retraining scheduler must be in the STOPPED status.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                type: string
        '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'
        '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.DeleteRetrainingScheduler
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DeleteRetrainingSchedulerRequest'
            example:
              ModelName: sample-model
      tags:
      - Retraining Scheduler
  /#DescribeRetrainingScheduler:
    post:
      operationId: DescribeRetrainingScheduler
      summary: Describe Retraining Scheduler
      description: Provides a description of the retraining scheduler, including information such as the model name and retraining parameters.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DescribeRetrainingSchedulerResponse'
              example:
                ModelName: sample-model
                ModelArn: arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
                RetrainingStartDate: '2023-11-01T00:00:00Z'
                RetrainingFrequency: P1M
                LookbackWindow: P360D
                Status: RUNNING
                PromoteMode: MANAGED
                CreatedAt: '2023-10-01T15:00:00Z'
                UpdatedAt: '2023-10-01T15:00:00Z'
        '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.DescribeRetrainingScheduler
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DescribeRetrainingSchedulerRequest'
            example:
              ModelName: sample-model
      tags:
      - Retraining Scheduler
  /#ListRetrainingSchedulers:
    post:
      operationId: ListRetrainingSchedulers
      summary: List Retraining Schedulers
      description: Lists all retraining schedulers in your account, filtering by model name prefix and status.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListRetrainingSchedulersResponse'
              example:
                RetrainingSchedulerSummaries:
                - ModelName: sample-model-1
                  ModelArn: arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model-1/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
                  Status: RUNNING
                  RetrainingStartDate: '2023-06-01T00:00:00Z'
                  RetrainingFrequency: P1M
                  LookbackWindow: P180D
                - ModelName: sample-model-2
                  ModelArn: arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model-2/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222
                  Status: RUNNING
                  RetrainingStartDate: '2023-08-15T00:00:00Z'
                  RetrainingFrequency: P30D
                  LookbackWindow: P180D
                - ModelName: sample-model-3
                  ModelArn: arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model-3/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333
                  Status: STOPPED
                  RetrainingStartDate: '2023-09-01T00:00:00Z'
                  RetrainingFrequency: P1M
                  LookbackWindow: P360D
        '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'
        '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.ListRetrainingSchedulers
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListRetrainingSchedulersRequest'
            example:
              MaxResults: 50
      tags:
      - Retraining Scheduler
  /#StartRetrainingScheduler:
    post:
      operationId: StartRetrainingScheduler
      summary: Start Retraining Scheduler
      description: Starts a retraining scheduler.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/StartRetrainingSchedulerResponse'
              example:
                ModelName: sample-model
                ModelArn: arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
                Status: PENDING
        '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'
        '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.StartRetrainingScheduler
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/StartRetrainingSchedulerRequest'
            example:
              ModelName: sample-model
      tags:
      - Retraining Scheduler
  /#StopRetrainingScheduler:
    post:
      operationId: StopRetrainingScheduler
      summary: Stop Retraining Scheduler
      description: Stops a retraining scheduler.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/StopRetrainingSchedulerResponse'
              example:
                ModelName: sample-model
                ModelArn: arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
                Status: STOPPING
        '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'
        '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.StopRetrainingScheduler
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/StopRetrainingSchedulerRequest'
            example:
              ModelName: sample-model
      tags:
      - Retraining Scheduler
  /#UpdateRetrainingScheduler:
    post:
      operationId: UpdateRetrainingScheduler
      summary: Update Retraining Scheduler
      description: Updates a retraining scheduler.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                type: string
        '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'
        '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.UpdateRetrainingScheduler
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/UpdateRetrainingSchedulerRequest'
            example:
              ModelName: sample-model
              RetrainingStartDate: '2024-01-01T00:00:00Z'
              RetrainingFrequency: P1Y
      tags:
      - Retraining Scheduler
components:
  schemas:
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    CreateRetrainingSchedulerResponse:
      type: object
      properties:
        ModelName:
          type: string
          description: The name of the model that you added the retraining scheduler to.
        ModelArn:
          type: string
          description: The ARN of the model that you added the retraining scheduler to.
        Status:
          type: string
          enum:
          - PENDING
          - RUNNING
          - STOPPING
          - STOPPED
          description: The status of the retraining scheduler.
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    DescribeRetrainingSchedulerRequest:
      type: object
      properties:
        ModelName:
          type: string
          description: The name of the model that the retraining scheduler is attached to.
      required:
      - ModelName
    UpdateRetrainingSchedulerRequest:
      type: object
      properties:
        ModelName:
          type: string
          description: The name of the model whose retraining scheduler you want to update.
        RetrainingStartDate:
          type: string
          format: date-time
          description: The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the nearest UTC day.
        RetrainingFrequency:
          type: string
          description: 'This parameter uses the ISO 8601 standard to set the frequency at which you want retraining to occur in terms of Years, Months, and/or Days (note: other parameters like Time are not currently supported). The minimum value is 30 days (P30D) and the maximum value is 1 year (P1Y). For example, the following values are valid: P3M15D – Every 3 months and 15 days P2M – Every 2 months P150D – Every 150 days'
        LookbackWindow:
          type: string
          description: The number of past days of data that will be used for retraining.
        PromoteMode:
          type: string
          enum:
          - MANAGED
          - MANUAL
          description: Indicates how the service will use new models. In MANAGED mode, new models will automatically be used for inference if they have better performance than the current model. In MANUAL mode, the new models will not be used until they are manually activated.
      required:
      - ModelName
    ConflictException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    StartRetrainingSchedulerRequest:
      type: object
      properties:
        ModelName:
          type: string
          description: The name of the model whose retraining scheduler you want to start.
      required:
      - ModelName
    StopRetrainingSchedulerRequest:
      type: object
      properties:
        ModelName:
          type: string
          description: The name of the model whose retraining scheduler you want to stop.
      required:
      - ModelName
    DescribeRetrainingSchedulerResponse:
      type: object
      properties:
        ModelName:
          type: string
          description: The name of the model that the retraining scheduler is attached to.
        ModelArn:
          type: string
          description: The ARN of the model that the retraining scheduler is attached to.
        RetrainingStartDate:
          type: string
          format: date-time
          description: The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the nearest UTC day.
        RetrainingFrequency:
          type: string
          description: The frequency at which the model retraining is set. This follows the ISO 8601 guidelines.
        LookbackWindow:
          type: string
          description: The number of past days of data used for retraining.
        Status:
          type: string
          enum:
          - PENDING
          - RUNNING
          - STOPPING
          - STOPPED
          description: The status of the retraining scheduler.
        PromoteMode:
          type: string
          enum:
          - MANAGED
          - MANUAL
          description: Indicates how the service uses new models. In MANAGED mode, new models are used for inference if they have better performance than the current model. In MANUAL mode, the new models are not used until they are manually activated.
        CreatedAt:
          type: string
          format: date-time
          description: Indicates the time and date at which the retraining scheduler was created.
        UpdatedAt:
          type: string
          format: date-time
          description: Indicates the time and date at which the retraining scheduler was updated.
    ListRetrainingSchedulersRequest:
      type: object
      properties:
        ModelNameBeginsWith:
          type: string
          description: Specify this field to only list retraining schedulers whose machine learning models begin with the value you specify.
        Status:
          type: string
          enum:
          - PENDING
          - RUNNING
          - STOPPING
          - STOPPED
          description: Specify this field to only list retraining schedulers whose status matches the value you specify.
        NextToken:
          type: string
          description: If the number of results exceeds the maximum, a pagination token is returned. Use the token in the request to show the next page of retraining schedulers.
        MaxResults:
          type: integer
          description: Specifies the maximum number of retraining schedulers to list.
    ValidationException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ListRetrainingSchedulersResponse:
      type: object
      properties:
        RetrainingSchedulerSummaries:
          type: array
          items:
            $ref: '#/components/schemas/RetrainingSchedulerSummary'
          description: Provides information on the specified retraining scheduler, including the model name, model ARN, status, and start date.
        NextToken:
          type: string
          description: If the number of results exceeds the maximum, this pagination token is returned. Use this token in the request to show the next page of retraining schedulers.
    CreateRetrainingSchedulerRequest:
      type: object
      properties:
        ModelName:
          type: string
          description: The name of the model to add the retraining scheduler to.
        RetrainingStartDate:
          type: string
          format: date-time
          description: The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the nearest UTC day.
        RetrainingFrequency:
          type: string
          description: 'This parameter uses the ISO 8601 standard to set the frequency at which you want retraining to occur in terms of Years, Months, and/or Days (note: other parameters like Time are not currently supported). The minimum value is 30 days (P30D) and the maximum value is 1 year (P1Y). For example, the following values are valid: P3M15D – Every 3 months and 15 days P2M – Every 2 months P150D – Every 150 days'
        LookbackWindow:
          type: string
          description: The number of past days of data that will be used for retraining.
        PromoteMode:
          type: string
          enum:
          - MANAGED
          - MANUAL
          description: Indicates how the service will use new models. In MANAGED mode, new models will automatically be used for inference if they have better performance than the current model. In MANUAL mode, the new models will not be used until they are manually activated.
        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.
      required:
      - ModelName
      - RetrainingFrequency
      - LookbackWindow
      - ClientToken
    StartRetrainingSchedulerResponse:
      type: object
      properties:
        ModelName:
          type: string
          description: The name of the model whose retraining scheduler is being started.
        ModelArn:
          type: string
          description: The ARN of the model whose retraining scheduler is being started.
        Status:
          type: string
          enum:
          - PENDING
          - RUNNING
          - STOPPING
          - STOPPED
          description: The status of the retraining scheduler.
    StopRetrainingSchedulerResponse:
      type: object
      properties:
        ModelName:
          type: string
          description: The name of the model whose retraining scheduler is being stopped.
        ModelArn:
          type: string
          description: The ARN of the model whose retraining scheduler is being stopped.
        Status:
          type: string
          enum:
          - PENDING
          - RUNNING
          - STOPPING
          - STOPPED
          description: The status of the retraining scheduler.
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    RetrainingSchedulerSummary:
      type: object
      properties:
        ModelName:
          type: string
          description: The name of the model that the retraining scheduler is attached to.
        ModelArn:
          type: string
          description: The ARN of the model that the retraining scheduler is attached to.
        Status:
          type: string
          enum:
          - PENDING
          - RUNNING
          - STOPPING
          - STOPPED
          description: The status of the retraining scheduler.
        RetrainingStartDate:
          type: string
          format: date-time
          description: The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the nearest UTC day.
        RetrainingFrequency:
          type: string
          description: The frequency at which the model retraining is set. This follows the ISO 8601 guidelines.
        LookbackWindow:
          type: string
          description: The number of past days of data used for retraining.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    DeleteRetrainingSchedulerRequest:
      type: object
      properties:
        ModelName:
          type: string
          description: The name of the model whose retraining scheduler you want to delete.
      required:
      - ModelName
  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)