Amazon Managed Service for Prometheus Managed Prometheus Anomalydetectors API

openapi: 3.2.0
info:
  title: Amazon Prometheus Service Anomalydetectors API
  version: '2020-08-01'
  description: Generated from AWS's published Smithy model for Amazon Prometheus Service. 5 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://aps.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Anomalydetectors
paths:
  /workspaces/{workspaceId}/anomalydetectors:
    post:
      operationId: CreateAnomalyDetector
      summary: Create Anomaly Detector
      description: Creates an anomaly detector within a workspace using the Random Cut Forest algorithm for time-series analysis. The anomaly detector analyzes Amazon Managed Service for Prometheus metrics to identify unusual patterns and behaviors.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAnomalyDetectorResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAnomalyDetectorRequest'
      tags:
      - Anomalydetectors
    get:
      operationId: ListAnomalyDetectors
      summary: List Anomaly Detectors
      description: Returns a paginated list of anomaly detectors for a workspace with optional filtering by alias.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAnomalyDetectorsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListAnomalyDetectorsRequest'
      tags:
      - Anomalydetectors
  /workspaces/{workspaceId}/anomalydetectors/{anomalyDetectorId}:
    put:
      operationId: PutAnomalyDetector
      summary: Put Anomaly Detector
      description: When you call PutAnomalyDetector, the operation creates a new anomaly detector if one doesn't exist, or updates an existing one. Each call to this operation triggers a complete retraining of the detector, which includes querying the minimum required samples and backfilling the detector with historical data. This process occurs regardless of whether you're making a minor change like updating the evaluation interval or making more substantial modifications. The operation serves as the single method for creating, updating, and retraining anomaly detectors.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutAnomalyDetectorResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutAnomalyDetectorRequest'
      tags:
      - Anomalydetectors
    get:
      operationId: DescribeAnomalyDetector
      summary: Describe Anomaly Detector
      description: Retrieves detailed information about a specific anomaly detector, including its status and configuration.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeAnomalyDetectorResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeAnomalyDetectorRequest'
      tags:
      - Anomalydetectors
    delete:
      operationId: DeleteAnomalyDetector
      summary: Delete Anomaly Detector
      description: Removes an anomaly detector from a workspace. This operation is idempotent.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteAnomalyDetectorRequest'
      tags:
      - Anomalydetectors
