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

Syntax

New-CWOMAlert
-Rule_TelemetryRule_Condition_Comparator <Comparator>
-Rule_TelemetryRule_Condition_CriticalThreshold <Double>
-Description <String>
-Rule_TelemetryRule_Query_Expression <String>
-Rule_TelemetryRule_Evaluation_IntervalSecond <Int32>
-Rule_TelemetryRule_Query_Language <QueryLanguage>
-Name <String>
-NotificationRule <NotificationRule[]>
-NotificationsEnabled <Boolean>
-Rule_TelemetryRule_Evaluation_PendingDurationSecond <Int32>
-ProfileId <String>
-Rule_TelemetryRule_Evaluation_RecoveryDurationSecond <Int32>
-SpaceId <String>
-Tag <Hashtable>
-Rule_TelemetryRule_Condition_ThresholdField <String>
-Rule_TelemetryRule_Condition_ThresholdMode <ThresholdMode>
-Rule_TelemetryRule_NoData_TreatAs <AlertState>
-Rule_TelemetryRule_Condition_WarningThreshold <Double>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonCloudWatchOmniConfig>

Description

Creates a new alert within a space. Use GetAlert and ListAlerts to retrieve alerts, UpdateAlert to modify one, and DeleteAlert to remove it.

Parameters

-ClientConfig <AmazonCloudWatchOmniConfig>
Amazon.PowerShell.Cmdlets.CWOM.AmazonCloudWatchOmniClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
Idempotency token for safe retries. Retrying with the same token within the idempotency window returns the original alert instead of creating a duplicate.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
An optional description of the alert.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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)
-Name <String>
Alert name, for display. Max 256 (the AlarmName budget). Not the alert's identity: the backend mints a separate uuid as the {@link AlertId}, so the name need not be unique within a space and addressing an alert never depends on it. UpdateAlert accepts a new name to rename the alert.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-NotificationRule <NotificationRule[]>
The notification rules that determine when and where notifications are sent. 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)
AliasesNotificationRules
-NotificationsEnabled <Boolean>
Whether actions (notifications) are enabled for this alert. Defaults to true when omitted.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ProfileId <String>
The ID of the access profile the alert uses to evaluate its query and execute notifications. The caller supplies it: there is no managed alert profile, and the service does not pick one on the caller's behalf.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Rule_TelemetryRule_Condition_Comparator <Comparator>
The comparison operator applied to the threshold.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Rule_TelemetryRule_Condition_CriticalThreshold <Double>
The value at which the alert enters the CRITICAL state.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Rule_TelemetryRule_Condition_ThresholdField <String>
The field the threshold is evaluated against.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Rule_TelemetryRule_Condition_ThresholdMode <ThresholdMode>
How the threshold is applied to query results.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Rule_TelemetryRule_Condition_WarningThreshold <Double>
The value at which the alert enters the WARNING state.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Rule_TelemetryRule_Evaluation_IntervalSecond <Int32>
The interval between evaluations, in seconds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRule_TelemetryRule_Evaluation_IntervalSeconds
-Rule_TelemetryRule_Evaluation_PendingDurationSecond <Int32>
The duration a breach must persist before the alert fires, in seconds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRule_TelemetryRule_Evaluation_PendingDurationSeconds
-Rule_TelemetryRule_Evaluation_RecoveryDurationSecond <Int32>
The duration a recovery must persist before the alert clears, in seconds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRule_TelemetryRule_Evaluation_RecoveryDurationSeconds
-Rule_TelemetryRule_NoData_TreatAs <AlertState>
The state to report when an evaluation produces no data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Rule_TelemetryRule_Query_Expression <String>
The query expression to evaluate.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Rule_TelemetryRule_Query_Language <QueryLanguage>
The query language of the expression.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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.CloudWatchOmni.Model.CreateAlertResponse). Specifying the name of a property of type Amazon.CloudWatchOmni.Model.CreateAlertResponse 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)
-SpaceId <String>
The unique ID of the space to create the alert in.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
The tags to associate with the alert. 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)
AliasesTags

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.CloudWatchOmni.Model.CreateAlertResponse
This cmdlet returns an Amazon.CloudWatchOmni.Model.CreateAlertResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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