{ "version": "2.0", "metadata": { "apiVersion": "2016-10-20", "endpointPrefix": "budgets", "jsonVersion": "1.1", "protocol": "json", "protocols": [ "json" ], "serviceAbbreviation": "AWSBudgets", "serviceFullName": "AWS Budgets", "serviceId": "Budgets", "signatureVersion": "v4", "targetPrefix": "AWSBudgetServiceGateway", "uid": "budgets-2016-10-20" }, "operations": { "CreateBudget": { "name": "CreateBudget", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateBudgetRequest" }, "output": { "shape": "CreateBudgetResponse" }, "errors": [ { "shape": "InvalidParameterException" }, { "shape": "InternalErrorException" }, { "shape": "CreationLimitExceededException" }, { "shape": "DuplicateRecordException" }, { "shape": "AccessDeniedException" }, { "shape": "ThrottlingException" }, { "shape": "ServiceQuotaExceededException" } ], "documentation": "

Creates a budget and, if included, notifications and subscribers.

Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

" }, "CreateBudgetAction": { "name": "CreateBudgetAction", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateBudgetActionRequest" }, "output": { "shape": "CreateBudgetActionResponse" }, "errors": [ { "shape": "InvalidParameterException" }, { "shape": "InternalErrorException" }, { "shape": "CreationLimitExceededException" }, { "shape": "DuplicateRecordException" }, { "shape": "NotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ThrottlingException" }, { "shape": "ServiceQuotaExceededException" } ], "documentation": "

Creates a budget action.

" }, "CreateNotification": { "name": "CreateNotification", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateNotificationRequest" }, "output": { "shape": "CreateNotificationResponse" }, "errors": [ { "shape": "InternalErrorException" }, { "shape": "InvalidParameterException" }, { "shape": "NotFoundException" }, { "shape": "CreationLimitExceededException" }, { "shape": "DuplicateRecordException" }, { "shape": "AccessDeniedException" }, { "shape": "ThrottlingException" } ], "documentation": "

Creates a notification. You must create the budget before you create the associated notification.

" }, "CreateSubscriber": { "name": "CreateSubscriber", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "CreateSubscriberRequest" }, "output": { "shape": "CreateSubscriberResponse" }, "errors": [ { "shape": "InternalErrorException" }, { "shape": "InvalidParameterException" }, { "shape": "CreationLimitExceededException" }, { "shape": "DuplicateRecordException" }, { "shape": "NotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ThrottlingException" } ], "documentation": "

Creates a subscriber. You must create the associated budget and notification before you create the subscriber.

" }, "DeleteBudget": { "name": "DeleteBudget", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteBudgetRequest" }, "output": { "shape": "DeleteBudgetResponse" }, "errors": [ { "shape": "InternalErrorException" }, { "shape": "InvalidParameterException" }, { "shape": "NotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ThrottlingException" } ], "documentation": "

Deletes a budget. You can delete your budget at any time.

Deleting a budget also deletes the notifications and subscribers that are associated with that budget.

" }, "DeleteBudgetAction": { "name": "DeleteBudgetAction", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteBudgetActionRequest" }, "output": { "shape": "DeleteBudgetActionResponse" }, "errors": [ { "shape": "InternalErrorException" }, { "shape": "InvalidParameterException" }, { "shape": "NotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ResourceLockedException" }, { "shape": "ThrottlingException" } ], "documentation": "

Deletes a budget action.

" }, "DeleteNotification": { "name": "DeleteNotification", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteNotificationRequest" }, "output": { "shape": "DeleteNotificationResponse" }, "errors": [ { "shape": "InvalidParameterException" }, { "shape": "InternalErrorException" }, { "shape": "NotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ThrottlingException" } ], "documentation": "

Deletes a notification.

Deleting a notification also deletes the subscribers that are associated with the notification.

" }, "DeleteSubscriber": { "name": "DeleteSubscriber", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteSubscriberRequest" }, "output": { "shape": "DeleteSubscriberResponse" }, "errors": [ { "shape": "InternalErrorException" }, { "shape": "InvalidParameterException" }, { "shape": "NotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ThrottlingException" } ], "documentation": "

Deletes a subscriber.

Deleting the last subscriber to a notification also deletes the notification.

" }, "DescribeBudget": { "name": "DescribeBudget", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeBudgetRequest" }, "output": { "shape": "DescribeBudgetResponse" }, "errors": [ { "shape": "InternalErrorException" }, { "shape": "InvalidParameterException" }, { "shape": "NotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ThrottlingException" } ], "documentation": "

Describes a budget.

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

" }, "DescribeBudgetAction": { "name": "DescribeBudgetAction", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeBudgetActionRequest" }, "output": { "shape": "DescribeBudgetActionResponse" }, "errors": [ { "shape": "InternalErrorException" }, { "shape": "InvalidParameterException" }, { "shape": "NotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ThrottlingException" } ], "documentation": "

Describes a budget action detail.

" }, "DescribeBudgetActionHistories": { "name": "DescribeBudgetActionHistories", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeBudgetActionHistoriesRequest" }, "output": { "shape": "DescribeBudgetActionHistoriesResponse" }, "errors": [ { "shape": "InternalErrorException" }, { "shape": "InvalidParameterException" }, { "shape": "NotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "InvalidNextTokenException" }, { "shape": "ThrottlingException" } ], "documentation": "

Describes a budget action history detail.

" }, "DescribeBudgetActionsForAccount": { "name": "DescribeBudgetActionsForAccount", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeBudgetActionsForAccountRequest" }, "output": { "shape": "DescribeBudgetActionsForAccountResponse" }, "errors": [ { "shape": "InternalErrorException" }, { "shape": "InvalidParameterException" }, { "shape": "AccessDeniedException" }, { "shape": "InvalidNextTokenException" }, { "shape": "ThrottlingException" } ], "documentation": "

Describes all of the budget actions for an account.

" }, "DescribeBudgetActionsForBudget": { "name": "DescribeBudgetActionsForBudget", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeBudgetActionsForBudgetRequest" }, "output": { "shape": "DescribeBudgetActionsForBudgetResponse" }, "errors": [ { "shape": "InternalErrorException" }, { "shape": "InvalidParameterException" }, { "shape": "NotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "InvalidNextTokenException" }, { "shape": "ThrottlingException" } ], "documentation": "

Describes all of the budget actions for a budget.

" }, "DescribeBudgetNotificationsForAccount": { "name": "DescribeBudgetNotificationsForAccount", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeBudgetNotificationsForAccountRequest" }, "output": { "shape": "DescribeBudgetNotificationsForAccountResponse" }, "errors": [ { "shape": "InternalErrorException" }, { "shape": "InvalidParameterException" }, { "shape": "NotFoundException" }, { "shape": "InvalidNextTokenException" }, { "shape": "ExpiredNextTokenException" }, { "shape": "AccessDeniedException" }, { "shape": "ThrottlingException" } ], "documentation": "

Lists the budget names and notifications that are associated with an account.

" }, "DescribeBudgetPerformanceHistory": { "name": "DescribeBudgetPerformanceHistory", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeBudgetPerformanceHistoryRequest" }, "output": { "shape": "DescribeBudgetPerformanceHistoryResponse" }, "errors": [ { "shape": "InternalErrorException" }, { "shape": "InvalidParameterException" }, { "shape": "NotFoundException" }, { "shape": "InvalidNextTokenException" }, { "shape": "ExpiredNextTokenException" }, { "shape": "AccessDeniedException" }, { "shape": "ThrottlingException" } ], "documentation": "