components:
  schemas:
    ValidationException:
      type: object
      properties:
        message:
          type: string
          description: Description of the error.
        reason:
          type: string
          description: Reason the request failed validation.
        fieldList:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: The field that caused the error, if applicable.
      required:
      - message
      - reason
    ListAnomalyDetectorsRequest:
      type: object
      properties:
        workspaceId:
          type: string
          description: The identifier of the workspace containing the anomaly detectors to list.
        alias:
          type: string
          description: Filters the results to anomaly detectors with the specified alias.
        maxResults:
          type: integer
          description: The maximum number of results to return in a single call. Valid range is 1 to 1000.
        nextToken:
          type: string
          description: The pagination token to continue retrieving results.
      required:
      - workspaceId
    DeleteAnomalyDetectorRequest:
      type: object
      properties:
        workspaceId:
          type: string
          description: The identifier of the workspace containing the anomaly detector to delete.
        anomalyDetectorId:
          type: string
          description: The identifier of the anomaly detector to delete.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
      required:
      - workspaceId
      - anomalyDetectorId
    ConflictException:
      type: object
      properties:
        message:
          type: string
          description: Description of the error.
        resourceId:
          type: string
          description: Identifier of the resource affected.
        resourceType:
          type: string
          description: Type of the resource affected.
      required:
      - message
      - resourceId
      - resourceType
    AnomalyDetectorStatus:
      type: object
      properties:
        statusCode:
          type: string
          enum:
          - CREATING
          - ACTIVE
          - UPDATING
          - DELETING
          - CREATION_FAILED
          - UPDATE_FAILED
          - DELETION_FAILED
          description: The status code of the anomaly detector.
        statusReason:
          type: string
          description: A description of the current status of the anomaly detector.
      required:
      - statusCode
    AnomalyDetectorConfiguration:
      type: object
      properties:
        randomCutForest:
          $ref: '#/components/schemas/RandomCutForestConfiguration'
      description: Exactly one member is set.
    RandomCutForestConfiguration:
      type: object
      properties:
        query:
          type: string
          description: 'The Prometheus query used to retrieve the time-series data for anomaly detection. Random Cut Forest queries must be wrapped by a supported PromQL aggregation operator. For more information, see Aggregation operators on the Prometheus docs website. Supported PromQL aggregation operators: avg, count, group, max, min, quantile, stddev, stdvar, and sum.'
        shingleSize:
          type: integer
          description: The number of consecutive data points used to create a shingle for the Random Cut Forest algorithm. The default number is 8 consecutive data points.
        sampleSize:
          type: integer
          description: The number of data points sampled from the input stream for the Random Cut Forest algorithm. The default number is 256 consecutive data points.
        ignoreNearExpectedFromAbove:
          $ref: '#/components/schemas/IgnoreNearExpected'
        ignoreNearExpectedFromBelow:
          $ref: '#/components/schemas/IgnoreNearExpected'
      required:
      - query
    ValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The name of the field that caused an exception.
        message:
          type: string
          description: A message describing why the field caused an exception.
      required:
      - name
      - message
    IgnoreNearExpected:
      type: object
      properties:
        amount:
          type: number
          description: The absolute amount by which values can differ from expected values before being considered anomalous.
        ratio:
          type: number
          description: The ratio by which values can differ from expected values before being considered anomalous.
      description: Exactly one member is set.
    CreateAnomalyDetectorResponse:
      type: object
      properties:
        anomalyDetectorId:
          type: string
          description: The unique identifier of the created anomaly detector.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the created anomaly detector.
        status:
          $ref: '#/components/schemas/AnomalyDetectorStatus'
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags applied to the created anomaly detector.
      required:
      - anomalyDetectorId
      - arn
      - status
    PutAnomalyDetectorRequest:
      type: object
      properties:
        workspaceId:
          type: string
          description: The identifier of the workspace containing the anomaly detector to update.
        anomalyDetectorId:
          type: string
          description: The identifier of the anomaly detector to update.
        evaluationIntervalInSeconds:
          type: integer
          description: The frequency, in seconds, at which the anomaly detector evaluates metrics.
        missingDataAction:
          $ref: '#/components/schemas/AnomalyDetectorMissingDataAction'
        configuration:
          $ref: '#/components/schemas/AnomalyDetectorConfiguration'
        labels:
          type: object
          additionalProperties:
            type: string
          description: The Amazon Managed Service for Prometheus metric labels to associate with the anomaly detector.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
      required:
      - workspaceId
      - anomalyDetectorId
      - configuration
    AnomalyDetectorMissingDataAction:
      type: object
      properties:
        markAsAnomaly:
          type: boolean
          description: Marks missing data points as anomalies.
        skip:
          type: boolean
          description: Skips evaluation when data is missing.
      description: Exactly one member is set.
    PutAnomalyDetectorResponse:
      type: object
      properties:
        anomalyDetectorId:
          type: string
          description: The unique identifier of the updated anomaly detector.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the updated anomaly detector.
        status:
          $ref: '#/components/schemas/AnomalyDetectorStatus'
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags applied to the updated anomaly detector.
      required:
      - anomalyDetectorId
      - arn
      - status
    CreateAnomalyDetectorRequest:
      type: object
      properties:
        workspaceId:
          type: string
          description: The identifier of the workspace where the anomaly detector will be created.
        alias:
          type: string
          description: A user-friendly name for the anomaly detector.
        evaluationIntervalInSeconds:
          type: integer
          description: The frequency, in seconds, at which the anomaly detector evaluates metrics. The default value is 60 seconds.
        missingDataAction:
          $ref: '#/components/schemas/AnomalyDetectorMissingDataAction'
        configuration:
          $ref: '#/components/schemas/AnomalyDetectorConfiguration'
        labels:
          type: object
          additionalProperties:
            type: string
          description: The Amazon Managed Service for Prometheus metric labels to associate with the anomaly detector.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The metadata to apply to the anomaly detector to assist with categorization and organization.
      required:
      - workspaceId
      - alias
      - configuration
    DescribeAnomalyDetectorResponse:
      type: object
      properties:
        anomalyDetector:
          $ref: '#/components/schemas/AnomalyDetectorDescription'
      required:
      - anomalyDetector
    DescribeAnomalyDetectorRequest:
      type: object
      properties:
        workspaceId:
          type: string
          description: The identifier of the workspace containing the anomaly detector.
        anomalyDetectorId:
          type: string
          description: The identifier of the anomaly detector to describe.
      required:
      - workspaceId
      - anomalyDetectorId
    InternalServerException:
      type: object
      properties:
        message:
          type: string
          description: Description of the error.
        retryAfterSeconds:
          type: integer
          description: Advice to clients on when the call can be safely retried.
      required:
      - message
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
          description: Description of the error.
        serviceCode:
          type: string
          description: Service quotas code for the originating service.
        quotaCode:
          type: string
          description: Service quotas code for the originating quota.
        retryAfterSeconds:
          type: integer
          description: Advice to clients on when the call can be safely retried.
      required:
      - message
    AnomalyDetectorSummary:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the anomaly detector.
        anomalyDetectorId:
          type: string
          description: The unique identifier of the anomaly detector.
        alias:
          type: string
          description: The user-friendly name of the anomaly detector.
        status:
          $ref: '#/components/schemas/AnomalyDetectorStatus'
        createdAt:
          type: string
          description: The timestamp when the anomaly detector was created.
        modifiedAt:
          type: string
          description: The timestamp when the anomaly detector was last modified.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags applied to the anomaly detector.
      required:
      - arn
      - anomalyDetectorId
      - alias
      - status
      - createdAt
      - modifiedAt
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
          description: Description of the error.
        resourceId:
          type: string
          description: Identifier of the resource affected.
        resourceType:
          type: string
          description: Type of the resource affected.
        serviceCode:
          type: string
          description: Service quotas code for the originating service.
        quotaCode:
          type: string
          description: Service quotas code of the originating quota.
      required:
      - message
      - resourceId
      - resourceType
      - serviceCode
      - quotaCode
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
          description: Description of the error.
        resourceId:
          type: string
          description: Identifier of the resource affected.
        resourceType:
          type: string
          description: Type of the resource affected.
      required:
      - message
      - resourceId
      - resourceType
    ListAnomalyDetectorsResponse:
      type: object
      properties:
        anomalyDetectors:
          type: array
          items:
            $ref: '#/components/schemas/AnomalyDetectorSummary'
          description: The list of anomaly detectors in the workspace.
        nextToken:
          type: string
          description: The pagination token to retrieve the next set of results.
      required:
      - anomalyDetectors
    AnomalyDetectorDescription:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the anomaly detector.
        anomalyDetectorId:
          type: string
          description: The unique identifier of the anomaly detector.
        alias:
          type: string
          description: The user-friendly name of the anomaly detector.
        evaluationIntervalInSeconds:
          type: integer
          description: The frequency, in seconds, at which the anomaly detector evaluates metrics.
        missingDataAction:
          $ref: '#/components/schemas/AnomalyDetectorMissingDataAction'
        configuration:
          $ref: '#/components/schemas/AnomalyDetectorConfiguration'
        labels:
          type: object
          additionalProperties:
            type: string
          description: The Amazon Managed Service for Prometheus metric labels associated with the anomaly detector.
        status:
          $ref: '#/components/schemas/AnomalyDetectorStatus'
        createdAt:
          type: string
          description: The timestamp when the anomaly detector was created.
        modifiedAt:
          type: string
          description: The timestamp when the anomaly detector was last modified.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags applied to the anomaly detector.
      required:
      - arn
      - anomalyDetectorId
      - alias
      - status
      - createdAt
      - modifiedAt
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
          description: Description of the error.
      required:
      - message
  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: aps
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/amp/service/2020-08-01/amp-2020-08-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)