lookoutmetrics/aws.sdk.kotlin.services.lookoutmetrics

Package-level declarations

Types

interface LookoutMetricsClient : SdkClient

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

activateAnomalyDetector

inline suspend fun LookoutMetricsClient.activateAnomalyDetector(crossinline block: ActivateAnomalyDetectorRequest.Builder.() -> Unit): ActivateAnomalyDetectorResponse

Activates an anomaly detector.

backTestAnomalyDetector

inline suspend fun LookoutMetricsClient.backTestAnomalyDetector(crossinline block: BackTestAnomalyDetectorRequest.Builder.() -> Unit): BackTestAnomalyDetectorResponse

Runs a backtest for anomaly detection for the specified resource.

createAlert

inline suspend fun LookoutMetricsClient.createAlert(crossinline block: CreateAlertRequest.Builder.() -> Unit): CreateAlertResponse

Creates an alert for an anomaly detector.

createAnomalyDetector

inline suspend fun LookoutMetricsClient.createAnomalyDetector(crossinline block: CreateAnomalyDetectorRequest.Builder.() -> Unit): CreateAnomalyDetectorResponse

Creates an anomaly detector.

createMetricSet

inline suspend fun LookoutMetricsClient.createMetricSet(crossinline block: CreateMetricSetRequest.Builder.() -> Unit): CreateMetricSetResponse

Creates a dataset.

deactivateAnomalyDetector

inline suspend fun LookoutMetricsClient.deactivateAnomalyDetector(crossinline block: DeactivateAnomalyDetectorRequest.Builder.() -> Unit): DeactivateAnomalyDetectorResponse

Deactivates an anomaly detector.

deleteAlert

inline suspend fun LookoutMetricsClient.deleteAlert(crossinline block: DeleteAlertRequest.Builder.() -> Unit): DeleteAlertResponse

Deletes an alert.

deleteAnomalyDetector

inline suspend fun LookoutMetricsClient.deleteAnomalyDetector(crossinline block: DeleteAnomalyDetectorRequest.Builder.() -> Unit): DeleteAnomalyDetectorResponse

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

describeAlert

inline suspend fun LookoutMetricsClient.describeAlert(crossinline block: DescribeAlertRequest.Builder.() -> Unit): DescribeAlertResponse

Describes an alert.

describeAnomalyDetectionExecutions

inline suspend fun LookoutMetricsClient.describeAnomalyDetectionExecutions(crossinline block: DescribeAnomalyDetectionExecutionsRequest.Builder.() -> Unit): DescribeAnomalyDetectionExecutionsResponse

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

describeAnomalyDetector

inline suspend fun LookoutMetricsClient.describeAnomalyDetector(crossinline block: DescribeAnomalyDetectorRequest.Builder.() -> Unit): DescribeAnomalyDetectorResponse

Describes a detector.

describeMetricSet

inline suspend fun LookoutMetricsClient.describeMetricSet(crossinline block: DescribeMetricSetRequest.Builder.() -> Unit): DescribeMetricSetResponse

Describes a dataset.

detectMetricSetConfig

inline suspend fun LookoutMetricsClient.detectMetricSetConfig(crossinline block: DetectMetricSetConfigRequest.Builder.() -> Unit): DetectMetricSetConfigResponse

Detects an Amazon S3 dataset's file format, interval, and offset.

getAnomalyGroup

inline suspend fun LookoutMetricsClient.getAnomalyGroup(crossinline block: GetAnomalyGroupRequest.Builder.() -> Unit): GetAnomalyGroupResponse

Returns details about a group of anomalous metrics.

getDataQualityMetrics

inline suspend fun LookoutMetricsClient.getDataQualityMetrics(crossinline block: GetDataQualityMetricsRequest.Builder.() -> Unit): GetDataQualityMetricsResponse

Returns details about the requested data quality metrics.

getFeedback

inline suspend fun LookoutMetricsClient.getFeedback(crossinline block: GetFeedbackRequest.Builder.() -> Unit): GetFeedbackResponse

Get feedback for an anomaly group.

getSampleData

inline suspend fun LookoutMetricsClient.getSampleData(crossinline block: GetSampleDataRequest.Builder.() -> Unit): GetSampleDataResponse

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

listAlerts

inline suspend fun LookoutMetricsClient.listAlerts(crossinline block: ListAlertsRequest.Builder.() -> Unit): ListAlertsResponse

Lists the alerts attached to a detector.

listAnomalyDetectors

inline suspend fun LookoutMetricsClient.listAnomalyDetectors(crossinline block: ListAnomalyDetectorsRequest.Builder.() -> Unit): ListAnomalyDetectorsResponse

Lists the detectors in the current AWS Region.

listAnomalyGroupRelatedMetrics

inline suspend fun LookoutMetricsClient.listAnomalyGroupRelatedMetrics(crossinline block: ListAnomalyGroupRelatedMetricsRequest.Builder.() -> Unit): ListAnomalyGroupRelatedMetricsResponse

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

listAnomalyGroupSummaries

inline suspend fun LookoutMetricsClient.listAnomalyGroupSummaries(crossinline block: ListAnomalyGroupSummariesRequest.Builder.() -> Unit): ListAnomalyGroupSummariesResponse

Returns a list of anomaly groups.

listAnomalyGroupTimeSeries

inline suspend fun LookoutMetricsClient.listAnomalyGroupTimeSeries(crossinline block: ListAnomalyGroupTimeSeriesRequest.Builder.() -> Unit): ListAnomalyGroupTimeSeriesResponse

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

listMetricSets

inline suspend fun LookoutMetricsClient.listMetricSets(crossinline block: ListMetricSetsRequest.Builder.() -> Unit): ListMetricSetsResponse

Lists the datasets in the current AWS Region.

listTagsForResource

inline suspend fun LookoutMetricsClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

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

putFeedback

inline suspend fun LookoutMetricsClient.putFeedback(crossinline block: PutFeedbackRequest.Builder.() -> Unit): PutFeedbackResponse

Add feedback for an anomalous metric.

tagResource

inline suspend fun LookoutMetricsClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds tags to a detector, dataset, or alert.

untagResource

inline suspend fun LookoutMetricsClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes tags from a detector, dataset, or alert.

updateAlert

inline suspend fun LookoutMetricsClient.updateAlert(crossinline block: UpdateAlertRequest.Builder.() -> Unit): UpdateAlertResponse

Make changes to an existing alert.

updateAnomalyDetector

inline suspend fun LookoutMetricsClient.updateAnomalyDetector(crossinline block: UpdateAnomalyDetectorRequest.Builder.() -> Unit): UpdateAnomalyDetectorResponse

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

updateMetricSet

inline suspend fun LookoutMetricsClient.updateMetricSet(crossinline block: UpdateMetricSetRequest.Builder.() -> Unit): UpdateMetricSetResponse

Updates a dataset.

withConfig

fun LookoutMetricsClient.withConfig(block: LookoutMetricsClient.Config.Builder.() -> Unit): LookoutMetricsClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.