Describes the history for DAILY, MONTHLY, and QUARTERLY budgets. Budget history isn't available for ANNUAL budgets.

" }, "DescribeBudgets": { "name": "DescribeBudgets", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeBudgetsRequest" }, "output": { "shape": "DescribeBudgetsResponse" }, "errors": [ { "shape": "InternalErrorException" }, { "shape": "InvalidParameterException" }, { "shape": "NotFoundException" }, { "shape": "InvalidNextTokenException" }, { "shape": "ExpiredNextTokenException" }, { "shape": "AccessDeniedException" }, { "shape": "ThrottlingException" } ], "documentation": "

Lists the budgets that are associated with an account.

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

" }, "DescribeNotificationsForBudget": { "name": "DescribeNotificationsForBudget", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeNotificationsForBudgetRequest" }, "output": { "shape": "DescribeNotificationsForBudgetResponse" }, "errors": [ { "shape": "InternalErrorException" }, { "shape": "InvalidParameterException" }, { "shape": "NotFoundException" }, { "shape": "InvalidNextTokenException" }, { "shape": "ExpiredNextTokenException" }, { "shape": "AccessDeniedException" }, { "shape": "ThrottlingException" } ], "documentation": "

Lists the notifications that are associated with a budget.

" }, "DescribeSubscribersForNotification": { "name": "DescribeSubscribersForNotification", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeSubscribersForNotificationRequest" }, "output": { "shape": "DescribeSubscribersForNotificationResponse" }, "errors": [ { "shape": "InternalErrorException" }, { "shape": "NotFoundException" }, { "shape": "InvalidParameterException" }, { "shape": "InvalidNextTokenException" }, { "shape": "ExpiredNextTokenException" }, { "shape": "AccessDeniedException" }, { "shape": "ThrottlingException" } ], "documentation": "

Lists the subscribers that are associated with a notification.

" }, "ExecuteBudgetAction": { "name": "ExecuteBudgetAction", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ExecuteBudgetActionRequest" }, "output": { "shape": "ExecuteBudgetActionResponse" }, "errors": [ { "shape": "InternalErrorException" }, { "shape": "InvalidParameterException" }, { "shape": "NotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ResourceLockedException" }, { "shape": "ThrottlingException" } ], "documentation": "

Executes a budget action.

" }, "ListTagsForResource": { "name": "ListTagsForResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "ListTagsForResourceRequest" }, "output": { "shape": "ListTagsForResourceResponse" }, "errors": [ { "shape": "ThrottlingException" }, { "shape": "NotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "InternalErrorException" }, { "shape": "InvalidParameterException" } ], "documentation": "

Lists tags associated with a budget or budget action resource.

" }, "TagResource": { "name": "TagResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "TagResourceRequest" }, "output": { "shape": "TagResourceResponse" }, "errors": [ { "shape": "ThrottlingException" }, { "shape": "ServiceQuotaExceededException" }, { "shape": "NotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "InternalErrorException" }, { "shape": "InvalidParameterException" } ], "documentation": "

Creates tags for a budget or budget action resource.

" }, "UntagResource": { "name": "UntagResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UntagResourceRequest" }, "output": { "shape": "UntagResourceResponse" }, "errors": [ { "shape": "ThrottlingException" }, { "shape": "NotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "InternalErrorException" }, { "shape": "InvalidParameterException" } ], "documentation": "

Deletes tags associated with a budget or budget action resource.

" }, "UpdateBudget": { "name": "UpdateBudget", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateBudgetRequest" }, "output": { "shape": "UpdateBudgetResponse" }, "errors": [ { "shape": "InternalErrorException" }, { "shape": "InvalidParameterException" }, { "shape": "NotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ThrottlingException" } ], "documentation": "

Updates a budget. You can change every part of a budget except for the budgetName and the calculatedSpend. When you modify a budget, the calculatedSpend drops to zero until Amazon Web Services has new usage data to use for forecasting.

Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

" }, "UpdateBudgetAction": { "name": "UpdateBudgetAction", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateBudgetActionRequest" }, "output": { "shape": "UpdateBudgetActionResponse" }, "errors": [ { "shape": "InternalErrorException" }, { "shape": "InvalidParameterException" }, { "shape": "NotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ResourceLockedException" }, { "shape": "ThrottlingException" } ], "documentation": "

Updates a budget action.

" }, "UpdateNotification": { "name": "UpdateNotification", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateNotificationRequest" }, "output": { "shape": "UpdateNotificationResponse" }, "errors": [ { "shape": "InternalErrorException" }, { "shape": "InvalidParameterException" }, { "shape": "NotFoundException" }, { "shape": "DuplicateRecordException" }, { "shape": "AccessDeniedException" }, { "shape": "ThrottlingException" } ], "documentation": "

Updates a notification.

" }, "UpdateSubscriber": { "name": "UpdateSubscriber", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UpdateSubscriberRequest" }, "output": { "shape": "UpdateSubscriberResponse" }, "errors": [ { "shape": "InternalErrorException" }, { "shape": "InvalidParameterException" }, { "shape": "NotFoundException" }, { "shape": "DuplicateRecordException" }, { "shape": "AccessDeniedException" }, { "shape": "ThrottlingException" } ], "documentation": "

Updates a subscriber.

" } }, "shapes": { "AccountId": { "type": "string", "documentation": "

The account ID of the user. It's a 12-digit number.

", "max": 12, "min": 12, "pattern": "\\d{12}" }, "Action": { "type": "structure", "required": [ "ActionId", "BudgetName", "NotificationType", "ActionType", "ActionThreshold", "Definition", "ExecutionRoleArn", "ApprovalModel", "Status", "Subscribers" ], "members": { "ActionId": { "shape": "ActionId", "documentation": "

A system-generated universally unique identifier (UUID) for the action.

" }, "BudgetName": { "shape": "BudgetName" }, "NotificationType": { "shape": "NotificationType" }, "ActionType": { "shape": "ActionType", "documentation": "

The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.

" }, "ActionThreshold": { "shape": "ActionThreshold", "documentation": "

The trigger threshold of the action.

" }, "Definition": { "shape": "Definition", "documentation": "

Where you specify all of the type-specific parameters.

" }, "ExecutionRoleArn": { "shape": "RoleArn", "documentation": "

The role passed for action execution and reversion. Roles and actions must be in the same account.

" }, "ApprovalModel": { "shape": "ApprovalModel", "documentation": "

This specifies if the action needs manual or automatic approval.

" }, "Status": { "shape": "ActionStatus", "documentation": "

The status of the action.

" }, "Subscribers": { "shape": "Subscribers" } }, "documentation": "

A budget action resource.

" }, "ActionHistories": { "type": "list", "member": { "shape": "ActionHistory" }, "max": 100, "min": 0 }, "ActionHistory": { "type": "structure", "required": [ "Timestamp", "Status", "EventType", "ActionHistoryDetails" ], "members": { "Timestamp": { "shape": "GenericTimestamp" }, "Status": { "shape": "ActionStatus", "documentation": "

The status of action at the time of the event.

" }, "EventType": { "shape": "EventType", "documentation": "

This distinguishes between whether the events are triggered by the user or are generated by the system.

