java.lang.Object
- software.amazon.awssdk.services.costexplorer.model.AnomalySubscription

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AnomalySubscription.Builder,AnomalySubscription>
```
@Generated("software.amazon.awssdk:codegen")
public final class AnomalySubscription
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AnomalySubscription.Builder,AnomalySubscription>
```
An AnomalySubscription resource (also referred to as an alert subscription) sends notifications about specific anomalies that meet an alerting criteria defined by you.

You can specify the frequency of the alerts and the subscribers to notify.

Anomaly subscriptions can be associated with one or more AnomalyMonitor resources, and they only send notifications about anomalies detected by those associated monitors. You can also configure a threshold to further control which anomalies are included in the notifications.

Anomalies that don’t exceed the chosen threshold and therefore don’t trigger notifications from an anomaly subscription will still be available on the console and from the GetAnomalies API.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AnomalySubscription.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`String`	`accountId()`	Your unique account identifier.
`static AnomalySubscription.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`AnomalySubscriptionFrequency`	`frequency()`	The frequency that anomaly notifications are sent.
`String`	`frequencyAsString()`	The frequency that anomaly notifications are sent.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasMonitorArnList()`	For responses, this returns true if the service returned a value for the MonitorArnList property.
`boolean`	`hasSubscribers()`	For responses, this returns true if the service returned a value for the Subscribers property.
`List<String>`	`monitorArnList()`	A list of cost anomaly monitors.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AnomalySubscription.Builder>`	`serializableBuilderClass()`
`List<Subscriber>`	`subscribers()`	A list of subscribers to notify.
`String`	`subscriptionArn()`	The `AnomalySubscription` Amazon Resource Name (ARN).
`String`	`subscriptionName()`	The name for the subscription.
`Double`	`threshold()`	Deprecated. Threshold has been deprecated in favor of ThresholdExpression
`Expression`	`thresholdExpression()`	An Expression object used to specify the anomalies that you want to generate alerts for.
`AnomalySubscription.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - subscriptionArn
```
public final String subscriptionArn()
```
    The AnomalySubscription Amazon Resource Name (ARN).
    
    Returns:
    
    The AnomalySubscription Amazon Resource Name (ARN).
  - accountId
```
public final String accountId()
```
    Your unique account identifier.
    
    Returns:
    
    Your unique account identifier.
  - hasMonitorArnList
```
public final boolean hasMonitorArnList()
```
    For responses, this returns true if the service returned a value for the MonitorArnList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - monitorArnList
```
public final List<String> monitorArnList()
```
    A list of cost anomaly monitors.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMonitorArnList() method.
    
    Returns:
    
    A list of cost anomaly monitors.
  - hasSubscribers
```
public final boolean hasSubscribers()
```
    For responses, this returns true if the service returned a value for the Subscribers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - subscribers
```
public final List<Subscriber> subscribers()
```
    A list of subscribers to notify.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSubscribers() method.
    
    Returns:
    
    A list of subscribers to notify.
  - threshold
```
@Deprecated
public final Double threshold()
```
    Deprecated.
    Threshold has been deprecated in favor of ThresholdExpression
    
    (deprecated)
    
    An absolute dollar value that must be exceeded by the anomaly's total impact (see Impact for more details) for an anomaly notification to be generated.
    
    This field has been deprecated. To specify a threshold, use ThresholdExpression. Continued use of Threshold will be treated as shorthand syntax for a ThresholdExpression.
    
    One of Threshold or ThresholdExpression is required for this resource. You cannot specify both.
    
    Returns:
    
    (deprecated)
    
    An absolute dollar value that must be exceeded by the anomaly's total impact (see Impact for more details) for an anomaly notification to be generated.
    
    This field has been deprecated. To specify a threshold, use ThresholdExpression. Continued use of Threshold will be treated as shorthand syntax for a ThresholdExpression.
    
    One of Threshold or ThresholdExpression is required for this resource. You cannot specify both.
  - frequency
```
public final AnomalySubscriptionFrequency frequency()
```
    The frequency that anomaly notifications are sent. Notifications are sent either over email (for DAILY and WEEKLY frequencies) or SNS (for IMMEDIATE frequency). For more information, see Creating an Amazon SNS topic for anomaly notifications.
    
    If the service returns an enum value that is not available in the current SDK version, frequency will return AnomalySubscriptionFrequency.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from frequencyAsString().
    
    Returns:
    
    The frequency that anomaly notifications are sent. Notifications are sent either over email (for DAILY and WEEKLY frequencies) or SNS (for IMMEDIATE frequency). For more information, see Creating an Amazon SNS topic for anomaly notifications.
    
    See Also:
    
    AnomalySubscriptionFrequency
  - frequencyAsString
```
public final String frequencyAsString()
```
    The frequency that anomaly notifications are sent. Notifications are sent either over email (for DAILY and WEEKLY frequencies) or SNS (for IMMEDIATE frequency). For more information, see Creating an Amazon SNS topic for anomaly notifications.
    
    If the service returns an enum value that is not available in the current SDK version, frequency will return AnomalySubscriptionFrequency.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from frequencyAsString().
    
    Returns:
    
    The frequency that anomaly notifications are sent. Notifications are sent either over email (for DAILY and WEEKLY frequencies) or SNS (for IMMEDIATE frequency). For more information, see Creating an Amazon SNS topic for anomaly notifications.
    
    See Also:
    
    AnomalySubscriptionFrequency
  - subscriptionName
```
public final String subscriptionName()
```
    The name for the subscription.
    
    Returns:
    
    The name for the subscription.
  - thresholdExpression
```
public final Expression thresholdExpression()
```
    An Expression object used to specify the anomalies that you want to generate alerts for. This supports dimensions and nested expressions. The supported dimensions are ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE, corresponding to an anomaly’s TotalImpact and TotalImpactPercentage, respectively (see Impact for more details). The supported nested expression types are AND and OR. The match option GREATER_THAN_OR_EQUAL is required. Values must be numbers between 0 and 10,000,000,000 in string format.
    
    One of Threshold or ThresholdExpression is required for this resource. You cannot specify both.
    
    The following are examples of valid ThresholdExpressions:
    
    Absolute threshold: { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }
    
    Percentage threshold: { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }
    
    AND two thresholds together: { "And": [ { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }, { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } } ] }
    
    OR two thresholds together: { "Or": [ { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }, { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } } ] }
    Returns:
    
    An Expression object used to specify the anomalies that you want to generate alerts for. This supports dimensions and nested expressions. The supported dimensions are ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE, corresponding to an anomaly’s TotalImpact and TotalImpactPercentage, respectively (see Impact for more details). The supported nested expression types are AND and OR. The match option GREATER_THAN_OR_EQUAL is required. Values must be numbers between 0 and 10,000,000,000 in string format.
    
    One of Threshold or ThresholdExpression is required for this resource. You cannot specify both.
    
    The following are examples of valid ThresholdExpressions:
    
    Absolute threshold: { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }
    
    Percentage threshold: { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }
    
    AND two thresholds together: { "And": [ { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }, { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } } ] }
    
    OR two thresholds together: { "Or": [ { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }, { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } } ] }
  - toBuilder
```
public AnomalySubscription.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AnomalySubscription.Builder,AnomalySubscription>
  - builder
```
public static AnomalySubscription.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AnomalySubscription.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class AnomalySubscription

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

subscriptionArn

accountId

hasMonitorArnList

monitorArnList

hasSubscribers

subscribers

threshold

frequency

frequencyAsString

subscriptionName

thresholdExpression

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields