types

package
v1.28.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 18, 2024 License: Apache-2.0 Imports: 4 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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 Action added in v0.29.0 

type Action struct {

	// A system-generated universally unique identifier (UUID) for the action.
	//
	// This member is required.
	ActionId *string

	// The trigger threshold of the action.
	//
	// This member is required.
	ActionThreshold *ActionThreshold

	// 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.
	//
	// This member is required.
	ActionType ActionType

	// This specifies if the action needs manual or automatic approval.
	//
	// This member is required.
	ApprovalModel ApprovalModel

	//  A string that represents the budget name. The ":" and "\" characters, and the
	// "/action/" substring, aren't allowed.
	//
	// This member is required.
	BudgetName *string

	// Where you specify all of the type-specific parameters.
	//
	// This member is required.
	Definition *Definition

	// The role passed for action execution and reversion. Roles and actions must be
	// in the same account.
	//
	// This member is required.
	ExecutionRoleArn *string

	//  The type of a notification. It must be ACTUAL or FORECASTED.
	//
	// This member is required.
	NotificationType NotificationType

	// The status of the action.
	//
	// This member is required.
	Status ActionStatus

	//  A list of subscribers.
	//
	// This member is required.
	Subscribers []Subscriber
	// contains filtered or unexported fields
}

A budget action resource.

type ActionHistory added in v0.29.0 

type ActionHistory struct {

	// The description of the details for the event.
	//
	// This member is required.
	ActionHistoryDetails *ActionHistoryDetails

	// This distinguishes between whether the events are triggered by the user or are
	// generated by the system.
	//
	// This member is required.
	EventType EventType

	// The status of action at the time of the event.
	//
	// This member is required.
	Status ActionStatus

	//  A generic time stamp. In Java, it's transformed to a Date object.
	//
	// This member is required.
	Timestamp *time.Time
	// contains filtered or unexported fields
}

The historical records for a budget action.

type ActionHistoryDetails added in v0.29.0 

type ActionHistoryDetails struct {

	// The budget action resource.
	//
	// This member is required.
	Action *Action

	//  A generic string.
	//
	// This member is required.
	Message *string
	// contains filtered or unexported fields
}

The description of the details for the event.

type ActionStatus added in v0.29.0 

type ActionStatus string
const (
	ActionStatusStandby             ActionStatus = "STANDBY"
	ActionStatusPending             ActionStatus = "PENDING"
	ActionStatusExecutionInProgress ActionStatus = "EXECUTION_IN_PROGRESS"
	ActionStatusExecutionSuccess    ActionStatus = "EXECUTION_SUCCESS"
	ActionStatusExecutionFailure    ActionStatus = "EXECUTION_FAILURE"
	ActionStatusReverseInProgress   ActionStatus = "REVERSE_IN_PROGRESS"
	ActionStatusReverseSuccess      ActionStatus = "REVERSE_SUCCESS"
	ActionStatusReverseFailure      ActionStatus = "REVERSE_FAILURE"
	ActionStatusResetInProgress     ActionStatus = "RESET_IN_PROGRESS"
	ActionStatusResetFailure        ActionStatus = "RESET_FAILURE"
)

Enum values for ActionStatus

func (ActionStatus) Values added in v0.29.0 

func (ActionStatus) Values() []ActionStatus

Values returns all known values for ActionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ActionSubType added in v0.29.0 

type ActionSubType string
const (
	ActionSubTypeStopEc2 ActionSubType = "STOP_EC2_INSTANCES"
	ActionSubTypeStopRds ActionSubType = "STOP_RDS_INSTANCES"
)

Enum values for ActionSubType

func (ActionSubType) Values added in v0.29.0 

func (ActionSubType) Values() []ActionSubType

Values returns all known values for ActionSubType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ActionThreshold added in v0.29.0 

type ActionThreshold struct {

	//  The type of threshold for a notification.
	//
	// This member is required.
	ActionThresholdType ThresholdType

	//  The threshold of a notification.
	//
	// This member is required.
	ActionThresholdValue float64
	// contains filtered or unexported fields
}

The trigger threshold of the action.

type ActionType added in v0.29.0 

type ActionType string
const (
	ActionTypeIam ActionType = "APPLY_IAM_POLICY"
	ActionTypeScp ActionType = "APPLY_SCP_POLICY"
	ActionTypeSsm ActionType = "RUN_SSM_DOCUMENTS"
)

Enum values for ActionType