" }, "ActionHistoryDetails": { "shape": "ActionHistoryDetails", "documentation": "

The description of the details for the event.

" } }, "documentation": "

The historical records for a budget action.

" }, "ActionHistoryDetails": { "type": "structure", "required": [ "Message", "Action" ], "members": { "Message": { "shape": "GenericString" }, "Action": { "shape": "Action", "documentation": "

The budget action resource.

" } }, "documentation": "

The description of the details for the event.

" }, "ActionId": { "type": "string", "max": 36, "min": 36, "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "ActionStatus": { "type": "string", "enum": [ "STANDBY", "PENDING", "EXECUTION_IN_PROGRESS", "EXECUTION_SUCCESS", "EXECUTION_FAILURE", "REVERSE_IN_PROGRESS", "REVERSE_SUCCESS", "REVERSE_FAILURE", "RESET_IN_PROGRESS", "RESET_FAILURE" ] }, "ActionSubType": { "type": "string", "enum": [ "STOP_EC2_INSTANCES", "STOP_RDS_INSTANCES" ] }, "ActionThreshold": { "type": "structure", "required": [ "ActionThresholdValue", "ActionThresholdType" ], "members": { "ActionThresholdValue": { "shape": "NotificationThreshold" }, "ActionThresholdType": { "shape": "ThresholdType" } }, "documentation": "

The trigger threshold of the action.

" }, "ActionType": { "type": "string", "enum": [ "APPLY_IAM_POLICY", "APPLY_SCP_POLICY", "RUN_SSM_DOCUMENTS" ] }, "Actions": { "type": "list", "member": { "shape": "Action" }, "max": 100, "min": 0 }, "AdjustmentPeriod": { "type": "integer", "box": true, "max": 60, "min": 1 }, "AmazonResourceName": { "type": "string", "max": 1011, "min": 1 }, "ApprovalModel": { "type": "string", "enum": [ "AUTOMATIC", "MANUAL" ] }, "AutoAdjustData": { "type": "structure", "required": [ "AutoAdjustType" ], "members": { "AutoAdjustType": { "shape": "AutoAdjustType", "documentation": "

The string that defines whether your budget auto-adjusts based on historical or forecasted data.

" }, "HistoricalOptions": { "shape": "HistoricalOptions", "documentation": "

The parameters that define or describe the historical data that your auto-adjusting budget is based on.

" }, "LastAutoAdjustTime": { "shape": "GenericTimestamp", "documentation": "

The last time that your budget was auto-adjusted.

" } }, "documentation": "

The parameters that determine the budget amount for an auto-adjusting budget.

" }, "AutoAdjustType": { "type": "string", "enum": [ "HISTORICAL", "FORECAST" ] }, "Budget": { "type": "structure", "required": [ "BudgetName", "TimeUnit", "BudgetType" ], "members": { "BudgetName": { "shape": "BudgetName", "documentation": "

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.

" }, "BudgetLimit": { "shape": "Spend", "documentation": "

The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage that you want to track with your budget.

BudgetLimit is required for cost or usage budgets, but optional for RI or Savings Plans utilization or coverage budgets. RI and Savings Plans utilization or coverage budgets default to 100. This is the only valid value for RI or Savings Plans utilization or coverage budgets. You can't use BudgetLimit with PlannedBudgetLimits for CreateBudget and UpdateBudget actions.

" }, "PlannedBudgetLimits": { "shape": "PlannedBudgetLimits", "documentation": "

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 start of the quarter, UTC in epoch seconds.

If the planned budget expires before 12 months for monthly or four quarters for quarterly, provide the PlannedBudgetLimits values only for the remaining periods.

If the budget begins at a date in the future, provide PlannedBudgetLimits values from the start date of the budget.

After all of the BudgetLimit values in PlannedBudgetLimits are used, the budget continues to use the last limit as the BudgetLimit. At that point, the planned budget provides the same experience as a fixed budget.

DescribeBudget and DescribeBudgets response along with PlannedBudgetLimits also contain BudgetLimit representing the current month or quarter limit present in PlannedBudgetLimits. This only applies to budgets that are created with PlannedBudgetLimits. Budgets that are created without PlannedBudgetLimits only contain BudgetLimit. They don't contain PlannedBudgetLimits.

" }, "CostFilters": { "shape": "CostFilters", "documentation": "

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:

" }, "CostTypes": { "shape": "CostTypes", "documentation": "

The types of costs that are included in this COST budget.

USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, and SAVINGS_PLANS_COVERAGE budgets do not have CostTypes.

" }, "TimeUnit": { "shape": "TimeUnit", "documentation": "

The length of time until a budget resets the actual and forecasted spend.

" }, "TimePeriod": { "shape": "TimePeriod", "documentation": "

The period of time that's covered by a budget. You setthe start date and end date. The start date must come before the end date. The end date must come before 06/15/87 00:00 UTC.

If you create your budget and don't specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). 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. 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.

You can change either date with the UpdateBudget operation.

After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers.

" }, "CalculatedSpend": { "shape": "CalculatedSpend", "documentation": "

The actual and forecasted cost or usage that the budget tracks.

" }, "BudgetType": { "shape": "BudgetType", "documentation": "

Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.

" }, "LastUpdatedTime": { "shape": "GenericTimestamp", "documentation": "

The last time that you updated this budget.

" }, "AutoAdjustData": { "shape": "AutoAdjustData", "documentation": "

The parameters that determine the budget amount for an auto-adjusting budget.

" } }, "documentation": "

Represents the output of the CreateBudget operation. The content consists of the detailed metadata and data file information, and the current status of the budget object.

This is the Amazon Resource Name (ARN) pattern for a budget:

arn:aws:budgets::AccountId:budget/budgetName

" }, "BudgetName": { "type": "string", "documentation": "

A string that represents the budget name. The \":\" and \"\\\" characters, and the \"/action/\" substring, aren't allowed.

", "max": 100, "min": 1, "pattern": "^(?![^:\\\\]*/action/|(?i).*.*)[^:\\\\]+$" }, "BudgetNotificationsForAccount": { "type": "structure", "members": { "Notifications": { "shape": "Notifications" }, "BudgetName": { "shape": "BudgetName" } }, "documentation": "

The budget name and associated notifications for an account.

" }, "BudgetNotificationsForAccountList": { "type": "list", "member": { "shape": "BudgetNotificationsForAccount" }, "max": 1000 }, "BudgetPerformanceHistory": { "type": "structure", "members": { "BudgetName": { "shape": "BudgetName" }, "BudgetType": { "shape": "BudgetType" }, "CostFilters": { "shape": "CostFilters", "documentation": "

The history of the cost filters for a budget during the specified time period.

" }, "CostTypes": { "shape": "CostTypes", "documentation": "

The history of the cost types for a budget during the specified time period.

" }, "TimeUnit": { "shape": "TimeUnit" }, "BudgetedAndActualAmountsList": { "shape": "BudgetedAndActualAmountsList", "documentation": "

A list of amounts of cost or usage that you created budgets for, which are compared to your actual costs or usage.

" } }, "documentation": "

A history of the state of a budget at the end of the budget's specified time period.

" }, "BudgetType": { "type": "string", "documentation": "

The type of a budget. It must be one of the following types:

COST, USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, or SAVINGS_PLANS_COVERAGE.

", "enum": [ "USAGE", "COST", "RI_UTILIZATION", "RI_COVERAGE", "SAVINGS_PLANS_UTILIZATION", "SAVINGS_PLANS_COVERAGE" ] }, "BudgetedAndActualAmounts": { "type": "structure", "members": { "BudgetedAmount": { "shape": "Spend", "documentation": "

The amount of cost or usage that you created the budget for.

" }, "ActualAmount": { "shape": "Spend", "documentation": "

Your actual costs or usage for a budget period.

" }, "TimePeriod": { "shape": "TimePeriod", "documentation": "

The time period that's covered by this budget comparison.

" } }, "documentation": "

The amount of cost or usage that you created the budget for, compared to your actual costs or usage.

" }, "BudgetedAndActualAmountsList": { "type": "list", "member": { "shape": "BudgetedAndActualAmounts" } }, "Budgets": { "type": "list", "member": { "shape": "Budget" }, "documentation": "

A list of budgets.

" }, "CalculatedSpend": { "type": "structure", "required": [ "ActualSpend" ], "members": { "ActualSpend": { "shape": "Spend", "documentation": "

The amount of cost, usage, RI units, or Savings Plans units that you used.

" }, "ForecastedSpend": { "shape": "Spend", "documentation": "

The amount of cost, usage, RI units, or Savings Plans units that you're forecasted to use.

" } }, "documentation": "

The spend objects that are associated with this budget. The actualSpend tracks how much you've used, cost, usage, RI units, or Savings Plans units and the forecastedSpend tracks how much that you're predicted to spend based on your historical usage profile.

For example, if it's the 20th of the month and you have spent 50 dollars on Amazon EC2, your actualSpend is 50 USD, and your forecastedSpend is 75 USD.

" }, "ComparisonOperator": { "type": "string", "documentation": "

The comparison operator of a notification. Currently, the service supports the following operators:

GREATER_THAN, LESS_THAN, EQUAL_TO

", "enum": [ "GREATER_THAN", "LESS_THAN", "EQUAL_TO" ] }, "CostFilters": { "type": "map", "key": { "shape": "GenericString" }, "value": { "shape": "DimensionValues" }, "documentation": "

A map that represents the cost filters that are applied to the budget.

" }, "CostTypes": { "type": "structure", "members": { "IncludeTax": { "shape": "NullableBoolean", "documentation": "

Specifies whether a budget includes taxes.

The default value is true.

" }, "IncludeSubscription": { "shape": "NullableBoolean", "documentation": "

Specifies whether a budget includes subscriptions.

The default value is true.

" }, "UseBlended": { "shape": "NullableBoolean", "documentation": "

Specifies whether a budget uses a blended rate.

The default value is false.

" }, "IncludeRefund": { "shape": "NullableBoolean", "documentation": "

Specifies whether a budget includes refunds.

The default value is true.

" }, "IncludeCredit": { "shape": "NullableBoolean", "documentation": "

Specifies whether a budget includes credits.

The default value is true.

" }, "IncludeUpfront": { "shape": "NullableBoolean", "documentation": "

Specifies whether a budget includes upfront RI costs.

The default value is true.

" }, "IncludeRecurring": { "shape": "NullableBoolean", "documentation": "

Specifies whether a budget includes recurring fees such as monthly RI fees.

The default value is true.

" }, "IncludeOtherSubscription": { "shape": "NullableBoolean", "documentation": "

Specifies whether a budget includes non-RI subscription costs.

The default value is true.

" }, "IncludeSupport": { "shape": "NullableBoolean", "documentation": "

Specifies whether a budget includes support subscription fees.

The default value is true.

" }, "IncludeDiscount": { "shape": "NullableBoolean", "documentation": "

Specifies whether a budget includes discounts.

The default value is true.

" }, "UseAmortized": { "shape": "NullableBoolean", "documentation": "

Specifies whether a budget uses the amortized rate.

The default value is false.

" } }, "documentation": "

The types of cost that are included in a COST budget, such as tax and subscriptions.

USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, and SAVINGS_PLANS_COVERAGE budgets don't have CostTypes.

" }, "CreateBudgetActionRequest": { "type": "structure", "required": [ "AccountId", "BudgetName", "NotificationType", "ActionType", "ActionThreshold", "Definition", "ExecutionRoleArn", "ApprovalModel", "Subscribers" ], "members": { "AccountId": { "shape": "AccountId" }, "BudgetName": { "shape": "BudgetName" }, "NotificationType": { "shape": "NotificationType" }, "ActionType": { "shape": "ActionType", "documentation": "

The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.

" }, "ActionThreshold": { "shape": "ActionThreshold" }, "Definition": { "shape": "Definition" }, "ExecutionRoleArn": { "shape": "RoleArn", "documentation": "

The role passed for action execution and reversion. Roles and actions must be in the same account.

" }, "ApprovalModel": { "shape": "ApprovalModel", "documentation": "

This specifies if the action needs manual or automatic approval.

" }, "Subscribers": { "shape": "Subscribers" }, "ResourceTags": { "shape": "ResourceTagList", "documentation": "

An optional list of tags to associate with the specified budget action. Each tag consists of a key and a value, and each key must be unique for the resource.

" } } }, "CreateBudgetActionResponse": { "type": "structure", "required": [ "AccountId", "BudgetName", "ActionId" ], "members": { "AccountId": { "shape": "AccountId" }, "BudgetName": { "shape": "BudgetName" }, "ActionId": { "shape": "ActionId", "documentation": "

A system-generated universally unique identifier (UUID) for the action.

" } } }, "CreateBudgetRequest": { "type": "structure", "required": [ "AccountId", "Budget" ], "members": { "AccountId": { "shape": "AccountId", "documentation": "

The accountId that is associated with the budget.

" }, "Budget": { "shape": "Budget", "documentation": "

The budget object that you want to create.

" }, "NotificationsWithSubscribers": { "shape": "NotificationWithSubscribersList", "documentation": "

A notification that you want to associate with a budget. A budget can have up to five notifications, and each notification can have one SNS subscriber and up to 10 email subscribers. If you include notifications and subscribers in your CreateBudget call, Amazon Web Services creates the notifications and subscribers for you.

" }, "ResourceTags": { "shape": "ResourceTagList", "documentation": "

An optional list of tags to associate with the specified budget. Each tag consists of a key and a value, and each key must be unique for the resource.

" } }, "documentation": "

Request of CreateBudget

" }, "CreateBudgetResponse": { "type": "structure", "members": {}, "documentation": "

Response of CreateBudget

" }, "CreateNotificationRequest": { "type": "structure", "required": [ "AccountId", "BudgetName", "Notification", "Subscribers" ], "members": { "AccountId": { "shape": "AccountId", "documentation": "

The accountId that is associated with the budget that you want to create a notification for.

" }, "BudgetName": { "shape": "BudgetName", "documentation": "

The name of the budget that you want Amazon Web Services to notify you about. Budget names must be unique within an account.

" }, "Notification": { "shape": "Notification", "documentation": "

The notification that you want to create.

" }, "Subscribers": { "shape": "Subscribers", "documentation": "

A list of subscribers that you want to associate with the notification. Each notification can have one SNS subscriber and up to 10 email subscribers.

" } }, "documentation": "

Request of CreateNotification

" }, "CreateNotificationResponse": { "type": "structure", "members": {}, "documentation": "

Response of CreateNotification

" }, "CreateSubscriberRequest": { "type": "structure", "required": [ "AccountId", "BudgetName", "Notification", "Subscriber" ], "members": { "AccountId": { "shape": "AccountId", "documentation": "

The accountId that is associated with the budget that you want to create a subscriber for.

" }, "BudgetName": { "shape": "BudgetName", "documentation": "

The name of the budget that you want to subscribe to. Budget names must be unique within an account.

" }, "Notification": { "shape": "Notification", "documentation": "

The notification that you want to create a subscriber for.

" }, "Subscriber": { "shape": "Subscriber", "documentation": "

The subscriber that you want to associate with a budget notification.

" } }, "documentation": "

Request of CreateSubscriber

" }, "CreateSubscriberResponse": { "type": "structure", "members": {}, "documentation": "

Response of CreateSubscriber

" }, "Definition": { "type": "structure", "members": { "IamActionDefinition": { "shape": "IamActionDefinition", "documentation": "

The Identity and Access Management (IAM) action definition details.

" }, "ScpActionDefinition": { "shape": "ScpActionDefinition", "documentation": "

The service control policies (SCPs) action definition details.

" }, "SsmActionDefinition": { "shape": "SsmActionDefinition", "documentation": "

The Amazon Web Services Systems Manager (SSM) action definition details.

" } }, "documentation": "

Specifies all of the type-specific parameters.

" }, "DeleteBudgetActionRequest": { "type": "structure", "required": [ "AccountId", "BudgetName", "ActionId" ], "members": { "AccountId": { "shape": "AccountId" }, "BudgetName": { "shape": "BudgetName" }, "ActionId": { "shape": "ActionId", "documentation": "

A system-generated universally unique identifier (UUID) for the action.

" } } }, "DeleteBudgetActionResponse": { "type": "structure", "required": [ "AccountId", "BudgetName", "Action" ], "members": { "AccountId": { "shape": "AccountId" }, "BudgetName": { "shape": "BudgetName" }, "Action": { "shape": "Action" } } }, "DeleteBudgetRequest": { "type": "structure", "required": [ "AccountId", "BudgetName" ], "members": { "AccountId": { "shape": "AccountId", "documentation": "

The accountId that is associated with the budget that you want to delete.

" }, "BudgetName": { "shape": "BudgetName", "documentation": "

The name of the budget that you want to delete.

" } }, "documentation": "

Request of DeleteBudget

" }, "DeleteBudgetResponse": { "type": "structure", "members": {}, "documentation": "

Response of DeleteBudget

" }, "DeleteNotificationRequest": { "type": "structure", "required": [ "AccountId", "BudgetName", "Notification" ], "members": { "AccountId": { "shape": "AccountId", "documentation": "

The accountId that is associated with the budget whose notification you want to delete.

" }, "BudgetName": { "shape": "BudgetName", "documentation": "

The name of the budget whose notification you want to delete.

" }, "Notification": { "shape": "Notification", "documentation": "

The notification that you want to delete.

" } }, "documentation": "

Request of DeleteNotification

" }, "DeleteNotificationResponse": { "type": "structure", "members": {}, "documentation": "

Response of DeleteNotification

" }, "DeleteSubscriberRequest": { "type": "structure", "required": [ "AccountId", "BudgetName", "Notification", "Subscriber" ], "members": { "AccountId": { "shape": "AccountId", "documentation": "

The accountId that is associated with the budget whose subscriber you want to delete.

" }, "BudgetName": { "shape": "BudgetName", "documentation": "

The name of the budget whose subscriber you want to delete.

" }, "Notification": { "shape": "Notification", "documentation": "

The notification whose subscriber you want to delete.

" }, "Subscriber": { "shape": "Subscriber", "documentation": "

The subscriber that you want to delete.

" } }, "documentation": "

Request of DeleteSubscriber

" }, "DeleteSubscriberResponse": { "type": "structure", "members": {}, "documentation": "

Response of DeleteSubscriber

" }, "DescribeBudgetActionHistoriesRequest": { "type": "structure", "required": [ "AccountId", "BudgetName", "ActionId" ], "members": { "AccountId": { "shape": "AccountId" }, "BudgetName": { "shape": "BudgetName" }, "ActionId": { "shape": "ActionId", "documentation": "

A system-generated universally unique identifier (UUID) for the action.

" }, "TimePeriod": { "shape": "TimePeriod" }, "MaxResults": { "shape": "MaxResults" }, "NextToken": { "shape": "GenericString" } } }, "DescribeBudgetActionHistoriesResponse": { "type": "structure", "required": [ "ActionHistories" ], "members": { "ActionHistories": { "shape": "ActionHistories", "documentation": "

The historical record of the budget action resource.

" }, "NextToken": { "shape": "GenericString" } } }, "DescribeBudgetActionRequest": { "type": "structure", "required": [ "AccountId", "BudgetName", "ActionId" ], "members": { "AccountId": { "shape": "AccountId" }, "BudgetName": { "shape": "BudgetName" }, "ActionId": { "shape": "ActionId", "documentation": "

A system-generated universally unique identifier (UUID) for the action.

" } } }, "DescribeBudgetActionResponse": { "type": "structure", "required": [ "AccountId", "BudgetName", "Action" ], "members": { "AccountId": { "shape": "AccountId" }, "BudgetName": { "shape": "BudgetName" }, "Action": { "shape": "Action", "documentation": "

A budget action resource.

" } } }, "DescribeBudgetActionsForAccountRequest": { "type": "structure", "required": [ "AccountId" ], "members": { "AccountId": { "shape": "AccountId" }, "MaxResults": { "shape": "MaxResults" }, "NextToken": { "shape": "GenericString" } } }, "DescribeBudgetActionsForAccountResponse": { "type": "structure", "required": [ "Actions" ], "members": { "Actions": { "shape": "Actions", "documentation": "

A list of the budget action resources information.

" }, "NextToken": { "shape": "GenericString" } } }, "DescribeBudgetActionsForBudgetRequest": { "type": "structure", "required": [ "AccountId", "BudgetName" ], "members": { "AccountId": { "shape": "AccountId" }, "BudgetName": { "shape": "BudgetName" }, "MaxResults": { "shape": "MaxResults" }, "NextToken": { "shape": "GenericString" } } }, "DescribeBudgetActionsForBudgetResponse": { "type": "structure", "required": [ "Actions" ], "members": { "Actions": { "shape": "Actions", "documentation": "

A list of the budget action resources information.

" }, "NextToken": { "shape": "GenericString" } } }, "DescribeBudgetNotificationsForAccountRequest": { "type": "structure", "required": [ "AccountId" ], "members": { "AccountId": { "shape": "AccountId" }, "MaxResults": { "shape": "MaxResultsBudgetNotifications", "documentation": "

An integer that represents how many budgets a paginated response contains. The default is 50.

" }, "NextToken": { "shape": "GenericString" } } }, "DescribeBudgetNotificationsForAccountResponse": { "type": "structure", "members": { "BudgetNotificationsForAccount": { "shape": "BudgetNotificationsForAccountList", "documentation": "

A list of budget names and associated notifications for an account.

" }, "NextToken": { "shape": "GenericString" } } }, "DescribeBudgetPerformanceHistoryRequest": { "type": "structure", "required": [ "AccountId", "BudgetName" ], "members": { "AccountId": { "shape": "AccountId" }, "BudgetName": { "shape": "BudgetName" }, "TimePeriod": { "shape": "TimePeriod", "documentation": "

Retrieves how often the budget went into an ALARM state for the specified time period.

" }, "MaxResults": { "shape": "MaxResults" }, "NextToken": { "shape": "GenericString" } } }, "DescribeBudgetPerformanceHistoryResponse": { "type": "structure", "members": { "BudgetPerformanceHistory": { "shape": "BudgetPerformanceHistory", "documentation": "

The history of how often the budget has gone into an ALARM state.

For DAILY budgets, the history saves the state of the budget for the last 60 days. For MONTHLY budgets, the history saves the state of the budget for the current month plus the last 12 months. For QUARTERLY budgets, the history saves the state of the budget for the last four quarters.

" }, "NextToken": { "shape": "GenericString" } } }, "DescribeBudgetRequest": { "type": "structure", "required": [ "AccountId", "BudgetName" ], "members": { "AccountId": { "shape": "AccountId", "documentation": "

The accountId that is associated with the budget that you want a description of.

" }, "BudgetName": { "shape": "BudgetName", "documentation": "

The name of the budget that you want a description of.

" } }, "documentation": "

Request of DescribeBudget

" }, "DescribeBudgetResponse": { "type": "structure", "members": { "Budget": { "shape": "Budget", "documentation": "

The description of the budget.

" } }, "documentation": "

Response of DescribeBudget

" }, "DescribeBudgetsRequest": { "type": "structure", "required": [ "AccountId" ], "members": { "AccountId": { "shape": "AccountId", "documentation": "

The accountId that is associated with the budgets that you want to describe.

" }, "MaxResults": { "shape": "MaxResultsDescribeBudgets", "documentation": "

An integer that represents how many budgets a paginated response contains. The default is 100.

" }, "NextToken": { "shape": "GenericString", "documentation": "

The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

" } }, "documentation": "

Request of DescribeBudgets

" }, "DescribeBudgetsResponse": { "type": "structure", "members": { "Budgets": { "shape": "Budgets", "documentation": "

A list of budgets.

" }, "NextToken": { "shape": "GenericString", "documentation": "

The pagination token in the service response that indicates the next set of results that you can retrieve.

" } }, "documentation": "

Response of DescribeBudgets

" }, "DescribeNotificationsForBudgetRequest": { "type": "structure", "required": [ "AccountId", "BudgetName" ], "members": { "AccountId": { "shape": "AccountId", "documentation": "

The accountId that is associated with the budget whose notifications you want descriptions of.

" }, "BudgetName": { "shape": "BudgetName", "documentation": "

The name of the budget whose notifications you want descriptions of.

" }, "MaxResults": { "shape": "MaxResults", "documentation": "

An optional integer that represents how many entries a paginated response contains.

" }, "NextToken": { "shape": "GenericString", "documentation": "

The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

" } }, "documentation": "

Request of DescribeNotificationsForBudget

" }, "DescribeNotificationsForBudgetResponse": { "type": "structure", "members": { "Notifications": { "shape": "Notifications", "documentation": "

A list of notifications that are associated with a budget.

" }, "NextToken": { "shape": "GenericString", "documentation": "

The pagination token in the service response that indicates the next set of results that you can retrieve.

" } }, "documentation": "

Response of GetNotificationsForBudget

" }, "DescribeSubscribersForNotificationRequest": { "type": "structure", "required": [ "AccountId", "BudgetName", "Notification" ], "members": { "AccountId": { "shape": "AccountId", "documentation": "

The accountId that is associated with the budget whose subscribers you want descriptions of.

" }, "BudgetName": { "shape": "BudgetName", "documentation": "

The name of the budget whose subscribers you want descriptions of.

" }, "Notification": { "shape": "Notification", "documentation": "

The notification whose subscribers you want to list.

" }, "MaxResults": { "shape": "MaxResults", "documentation": "

An optional integer that represents how many entries a paginated response contains.

" }, "NextToken": { "shape": "GenericString", "documentation": "

The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

" } }, "documentation": "

Request of DescribeSubscribersForNotification

" }, "DescribeSubscribersForNotificationResponse": { "type": "structure", "members": { "Subscribers": { "shape": "Subscribers", "documentation": "

A list of subscribers that are associated with a notification.

" }, "NextToken": { "shape": "GenericString", "documentation": "

The pagination token in the service response that indicates the next set of results that you can retrieve.

" } }, "documentation": "

Response of DescribeSubscribersForNotification

" }, "DimensionValue": { "type": "string", "max": 2147483647, "min": 0, "pattern": "[\\S\\s]*" }, "DimensionValues": { "type": "list", "member": { "shape": "DimensionValue" } }, "EventType": { "type": "string", "enum": [ "SYSTEM", "CREATE_ACTION", "DELETE_ACTION", "UPDATE_ACTION", "EXECUTE_ACTION" ] }, "ExecuteBudgetActionRequest": { "type": "structure", "required": [ "AccountId", "BudgetName", "ActionId", "ExecutionType" ], "members": { "AccountId": { "shape": "AccountId" }, "BudgetName": { "shape": "BudgetName" }, "ActionId": { "shape": "ActionId", "documentation": "

A system-generated universally unique identifier (UUID) for the action.

" }, "ExecutionType": { "shape": "ExecutionType", "documentation": "

The type of execution.

" } } }, "ExecuteBudgetActionResponse": { "type": "structure", "required": [ "AccountId", "BudgetName", "ActionId", "ExecutionType" ], "members": { "AccountId": { "shape": "AccountId" }, "BudgetName": { "shape": "BudgetName" }, "ActionId": { "shape": "ActionId", "documentation": "

A system-generated universally unique identifier (UUID) for the action.

" }, "ExecutionType": { "shape": "ExecutionType", "documentation": "

The type of execution.

" } } }, "ExecutionType": { "type": "string", "enum": [ "APPROVE_BUDGET_ACTION", "RETRY_BUDGET_ACTION", "REVERSE_BUDGET_ACTION", "RESET_BUDGET_ACTION" ] }, "GenericString": { "type": "string", "documentation": "

A generic string.

", "max": 2147483647, "min": 0, "pattern": ".*" }, "GenericTimestamp": { "type": "timestamp", "documentation": "

A generic time stamp. In Java, it's transformed to a Date object.

" }, "Group": { "type": "string", "max": 640, "min": 1, "pattern": "^([\\u0021-\\u007F]+\\u002F)?[\\w+=,.@-]+$" }, "Groups": { "type": "list", "member": { "shape": "Group" }, "max": 100, "min": 1 }, "HistoricalOptions": { "type": "structure", "required": [ "BudgetAdjustmentPeriod" ], "members": { "BudgetAdjustmentPeriod": { "shape": "AdjustmentPeriod", "documentation": "

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:

" }, "LookBackAvailablePeriods": { "shape": "AdjustmentPeriod", "documentation": "

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 value is automatically calculated from the BudgetAdjustmentPeriod and your historical cost data.

" } }, "documentation": "

The parameters that define or describe the historical data that your auto-adjusting budget is based on.

" }, "IamActionDefinition": { "type": "structure", "required": [ "PolicyArn" ], "members": { "PolicyArn": { "shape": "PolicyArn", "documentation": "

The Amazon Resource Name (ARN) of the policy to be attached.

" }, "Roles": { "shape": "Roles", "documentation": "

A list of roles to be attached. There must be at least one role.

" }, "Groups": { "shape": "Groups", "documentation": "

A list of groups to be attached. There must be at least one group.

" }, "Users": { "shape": "Users", "documentation": "

A list of users to be attached. There must be at least one user.

" } }, "documentation": "

The Identity and Access Management (IAM) action definition details.

" }, "InstanceId": { "type": "string", "max": 63, "min": 1, "pattern": "^i-(\\w{8}|\\w{17})$|^[a-zA-Z]([\\w-]{0,61}\\w)?$" }, "InstanceIds": { "type": "list", "member": { "shape": "InstanceId" }, "max": 100, "min": 1 }, "ListTagsForResourceRequest": { "type": "structure", "required": [ "ResourceARN" ], "members": { "ResourceARN": { "shape": "AmazonResourceName", "documentation": "

The unique identifier for the resource.

" } } }, "ListTagsForResourceResponse": { "type": "structure", "members": { "ResourceTags": { "shape": "ResourceTagList", "documentation": "

The tags associated with the resource.

" } } }, "MaxResults": { "type": "integer", "documentation": "

An integer that represents how many entries a paginated response contains. The maximum is 100.

", "box": true, "max": 100, "min": 1 }, "MaxResultsBudgetNotifications": { "type": "integer", "box": true, "max": 1000, "min": 1 }, "MaxResultsDescribeBudgets": { "type": "integer", "box": true, "max": 1000, "min": 1 }, "Notification": { "type": "structure", "required": [ "NotificationType", "ComparisonOperator", "Threshold" ], "members": { "NotificationType": { "shape": "NotificationType", "documentation": "

Specifies whether the notification is for how much you have spent (ACTUAL) or for how much that you're forecasted to spend (FORECASTED).

" }, "ComparisonOperator": { "shape": "ComparisonOperator", "documentation": "

The comparison that's used for this notification.

" }, "Threshold": { "shape": "NotificationThreshold", "documentation": "

The threshold that's associated with a notification. Thresholds are always a percentage, and many customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000% above the budgeted amount.

" }, "ThresholdType": { "shape": "ThresholdType", "documentation": "

The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.

" }, "NotificationState": { "shape": "NotificationState", "documentation": "

Specifies whether this notification is in alarm. If a budget notification is in the ALARM state, you passed the set threshold for the budget.

" } }, "documentation": "

A notification that's associated with a budget. A budget can have up to ten notifications.

Each notification must have at least one subscriber. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.

For example, if you have a budget for 200 dollars and you want to be notified when you go over 160 dollars, create a notification with the following parameters:

" }, "NotificationState": { "type": "string", "enum": [ "OK", "ALARM" ] }, "NotificationThreshold": { "type": "double", "documentation": "

The threshold of a notification.

", "max": 15000000000000, "min": 0 }, "NotificationType": { "type": "string", "documentation": "

The type of a notification. It must be ACTUAL or FORECASTED.

", "enum": [ "ACTUAL", "FORECASTED" ] }, "NotificationWithSubscribers": { "type": "structure", "required": [ "Notification", "Subscribers" ], "members": { "Notification": { "shape": "Notification", "documentation": "

The notification that's associated with a budget.

" }, "Subscribers": { "shape": "Subscribers", "documentation": "

A list of subscribers who are subscribed to this notification.

" } }, "documentation": "

A notification with subscribers. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.

" }, "NotificationWithSubscribersList": { "type": "list", "member": { "shape": "NotificationWithSubscribers" }, "documentation": "

A list of notifications, each with a list of subscribers.

", "max": 10 }, "Notifications": { "type": "list", "member": { "shape": "Notification" }, "documentation": "

A list of notifications.

" }, "NullableBoolean": { "type": "boolean", "box": true }, "NumericValue": { "type": "string", "documentation": "

A string that represents a numeric value.

", "max": 2147483647, "min": 1, "pattern": "([0-9]*\\.)?[0-9]+" }, "PlannedBudgetLimits": { "type": "map", "key": { "shape": "GenericString" }, "value": { "shape": "Spend" } }, "PolicyArn": { "type": "string", "max": 684, "min": 25, "pattern": "^arn:(aws|aws-cn|aws-us-gov|us-iso-east-1|us-isob-east-1):iam::(\\d{12}|aws):policy(\\u002F[\\u0021-\\u007F]+\\u002F|\\u002F)[\\w+=,.@-]+$" }, "PolicyId": { "type": "string", "max": 130, "min": 10, "pattern": "^p-[0-9a-zA-Z_]{8,128}$" }, "Region": { "type": "string", "max": 20, "min": 9, "pattern": "^\\w{2}-\\w+(-\\w+)?-\\d$" }, "ResourceTag": { "type": "structure", "required": [ "Key", "Value" ], "members": { "Key": { "shape": "ResourceTagKey", "documentation": "

The key that's associated with the tag.

" }, "Value": { "shape": "ResourceTagValue", "documentation": "

The value that's associated with the tag.

" } }, "documentation": "

The tag structure that contains a tag key and value.

" }, "ResourceTagKey": { "type": "string", "max": 128, "min": 1 }, "ResourceTagKeyList": { "type": "list", "member": { "shape": "ResourceTagKey" }, "max": 200, "min": 0 }, "ResourceTagList": { "type": "list", "member": { "shape": "ResourceTag" }, "max": 200, "min": 0 }, "ResourceTagValue": { "type": "string", "max": 256, "min": 0 }, "Role": { "type": "string", "max": 576, "min": 1, "pattern": "^([\\u0021-\\u007F]+\\u002F)?[\\w+=,.@-]+$" }, "RoleArn": { "type": "string", "max": 618, "min": 32, "pattern": "^arn:(aws|aws-cn|aws-us-gov|us-iso-east-1|us-isob-east-1):iam::\\d{12}:role(\\u002F[\\u0021-\\u007F]+\\u002F|\\u002F)[\\w+=,.@-]+$" }, "Roles": { "type": "list", "member": { "shape": "Role" }, "max": 100, "min": 1 }, "ScpActionDefinition": { "type": "structure", "required": [ "PolicyId", "TargetIds" ], "members": { "PolicyId": { "shape": "PolicyId", "documentation": "

The policy ID attached.

" }, "TargetIds": { "shape": "TargetIds", "documentation": "

A list of target IDs.

" } }, "documentation": "

The service control policies (SCP) action definition details.

" }, "Spend": { "type": "structure", "required": [ "Amount", "Unit" ], "members": { "Amount": { "shape": "NumericValue", "documentation": "

The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold.

" }, "Unit": { "shape": "UnitValue", "documentation": "

The unit of measurement that's used for the budget forecast, actual spend, or budget threshold.

" } }, "documentation": "

The amount of cost or usage that's measured for a budget.

Cost example: A Spend for 3 USD of costs has the following parameters:

Usage example: A Spend for 3 GB of S3 usage has the following parameters:

" }, "SsmActionDefinition": { "type": "structure", "required": [ "ActionSubType", "Region", "InstanceIds" ], "members": { "ActionSubType": { "shape": "ActionSubType", "documentation": "

The action subType.

" }, "Region": { "shape": "Region", "documentation": "

The Region to run the SSM document.

" }, "InstanceIds": { "shape": "InstanceIds", "documentation": "

The EC2 and RDS instance IDs.

" } }, "documentation": "

The Amazon Web Services Systems Manager (SSM) action definition details.

" }, "Subscriber": { "type": "structure", "required": [ "SubscriptionType", "Address" ], "members": { "SubscriptionType": { "shape": "SubscriptionType", "documentation": "

The type of notification that Amazon Web Services sends to a subscriber.

" }, "Address": { "shape": "SubscriberAddress", "documentation": "

The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.

When you create a subscriber, the value of Address can't contain line breaks.

" } }, "documentation": "

The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon SNS topic or an email address.

For example, an email subscriber has the following parameters:

" }, "SubscriberAddress": { "type": "string", "documentation": "

A string that contains an email address or SNS topic for the subscriber's address.

", "max": 2147483647, "min": 1, "pattern": "(.*[\\n\\r\\t\\f\\ ]?)*", "sensitive": true }, "Subscribers": { "type": "list", "member": { "shape": "Subscriber" }, "documentation": "

A list of subscribers.

", "max": 11, "min": 1 }, "SubscriptionType": { "type": "string", "documentation": "

The subscription type of the subscriber. It can be SMS or EMAIL.

", "enum": [ "SNS", "EMAIL" ] }, "TagResourceRequest": { "type": "structure", "required": [ "ResourceARN", "ResourceTags" ], "members": { "ResourceARN": { "shape": "AmazonResourceName", "documentation": "

The unique identifier for the resource.

" }, "ResourceTags": { "shape": "ResourceTagList", "documentation": "

The tags associated with the resource.

" } } }, "TagResourceResponse": { "type": "structure", "members": {} }, "TargetId": { "type": "string", "max": 68, "min": 12, "pattern": "^(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$)|(\\d{12})" }, "TargetIds": { "type": "list", "member": { "shape": "TargetId" }, "max": 100, "min": 1 }, "ThresholdType": { "type": "string", "documentation": "

The type of threshold for a notification.

", "enum": [ "PERCENTAGE", "ABSOLUTE_VALUE" ] }, "TimePeriod": { "type": "structure", "members": { "Start": { "shape": "GenericTimestamp", "documentation": "

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, or ANNUALLY). 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 operation.

