Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

LookoutMetrics

import { LookoutMetrics } from "https://aws-api.deno.dev/v0.3/services/lookoutmetrics.ts?docs=full";
class LookoutMetrics {
constructor(apiFactory: client.ApiFactory);
async activateAnomalyDetector(params: ActivateAnomalyDetectorRequest, opts?: client.RequestOptions): Promise<void>;
async backTestAnomalyDetector(params: BackTestAnomalyDetectorRequest, opts?: client.RequestOptions): Promise<void>;
async createAlert(params: CreateAlertRequest, opts?: client.RequestOptions): Promise<CreateAlertResponse>;
async createAnomalyDetector(params: CreateAnomalyDetectorRequest, opts?: client.RequestOptions): Promise<CreateAnomalyDetectorResponse>;
async createMetricSet(params: CreateMetricSetRequest, opts?: client.RequestOptions): Promise<CreateMetricSetResponse>;
async deactivateAnomalyDetector(params: DeactivateAnomalyDetectorRequest, opts?: client.RequestOptions): Promise<void>;
async deleteAlert(params: DeleteAlertRequest, opts?: client.RequestOptions): Promise<void>;
async deleteAnomalyDetector(params: DeleteAnomalyDetectorRequest, opts?: client.RequestOptions): Promise<void>;
async describeAlert(params: DescribeAlertRequest, opts?: client.RequestOptions): Promise<DescribeAlertResponse>;
async describeAnomalyDetectionExecutions(params: DescribeAnomalyDetectionExecutionsRequest, opts?: client.RequestOptions): Promise<DescribeAnomalyDetectionExecutionsResponse>;
async describeAnomalyDetector(params: DescribeAnomalyDetectorRequest, opts?: client.RequestOptions): Promise<DescribeAnomalyDetectorResponse>;
async describeMetricSet(params: DescribeMetricSetRequest, opts?: client.RequestOptions): Promise<DescribeMetricSetResponse>;
async getAnomalyGroup(params: GetAnomalyGroupRequest, opts?: client.RequestOptions): Promise<GetAnomalyGroupResponse>;
async getFeedback(params: GetFeedbackRequest, opts?: client.RequestOptions): Promise<GetFeedbackResponse>;
async getSampleData(params?: GetSampleDataRequest, opts?: client.RequestOptions): Promise<GetSampleDataResponse>;
async listAlerts(params?: ListAlertsRequest, opts?: client.RequestOptions): Promise<ListAlertsResponse>;
async listAnomalyDetectors(params?: ListAnomalyDetectorsRequest, opts?: client.RequestOptions): Promise<ListAnomalyDetectorsResponse>;
async listAnomalyGroupRelatedMetrics(params: ListAnomalyGroupRelatedMetricsRequest, opts?: client.RequestOptions): Promise<ListAnomalyGroupRelatedMetricsResponse>;
async listAnomalyGroupSummaries(params: ListAnomalyGroupSummariesRequest, opts?: client.RequestOptions): Promise<ListAnomalyGroupSummariesResponse>;
async listAnomalyGroupTimeSeries(params: ListAnomalyGroupTimeSeriesRequest, opts?: client.RequestOptions): Promise<ListAnomalyGroupTimeSeriesResponse>;
async listMetricSets(params?: ListMetricSetsRequest, opts?: client.RequestOptions): Promise<ListMetricSetsResponse>;
async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;
async putFeedback(params: PutFeedbackRequest, opts?: client.RequestOptions): Promise<void>;
async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async updateAnomalyDetector(params: UpdateAnomalyDetectorRequest, opts?: client.RequestOptions): Promise<UpdateAnomalyDetectorResponse>;
async updateMetricSet(params: UpdateMetricSetRequest, opts?: client.RequestOptions): Promise<UpdateMetricSetResponse>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new LookoutMetrics(apiFactory: client.ApiFactory)
[src]

§Methods

§
activateAnomalyDetector(params: ActivateAnomalyDetectorRequest, opts?: client.RequestOptions): Promise<void>
[src]

Activates an anomaly detector.

§
backTestAnomalyDetector(params: BackTestAnomalyDetectorRequest, opts?: client.RequestOptions): Promise<void>
[src]

Runs a backtest for anomaly detection for the specified resource.

§
createAlert(params: CreateAlertRequest, opts?: client.RequestOptions): Promise<CreateAlertResponse>
[src]

Creates an alert for an anomaly detector.

§
createAnomalyDetector(params: CreateAnomalyDetectorRequest, opts?: client.RequestOptions): Promise<CreateAnomalyDetectorResponse>
[src]

Creates an anomaly detector.

§
createMetricSet(params: CreateMetricSetRequest, opts?: client.RequestOptions): Promise<CreateMetricSetResponse>
[src]

Creates a dataset.

§
deactivateAnomalyDetector(params: DeactivateAnomalyDetectorRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deactivates an anomaly detector.

§
deleteAlert(params: DeleteAlertRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes an alert.

§
deleteAnomalyDetector(params: DeleteAnomalyDetectorRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a detector. Deleting an anomaly detector will delete all of its corresponding resources including any configured datasets and alerts.

§
describeAlert(params: DescribeAlertRequest, opts?: client.RequestOptions): Promise<DescribeAlertResponse>
[src]

Describes an alert.

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.

§
describeAnomalyDetectionExecutions(params: DescribeAnomalyDetectionExecutionsRequest, opts?: client.RequestOptions): Promise<DescribeAnomalyDetectionExecutionsResponse>
[src]

Returns information about the status of the specified anomaly detection jobs.

§
describeAnomalyDetector(params: DescribeAnomalyDetectorRequest, opts?: client.RequestOptions): Promise<DescribeAnomalyDetectorResponse>
[src]

Describes a detector.

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.

§
describeMetricSet(params: DescribeMetricSetRequest, opts?: client.RequestOptions): Promise<DescribeMetricSetResponse>
[src]

Describes a dataset.

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.

§
getAnomalyGroup(params: GetAnomalyGroupRequest, opts?: client.RequestOptions): Promise<GetAnomalyGroupResponse>
[src]

Returns details about a group of anomalous metrics.

§
getFeedback(params: GetFeedbackRequest, opts?: client.RequestOptions): Promise<GetFeedbackResponse>
[src]

Get feedback for an anomaly group.

§
getSampleData(params?: GetSampleDataRequest, opts?: client.RequestOptions): Promise<GetSampleDataResponse>
[src]

Returns a selection of sample records from an Amazon S3 datasource.

§
listAlerts(params?: ListAlertsRequest, opts?: client.RequestOptions): Promise<ListAlertsResponse>
[src]

Lists the alerts attached to a detector.

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.

§
listAnomalyDetectors(params?: ListAnomalyDetectorsRequest, opts?: client.RequestOptions): Promise<ListAnomalyDetectorsResponse>
[src]

Lists the detectors in the current AWS Region.

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.

§
listAnomalyGroupRelatedMetrics(params: ListAnomalyGroupRelatedMetricsRequest, opts?: client.RequestOptions): Promise<ListAnomalyGroupRelatedMetricsResponse>
[src]

Returns a list of measures that are potential causes or effects of an anomaly group.

§
listAnomalyGroupSummaries(params: ListAnomalyGroupSummariesRequest, opts?: client.RequestOptions): Promise<ListAnomalyGroupSummariesResponse>
[src]

Returns a list of anomaly groups.

§
listAnomalyGroupTimeSeries(params: ListAnomalyGroupTimeSeriesRequest, opts?: client.RequestOptions): Promise<ListAnomalyGroupTimeSeriesResponse>
[src]

Gets a list of anomalous metrics for a measure in an anomaly group.

§
listMetricSets(params?: ListMetricSetsRequest, opts?: client.RequestOptions): Promise<ListMetricSetsResponse>
[src]

Lists the datasets in the current AWS Region.

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.

§
listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>
[src]

Gets a list of tags for a detector, dataset, or alert.

§
putFeedback(params: PutFeedbackRequest, opts?: client.RequestOptions): Promise<void>
[src]

Add feedback for an anomalous metric.

§
tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Adds tags to a detector, dataset, or alert.

§
untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Removes tags from a detector, dataset, or alert.

§
updateAnomalyDetector(params: UpdateAnomalyDetectorRequest, opts?: client.RequestOptions): Promise<UpdateAnomalyDetectorResponse>
[src]

Updates a detector. After activation, you can only change a detector's ingestion delay and description.

§
updateMetricSet(params: UpdateMetricSetRequest, opts?: client.RequestOptions): Promise<UpdateMetricSetResponse>
[src]

Updates a dataset.

§Static Properties