func (ActionType) Values added in v0.29.0 

func (ActionType) Values() []ActionType

Values returns all known values for ActionType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ApprovalModel added in v0.29.0 

type ApprovalModel string
const (
	ApprovalModelAuto   ApprovalModel = "AUTOMATIC"
	ApprovalModelManual ApprovalModel = "MANUAL"
)

Enum values for ApprovalModel

func (ApprovalModel) Values added in v0.29.0 

func (ApprovalModel) Values() []ApprovalModel

Values returns all known values for ApprovalModel. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AutoAdjustData added in v1.11.0 

type AutoAdjustData struct {

	// The string that defines whether your budget auto-adjusts based on historical or
	// forecasted data.
	//
	// This member is required.
	AutoAdjustType AutoAdjustType

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

	// The last time that your budget was auto-adjusted.
	LastAutoAdjustTime *time.Time
	// contains filtered or unexported fields
}

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

type AutoAdjustType added in v1.11.0 

type AutoAdjustType string
const (
	AutoAdjustTypeHistorical AutoAdjustType = "HISTORICAL"
	AutoAdjustTypeForecast   AutoAdjustType = "FORECAST"
)

Enum values for AutoAdjustType

func (AutoAdjustType) Values added in v1.11.0 

func (AutoAdjustType) Values() []AutoAdjustType

Values returns all known values for AutoAdjustType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Budget 

type Budget struct {

	// 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 .
	//
	// This member is required.
	BudgetName *string

	// Specifies whether this budget tracks costs, usage, RI utilization, RI coverage,
	// Savings Plans utilization, or Savings Plans coverage.
	//
	// This member is required.
	BudgetType BudgetType

	// The length of time until a budget resets the actual and forecasted spend.
	//
	// This member is required.
	TimeUnit TimeUnit

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

	// 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.
	BudgetLimit *Spend

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

	// The cost filters, such as Region , Service , LinkedAccount , Tag , or
	// CostCategory , that are applied to a budget.
	//
	// Amazon Web Services Budgets supports the following services as a Service filter
	// for RI budgets:
	//
	//   - Amazon EC2
	//
	//   - Amazon Redshift
	//
	//   - Amazon Relational Database Service
	//
	//   - Amazon ElastiCache
	//
	//   - Amazon OpenSearch Service
	CostFilters map[string][]string

	// 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 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 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 .
	PlannedBudgetLimits map[string]Spend

	// 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.
	TimePeriod *TimePeriod
	// contains filtered or unexported fields
}

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

type BudgetNotificationsForAccount added in v1.11.0 

type BudgetNotificationsForAccount struct {

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

	//  A list of notifications.
	Notifications []Notification
	// contains filtered or unexported fields
}

The budget name and associated notifications for an account.

type BudgetPerformanceHistory 

type BudgetPerformanceHistory struct {

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

	//  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 .
	BudgetType BudgetType

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

	// 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 time unit of the budget, such as MONTHLY or QUARTERLY.
	TimeUnit TimeUnit
	// contains filtered or unexported fields
}

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

func (BudgetType) Values added in v0.29.0 

func (BudgetType) Values() []BudgetType

Values returns all known values for BudgetType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

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 that's covered by this budget comparison.
	TimePeriod *TimePeriod
	// contains filtered or unexported fields
}

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, RI units, or Savings Plans units that you used.
	//
	// This member is required.
	ActualSpend *Spend

	// The amount of cost, usage, RI units, or Savings Plans units that you're
	// forecasted to use.
	ForecastedSpend *Spend
	// contains filtered or unexported fields
}

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 .

type ComparisonOperator 

type ComparisonOperator string
const (
	ComparisonOperatorGreaterThan ComparisonOperator = "GREATER_THAN"
	ComparisonOperatorLessThan    ComparisonOperator = "LESS_THAN"
	ComparisonOperatorEqualTo     ComparisonOperator = "EQUAL_TO"
)

Enum values for ComparisonOperator

func (ComparisonOperator) Values added in v0.29.0 

func (ComparisonOperator) Values() []ComparisonOperator

Values returns all known values for ComparisonOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CostTypes 

