@aws-sdk/client-budgets 3.296.0 → 3.297.0

package/dist-types/models/models_0.d.ts

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { BudgetsServiceException as __BaseException } from "./BudgetsServiceException";
 /**
+ * @public
  * <p>You are not authorized to use this operation with the given parameters.</p>
  */
 export declare class AccessDeniedException extends __BaseException {
@@ -15,11 +16,15 @@ export declare class AccessDeniedException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum ThresholdType {
     ABSOLUTE_VALUE = "ABSOLUTE_VALUE",
     PERCENTAGE = "PERCENTAGE"
 }
 /**
+ * @public
  * <p>The trigger threshold of the action. </p>
  */
 export interface ActionThreshold {
@@ -32,16 +37,23 @@ export interface ActionThreshold {
      */
     ActionThresholdType: ThresholdType | string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum ActionType {
     IAM = "APPLY_IAM_POLICY",
     SCP = "APPLY_SCP_POLICY",
     SSM = "RUN_SSM_DOCUMENTS"
 }
+/**
+ * @public
+ */
 export declare enum ApprovalModel {
     AUTO = "AUTOMATIC",
     MANUAL = "MANUAL"
 }
 /**
+ * @public
  * <p>The Identity and Access Management (IAM) action definition details. </p>
  */
 export interface IamActionDefinition {
@@ -63,6 +75,7 @@ export interface IamActionDefinition {
     Users?: string[];
 }
 /**
+ * @public
  * <p>The service control policies (SCP) action definition details. </p>
  */
 export interface ScpActionDefinition {
@@ -75,11 +88,15 @@ export interface ScpActionDefinition {
      */
     TargetIds: string[] | undefined;
 }
+/**
+ * @public
+ */
 export declare enum ActionSubType {
     STOP_EC2 = "STOP_EC2_INSTANCES",
     STOP_RDS = "STOP_RDS_INSTANCES"
 }
 /**
+ * @public
  * <p>The Amazon Web Services Systems Manager (SSM) action definition details. </p>
  */
 export interface SsmActionDefinition {
@@ -97,6 +114,7 @@ export interface SsmActionDefinition {
     InstanceIds: string[] | undefined;
 }
 /**
+ * @public
  * <p>Specifies all of the type-specific parameters. </p>
  */
 export interface Definition {
@@ -113,10 +131,16 @@ export interface Definition {
      */
     SsmActionDefinition?: SsmActionDefinition;
 }
+/**
+ * @public
+ */
 export declare enum NotificationType {
     ACTUAL = "ACTUAL",
     FORECASTED = "FORECASTED"
 }
+/**
+ * @public
+ */
 export declare enum ActionStatus {
     Execution_Failure = "EXECUTION_FAILURE",
     Execution_In_Progress = "EXECUTION_IN_PROGRESS",
@@ -129,11 +153,15 @@ export declare enum ActionStatus {
     Reverse_Success = "REVERSE_SUCCESS",
     Standby = "STANDBY"
 }
+/**
+ * @public
+ */
 export declare enum SubscriptionType {
     EMAIL = "EMAIL",
     SNS = "SNS"
 }
 /**
+ * @public
  * <p>The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon SNS topic or an email address.</p>
  * 		       <p>For example, an email subscriber has the following parameters:</p>
  * 		       <ul>
@@ -159,6 +187,7 @@ export interface Subscriber {
     Address: string | undefined;
 }
 /**
+ * @public
  * <p>A budget action resource. </p>
  */
 export interface Action {
@@ -206,6 +235,7 @@ export interface Action {
     Subscribers: Subscriber[] | undefined;
 }
 /**
+ * @public
  * <p>The description of the details for the event. </p>
  */
 export interface ActionHistoryDetails {
@@ -218,6 +248,9 @@ export interface ActionHistoryDetails {
      */
     Action: Action | undefined;
 }
+/**
+ * @public
+ */
 export declare enum EventType {
     CreateAction = "CREATE_ACTION",
     DeleteAction = "DELETE_ACTION",
@@ -226,6 +259,7 @@ export declare enum EventType {
     UpdateAction = "UPDATE_ACTION"
 }
 /**
+ * @public
  * <p>The historical records for a budget action. </p>
  */
 export interface ActionHistory {
@@ -247,11 +281,15 @@ export interface ActionHistory {
      */
     ActionHistoryDetails: ActionHistoryDetails | undefined;
 }
+/**
+ * @public
+ */
 export declare enum AutoAdjustType {
     FORECAST = "FORECAST",
     HISTORICAL = "HISTORICAL"
 }
 /**
+ * @public
  * <p>The parameters that define or describe the historical data that your auto-adjusting budget is based on.</p>
  */
 export interface HistoricalOptions {
@@ -281,6 +319,7 @@ export interface HistoricalOptions {
     LookBackAvailablePeriods?: number;
 }
 /**
+ * @public
  * <p>The parameters that determine the budget amount for an auto-adjusting budget.</p>
  */
 export interface AutoAdjustData {
@@ -298,6 +337,7 @@ export interface AutoAdjustData {
     LastAutoAdjustTime?: Date;
 }
 /**
+ * @public
  * <p>The amount of cost or usage that's measured for a budget.</p>
  * 		       <p>For example, a <code>Spend</code> for <code>3 GB</code> of S3 usage has the following
  * 			parameters:</p>
@@ -324,6 +364,9 @@ export interface Spend {
      */
     Unit: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum BudgetType {
     Cost = "COST",
     RICoverage = "RI_COVERAGE",
@@ -333,6 +376,7 @@ export declare enum BudgetType {
     Usage = "USAGE"
 }
 /**
+ * @public
  * <p>The spend objects that are associated with this budget. The <code>actualSpend</code> tracks
  * 			how much you've used, cost, usage, RI units, or Savings Plans units and the
  * 				<code>forecastedSpend</code> tracks how much that you're predicted to spend based on
@@ -353,6 +397,7 @@ export interface CalculatedSpend {
     ForecastedSpend?: Spend;
 }
 /**
+ * @public
  * <p>The types of cost that are included in a <code>COST</code> budget, such as tax and subscriptions.</p>
  * 		       <p>
  *             <code>USAGE</code>, <code>RI_UTILIZATION</code>, <code>RI_COVERAGE</code>,
@@ -417,6 +462,7 @@ export interface CostTypes {
     UseAmortized?: boolean;
 }
 /**
+ * @public
  * <p>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. </p>
  */
@@ -434,6 +480,9 @@ export interface TimePeriod {
      */
     End?: Date;
 }
+/**
+ * @public
+ */
 export declare enum TimeUnit {
     ANNUALLY = "ANNUALLY",
     DAILY = "DAILY",
@@ -441,6 +490,7 @@ export declare enum TimeUnit {
     QUARTERLY = "QUARTERLY"
 }
 /**
+ * @public
  * <p>Represents the output of the <code>CreateBudget</code> operation. The content consists of the detailed metadata and data file information, and the current status of the <code>budget</code> object.</p>
  * 		       <p>This is the Amazon Resource Name (ARN) pattern for a budget: </p>
  * 		       <p>
@@ -555,16 +605,23 @@ export interface Budget {
      */
     AutoAdjustData?: AutoAdjustData;
 }
+/**
+ * @public
+ */
 export declare enum ComparisonOperator {
     EQUAL_TO = "EQUAL_TO",
     GREATER_THAN = "GREATER_THAN",
     LESS_THAN = "LESS_THAN"
 }
+/**
+ * @public
+ */
 export declare enum NotificationState {
     ALARM = "ALARM",
     OK = "OK"
 }
 /**
+ * @public
  * <p>A notification that's associated with a budget. A budget can have up to ten notifications. </p>
  * 		       <p>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.</p>
  * 		       <p>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:</p>
@@ -614,6 +671,7 @@ export interface Notification {
     NotificationState?: NotificationState | string;
 }
 /**
+ * @public
  * <p>A notification with subscribers. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.</p>
  */
 export interface NotificationWithSubscribers {
@@ -627,6 +685,7 @@ export interface NotificationWithSubscribers {
     Subscribers: Subscriber[] | undefined;
 }
 /**
+ * @public
  * <p> Request of CreateBudget </p>
  */
 export interface CreateBudgetRequest {
@@ -644,11 +703,13 @@ export interface CreateBudgetRequest {
     NotificationsWithSubscribers?: NotificationWithSubscribers[];
 }
 /**
+ * @public
  * <p> Response of CreateBudget </p>
  */
 export interface CreateBudgetResponse {
 }
 /**
+ * @public
  * <p>You've exceeded the notification or subscriber limit.</p>
  */
 export declare class CreationLimitExceededException extends __BaseException {
@@ -664,6 +725,7 @@ export declare class CreationLimitExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<CreationLimitExceededException, __BaseException>);
 }
 /**
+ * @public
  * <p>The budget name already exists. Budget names must be unique within an account.</p>
  */
 export declare class DuplicateRecordException extends __BaseException {
@@ -679,6 +741,7 @@ export declare class DuplicateRecordException extends __BaseException {
     constructor(opts: __ExceptionOptionType<DuplicateRecordException, __BaseException>);
 }
 /**
+ * @public
  * <p>An error on the server occurred during the processing of your request. Try again later.</p>
  */
 export declare class InternalErrorException extends __BaseException {
@@ -694,6 +757,7 @@ export declare class InternalErrorException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalErrorException, __BaseException>);
 }
 /**
+ * @public
  * <p>An error on the client occurred. Typically, the cause is an invalid input value.</p>
  */
 export declare class InvalidParameterException extends __BaseException {
@@ -709,6 +773,7 @@ export declare class InvalidParameterException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
 }
 /**
+ * @public
  * <p>
  *       The number of API requests has exceeded the maximum allowed API request throttling limit for the account.
  *     </p>
@@ -725,6 +790,9 @@ export declare class ThrottlingException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface CreateBudgetActionRequest {
     /**
      * <p>The account ID of the user. It's a 12-digit number.</p>
@@ -769,6 +837,9 @@ export interface CreateBudgetActionRequest {
      */
     Subscribers: Subscriber[] | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateBudgetActionResponse {
     /**
      * <p>The account ID of the user. It's a 12-digit number.</p>
@@ -786,6 +857,7 @@ export interface CreateBudgetActionResponse {
     ActionId: string | undefined;
 }
 /**
+ * @public
  * <p>We can’t locate the resource that you specified.</p>
  */
 export declare class NotFoundException extends __BaseException {
@@ -801,6 +873,7 @@ export declare class NotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p> Request of CreateNotification </p>
  */
 export interface CreateNotificationRequest {
@@ -822,11 +895,13 @@ export interface CreateNotificationRequest {
     Subscribers: Subscriber[] | undefined;
 }
 /**
+ * @public
  * <p> Response of CreateNotification </p>
  */
 export interface CreateNotificationResponse {
 }
 /**
+ * @public
  * <p> Request of CreateSubscriber </p>
  */
 export interface CreateSubscriberRequest {
@@ -848,11 +923,13 @@ export interface CreateSubscriberRequest {
     Subscriber: Subscriber | undefined;
 }
 /**
+ * @public
  * <p> Response of CreateSubscriber </p>
  */
 export interface CreateSubscriberResponse {
 }
 /**
+ * @public
  * <p> Request of DeleteBudget </p>
  */
 export interface DeleteBudgetRequest {
@@ -866,10 +943,14 @@ export interface DeleteBudgetRequest {
     BudgetName: string | undefined;
 }
 /**
+ * @public
  * <p> Response of DeleteBudget </p>
  */
 export interface DeleteBudgetResponse {
 }
+/**
+ * @public
+ */
 export interface DeleteBudgetActionRequest {
     /**
      * <p>The account ID of the user. It's a 12-digit number.</p>
@@ -886,6 +967,9 @@ export interface DeleteBudgetActionRequest {
      */
     ActionId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteBudgetActionResponse {
     /**
      * <p>The account ID of the user. It's a 12-digit number.</p>
@@ -901,6 +985,7 @@ export interface DeleteBudgetActionResponse {
     Action: Action | undefined;
 }
 /**
+ * @public
  * <p> The request was received and recognized by the server, but the server rejected that
  *       particular method for the requested resource. </p>
  */
@@ -917,6 +1002,7 @@ export declare class ResourceLockedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceLockedException, __BaseException>);
 }
 /**
+ * @public
  * <p> Request of DeleteNotification </p>
  */
 export interface DeleteNotificationRequest {
@@ -934,11 +1020,13 @@ export interface DeleteNotificationRequest {
     Notification: Notification | undefined;
 }
 /**
+ * @public
  * <p> Response of DeleteNotification </p>
  */
 export interface DeleteNotificationResponse {
 }
 /**
+ * @public
  * <p> Request of DeleteSubscriber </p>
  */
 export interface DeleteSubscriberRequest {
@@ -960,11 +1048,13 @@ export interface DeleteSubscriberRequest {
     Subscriber: Subscriber | undefined;
 }
 /**
+ * @public
  * <p> Response of DeleteSubscriber </p>
  */
 export interface DeleteSubscriberResponse {
 }
 /**
+ * @public
  * <p> Request of DescribeBudget </p>
  */
 export interface DescribeBudgetRequest {
@@ -978,6 +1068,7 @@ export interface DescribeBudgetRequest {
     BudgetName: string | undefined;
 }
 /**
+ * @public
  * <p> Response of DescribeBudget </p>
  */
 export interface DescribeBudgetResponse {
@@ -986,6 +1077,9 @@ export interface DescribeBudgetResponse {
      */
     Budget?: Budget;
 }
+/**
+ * @public
+ */
 export interface DescribeBudgetActionRequest {
     /**
      * <p>The account ID of the user. It's a 12-digit number.</p>
@@ -1002,6 +1096,9 @@ export interface DescribeBudgetActionRequest {
      */
     ActionId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeBudgetActionResponse {
     /**
      * <p>The account ID of the user. It's a 12-digit number.</p>
@@ -1018,6 +1115,9 @@ export interface DescribeBudgetActionResponse {
      */
     Action: Action | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeBudgetActionHistoriesRequest {
     /**
      * <p>The account ID of the user. It's a 12-digit number.</p>
@@ -1047,6 +1147,9 @@ export interface DescribeBudgetActionHistoriesRequest {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeBudgetActionHistoriesResponse {
     /**
      * <p>
@@ -1060,6 +1163,7 @@ export interface DescribeBudgetActionHistoriesResponse {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>The pagination token is invalid.</p>
  */
 export declare class InvalidNextTokenException extends __BaseException {
@@ -1074,6 +1178,9 @@ export declare class InvalidNextTokenException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<InvalidNextTokenException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DescribeBudgetActionsForAccountRequest {
     /**
      * <p>The account ID of the user. It's a 12-digit number.</p>
@@ -1088,6 +1195,9 @@ export interface DescribeBudgetActionsForAccountRequest {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeBudgetActionsForAccountResponse {
     /**
      * <p>
@@ -1100,6 +1210,9 @@ export interface DescribeBudgetActionsForAccountResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeBudgetActionsForBudgetRequest {
     /**
      * <p>The account ID of the user. It's a 12-digit number.</p>
@@ -1118,6 +1231,9 @@ export interface DescribeBudgetActionsForBudgetRequest {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeBudgetActionsForBudgetResponse {
     /**
      * <p>
@@ -1130,6 +1246,9 @@ export interface DescribeBudgetActionsForBudgetResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeBudgetNotificationsForAccountRequest {
     /**
      * <p>The account ID of the user. It's a 12-digit number.</p>
@@ -1147,6 +1266,7 @@ export interface DescribeBudgetNotificationsForAccountRequest {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>
  *          The budget name and associated notifications for an account.
  *       </p>
@@ -1161,6 +1281,9 @@ export interface BudgetNotificationsForAccount {
      */
     BudgetName?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeBudgetNotificationsForAccountResponse {
     /**
      * <p>
@@ -1174,6 +1297,7 @@ export interface DescribeBudgetNotificationsForAccountResponse {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>The pagination token expired.</p>
  */
 export declare class ExpiredNextTokenException extends __BaseException {
@@ -1188,6 +1312,9 @@ export declare class ExpiredNextTokenException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ExpiredNextTokenException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DescribeBudgetPerformanceHistoryRequest {
     /**
      * <p>The account ID of the user. It's a 12-digit number.</p>
@@ -1211,6 +1338,7 @@ export interface DescribeBudgetPerformanceHistoryRequest {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>The amount of cost or usage that you created the budget for, compared to your actual costs or usage.</p>
  */
 export interface BudgetedAndActualAmounts {
@@ -1228,6 +1356,7 @@ export interface BudgetedAndActualAmounts {
     TimePeriod?: TimePeriod;
 }
 /**
+ * @public
  * <p>A history of the state of a budget at the end of the budget's specified time period.</p>
  */
 export interface BudgetPerformanceHistory {
@@ -1259,6 +1388,9 @@ export interface BudgetPerformanceHistory {
      */
     BudgetedAndActualAmountsList?: BudgetedAndActualAmounts[];
 }
+/**
+ * @public
+ */
 export interface DescribeBudgetPerformanceHistoryResponse {
     /**
      * <p>The history of how often the budget has gone into an <code>ALARM</code> state.</p>
@@ -1271,6 +1403,7 @@ export interface DescribeBudgetPerformanceHistoryResponse {
     NextToken?: string;
 }
 /**
+ * @public
  * <p> Request of DescribeBudgets </p>
  */
 export interface DescribeBudgetsRequest {
@@ -1288,6 +1421,7 @@ export interface DescribeBudgetsRequest {
     NextToken?: string;
 }
 /**
+ * @public
  * <p> Response of DescribeBudgets </p>
  */
 export interface DescribeBudgetsResponse {
@@ -1301,6 +1435,7 @@ export interface DescribeBudgetsResponse {
     NextToken?: string;
 }
 /**
+ * @public
  * <p> Request of DescribeNotificationsForBudget </p>
  */
 export interface DescribeNotificationsForBudgetRequest {
@@ -1322,6 +1457,7 @@ export interface DescribeNotificationsForBudgetRequest {
     NextToken?: string;
 }
 /**
+ * @public
  * <p> Response of GetNotificationsForBudget </p>
  */
 export interface DescribeNotificationsForBudgetResponse {
@@ -1335,6 +1471,7 @@ export interface DescribeNotificationsForBudgetResponse {
     NextToken?: string;
 }
 /**
+ * @public
  * <p> Request of DescribeSubscribersForNotification </p>
  */
 export interface DescribeSubscribersForNotificationRequest {
@@ -1360,6 +1497,7 @@ export interface DescribeSubscribersForNotificationRequest {
     NextToken?: string;
 }
 /**
+ * @public
  * <p> Response of DescribeSubscribersForNotification </p>
  */
 export interface DescribeSubscribersForNotificationResponse {
@@ -1372,12 +1510,18 @@ export interface DescribeSubscribersForNotificationResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export declare enum ExecutionType {
     ApproveBudgetAction = "APPROVE_BUDGET_ACTION",
     ResetBudgetAction = "RESET_BUDGET_ACTION",
     RetryBudgetAction = "RETRY_BUDGET_ACTION",
     ReverseBudgetAction = "REVERSE_BUDGET_ACTION"
 }
+/**
+ * @public
+ */
 export interface ExecuteBudgetActionRequest {
     /**
      * <p>The account ID of the user. It's a 12-digit number.</p>
@@ -1400,6 +1544,9 @@ export interface ExecuteBudgetActionRequest {
      */
     ExecutionType: ExecutionType | string | undefined;
 }
+/**
+ * @public
+ */
 export interface ExecuteBudgetActionResponse {
     /**
      * <p>The account ID of the user. It's a 12-digit number.</p>
@@ -1423,6 +1570,7 @@ export interface ExecuteBudgetActionResponse {
     ExecutionType: ExecutionType | string | undefined;
 }
 /**
+ * @public
  * <p> Request of UpdateBudget </p>
  */
 export interface UpdateBudgetRequest {
@@ -1436,10 +1584,14 @@ export interface UpdateBudgetRequest {
     NewBudget: Budget | undefined;
 }
 /**
+ * @public
  * <p> Response of UpdateBudget </p>
  */
 export interface UpdateBudgetResponse {
 }
+/**
+ * @public
+ */
 export interface UpdateBudgetActionRequest {
     /**
      * <p>The account ID of the user. It's a 12-digit number.</p>
@@ -1484,6 +1636,9 @@ export interface UpdateBudgetActionRequest {
      */
     Subscribers?: Subscriber[];
 }
+/**
+ * @public
+ */
 export interface UpdateBudgetActionResponse {
     /**
      * <p>The account ID of the user. It's a 12-digit number.</p>
@@ -1507,6 +1662,7 @@ export interface UpdateBudgetActionResponse {
     NewAction: Action | undefined;
 }
 /**
+ * @public
  * <p> Request of UpdateNotification </p>
  */
 export interface UpdateNotificationRequest {
@@ -1528,11 +1684,13 @@ export interface UpdateNotificationRequest {
     NewNotification: Notification | undefined;
 }
 /**
+ * @public
  * <p> Response of UpdateNotification </p>
  */
 export interface UpdateNotificationResponse {
 }
 /**
+ * @public
  * <p> Request of UpdateSubscriber </p>
  */
 export interface UpdateSubscriberRequest {
@@ -1558,6 +1716,7 @@ export interface UpdateSubscriberRequest {
     NewSubscriber: Subscriber | undefined;
 }
 /**
+ * @public
  * <p> Response of UpdateSubscriber </p>
  */
 export interface UpdateSubscriberResponse {