package types
import "github.com/aws/aws-sdk-go-v2/service/budgets/types"
Index ¶
- type AccessDeniedException
- func (e *AccessDeniedException) Error() string
- func (e *AccessDeniedException) ErrorCode() string
- func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault
- func (e *AccessDeniedException) ErrorMessage() string
- type Budget
- type BudgetPerformanceHistory
- type BudgetType
- type BudgetedAndActualAmounts
- type CalculatedSpend
- type ComparisonOperator
- type CostTypes
- type CreationLimitExceededException
- func (e *CreationLimitExceededException) Error() string
- func (e *CreationLimitExceededException) ErrorCode() string
- func (e *CreationLimitExceededException) ErrorFault() smithy.ErrorFault
- func (e *CreationLimitExceededException) ErrorMessage() string
- type DuplicateRecordException
- func (e *DuplicateRecordException) Error() string
- func (e *DuplicateRecordException) ErrorCode() string
- func (e *DuplicateRecordException) ErrorFault() smithy.ErrorFault
- func (e *DuplicateRecordException) ErrorMessage() string
- type ExpiredNextTokenException
- func (e *ExpiredNextTokenException) Error() string
- func (e *ExpiredNextTokenException) ErrorCode() string
- func (e *ExpiredNextTokenException) ErrorFault() smithy.ErrorFault
- func (e *ExpiredNextTokenException) ErrorMessage() string
- type InternalErrorException
- func (e *InternalErrorException) Error() string
- func (e *InternalErrorException) ErrorCode() string
- func (e *InternalErrorException) ErrorFault() smithy.ErrorFault
- func (e *InternalErrorException) ErrorMessage() string
- type InvalidNextTokenException
- func (e *InvalidNextTokenException) Error() string
- func (e *InvalidNextTokenException) ErrorCode() string
- func (e *InvalidNextTokenException) ErrorFault() smithy.ErrorFault
- func (e *InvalidNextTokenException) ErrorMessage() string
- type InvalidParameterException
- func (e *InvalidParameterException) Error() string
- func (e *InvalidParameterException) ErrorCode() string
- func (e *InvalidParameterException) ErrorFault() smithy.ErrorFault
- func (e *InvalidParameterException) ErrorMessage() string
- type NotFoundException
- func (e *NotFoundException) Error() string
- func (e *NotFoundException) ErrorCode() string
- func (e *NotFoundException) ErrorFault() smithy.ErrorFault
- func (e *NotFoundException) ErrorMessage() string
- type Notification
- type NotificationState
- type NotificationType
- type NotificationWithSubscribers
- type Spend
- type Subscriber
- type SubscriptionType
- type ThresholdType
- type TimePeriod
- type TimeUnit
Types ¶
type AccessDeniedException ¶
type AccessDeniedException struct { Message *string }
You are not authorized to use this operation with the given parameters.
func (*AccessDeniedException) Error ¶
func (e *AccessDeniedException) Error() string
func (*AccessDeniedException) ErrorCode ¶
func (e *AccessDeniedException) ErrorCode() string
func (*AccessDeniedException) ErrorFault ¶
func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault
func (*AccessDeniedException) ErrorMessage ¶
func (e *AccessDeniedException) ErrorMessage() string
type Budget ¶
type Budget struct { // 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. CostTypes *CostTypes // The length of time until a budget resets the actual and forecasted spend. DAILY // is available only for RI_UTILIZATION, RI_COVERAGE, Savings_Plans_Utilization, // and Savings_Plans_Coverage budgets. // // This member is required. TimeUnit TimeUnit // The cost filters, such as service or tag, that are applied to a budget. AWS // Budgets supports the following services as a filter for RI budgets: // // * // Amazon Elastic Compute Cloud - Compute // // * Amazon Redshift // // * Amazon // Relational Database Service // // * Amazon ElastiCache // // * Amazon // Elasticsearch Service CostFilters map[string][]*string // The actual and forecasted cost or usage that the budget tracks. CalculatedSpend *CalculatedSpend // The last time that you updated this budget. LastUpdatedTime *time.Time // A map containing multiple BudgetLimit, including current or future limits. // PlannedBudgetLimits is available for cost or usage budget and supports 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 4 quarters of PlannedBudgetLimits value entries in // standard calendar quarter increments. This must start from the current quarter // and include the next 3 quarters. The key is the start of the quarter, UTC in // epoch seconds. If the planned budget expires before 12 months for monthly or 4 // 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 will also contain BudgetLimit // representing the current month or quarter limit present in PlannedBudgetLimits. // This only applies to budgets created with PlannedBudgetLimits. Budgets created // without PlannedBudgetLimits will only contain BudgetLimit, and no // PlannedBudgetLimits. PlannedBudgetLimits map[string]*Spend // The name of a budget. The name must be unique within an account. The : and \ // characters aren't allowed in BudgetName. // // This member is required. BudgetName *string // 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, which 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. BudgetLimit *Spend // The period of time that is covered by a budget. The period has a start date and // an 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, AWS 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, AWS set your start // date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to // 01/01/18 00:00 UTC. If you didn't specify an end date, AWS set your end date to // 06/15/87 00:00 UTC. The defaults are the same for the AWS Billing and Cost // Management console and the API. You can change either date with the UpdateBudget // operation. After the end date, AWS deletes the budget and all associated // notifications and subscribers. TimePeriod *TimePeriod // Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings // Plans utilization, or Savings Plans coverage. // // This member is required. BudgetType BudgetType }
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 ARN pattern for a budget: arn:aws:budgetservice::AccountId:budget/budgetName
type BudgetPerformanceHistory ¶
type BudgetPerformanceHistory struct { // A string that represents the budget name. The ":" and "\" characters aren't // allowed. BudgetName *string // A list of amounts of cost or usage that you created budgets for, compared to // your actual costs or usage. BudgetedAndActualAmountsList []*BudgetedAndActualAmounts // The time unit of the budget, such as MONTHLY or QUARTERLY. TimeUnit TimeUnit // The history of the cost filters for a budget during the specified time period. CostFilters map[string][]*string // The history of the cost types for a budget during the specified time period. CostTypes *CostTypes // The type of a budget. It must be one of the following types: COST, USAGE, // RI_UTILIZATION, or RI_COVERAGE. BudgetType BudgetType }
A history of the state of a budget at the end of the budget's specified time period.
type BudgetType ¶
type BudgetType string
const ( BudgetTypeUsage BudgetType = "USAGE" BudgetTypeCost BudgetType = "COST" BudgetTypeRiutilization BudgetType = "RI_UTILIZATION" BudgetTypeRicoverage BudgetType = "RI_COVERAGE" BudgetTypeSputilization BudgetType = "SAVINGS_PLANS_UTILIZATION" BudgetTypeSpcoverage BudgetType = "SAVINGS_PLANS_COVERAGE" )
Enum values for BudgetType
type BudgetedAndActualAmounts ¶
type BudgetedAndActualAmounts struct { // Your actual costs or usage for a budget period. ActualAmount *Spend // The amount of cost or usage that you created the budget for. BudgetedAmount *Spend // The time period covered by this budget comparison. TimePeriod *TimePeriod }
The amount of cost or usage that you created the budget for, compared to your actual costs or usage.
type CalculatedSpend ¶
type CalculatedSpend struct { // The amount of cost, usage, or RI units that you are forecasted to use. ForecastedSpend *Spend // The amount of cost, usage, or RI units that you have used. // // This member is required. ActualSpend *Spend }
The spend objects that are associated with this budget. The actualSpend tracks how much you've used, cost, usage, or RI units, and the forecastedSpend tracks how much you are predicted to spend if your current usage remains steady. For example, if it is 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.
type ComparisonOperator ¶
type ComparisonOperator string
const ( ComparisonOperatorGreater_than ComparisonOperator = "GREATER_THAN" ComparisonOperatorLess_than ComparisonOperator = "LESS_THAN" ComparisonOperatorEqual_to ComparisonOperator = "EQUAL_TO" )
Enum values for ComparisonOperator
type CostTypes ¶
type CostTypes struct { // Specifies whether a budget includes upfront RI costs. The default value is true. IncludeUpfront *bool // Specifies whether a budget includes subscriptions. The default value is true. IncludeSubscription *bool // Specifies whether a budget includes credits. The default value is true. IncludeCredit *bool // Specifies whether a budget includes discounts. The default value is true. IncludeDiscount *bool // Specifies whether a budget includes refunds. The default value is true. IncludeRefund *bool // Specifies whether a budget includes recurring fees such as monthly RI fees. The // default value is true. IncludeRecurring *bool // Specifies whether a budget uses the amortized rate. The default value is false. UseAmortized *bool // Specifies whether a budget includes non-RI subscription costs. The default value // is true. IncludeOtherSubscription *bool // Specifies whether a budget includes support subscription fees. The default value // is true. IncludeSupport *bool // Specifies whether a budget uses a blended rate. The default value is false. UseBlended *bool // Specifies whether a budget includes taxes. The default value is true. IncludeTax *bool }
The types of cost that are included in a COST budget, such as tax and subscriptions. USAGE, RI_UTILIZATION, and RI_COVERAGE budgets do not have CostTypes.
type CreationLimitExceededException ¶
type CreationLimitExceededException struct { Message *string }
You've exceeded the notification or subscriber limit.
func (*CreationLimitExceededException) Error ¶
func (e *CreationLimitExceededException) Error() string
func (*CreationLimitExceededException) ErrorCode ¶
func (e *CreationLimitExceededException) ErrorCode() string
func (*CreationLimitExceededException) ErrorFault ¶
func (e *CreationLimitExceededException) ErrorFault() smithy.ErrorFault
func (*CreationLimitExceededException) ErrorMessage ¶
func (e *CreationLimitExceededException) ErrorMessage() string
type DuplicateRecordException ¶
type DuplicateRecordException struct { Message *string }
The budget name already exists. Budget names must be unique within an account.
func (*DuplicateRecordException) Error ¶
func (e *DuplicateRecordException) Error() string
func (*DuplicateRecordException) ErrorCode ¶
func (e *DuplicateRecordException) ErrorCode() string
func (*DuplicateRecordException) ErrorFault ¶
func (e *DuplicateRecordException) ErrorFault() smithy.ErrorFault
func (*DuplicateRecordException) ErrorMessage ¶
func (e *DuplicateRecordException) ErrorMessage() string
type ExpiredNextTokenException ¶
type ExpiredNextTokenException struct { Message *string }
The pagination token expired.
func (*ExpiredNextTokenException) Error ¶
func (e *ExpiredNextTokenException) Error() string
func (*ExpiredNextTokenException) ErrorCode ¶
func (e *ExpiredNextTokenException) ErrorCode() string
func (*ExpiredNextTokenException) ErrorFault ¶
func (e *ExpiredNextTokenException) ErrorFault() smithy.ErrorFault
func (*ExpiredNextTokenException) ErrorMessage ¶
func (e *ExpiredNextTokenException) ErrorMessage() string
type InternalErrorException ¶
type InternalErrorException struct { Message *string }
An error on the server occurred during the processing of your request. Try again later.
func (*InternalErrorException) Error ¶
func (e *InternalErrorException) Error() string
func (*InternalErrorException) ErrorCode ¶
func (e *InternalErrorException) ErrorCode() string
func (*InternalErrorException) ErrorFault ¶
func (e *InternalErrorException) ErrorFault() smithy.ErrorFault
func (*InternalErrorException) ErrorMessage ¶
func (e *InternalErrorException) ErrorMessage() string
type InvalidNextTokenException ¶
type InvalidNextTokenException struct { Message *string }
The pagination token is invalid.
func (*InvalidNextTokenException) Error ¶
func (e *InvalidNextTokenException) Error() string
func (*InvalidNextTokenException) ErrorCode ¶
func (e *InvalidNextTokenException) ErrorCode() string
func (*InvalidNextTokenException) ErrorFault ¶
func (e *InvalidNextTokenException) ErrorFault() smithy.ErrorFault
func (*InvalidNextTokenException) ErrorMessage ¶
func (e *InvalidNextTokenException) ErrorMessage() string
type InvalidParameterException ¶
type InvalidParameterException struct { Message *string }
An error on the client occurred. Typically, the cause is an invalid input value.
func (*InvalidParameterException) Error ¶
func (e *InvalidParameterException) Error() string
func (*InvalidParameterException) ErrorCode ¶
func (e *InvalidParameterException) ErrorCode() string
func (*InvalidParameterException) ErrorFault ¶
func (e *InvalidParameterException) ErrorFault() smithy.ErrorFault
func (*InvalidParameterException) ErrorMessage ¶
func (e *InvalidParameterException) ErrorMessage() string
type NotFoundException ¶
type NotFoundException struct { Message *string }
We can’t locate the resource that you specified.
func (*NotFoundException) Error ¶
func (e *NotFoundException) Error() string
func (*NotFoundException) ErrorCode ¶
func (e *NotFoundException) ErrorCode() string
func (*NotFoundException) ErrorFault ¶
func (e *NotFoundException) ErrorFault() smithy.ErrorFault
func (*NotFoundException) ErrorMessage ¶
func (e *NotFoundException) ErrorMessage() string
type Notification ¶
type Notification struct { // The comparison that is used for this notification. // // This member is required. ComparisonOperator ComparisonOperator // The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, AWS // notifies you when you go over or are forecasted to go over your total cost // threshold. For PERCENTAGE thresholds, AWS 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%, AWS notifies you when you go over 160 dollars. ThresholdType ThresholdType // Whether this notification is in alarm. If a budget notification is in the ALARM // state, you have passed the set threshold for the budget. NotificationState NotificationState // The threshold that is associated with a notification. Thresholds are always a // percentage. // // This member is required. Threshold *float64 // Whether the notification is for how much you have spent (ACTUAL) or for how much // you're forecasted to spend (FORECASTED). // // This member is required. NotificationType NotificationType }
A notification that is associated with a budget. A budget can have up to five 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:
A notificationType of ACTUAL
A
thresholdType of PERCENTAGE
A comparisonOperator of GREATER_THAN
A
notification threshold of 80
type NotificationState ¶
type NotificationState string
const ( NotificationStateOk NotificationState = "OK" NotificationStateAlarm NotificationState = "ALARM" )
Enum values for NotificationState
type NotificationType ¶
type NotificationType string
const ( NotificationTypeActual NotificationType = "ACTUAL" NotificationTypeForecasted NotificationType = "FORECASTED" )
Enum values for NotificationType
type NotificationWithSubscribers ¶
type NotificationWithSubscribers struct { // The notification that is associated with a budget. // // This member is required. Notification *Notification // A list of subscribers who are subscribed to this notification. // // This member is required. Subscribers []*Subscriber }
A notification with subscribers. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.
type Spend ¶
type Spend struct { // The cost or usage amount that is associated with a budget forecast, actual // spend, or budget threshold. // // This member is required. Amount *string // The unit of measurement that is used for the budget forecast, actual spend, or // budget threshold, such as dollars or GB. // // This member is required. Unit *string }
The amount of cost or usage that is measured for a budget. For example, a Spend for 3 GB of S3 usage would have the following parameters:
- An Amount of
3
- A unit of GB
type Subscriber ¶
type Subscriber struct { // The address that AWS 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. // // This member is required. Address *string // The type of notification that AWS sends to a subscriber. // // This member is required. SubscriptionType SubscriptionType }
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 would have the following parameters:
- A
subscriptionType of EMAIL
- An address of example@example.com
type SubscriptionType ¶
type SubscriptionType string
const ( SubscriptionTypeSns SubscriptionType = "SNS" SubscriptionTypeEmail SubscriptionType = "EMAIL" )
Enum values for SubscriptionType
type ThresholdType ¶
type ThresholdType string
const ( ThresholdTypePercentage ThresholdType = "PERCENTAGE" ThresholdTypeAbsolute_value ThresholdType = "ABSOLUTE_VALUE" )
Enum values for ThresholdType
type TimePeriod ¶
type TimePeriod struct { // The start date for a budget. If you created your budget and didn't specify a // start date, AWS 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, AWS set your start // date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to // 01/01/18 00:00 UTC. The defaults are the same for the AWS Billing and Cost // Management console and the API. You can change your start date with the // UpdateBudget operation. Start *time.Time // The end date for a budget. If you didn't specify an end date, AWS set your end // date to 06/15/87 00:00 UTC. The defaults are the same for the AWS Billing and // Cost Management console and the API. After the end date, AWS deletes the budget // and all associated notifications and subscribers. You can change your end date // with the UpdateBudget operation. End *time.Time }
The period of time that is 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.
type TimeUnit ¶
type TimeUnit string
const ( TimeUnitDaily TimeUnit = "DAILY" TimeUnitMonthly TimeUnit = "MONTHLY" TimeUnitQuarterly TimeUnit = "QUARTERLY" TimeUnitAnnually TimeUnit = "ANNUALLY" )
Enum values for TimeUnit
Source Files ¶
- Version
- v0.26.0
- Published
- Oct 1, 2020
- Platform
- js/wasm
- Imports
- 3 packages
- Last checked
- 7 hours ago –
Tools for package owners.