Amazon Web Services, Inc.

Amazon Lookout for Metrics

This is the Amazon Lookout for Metrics API Reference . For an introduction to the service with tutorials for getting started, visit Amazon Lookout for Metrics…

AI & machine learning#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

This is the Amazon Lookout for Metrics API Reference . For an introduction to the service with tutorials for getting started, visit Amazon Lookout for Metrics Developer Guide .

Endpoints 30

  • POSTActivateAnomalyDetector/ActivateAnomalyDetectorActivates an anomaly detector.
  • POSTBackTestAnomalyDetector/BackTestAnomalyDetectorRuns a backtest for anomaly detection for the specified resource.
  • POSTCreateAlert/CreateAlertCreates an alert for an anomaly detector.
  • POSTCreateAnomalyDetector/CreateAnomalyDetectorCreates an anomaly detector.
  • POSTCreateMetricSet/CreateMetricSetCreates a dataset.
  • POSTDeactivateAnomalyDetector/DeactivateAnomalyDetectorDeactivates an anomaly detector.
  • POSTDeleteAlert/DeleteAlertDeletes an alert.
  • POSTDeleteAnomalyDetector/DeleteAnomalyDetectorDeletes a detector. Deleting an anomaly detector will delete all of its corresponding resources including any configured datasets and alerts.
  • POSTDescribeAlert/DescribeAlert<p>Describes an alert.</p> <p>Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after…
  • POSTDescribeAnomalyDetectionExecutions/DescribeAnomalyDetectionExecutions?MaxResults=string&NextToken=stringReturns information about the status of the specified anomaly detection jobs.
  • POSTDescribeAnomalyDetector/DescribeAnomalyDetector<p>Describes a detector.</p> <p>Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after…
  • POSTDescribeMetricSet/DescribeMetricSet<p>Describes a dataset.</p> <p>Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after…
  • POSTDetectMetricSetConfig/DetectMetricSetConfigDetects an Amazon S3 dataset's file format, interval, and offset.
  • POSTGetAnomalyGroup/GetAnomalyGroupReturns details about a group of anomalous metrics.
  • POSTGetDataQualityMetrics/GetDataQualityMetricsReturns details about the requested data quality metrics.
  • POSTGetFeedback/GetFeedback?MaxResults=string&NextToken=stringGet feedback for an anomaly group.
  • POSTGetSampleData/GetSampleDataReturns a selection of sample records from an Amazon S3 datasource.
  • POSTListAlerts/ListAlerts?MaxResults=string&NextToken=string<p>Lists the alerts attached to a detector.</p> <p>Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource…
  • POSTListAnomalyDetectors/ListAnomalyDetectors?MaxResults=string&NextToken=string<p>Lists the detectors in the current AWS Region.</p> <p>Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a…
  • POSTListAnomalyGroupRelatedMetrics/ListAnomalyGroupRelatedMetrics?MaxResults=string&NextToken=stringReturns a list of measures that are potential causes or effects of an anomaly group.
  • POSTListAnomalyGroupSummaries/ListAnomalyGroupSummaries?MaxResults=string&NextToken=stringReturns a list of anomaly groups.
  • POSTListAnomalyGroupTimeSeries/ListAnomalyGroupTimeSeries?MaxResults=string&NextToken=stringGets a list of anomalous metrics for a measure in an anomaly group.
  • POSTListMetricSets/ListMetricSets?MaxResults=string&NextToken=string<p>Lists the datasets in the current AWS Region.</p> <p>Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a…
  • GETListTagsForResource/tags/:resourceArnGets a list of <a href="https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html">tags</a> for a detector, dataset, or alert.
  • POSTTagResource/tags/:resourceArnAdds <a href="https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html">tags</a> to a detector, dataset, or alert.
  • POSTPutFeedback/PutFeedbackAdd feedback for an anomalous metric.
  • DELETEUntagResource/tags/:resourceArn#tagKeys?tagKeys=stringRemoves <a href="https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html">tags</a> from a detector, dataset, or alert.
  • POSTUpdateAlert/UpdateAlertMake changes to an existing alert.
  • POSTUpdateAnomalyDetector/UpdateAnomalyDetectorUpdates a detector. After activation, you can only change a detector's ingestion delay and description.
  • POSTUpdateMetricSet/UpdateMetricSetUpdates a dataset.

API details

Base URL
http://lookoutmetrics.{region}.amazonaws.com
https://lookoutmetrics.{region}.amazonaws.com
http://lookoutmetrics.{region}.amazonaws.com.cn
https://lookoutmetrics.{region}.amazonaws.com.cn
Authentication
An API key in the Authorization header
Operations
30 operations on 29 pathsPOST 28GET 1DELETE 1
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 2017-07-25
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Amazon Lookout for Metrics in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Lookout for Metrics collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “ActivateAnomalyDetector” (POST /ActivateAnomalyDetector), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Lookout for Metrics?

This is the Amazon Lookout for Metrics API Reference . For an introduction to the service with tutorials for getting started, visit Amazon Lookout for Metrics… It is listed under AI & machine learning and has 30 endpoints.

Who publishes the Amazon Lookout for Metrics?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Lookout for Metrics?

Its description lists 4 base URLs: http://lookoutmetrics.{region}.amazonaws.com, https://lookoutmetrics.{region}.amazonaws.com, http://lookoutmetrics.{region}.amazonaws.com.cn, https://lookoutmetrics.{region}.amazonaws.com.cn. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Amazon Lookout for Metrics?

With an API key in the Authorization header.

How many endpoints does the Amazon Lookout for Metrics have?

30 operations on 29 paths (28 POST, 1 GET, 1 DELETE).

Is forking the Amazon Lookout for Metrics free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.