" }, "End": { "shape": "GenericTimestamp", "documentation": "

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.

" } }, "documentation": "

The period of time that's covered by a budget. The period has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date.

" }, "TimeUnit": { "type": "string", "documentation": "

The time unit of the budget, such as MONTHLY or QUARTERLY.

", "enum": [ "DAILY", "MONTHLY", "QUARTERLY", "ANNUALLY" ] }, "UnitValue": { "type": "string", "documentation": "

A string that represents the spend unit of a budget. It can't be null or empty.

", "max": 2147483647, "min": 1, "pattern": ".*" }, "UntagResourceRequest": { "type": "structure", "required": [ "ResourceARN", "ResourceTagKeys" ], "members": { "ResourceARN": { "shape": "AmazonResourceName", "documentation": "

The unique identifier for the resource.

" }, "ResourceTagKeys": { "shape": "ResourceTagKeyList", "documentation": "

The key that's associated with the tag.

" } } }, "UntagResourceResponse": { "type": "structure", "members": {} }, "UpdateBudgetActionRequest": { "type": "structure", "required": [ "AccountId", "BudgetName", "ActionId" ], "members": { "AccountId": { "shape": "AccountId" }, "BudgetName": { "shape": "BudgetName" }, "ActionId": { "shape": "ActionId", "documentation": "

