CreateAnomalySubscriptionRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-billing-and-cost-management/json-schema/amazon-billing-and-cost-management-create-anomaly-subscription-request-schema.json",
  "title": "CreateAnomalySubscriptionRequest",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-billing-and-cost-management-anomaly-detection-api-openapi.yml#/components/schemas/CreateAnomalySubscriptionRequest",
  "type": "object",
  "properties": {
    "AnomalySubscription": {
      "$ref": "#/$defs/AnomalySubscription"
    },
    "ResourceTags": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ResourceTag"
      },
      "description": "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 alphan"
    }
  },
  "required": [
    "AnomalySubscription"
  ],
  "$defs": {
    "AnomalySubscription": {
      "type": "object",
      "properties": {
        "SubscriptionArn": {
          "type": "string",
          "description": "The AnomalySubscription Amazon Resource Name (ARN)."
        },
        "AccountId": {
          "type": "string",
          "description": "Your unique account identifier."
        },
        "MonitorArnList": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "A list of cost anomaly monitors."
        },
        "Subscribers": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Subscriber"
          },
          "description": "A list of subscribers to notify."
        },
        "Threshold": {
          "type": "number",
          "description": "(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": {
          "type": "string",
          "enum": [
            "DAILY",
            "IMMEDIATE",
            "WEEKLY"
          ],
          "description": "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."
        },
        "SubscriptionName": {
          "type": "string",
          "description": "The name for the subscription."
        },
        "ThresholdExpression": {
          "$ref": "#/$defs/Expression"
        }
      },
      "required": [
        "MonitorArnList",
        "Subscribers",
        "Frequency",
        "SubscriptionName"
      ]
    },
    "CostCategoryValues": {
      "type": "object",
      "properties": {
        "Key": {
          "type": "string"
        },
        "Values": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The specific value of the cost category."
        },
        "MatchOptions": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "EQUALS",
              "ABSENT",
              "STARTS_WITH",
              "ENDS_WITH",
              "CONTAINS",
              "CASE_SENSITIVE",
              "CASE_INSENSITIVE",
              "GREATER_THAN_OR_EQUAL"
            ]
          },
          "description": "The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE."
        }
      }
    },
    "DimensionValues": {
      "type": "object",
      "properties": {
        "Key": {
          "type": "string",
          "enum": [
            "AZ",
            "INSTANCE_TYPE",
            "LINKED_ACCOUNT",
            "PAYER_ACCOUNT",
            "LINKED_ACCOUNT_NAME",
            "OPERATION",
            "PURCHASE_TYPE",
            "REGION",
            "SERVICE",
            "SERVICE_CODE",
            "USAGE_TYPE",
            "USAGE_TYPE_GROUP",
            "RECORD_TYPE",
            "OPERATING_SYSTEM",
            "TENANCY",
            "SCOPE",
            "PLATFORM",
            "SUBSCRIPTION_ID",
            "LEGAL_ENTITY_NAME",
            "DEPLOYMENT_OPTION",
            "DATABASE_ENGINE",
            "CACHE_ENGINE",
            "INSTANCE_TYPE_FAMILY",
            "BILLING_ENTITY",
            "RESERVATION_ID",
            "RESOURCE_ID",
            "RIGHTSIZING_TYPE",
            "SAVINGS_PLANS_TYPE",
            "SAVINGS_PLAN_ARN",
            "PAYMENT_OPTION",
            "AGREEMENT_END_DATE_TIME_AFTER",
            "AGREEMENT_END_DATE_TIME_BEFORE",
            "INVOICING_ENTITY",
            "ANOMALY_TOTAL_IMPACT_ABSOLUTE",
            "ANOMALY_TOTAL_IMPACT_PERCENTAGE",
            "PRODUCT_ATTRIBUTE"
          ],
          "description": "The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones. Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported. LINKED_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule. ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions. Use PRODUCT_ATTRIBUTE only as the Dimension in GetDimensionValues. To filter or group by product attributes, use the ProductAttributes field of Expression or t"
        },
        "Values": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values."
        },
        "MatchOptions": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "EQUALS",
              "ABSENT",
              "STARTS_WITH",
              "ENDS_WITH",
              "CONTAINS",
              "CASE_SENSITIVE",
              "CASE_INSENSITIVE",
              "GREATER_THAN_OR_EQUAL"
            ]
          },
          "description": "The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported. The default values for MatchOptions are EQUALS and CASE_SENSITIVE."
        }
      }
    },
    "Expression": {
      "type": "object",
      "properties": {
        "Or": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Expression"
          },
          "description": "Return results that match either Dimension object."
        },
        "And": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Expression"
          },
          "description": "Return results that match both Dimension objects."
        },
        "Not": {
          "$ref": "#/$defs/Expression"
        },
        "Dimensions": {
          "$ref": "#/$defs/DimensionValues"
        },
        "Tags": {
          "$ref": "#/$defs/TagValues"
        },
        "CostCategories": {
          "$ref": "#/$defs/CostCategoryValues"
        },
        "ProductAttributes": {
          "$ref": "#/$defs/ProductAttributeValues"
        }
      }
    },
    "ProductAttributeValues": {
      "type": "object",
      "properties": {
        "Key": {
          "type": "string",
          "description": "The name of the product attribute, such as model. The keys that are available depend on the service. For the keys of each supported service, see ProductAttributeValues . Keys are case-sensitive. A key that doesn't exist doesn't return an error: EQUALS matches no costs, and ABSENT matches all costs of supported services."
        },
        "Values": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The specific values of the product attribute, such as Claude Sonnet 5 for the model key. Values are matched exactly, including case. To list the values of a key, use GetDimensionValues with Dimension set to PRODUCT_ATTRIBUTE and DimensionKey set to the key. To match costs that have no value for the key, set MatchOptions to ABSENT and omit Values. Otherwise, Values is required."
        },
        "MatchOptions": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "EQUALS",
              "ABSENT",
              "STARTS_WITH",
              "ENDS_WITH",
              "CONTAINS",
              "CASE_SENSITIVE",
              "CASE_INSENSITIVE",
              "GREATER_THAN_OR_EQUAL"
            ]
          },
          "description": "The match options that you can use to filter your results. Valid values: EQUALS - Matches the values that you specify. ABSENT - Matches costs that have no value for the key. Omit Values. CASE_SENSITIVE - Use only with EQUALS. Values are always matched case-sensitively. Default values are EQUALS and CASE_SENSITIVE."
        }
      },
      "required": [
        "Key"
      ]
    },
    "ResourceTag": {
      "type": "object",
      "properties": {
        "Key": {
          "type": "string",
          "description": "The key that's associated with the tag."
        },
        "Value": {
          "type": "string",
          "description": "The value that's associated with the tag."
        }
      },
      "required": [
        "Key",
        "Value"
      ]
    },
    "Subscriber": {
      "type": "object",
      "properties": {
        "Address": {
          "type": "string",
          "description": "The email address or SNS Amazon Resource Name (ARN). This depends on the Type."
        },
        "Type": {
          "type": "string",
          "enum": [
            "EMAIL",
            "SNS"
          ],
          "description": "The notification delivery channel."
        },
        "Status": {
          "type": "string",
          "enum": [
            "CONFIRMED",
            "DECLINED"
          ],
          "description": "Indicates if the subscriber accepts the notifications."
        }
      }
    },
    "TagValues": {
      "type": "object",
      "properties": {
        "Key": {
          "type": "string",
          "description": "The key for the tag."
        },
        "Values": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The specific value of the tag."
        },
        "MatchOptions": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "EQUALS",
              "ABSENT",
              "STARTS_WITH",
              "ENDS_WITH",
              "CONTAINS",
              "CASE_SENSITIVE",
              "CASE_INSENSITIVE",
              "GREATER_THAN_OR_EQUAL"
            ]
          },
          "description": "The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE."
        }
      }
    }
  }
}