type CostTypes struct {

	// 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 non-RI subscription costs.
	//
	// The default value is true .
	IncludeOtherSubscription *bool

	// Specifies whether a budget includes recurring fees such as monthly RI fees.
	//
	// The default value is true .
	IncludeRecurring *bool

	// Specifies whether a budget includes refunds.
	//
	// The default value is true .
	IncludeRefund *bool

	// Specifies whether a budget includes subscriptions.
	//
	// The default value is true .
	IncludeSubscription *bool

	// Specifies whether a budget includes support subscription fees.
	//
	// The default value is true .
	IncludeSupport *bool

	// Specifies whether a budget includes taxes.
	//
	// The default value is true .
	IncludeTax *bool

	// Specifies whether a budget includes upfront RI costs.
	//
	// The default value is true .
	IncludeUpfront *bool

	// Specifies whether a budget uses the amortized rate.
	//
	// The default value is false .
	UseAmortized *bool

	// Specifies whether a budget uses a blended rate.
	//
	// The default value is false .
	UseBlended *bool
	// contains filtered or unexported fields
}

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 .

type CreationLimitExceededException 

type CreationLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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 Definition added in v0.29.0 

type Definition struct {

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

	// The service control policies (SCPs) action definition details.
	ScpActionDefinition *ScpActionDefinition

	// The Amazon Web Services Systems Manager (SSM) action definition details.
	SsmActionDefinition *SsmActionDefinition
	// contains filtered or unexported fields
}

Specifies all of the type-specific parameters.

type DuplicateRecordException 

type DuplicateRecordException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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 EventType added in v0.29.0 

type EventType string
const (
	EventTypeSystem        EventType = "SYSTEM"
	EventTypeCreateAction  EventType = "CREATE_ACTION"
	EventTypeDeleteAction  EventType = "DELETE_ACTION"
	EventTypeUpdateAction  EventType = "UPDATE_ACTION"
	EventTypeExecuteAction EventType = "EXECUTE_ACTION"
)

Enum values for EventType

func (EventType) Values added in v0.29.0 

func (EventType) Values() []EventType

Values returns all known values for EventType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ExecutionType added in v0.29.0 

type ExecutionType string
const (
	ExecutionTypeApproveBudgetAction ExecutionType = "APPROVE_BUDGET_ACTION"
	ExecutionTypeRetryBudgetAction   ExecutionType = "RETRY_BUDGET_ACTION"
	ExecutionTypeReverseBudgetAction ExecutionType = "REVERSE_BUDGET_ACTION"
	ExecutionTypeResetBudgetAction   ExecutionType = "RESET_BUDGET_ACTION"
)

Enum values for ExecutionType

func (ExecutionType) Values added in v0.29.0 

func (ExecutionType) Values() []ExecutionType

Values returns all known values for ExecutionType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ExpiredNextTokenException 

type ExpiredNextTokenException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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 HistoricalOptions added in v1.11.0 

type HistoricalOptions struct {

	// The number of budget periods included in the moving-average calculation that
	// determines your auto-adjusted budget amount. The maximum value depends on the
	// TimeUnit granularity of the budget:
	//
	//   - For the DAILY granularity, the maximum value is 60 .
	//
	//   - For the MONTHLY granularity, the maximum value is 12 .
	//
	//   - For the QUARTERLY granularity, the maximum value is 4 .
	//
	//   - For the ANNUALLY granularity, the maximum value is 1 .
	//
	// This member is required.
	BudgetAdjustmentPeriod *int32

	// 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.
	LookBackAvailablePeriods *int32
	// contains filtered or unexported fields
}

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

type IamActionDefinition added in v0.29.0 

type IamActionDefinition struct {

	// The Amazon Resource Name (ARN) of the policy to be attached.
	//
	// This member is required.
	PolicyArn *string

	// A list of groups to be attached. There must be at least one group.
	Groups []string

	// A list of roles to be attached. There must be at least one role.
	Roles []string

	// A list of users to be attached. There must be at least one user.
	Users []string
	// contains filtered or unexported fields
}

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

type InternalErrorException 

type InternalErrorException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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's used for this notification.
	//
	// This member is required.
	ComparisonOperator ComparisonOperator

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

	// 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.
	//
	// This member is required.
	Threshold float64

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

	// 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.
	ThresholdType ThresholdType
	// contains filtered or unexported fields
}

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:

  • 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

func (NotificationState) Values added in v0.29.0 

func (NotificationState) Values() []NotificationState

Values returns all known values for NotificationState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type NotificationType 

type NotificationType string
const (
	NotificationTypeActual     NotificationType = "ACTUAL"
	NotificationTypeForecasted NotificationType = "FORECASTED"
)

