[ aws . ce ]

create-anomaly-subscription

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-anomaly-subscription
--anomaly-subscription <value>
[--resource-tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--anomaly-subscription (structure)

The cost anomaly subscription object that you want to create.

SubscriptionArn -> (string)

The AnomalySubscription Amazon Resource Name (ARN).

AccountId -> (string)

Your unique account identifier.

MonitorArnList -> (list)

A list of cost anomaly monitors.

(string)

Subscribers -> (list)

A list of subscribers to notify.

(structure)

The recipient of AnomalySubscription notifications.

Address -> (string)

The email address or SNS Amazon Resource Name (ARN). This depends on the Type .

Type -> (string)

The notification delivery channel.

Status -> (string)

Indicates if the subscriber accepts the notifications.

Threshold -> (double)

The dollar value that triggers a notification if the threshold is exceeded.

Frequency -> (string)

The frequency that anomaly reports are sent over email.

SubscriptionName -> (string)

The name for the subscription.

Shorthand Syntax:

SubscriptionArn=string,AccountId=string,MonitorArnList=string,string,Subscribers=[{Address=string,Type=string,Status=string},{Address=string,Type=string,Status=string}],Threshold=double,Frequency=string,SubscriptionName=string

JSON Syntax:

{
  "SubscriptionArn": "string",
  "AccountId": "string",
  "MonitorArnList": ["string", ...],
  "Subscribers": [
    {
      "Address": "string",
      "Type": "EMAIL"|"SNS",
      "Status": "CONFIRMED"|"DECLINED"
    }
    ...
  ],
  "Threshold": double,
  "Frequency": "DAILY"|"IMMEDIATE"|"WEEKLY",
  "SubscriptionName": "string"
}

--resource-tags (list)

An optional list of tags to associate with the specified ` AnomalySubscription https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html`__ . 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

(structure)

The tag structure that contains a tag key and value.

Note

Tagging is supported only for the following Cost Explorer resource types: ` AnomalyMonitor https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalyMonitor.html`__ , ` AnomalySubscription https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AnomalySubscription.html`__ , ` CostCategory https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategory.html`__ .

Key -> (string)

The key that’s associated with the tag.

Value -> (string)

The value that’s associated with the tag.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

SubscriptionArn -> (string)

The unique identifier of your newly created cost anomaly subscription.