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 CloudWatch PutAnomalyDetector API operation.

Syntax

Write-CWAnomalyDetector
-MetricName <String>
-SingleMetricAnomalyDetector_Dimension <Dimension[]>
-Configuration_ExcludedTimeRange <Range[]>
-MetricMathAnomalyDetector_MetricDataQuery <MetricDataQuery[]>
-SingleMetricAnomalyDetector_MetricName <String>
-Configuration_MetricTimezone <String>
-SingleMetricAnomalyDetector_Namespace <String>
-SingleMetricAnomalyDetector_Stat <String>
-Dimension <Dimension[]>
-Namespace <String>
-Stat <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonCloudWatchConfig>

Description

Creates an anomaly detection model for a CloudWatch metric. You can use the model to display a band of expected normal values when the metric is graphed. For more information, see CloudWatch Anomaly Detection.

Parameters

-ClientConfig <AmazonCloudWatchConfig>
Amazon.PowerShell.Cmdlets.CW.AmazonCloudWatchClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Configuration_ExcludedTimeRange <Range[]>
An array of time ranges to exclude from use when the anomaly detection model is trained. Use this to make sure that events that could cause unusual values for the metric, such as deployments, aren't used when CloudWatch creates the model.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConfiguration_ExcludedTimeRanges
-Configuration_MetricTimezone <String>
The time zone to use for the metric. This is useful to enable the model to automatically account for daylight savings time changes if the metric is sensitive to such time changes.To specify a time zone, use the name of the time zone as specified in the standard tz database. For more information, see tz database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Dimension <Dimension[]>
The metric dimensions to create the anomaly detection model for.This parameter is deprecated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDimensions
-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)
-MetricMathAnomalyDetector_MetricDataQuery <MetricDataQuery[]>
An array of metric data query structures that enables you to create an anomaly detector based on the result of a metric math expression. Each item in MetricDataQueries gets a metric or performs a math expression. One item in MetricDataQueries is the expression that provides the time series that the anomaly detector uses as input. Designate the expression by setting ReturnData to true for this object in the array. For all other expressions and metrics, set ReturnData to false. The designated expression must return a single time series.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMetricMathAnomalyDetector_MetricDataQueries
-MetricName <String>
The name of the metric to create the anomaly detection model for.This parameter is deprecated.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Namespace <String>
The namespace of the metric to create the anomaly detection model for.This parameter is deprecated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the MetricName parameter. The -PassThru parameter is deprecated, use -Select '^MetricName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudWatch.Model.PutAnomalyDetectorResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SingleMetricAnomalyDetector_Dimension <Dimension[]>
The metric dimensions to create the anomaly detection model for.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSingleMetricAnomalyDetector_Dimensions
-SingleMetricAnomalyDetector_MetricName <String>
The name of the metric to create the anomaly detection model for.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SingleMetricAnomalyDetector_Namespace <String>
The namespace of the metric to create the anomaly detection model for.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SingleMetricAnomalyDetector_Stat <String>
The statistic to use for the metric and anomaly detection model.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Stat <String>
The statistic to use for the metric and the anomaly detection model.This parameter is deprecated.
Required?False
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

None or Amazon.CloudWatch.Model.PutAnomalyDetectorResponse
This cmdlet does not generate any output.The service response (type Amazon.CloudWatch.Model.PutAnomalyDetectorResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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