Amazon Lookout for Metrics GetDataQualityMetrics API

openapi: 3.0.0
info:
  version: 2017-07-25
  x-release: v4
  title: Amazon Lookout for Metrics ActivateAnomalyDetector GetDataQualityMetrics API
  description: This is the <i>Amazon Lookout for Metrics API Reference</i>. For an introduction to the service with tutorials for getting started, visit <a href="https://docs.aws.amazon.com/lookoutmetrics/latest/dev">Amazon Lookout for Metrics Developer Guide</a>.
  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: mike.ralphson@gmail.com
    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: lookoutmetrics
  x-aws-signingName: lookoutmetrics
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/lookoutmetrics-2017-07-25.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
servers:
- url: http://lookoutmetrics.{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 LookoutMetrics multi-region endpoint
- url: https://lookoutmetrics.{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 LookoutMetrics multi-region endpoint
- url: http://lookoutmetrics.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The LookoutMetrics endpoint for China (Beijing) and China (Ningxia)
- url: https://lookoutmetrics.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The LookoutMetrics endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: GetDataQualityMetrics
paths:
  /GetDataQualityMetrics:
    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'
    post:
      operationId: GetDataQualityMetrics
      description: Returns details about the requested data quality metrics.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDataQualityMetricsResponse'
        '480':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '481':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '482':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '483':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
        '484':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - AnomalyDetectorArn
              properties:
                AnomalyDetectorArn:
                  description: The Amazon Resource Name (ARN) of the anomaly detector that you want to investigate.
                  type: string
                  pattern: arn:([a-z\d-]+):.*:.*:.*:.+
                  maxLength: 256
                MetricSetArn:
                  description: The Amazon Resource Name (ARN) of a specific data quality metric set.
                  type: string
                  pattern: arn:([a-z\d-]+):.*:.*:.*:.+
                  maxLength: 256
      summary: Amazon Lookout for Metrics Get Data Quality Metrics
      tags:
      - GetDataQualityMetrics
components:
  schemas:
    AnomalyDetectorDataQualityMetricList:
      type: array
      items:
        $ref: '#/components/schemas/AnomalyDetectorDataQualityMetric'
    DataQualityMetricType:
      type: string
      enum:
      - COLUMN_COMPLETENESS
      - DIMENSION_UNIQUENESS
      - TIME_SERIES_COUNT
      - ROWS_PROCESSED
      - ROWS_PARTIAL_COMPLIANCE
      - INVALID_ROWS_COMPLIANCE
      - BACKTEST_TRAINING_DATA_START_TIME_STAMP
      - BACKTEST_TRAINING_DATA_END_TIME_STAMP
      - BACKTEST_INFERENCE_DATA_START_TIME_STAMP
      - BACKTEST_INFERENCE_DATA_END_TIME_STAMP
    ValidationException: {}
    ResourceNotFoundException: {}
    AnomalyDetectorDataQualityMetric:
      type: object
      properties:
        StartTimestamp:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The start time for the data quality metrics collection.
        MetricSetDataQualityMetricList:
          allOf:
          - $ref: '#/components/schemas/MetricSetDataQualityMetricList'
          - description: An array of <code>DataQualityMetricList</code> objects. Each object in the array contains information about a data quality metric.
      description: Aggregated details about the data quality metrics collected for the <code>AnomalyDetectorArn</code> provided in the <a>GetDataQualityMetrics</a> object.
    DataQualityMetric:
      type: object
      properties:
        MetricType:
          allOf:
          - $ref: '#/components/schemas/DataQualityMetricType'
          - description: The name of the data quality metric.
        MetricDescription:
          allOf:
          - $ref: '#/components/schemas/DataQualityMetricDescription'
          - description: A description of the data quality metric.
        RelatedColumnName:
          allOf:
          - $ref: '#/components/schemas/RelatedColumnName'
          - description: The column that is being monitored.
        MetricValue:
          allOf:
          - $ref: '#/components/schemas/Double'
          - description: The value of the data quality metric.
      description: An array that describes a data quality metric. Each <code>DataQualityMetric</code> object contains the data quality metric name, its value, a description of the metric, and the affected column.
    RelatedColumnName:
      type: string
      pattern: .*\S.*
      minLength: 1
      maxLength: 256
    Arn:
      type: string
      pattern: arn:([a-z\d-]+):.*:.*:.*:.+
      maxLength: 256
    Timestamp:
      type: string
      format: date-time
    DataQualityMetricDescription:
      type: string
      pattern: .*\S.*
      minLength: 1
      maxLength: 256
    Double:
      type: number
      format: double
    AccessDeniedException: {}
    MetricSetDataQualityMetricList:
      type: array
      items:
        $ref: '#/components/schemas/MetricSetDataQualityMetric'
    TooManyRequestsException: {}
    MetricSetDataQualityMetric:
      type: object
      properties:
        MetricSetArn:
          allOf:
          - $ref: '#/components/schemas/Arn'
          - description: The Amazon Resource Name (ARN) of the data quality metric array.
        DataQualityMetricList:
          allOf:
          - $ref: '#/components/schemas/DataQualityMetricList'
          - description: The array of data quality metrics contained in the data quality metric set.
      description: An array of <code>DataQualityMetric</code> objects that describes one or more data quality metrics.
    InternalServerException: {}
    DataQualityMetricList:
      type: array
      items:
        $ref: '#/components/schemas/DataQualityMetric'
    GetDataQualityMetricsResponse:
      type: object
      properties:
        AnomalyDetectorDataQualityMetricList:
          allOf:
          - $ref: '#/components/schemas/AnomalyDetectorDataQualityMetricList'
          - description: A list of the data quality metrics for the <code>AnomalyDetectorArn</code> that you requested.
  parameters:
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/lookoutmetrics/
x-hasEquivalentPaths: true