DescribeBudgetsResponse

{
  "$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-describe-budgets-response-schema.json",
  "title": "DescribeBudgetsResponse",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-billing-and-cost-management-budgets-api-openapi.yml#/components/schemas/DescribeBudgetsResponse",
  "type": "object",
  "properties": {
    "Budgets": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Budget"
      },
      "description": "A list of budgets."
    },
    "NextToken": {
      "type": "string",
      "description": "The pagination token in the service response that indicates the next set of results that you can retrieve."
    }
  },
  "$defs": {
    "AutoAdjustData": {
      "type": "object",
      "properties": {
        "AutoAdjustType": {
          "type": "string",
          "enum": [
            "HISTORICAL",
            "FORECAST"
          ],
          "description": "The string that defines whether your budget auto-adjusts based on historical or forecasted data."
        },
        "HistoricalOptions": {
          "$ref": "#/$defs/HistoricalOptions"
        },
        "LastAutoAdjustTime": {
          "type": "string",
          "format": "date-time",
          "description": "The last time that your budget was auto-adjusted."
        }
      },
      "required": [
        "AutoAdjustType"
      ]
    },
    "Budget": {
      "type": "object",
      "properties": {
        "BudgetName": {
          "type": "string",
          "description": "The name of a budget. The name must be unique within an account. The : and \\ characters, and the \"/action/\" substring, aren't allowed in BudgetName. Budget names are validated for content. Names that contain phone numbers, URLs, or email addresses combined with certain terms may be rejected."
        },
        "BudgetLimit": {
          "$ref": "#/$defs/Spend"
        },
        "PlannedBudgetLimits": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/$defs/Spend"
          },
          "description": "A map containing multiple BudgetLimit, including current or future limits. PlannedBudgetLimits is available for cost or usage budget and supports both monthly and quarterly TimeUnit. For monthly budgets, provide 12 months of PlannedBudgetLimits values. This must start from the current month and include the next 11 months. The key is the start of the month, UTC in epoch seconds. For quarterly budgets, provide four quarters of PlannedBudgetLimits value entries in standard calendar quarter increments. This must start from the current quarter and include the next three quarters. The key is the sta"
        },
        "CostFilters": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "description": "The cost filters, such as Region, Service, LinkedAccount, Tag, or CostCategory, that are applied to a budget. Amazon Web Services Budgets supports the following services as a Service filter for RI budgets: Amazon EC2 Amazon Redshift Amazon Relational Database Service Amazon ElastiCache Amazon OpenSearch Service"
        },
        "CostTypes": {
          "$ref": "#/$defs/CostTypes"
        },
        "TimeUnit": {
          "type": "string",
          "enum": [
            "DAILY",
            "MONTHLY",
            "QUARTERLY",
            "ANNUALLY",
            "CUSTOM"
          ],
          "description": "The length of time until a budget resets the actual and forecasted spend."
        },
        "TimePeriod": {
          "$ref": "#/$defs/TimePeriod"
        },
        "CalculatedSpend": {
          "$ref": "#/$defs/CalculatedSpend"
        },
        "BudgetType": {
          "type": "string",
          "enum": [
            "USAGE",
            "COST",
            "RI_UTILIZATION",
            "RI_COVERAGE",
            "SAVINGS_PLANS_UTILIZATION",
            "SAVINGS_PLANS_COVERAGE"
          ],
          "description": "Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage."
        },
        "LastUpdatedTime": {
          "type": "string",
          "format": "date-time",
          "description": "The last time that you updated this budget."
        },
        "AutoAdjustData": {
          "$ref": "#/$defs/AutoAdjustData"
        },
        "FilterExpression": {
          "$ref": "#/$defs/BudgetsExpression"
        },
        "Metrics": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "BlendedCost",
              "UnblendedCost",
              "AmortizedCost",
              "NetUnblendedCost",
              "NetAmortizedCost",
              "UsageQuantity",
              "NormalizedUsageAmount",
              "Hours"
            ]
          },
          "description": "The definition for how the budget data is aggregated."
        },
        "BillingViewArn": {
          "type": "string",
          "description": "The Amazon Resource Name (ARN) that uniquely identifies a specific billing view. The ARN is used to specify which particular billing view you want to interact with or retrieve information from when making API calls related to Amazon Web Services Billing and Cost Management features. The BillingViewArn can be retrieved by calling the ListBillingViews API."
        },
        "HealthStatus": {
          "$ref": "#/$defs/HealthStatus"
        }
      },
      "required": [
        "BudgetName",
        "TimeUnit",
        "BudgetType"
      ]
    },
    "BudgetsCostCategoryValues": {
      "type": "object",
      "properties": {
        "Key": {
          "type": "string",
          "description": "The unique name of the cost category."
        },
        "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",
              "GREATER_THAN_OR_EQUAL",
              "CASE_SENSITIVE",
              "CASE_INSENSITIVE"
            ]
          },
          "description": "The match options that you can use to filter your results."
        }
      }
    },
    "BudgetsExpression": {
      "type": "object",
      "properties": {
        "Or": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/BudgetsExpression"
          },
          "description": "Return results that match either Dimension object."
        },
        "And": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/BudgetsExpression"
          },
          "description": "Return results that match both Dimension objects."
        },
        "Not": {
          "$ref": "#/$defs/BudgetsExpression"
        },
        "Dimensions": {
          "$ref": "#/$defs/ExpressionDimensionValues"
        },
        "Tags": {
          "$ref": "#/$defs/BudgetsTagValues"
        },
        "CostCategories": {
          "$ref": "#/$defs/BudgetsCostCategoryValues"
        },
        "ProductAttributes": {
          "$ref": "#/$defs/BudgetsProductAttributeValues"
        }
      }
    },
    "BudgetsProductAttributeValues": {
      "type": "object",
      "properties": {
        "Key": {
          "type": "string",
          "description": "The name of the product attribute to filter on. Valid values are the following: feature – The feature that was used, such as On-demand Inference. inferenceType – The type of inference usage, such as Input tokens or Output tokens. model – The model, such as Claude Sonnet 5 or Claude Haiku 4.5. provider – The model provider, such as Anthropic, Cohere, or Amazon. Keys are case-sensitive."
        },
        "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. Values is required unless MatchOptions is ABSENT. To match costs that have no value for the key, set MatchOptions to ABSENT and omit Values."
        },
        "MatchOptions": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "EQUALS",
              "ABSENT",
              "STARTS_WITH",
              "ENDS_WITH",
              "CONTAINS",
              "GREATER_THAN_OR_EQUAL",
              "CASE_SENSITIVE",
              "CASE_INSENSITIVE"
            ]
          },
          "description": "The match options for the ProductAttributes filter. Valid values: ABSENT – Matches costs that have no value for the attribute. CASE_SENSITIVE – Requires an exact case match. EQUALS – Matches costs where the attribute equals the specified value. Specify either EQUALS or ABSENT. You can add CASE_SENSITIVE to EQUALS, but you can't use it by itself or with ABSENT."
        }
      },
      "required": [
        "Key"
      ]
    },
    "BudgetsTagValues": {
      "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",
              "GREATER_THAN_OR_EQUAL",
              "CASE_SENSITIVE",
              "CASE_INSENSITIVE"
            ]
          },
          "description": "The match options that you can use to filter your results."
        }
      }
    },
    "CalculatedSpend": {
      "type": "object",
      "properties": {
        "ActualSpend": {
          "$ref": "#/$defs/Spend"
        },
        "ForecastedSpend": {
          "$ref": "#/$defs/Spend"
        }
      },
      "required": [
        "ActualSpend"
      ]
    },
    "CostTypes": {
      "type": "object",
      "properties": {
        "IncludeTax": {
          "type": "boolean",
          "description": "Specifies whether a budget includes taxes. The default value is true."
        },
        "IncludeSubscription": {
          "type": "boolean",
          "description": "Specifies whether a budget includes subscriptions. The default value is true."
        },
        "UseBlended": {
          "type": "boolean",
          "description": "Specifies whether a budget uses a blended rate. The default value is false."
        },
        "IncludeRefund": {
          "type": "boolean",
          "description": "Specifies whether a budget includes refunds. The default value is true."
        },
        "IncludeCredit": {
          "type": "boolean",
          "description": "Specifies whether a budget includes credits. The default value is true."
        },
        "IncludeUpfront": {
          "type": "boolean",
          "description": "Specifies whether a budget includes upfront RI costs. The default value is true."
        },
        "IncludeRecurring": {
          "type": "boolean",
          "description": "Specifies whether a budget includes recurring fees such as monthly RI fees. The default value is true."
        },
        "IncludeOtherSubscription": {
          "type": "boolean",
          "description": "Specifies whether a budget includes non-RI subscription costs. The default value is true."
        },
        "IncludeSupport": {
          "type": "boolean",
          "description": "Specifies whether a budget includes support subscription fees. The default value is true."
        },
        "IncludeDiscount": {
          "type": "boolean",
          "description": "Specifies whether a budget includes discounts. The default value is true."
        },
        "UseAmortized": {
          "type": "boolean",
          "description": "Specifies whether a budget uses the amortized rate. The default value is false."
        }
      }
    },
    "ExpressionDimensionValues": {
      "type": "object",
      "properties": {
        "Key": {
          "type": "string",
          "enum": [
            "AZ",
            "INSTANCE_TYPE",
            "LINKED_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",
            "INVOICING_ENTITY",
            "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",
            "RESERVATION_MODIFIED",
            "TAG_KEY",
            "COST_CATEGORY_NAME"
          ],
          "description": "The name of the dimension that you want to filter on."
        },
        "Values": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The metadata values you can specify to filter upon, so that the results all match at least one of the specified values."
        },
        "MatchOptions": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "EQUALS",
              "ABSENT",
              "STARTS_WITH",
              "ENDS_WITH",
              "CONTAINS",
              "GREATER_THAN_OR_EQUAL",
              "CASE_SENSITIVE",
              "CASE_INSENSITIVE"
            ]
          },
          "description": "The match options that you can use to filter your results. You can specify only one of these values in the array."
        }
      },
      "required": [
        "Key",
        "Values"
      ]
    },
    "HealthStatus": {
      "type": "object",
      "properties": {
        "Status": {
          "type": "string",
          "enum": [
            "HEALTHY",
            "UNHEALTHY"
          ],
          "description": "The current status of the billing view resource."
        },
        "StatusReason": {
          "type": "string",
          "enum": [
            "BILLING_VIEW_NO_ACCESS",
            "BILLING_VIEW_UNHEALTHY",
            "FILTER_INVALID",
            "MULTI_YEAR_HISTORICAL_DATA_DISABLED"
          ],
          "description": "The reason for the current status. BILLING_VIEW_NO_ACCESS: The billing view resource does not grant billing:GetBillingViewData permission to this account. BILLING_VIEW_UNHEALTHY: The billing view associated with the budget is unhealthy. FILTER_INVALID: The filter contains reference to an account you do not have access to. MULTI_YEAR_HISTORICAL_DATA_DISABLED: The budget is not being updated. Enable multi-year historical data in your Cost Management preferences."
        },
        "LastUpdatedTime": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "HistoricalOptions": {
      "type": "object",
      "properties": {
        "BudgetAdjustmentPeriod": {
          "type": "integer",
          "description": "The number of budget periods included in the moving-average calculation that determines your auto-adjusted budget amount. The maximum value depends on the TimeUnit granularity of the budget: For the DAILY granularity, the maximum value is 60. For the MONTHLY granularity, the maximum value is 12. For the QUARTERLY granularity, the maximum value is 4. For the ANNUALLY granularity, the maximum value is 1."
        },
        "LookBackAvailablePeriods": {
          "type": "integer",
          "description": "The integer that describes how many budget periods in your BudgetAdjustmentPeriod are included in the calculation of your current BudgetLimit. If the first budget period in your BudgetAdjustmentPeriod has no cost data, then that budget period isn’t included in the average that determines your budget limit. For example, if you set BudgetAdjustmentPeriod as 4 quarters, but your account had no cost data in the first quarter, then only the last three quarters are included in the calculation. In this scenario, LookBackAvailablePeriods returns 3. You can’t set your own LookBackAvailablePeriods. The "
        }
      },
      "required": [
        "BudgetAdjustmentPeriod"
      ]
    },
    "Spend": {
      "type": "object",
      "properties": {
        "Amount": {
          "type": "string",
          "description": "The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold."
        },
        "Unit": {
          "type": "string",
          "description": "The unit of measurement that's used for the budget forecast, actual spend, or budget threshold."
        }
      },
      "required": [
        "Amount",
        "Unit"
      ]
    },
    "TimePeriod": {
      "type": "object",
      "properties": {
        "Start": {
          "type": "string",
          "format": "date-time",
          "description": "The start date for a budget. If you created your budget and didn't specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, ANNUALLY, or CUSTOM). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, Amazon Web Services set your start date to 01/01/18 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API. You can change your start date with the UpdateBudget opera"
        },
        "End": {
          "type": "string",
          "format": "date-time",
          "description": "The end date for a budget. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API. After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers. You can change your end date with the UpdateBudget operation."
        }
      }
    }
  }
}