A system-generated universally unique identifier (UUID) for the action.

" }, "NotificationType": { "shape": "NotificationType" }, "ActionThreshold": { "shape": "ActionThreshold" }, "Definition": { "shape": "Definition" }, "ExecutionRoleArn": { "shape": "RoleArn", "documentation": "

The role passed for action execution and reversion. Roles and actions must be in the same account.

" }, "ApprovalModel": { "shape": "ApprovalModel", "documentation": "

This specifies if the action needs manual or automatic approval.

" }, "Subscribers": { "shape": "Subscribers" } } }, "UpdateBudgetActionResponse": { "type": "structure", "required": [ "AccountId", "BudgetName", "OldAction", "NewAction" ], "members": { "AccountId": { "shape": "AccountId" }, "BudgetName": { "shape": "BudgetName" }, "OldAction": { "shape": "Action", "documentation": "

The previous action resource information.

" }, "NewAction": { "shape": "Action", "documentation": "

The updated action resource information.

" } } }, "UpdateBudgetRequest": { "type": "structure", "required": [ "AccountId", "NewBudget" ], "members": { "AccountId": { "shape": "AccountId", "documentation": "

The accountId that is associated with the budget that you want to update.

" }, "NewBudget": { "shape": "Budget", "documentation": "

The budget that you want to update your budget to.

