- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
LookoutMetricsClient
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 .
Installation
npm install @aws-sdk/client-lookoutmetrics
yarn add @aws-sdk/client-lookoutmetrics
pnpm add @aws-sdk/client-lookoutmetrics
LookoutMetricsClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
ActivateAnomalyDetectorCommand | Activates an anomaly detector. |
BackTestAnomalyDetectorCommand | Runs a backtest for anomaly detection for the specified resource. |
CreateAlertCommand | Creates an alert for an anomaly detector. |
CreateAnomalyDetectorCommand | Creates an anomaly detector. |
CreateMetricSetCommand | Creates a dataset. |
DeactivateAnomalyDetectorCommand | Deactivates an anomaly detector. |
DeleteAlertCommand | Deletes an alert. |
DeleteAnomalyDetectorCommand | Deletes a detector. Deleting an anomaly detector will delete all of its corresponding resources including any configured datasets and alerts. |
DescribeAlertCommand | 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. |
DescribeAnomalyDetectionExecutionsCommand | Returns information about the status of the specified anomaly detection jobs. |
DescribeAnomalyDetectorCommand | 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. |
DescribeMetricSetCommand | 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. |
DetectMetricSetConfigCommand | Detects an Amazon S3 dataset's file format, interval, and offset. |
GetAnomalyGroupCommand | Returns details about a group of anomalous metrics. |
GetDataQualityMetricsCommand | Returns details about the requested data quality metrics. |
GetFeedbackCommand | Get feedback for an anomaly group. |
GetSampleDataCommand | Returns a selection of sample records from an Amazon S3 datasource. |
ListAlertsCommand | 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. |
ListAnomalyDetectorsCommand | 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. |
ListAnomalyGroupRelatedMetricsCommand | Returns a list of measures that are potential causes or effects of an anomaly group. |
ListAnomalyGroupSummariesCommand | Returns a list of anomaly groups. |
ListAnomalyGroupTimeSeriesCommand | Gets a list of anomalous metrics for a measure in an anomaly group. |
ListMetricSetsCommand | 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. |
ListTagsForResourceCommand | Gets a list of tags for a detector, dataset, or alert. |
PutFeedbackCommand | Add feedback for an anomalous metric. |
TagResourceCommand | Adds tags to a detector, dataset, or alert. |
UntagResourceCommand | Removes tags from a detector, dataset, or alert. |
UpdateAlertCommand | Make changes to an existing alert. |
UpdateAnomalyDetectorCommand | Updates a detector. After activation, you can only change a detector's ingestion delay and description. |
UpdateMetricSetCommand | Updates a dataset. |
LookoutMetricsClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: LookoutMetricsClientConfig