AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Prometheus Service PutAnomalyDetector API operation.

Syntax

Write-PROMAnomalyDetector
-IgnoreNearExpectedFromAbove_Amount <Double>
-IgnoreNearExpectedFromBelow_Amount <Double>
-AnomalyDetectorId <String>
-EvaluationIntervalInSecond <Int32>
-Label <Hashtable>
-MissingDataAction_MarkAsAnomaly <Boolean>
-RandomCutForest_Query <String>
-IgnoreNearExpectedFromAbove_Ratio <Double>
-IgnoreNearExpectedFromBelow_Ratio <Double>
-RandomCutForest_SampleSize <Int32>
-RandomCutForest_ShingleSize <Int32>
-MissingDataAction_Skip <Boolean>
-WorkspaceId <String>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonPrometheusServiceConfig>

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.

Parameters

-AnomalyDetectorId <String>
The identifier of the anomaly detector to update.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonPrometheusServiceConfig>
Amazon.PowerShell.Cmdlets.PROM.AmazonPrometheusServiceClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EvaluationIntervalInSecond <Int32>
The frequency, in seconds, at which the anomaly detector evaluates metrics.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEvaluationIntervalInSeconds
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IgnoreNearExpectedFromAbove_Amount <Double>
The absolute amount by which values can differ from expected values before being considered anomalous.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_RandomCutForest_IgnoreNearExpectedFromAbove_Amount
-IgnoreNearExpectedFromAbove_Ratio <Double>
The ratio by which values can differ from expected values before being considered anomalous.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_RandomCutForest_IgnoreNearExpectedFromAbove_Ratio
-IgnoreNearExpectedFromBelow_Amount <Double>
The absolute amount by which values can differ from expected values before being considered anomalous.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_RandomCutForest_IgnoreNearExpectedFromBelow_Amount
-IgnoreNearExpectedFromBelow_Ratio <Double>
The ratio by which values can differ from expected values before being considered anomalous.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_RandomCutForest_IgnoreNearExpectedFromBelow_Ratio
-Label <Hashtable>
The Amazon Managed Service for Prometheus metric labels to associate with the anomaly detector. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLabels
-MissingDataAction_MarkAsAnomaly <Boolean>
Marks missing data points as anomalies.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MissingDataAction_Skip <Boolean>
Skips evaluation when data is missing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RandomCutForest_Query <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_RandomCutForest_Query
-RandomCutForest_SampleSize <Int32>
The number of data points sampled from the input stream for the Random Cut Forest algorithm. The default number is 256 consecutive data points.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_RandomCutForest_SampleSize
-RandomCutForest_ShingleSize <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_RandomCutForest_ShingleSize
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PrometheusService.Model.PutAnomalyDetectorResponse). Specifying the name of a property of type Amazon.PrometheusService.Model.PutAnomalyDetectorResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WorkspaceId <String>
The identifier of the workspace containing the anomaly detector to update.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.PrometheusService.Model.PutAnomalyDetectorResponse
This cmdlet returns an Amazon.PrometheusService.Model.PutAnomalyDetectorResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z