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 AWS Cost Explorer CreateAnomalyMonitor API operation.

Syntax

New-CEAnomalyMonitor
-AnomalyMonitor_CreationDate <String>
-AnomalyMonitor_DimensionalValueCount <Int32>
-AnomalyMonitor_LastEvaluatedDate <String>
-AnomalyMonitor_LastUpdatedDate <String>
-AnomalyMonitor_MonitorArn <String>
-AnomalyMonitor_MonitorDimension <MonitorDimension>
-AnomalyMonitor_MonitorName <String>
-AnomalyMonitor_MonitorSpecification <Expression>
-AnomalyMonitor_MonitorType <MonitorType>
-ResourceTag <ResourceTag[]>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonCostExplorerConfig>

Description

Creates a new cost anomaly detection monitor with the requested type and monitor specification.

Parameters

-AnomalyMonitor_CreationDate <String>
The date when the monitor was created.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AnomalyMonitor_DimensionalValueCount <Int32>
The value for evaluated dimensions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AnomalyMonitor_LastEvaluatedDate <String>
The date when the monitor last evaluated for anomalies.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AnomalyMonitor_LastUpdatedDate <String>
The date when the monitor was last updated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AnomalyMonitor_MonitorArn <String>
The Amazon Resource Name (ARN) value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AnomalyMonitor_MonitorDimension <MonitorDimension>
For customer managed monitors, do not specify this field.For Amazon Web Services managed monitors, this field controls which cost dimension is automatically analyzed by the monitor. For TAG and COST_CATEGORY dimensions, you must also specify MonitorSpecification to configure the specific tag or cost category key to analyze.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AnomalyMonitor_MonitorName <String>
The name of the monitor.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-AnomalyMonitor_MonitorSpecification <Expression>
An Expression object used to control what costs the monitor analyzes for anomalies.For Amazon Web Services managed monitors:
  • If MonitorDimension is SERVICE or LINKED_ACCOUNT, do not specify this field
  • If MonitorDimension is TAG, set this field to { "Tags": { "Key": "your tag key" } }
  • If MonitorDimension is COST_CATEGORY, set this field to { "CostCategories": { "Key": "your cost category key" } }
For customer managed monitors:
  • To track linked accounts, set this field to { "Dimensions": { "Key": "LINKED_ACCOUNT", "Values": [ "your list of up to 10 account IDs" ] } }
  • To track cost allocation tags, set this field to { "Tags": { "Key": "your tag key", "Values": [ "your list of up to 10 tag values" ] } }
  • To track cost categories, set this field to{ "CostCategories": { "Key": "your cost category key", "Values": [ "your cost category value" ] } }
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AnomalyMonitor_MonitorType <MonitorType>
The type of the monitor. Set this to DIMENSIONAL for an Amazon Web Services managed monitor. Amazon Web Services managed monitors automatically track up to the top 5,000 values by cost within a dimension of your choosing. Each dimension value is evaluated independently. If you start incurring cost in a new value of your chosen dimension, it will automatically be analyzed by an Amazon Web Services managed monitor.Set this to CUSTOM for a customer managed monitor. Customer managed monitors let you select specific dimension values that get monitored in aggregate. For more information about monitor types, see Monitor types in the Billing and Cost Management User Guide.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonCostExplorerConfig>
Amazon.PowerShell.Cmdlets.CE.AmazonCostExplorerClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
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)
-ResourceTag <ResourceTag[]>
An optional list of tags to associate with the specified AnomalyMonitor. You can use resource tags to control access to your monitor using IAM policies.Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:
  • Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use
  • The maximum length of a key is 128 characters
  • The maximum length of a value is 256 characters
  • Keys and values can only contain alphanumeric characters, spaces, and any of the following: _.:/=+@-
  • Keys and values are case sensitive
  • Keys and values are trimmed for any leading or trailing whitespaces
  • Don’t use aws: as a prefix for your keys. This prefix is reserved for Amazon Web Services use
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)
AliasesResourceTags
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'MonitorArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CostExplorer.Model.CreateAnomalyMonitorResponse). Specifying the name of a property of type Amazon.CostExplorer.Model.CreateAnomalyMonitorResponse 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)

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

This cmdlet returns a System.String object. The service call response (type Amazon.CostExplorer.Model.CreateAnomalyMonitorResponse) can be returned by specifying '-Select *'.

Supported Version

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