" } }, "documentation": "

Request of UpdateBudget

" }, "UpdateBudgetResponse": { "type": "structure", "members": {}, "documentation": "

Response of UpdateBudget

" }, "UpdateNotificationRequest": { "type": "structure", "required": [ "AccountId", "BudgetName", "OldNotification", "NewNotification" ], "members": { "AccountId": { "shape": "AccountId", "documentation": "

The accountId that is associated with the budget whose notification you want to update.

" }, "BudgetName": { "shape": "BudgetName", "documentation": "

The name of the budget whose notification you want to update.

" }, "OldNotification": { "shape": "Notification", "documentation": "

The previous notification that is associated with a budget.

" }, "NewNotification": { "shape": "Notification", "documentation": "

The updated notification to be associated with a budget.

" } }, "documentation": "

Request of UpdateNotification

" }, "UpdateNotificationResponse": { "type": "structure", "members": {}, "documentation": "

Response of UpdateNotification

" }, "UpdateSubscriberRequest": { "type": "structure", "required": [ "AccountId", "BudgetName", "Notification", "OldSubscriber", "NewSubscriber" ], "members": { "AccountId": { "shape": "AccountId", "documentation": "

The accountId that is associated with the budget whose subscriber you want to update.

" }, "BudgetName": { "shape": "BudgetName", "documentation": "

The name of the budget whose subscriber you want to update.

" }, "Notification": { "shape": "Notification", "documentation": "

The notification whose subscriber you want to update.

" }, "OldSubscriber": { "shape": "Subscriber", "documentation": "

The previous subscriber that is associated with a budget notification.

" }, "NewSubscriber": { "shape": "Subscriber", "documentation": "

The updated subscriber that is associated with a budget notification.

" } }, "documentation": "

Request of UpdateSubscriber

" }, "UpdateSubscriberResponse": { "type": "structure", "members": {}, "documentation": "

Response of UpdateSubscriber

" }, "User": { "type": "string", "max": 576, "min": 1, "pattern": "^([\\u0021-\\u007F]+\\u002F)?[\\w+=,.@-]+$" }, "Users": { "type": "list", "member": { "shape": "User" }, "max": 100, "min": 1 } }, "documentation": "

Use the Amazon Web Services Budgets API to plan your service usage, service costs, and instance reservations. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for the Amazon Web Services Budgets feature.

Budgets provide you with a way to see the following information:

Amazon Web Services updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:

Service Endpoint

The Amazon Web Services Budgets API provides the following endpoint:

For information about costs that are associated with the Amazon Web Services Budgets API, see Amazon Web Services Cost Management Pricing.

" }