Amazon Lookout for Equipment Lookout For Equipment Data Ingestion Job API

openapi: 3.2.0
info:
  title: Amazon Lookout for Equipment Data Ingestion Job 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: Data Ingestion Job
paths:
  /#DescribeDataIngestionJob:
    post:
      operationId: DescribeDataIngestionJob
      summary: Describe Data Ingestion Job
      description: Provides information on a specific data ingestion job such as creation time, dataset ARN, and status.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DescribeDataIngestionJobResponse'
        '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.DescribeDataIngestionJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DescribeDataIngestionJobRequest'
      tags:
      - Data Ingestion Job
  /#ListDataIngestionJobs:
    post:
      operationId: ListDataIngestionJobs
      summary: List Data Ingestion Jobs
      description: Provides a list of all data ingestion jobs, including dataset name and ARN, S3 location of the input data, status, and so on.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListDataIngestionJobsResponse'
        '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.ListDataIngestionJobs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListDataIngestionJobsRequest'
      tags:
      - Data Ingestion Job
  /#StartDataIngestionJob:
    post:
      operationId: StartDataIngestionJob
      summary: Start Data Ingestion Job
      description: Starts a data ingestion job. Amazon Lookout for Equipment returns the job status.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/StartDataIngestionJobResponse'
        '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.StartDataIngestionJob
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/StartDataIngestionJobRequest'
      tags:
      - Data Ingestion Job
