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 CreateAnomalySubscription API operation.

Syntax

New-CEAnomalySubscription
-AnomalySubscription_AccountId <String>
-AnomalySubscription_Frequency <AnomalySubscriptionFrequency>
-AnomalySubscription_MonitorArnList <String[]>
-ResourceTag <ResourceTag[]>
-AnomalySubscription_Subscriber <Subscriber[]>
-AnomalySubscription_SubscriptionArn <String>
-AnomalySubscription_SubscriptionName <String>
-AnomalySubscription_Threshold <Double>
-Select <String>
-Force <SwitchParameter>

Description

Adds a subscription to a cost anomaly detection monitor. You can use each subscription to define subscribers with email or SNS notifications. Email subscribers can set a dollar threshold and a time frequency for receiving notifications.

Parameters

-AnomalySubscription_AccountId <String>
Your unique account identifier.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AnomalySubscription_Frequency <AnomalySubscriptionFrequency>
The frequency that anomaly reports are sent over email.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-AnomalySubscription_MonitorArnList <String[]>
A list of cost anomaly monitors.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-AnomalySubscription_Subscriber <Subscriber[]>
A list of subscribers to notify.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAnomalySubscription_Subscribers
-AnomalySubscription_SubscriptionArn <String>
The AnomalySubscription Amazon Resource Name (ARN).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AnomalySubscription_SubscriptionName <String>
The name for the subscription.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-AnomalySubscription_Threshold <Double>
The dollar value that triggers a notification if the threshold is exceeded.
Required?True
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 AnomalySubscription. You can use resource tags to control access to your subscription 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
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 'SubscriptionArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CostExplorer.Model.CreateAnomalySubscriptionResponse). Specifying the name of a property of type Amazon.CostExplorer.Model.CreateAnomalySubscriptionResponse 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.CreateAnomalySubscriptionResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

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