Enum values for NotificationType

func (NotificationType) Values added in v0.29.0 

func (NotificationType) Values() []NotificationType

Values returns all known values for NotificationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type NotificationWithSubscribers 

type NotificationWithSubscribers struct {

	// The notification that's 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
	// contains filtered or unexported fields
}

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

type ResourceLockedException added in v0.29.0 

type ResourceLockedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request was received and recognized by the server, but the server rejected that particular method for the requested resource.

func (*ResourceLockedException) Error added in v0.29.0 

func (e *ResourceLockedException) Error() string

func (*ResourceLockedException) ErrorCode added in v0.29.0 

func (e *ResourceLockedException) ErrorCode() string

func (*ResourceLockedException) ErrorFault added in v0.29.0 

func (e *ResourceLockedException) ErrorFault() smithy.ErrorFault

func (*ResourceLockedException) ErrorMessage added in v0.29.0 

func (e *ResourceLockedException) ErrorMessage() string

type ResourceTag added in v1.23.0 

type ResourceTag struct {

	// The key that's associated with the tag.
	//
	// This member is required.
	Key *string

	// The value that's associated with the tag.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

The tag structure that contains a tag key and value.

type ScpActionDefinition added in v0.29.0 

type ScpActionDefinition struct {

	// The policy ID attached.
	//
	// This member is required.
	PolicyId *string

	// A list of target IDs.
	//
	// This member is required.
	TargetIds []string
	// contains filtered or unexported fields
}

The service control policies (SCP) action definition details.

type ServiceQuotaExceededException added in v1.23.0 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You've reached the limit on the number of tags you can associate with a resource.

func (*ServiceQuotaExceededException) Error added in v1.23.0 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode added in v1.23.0 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault added in v1.23.0 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage added in v1.23.0 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type Spend 

type Spend struct {

	// The cost or usage amount that's associated with a budget forecast, actual
	// spend, or budget threshold.
	//
	// This member is required.
	Amount *string

	// The unit of measurement that's used for the budget forecast, actual spend, or
	// budget threshold.
	//
	// This member is required.
	Unit *string
	// contains filtered or unexported fields
}

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:

  • An Amount of 3

  • A Unit of USD

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

  • An Amount of 3

  • A Unit of GB

type SsmActionDefinition added in v0.29.0 

type SsmActionDefinition struct {

	// The action subType.
	//
	// This member is required.
	ActionSubType ActionSubType

	// The EC2 and RDS instance IDs.
	//
	// This member is required.
	InstanceIds []string

	// The Region to run the SSM document.
	//
	// This member is required.
	Region *string
	// contains filtered or unexported fields
}

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

type Subscriber 

type Subscriber struct {

	// 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.
	//
	// This member is required.
	Address *string

	// The type of notification that Amazon Web Services sends to a subscriber.
	//
	// This member is required.
	SubscriptionType SubscriptionType
	// contains filtered or unexported fields
}

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:

  • 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

func (SubscriptionType) Values added in v0.29.0 

func (SubscriptionType) Values() []SubscriptionType

Values returns all known values for SubscriptionType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ThresholdType 

type ThresholdType string
const (
	ThresholdTypePercentage    ThresholdType = "PERCENTAGE"
	ThresholdTypeAbsoluteValue ThresholdType = "ABSOLUTE_VALUE"
)

Enum values for ThresholdType

func (ThresholdType) Values added in v0.29.0 

func (ThresholdType) Values() []ThresholdType

Values returns all known values for ThresholdType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ThrottlingException added in v1.13.0 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

func (*ThrottlingException) Error added in v1.13.0 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode added in v1.13.0 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault added in v1.13.0 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage added in v1.13.0 

func (e *ThrottlingException) ErrorMessage() string

type TimePeriod 

type TimePeriod struct {

	// 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.
	End *time.Time

	// 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.
	Start *time.Time
	// contains filtered or unexported fields
}

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.

type TimeUnit 

type TimeUnit string
const (
	TimeUnitDaily     TimeUnit = "DAILY"
	TimeUnitMonthly   TimeUnit = "MONTHLY"
	TimeUnitQuarterly TimeUnit = "QUARTERLY"
	TimeUnitAnnually  TimeUnit = "ANNUALLY"
)

Enum values for TimeUnit

func (TimeUnit) Values added in v0.29.0 

func (TimeUnit) Values() []TimeUnit

Values returns all known values for TimeUnit. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.