components:
  schemas:
    MissingSensorData:
      type: object
      properties:
        AffectedSensorCount:
          type: integer
          description: Indicates the number of sensors that have atleast some data missing.
        TotalNumberOfMissingValues:
          type: integer
          description: Indicates the total number of missing values across all the sensors.
      required:
      - AffectedSensorCount
      - TotalNumberOfMissingValues
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    DataIngestionJobSummary:
      type: object
      properties:
        JobId:
          type: string
          description: Indicates the job ID of the data ingestion job.
        DatasetName:
          type: string
          description: The name of the dataset used for the data ingestion job.
        DatasetArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset used in the data ingestion job.
        IngestionInputConfiguration:
          $ref: '#/components/schemas/IngestionInputConfiguration'
        Status:
          type: string
          enum:
          - IN_PROGRESS
          - SUCCESS
          - FAILED
          - IMPORT_IN_PROGRESS
          description: Indicates the status of the data ingestion job.
    DescribeDataIngestionJobRequest:
      type: object
      properties:
        JobId:
          type: string
          description: The job ID of the data ingestion job.
      required:
      - JobId
    IngestedFilesSummary:
      type: object
      properties:
        TotalNumberOfFiles:
          type: integer
          description: Indicates the total number of files that were submitted for ingestion.
        IngestedNumberOfFiles:
          type: integer
          description: Indicates the number of files that were successfully ingested.
        DiscardedFiles:
          type: array
          items:
            $ref: '#/components/schemas/S3Object'
          description: Indicates the number of files that were discarded. A file could be discarded because its format is invalid (for example, a jpg or pdf) or not readable.
      required:
      - TotalNumberOfFiles
      - IngestedNumberOfFiles
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    InsufficientSensorData:
      type: object
      properties:
        MissingCompleteSensorData:
          $ref: '#/components/schemas/MissingCompleteSensorData'
        SensorsWithShortDateRange:
          $ref: '#/components/schemas/SensorsWithShortDateRange'
      required:
      - MissingCompleteSensorData
      - SensorsWithShortDateRange
    StartDataIngestionJobResponse:
      type: object
      properties:
        JobId:
          type: string
          description: Indicates the job ID of the data ingestion job.
        Status:
          type: string
          enum:
          - IN_PROGRESS
          - SUCCESS
          - FAILED
          - IMPORT_IN_PROGRESS
          description: Indicates the status of the StartDataIngestionJob operation.
    IngestionS3InputConfiguration:
      type: object
      properties:
        Bucket:
          type: string
          description: The name of the S3 bucket used for the input data for the data ingestion.
        Prefix:
          type: string
          description: The prefix for the S3 location being used for the input data for the data ingestion.
        KeyPattern:
          type: string
          description: 'The pattern for matching the Amazon S3 files that will be used for ingestion. If the schema was created previously without any KeyPattern, then the default KeyPattern {prefix}/{component_name}/* is used to download files from Amazon S3 according to the schema. This field is required when ingestion is being done for the first time. Valid Values: {prefix}/{component_name}_* | {prefix}/{component_name}/* | {prefix}/{component_name}[DELIMITER]* (Allowed delimiters : space, dot, underscore, hyphen)'
      required:
      - Bucket
    MissingCompleteSensorData:
      type: object
      properties:
        AffectedSensorCount:
          type: integer
          description: Indicates the number of sensors that have data missing completely.
      required:
      - AffectedSensorCount
    DuplicateTimestamps:
      type: object
      properties:
        TotalNumberOfDuplicateTimestamps:
          type: integer
          description: Indicates the total number of duplicate timestamps.
      required:
      - TotalNumberOfDuplicateTimestamps
    ConflictException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    ValidationException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    DataQualitySummary:
      type: object
      properties:
        InsufficientSensorData:
          $ref: '#/components/schemas/InsufficientSensorData'
        MissingSensorData:
          $ref: '#/components/schemas/MissingSensorData'
        InvalidSensorData:
          $ref: '#/components/schemas/InvalidSensorData'
        UnsupportedTimestamps:
          $ref: '#/components/schemas/UnsupportedTimestamps'
        DuplicateTimestamps:
          $ref: '#/components/schemas/DuplicateTimestamps'
      required:
      - InsufficientSensorData
      - MissingSensorData
      - InvalidSensorData
      - UnsupportedTimestamps
      - DuplicateTimestamps
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    StartDataIngestionJobRequest:
      type: object
      properties:
        DatasetName:
          type: string
          description: The name of the dataset being used by the data ingestion job.
        IngestionInputConfiguration:
          $ref: '#/components/schemas/IngestionInputConfiguration'
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of a role with permission to access the data source for the data ingestion job.
        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:
      - DatasetName
      - IngestionInputConfiguration
      - RoleArn
      - ClientToken
    ListDataIngestionJobsResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: An opaque pagination token indicating where to continue the listing of data ingestion jobs.
        DataIngestionJobSummaries:
          type: array
          items:
            $ref: '#/components/schemas/DataIngestionJobSummary'
          description: Specifies information about the specific data ingestion job, including dataset name and status.
    InvalidSensorData:
      type: object
      properties:
        AffectedSensorCount:
          type: integer
          description: Indicates the number of sensors that have at least some invalid values.
        TotalNumberOfInvalidValues:
          type: integer
          description: Indicates the total number of invalid values across all the sensors.
      required:
      - AffectedSensorCount
      - TotalNumberOfInvalidValues
    ListDataIngestionJobsRequest:
      type: object
      properties:
        DatasetName:
          type: string
          description: The name of the dataset being used for the data ingestion job.
        NextToken:
          type: string
          description: An opaque pagination token indicating where to continue the listing of data ingestion jobs.
        MaxResults:
          type: integer
          description: Specifies the maximum number of data ingestion jobs to list.
        Status:
          type: string
          enum:
          - IN_PROGRESS
          - SUCCESS
          - FAILED
          - IMPORT_IN_PROGRESS
          description: Indicates the status of the data ingestion job.
    ThrottlingException:
      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
    IngestionInputConfiguration:
      type: object
      properties:
        S3InputConfiguration:
          $ref: '#/components/schemas/IngestionS3InputConfiguration'
      required:
      - S3InputConfiguration
    SensorsWithShortDateRange:
      type: object
      properties:
        AffectedSensorCount:
          type: integer
          description: Indicates the number of sensors that have less than 14 days of data.
      required:
      - AffectedSensorCount
    ServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    UnsupportedTimestamps:
      type: object
      properties:
        TotalNumberOfUnsupportedTimestamps:
          type: integer
          description: Indicates the total number of unsupported timestamps across the ingested data.
      required:
      - TotalNumberOfUnsupportedTimestamps
    DescribeDataIngestionJobResponse:
      type: object
      properties:
        JobId:
          type: string
          description: Indicates the job ID of the data ingestion job.
        DatasetArn:
          type: string
          description: The Amazon Resource Name (ARN) of the dataset being used in the data ingestion job.
        IngestionInputConfiguration:
          $ref: '#/components/schemas/IngestionInputConfiguration'
        RoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of an IAM role with permission to access the data source being ingested.
        CreatedAt:
          type: string
          format: date-time
          description: The time at which the data ingestion job was created.
        Status:
          type: string
          enum:
          - IN_PROGRESS
          - SUCCESS
          - FAILED
          - IMPORT_IN_PROGRESS
          description: Indicates the status of the DataIngestionJob operation.
        FailedReason:
          type: string
          description: Specifies the reason for failure when a data ingestion job has failed.
        DataQualitySummary:
          $ref: '#/components/schemas/DataQualitySummary'
        IngestedFilesSummary:
          $ref: '#/components/schemas/IngestedFilesSummary'
        StatusDetail:
          type: string
          description: Provides details about status of the ingestion job that is currently in progress.
        IngestedDataSize:
          type: integer
          description: Indicates the size of the ingested dataset.
        DataStartTime:
          type: string
          format: date-time
          description: Indicates the earliest timestamp corresponding to data that was successfully ingested during this specific ingestion job.
        DataEndTime:
          type: string
          format: date-time
          description: Indicates the latest timestamp corresponding to data that was successfully ingested during this specific ingestion job.
        SourceDatasetArn:
          type: string
          description: The Amazon Resource Name (ARN) of the source dataset from which the data used for the data ingestion job was imported from.
  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)