Documentation
¶
Overview ¶
Package budgets provides the client and types for making API requests to AWS Budgets.
Budgets enable you to plan your service usage, service costs, and your RI utilization. You can also track how close your plan is to your budgeted amount or to the free tier limits. Budgets provide you with a quick way to see your usage-to-date and current estimated charges from AWS and to see how much your predicted usage accrues in charges by the end of the month. Budgets also compare current estimates and charges to the amount that you indicated you want to use or spend and lets you see how much of your budget has been used. AWS updates your budget status several times a day. Budgets track your unblended costs, subscriptions, and refunds. You can create the following types of budgets:
Cost budgets allow you to say how much you want to spend on a service.
Usage budgets allow you to say how many hours you want to use for one or more services.
RI utilization budgets allow you to define a utilization threshold and receive alerts when RIs are tracking below that threshold.
You can create up to 20,000 budgets per AWS master account. Your first two budgets are free of charge. Each additional budget costs $0.02 per day. You can set up optional notifications that warn you if you exceed, or are forecasted to exceed, your budgeted amount. You can have notifications sent to an Amazon SNS topic, to an email address, or to both. For more information, see Creating an Amazon SNS Topic for Budget Notifications (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-sns-policy.html). AWS Free Tier usage alerts via AWS Budgets are provided for you, and do not count toward your budget limits.
Service Endpoint ¶
The AWS Budgets API provides the following endpoint:
See budgets package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/budgets/
Using the Client ¶
To contact AWS Budgets with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the AWS Budgets client Budgets for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/budgets/#New
Index ¶
- Constants
- type Budget
- func (s Budget) GoString() string
- func (s *Budget) SetBudgetLimit(v *Spend) *Budget
- func (s *Budget) SetBudgetName(v string) *Budget
- func (s *Budget) SetBudgetType(v string) *Budget
- func (s *Budget) SetCalculatedSpend(v *CalculatedSpend) *Budget
- func (s *Budget) SetCostFilters(v map[string][]*string) *Budget
- func (s *Budget) SetCostTypes(v *CostTypes) *Budget
- func (s *Budget) SetTimePeriod(v *TimePeriod) *Budget
- func (s *Budget) SetTimeUnit(v string) *Budget
- func (s Budget) String() string
- func (s *Budget) Validate() error
- type Budgets
- func (c *Budgets) CreateBudget(input *CreateBudgetInput) (*CreateBudgetOutput, error)
- func (c *Budgets) CreateBudgetRequest(input *CreateBudgetInput) (req *request.Request, output *CreateBudgetOutput)
- func (c *Budgets) CreateBudgetWithContext(ctx aws.Context, input *CreateBudgetInput, opts ...request.Option) (*CreateBudgetOutput, error)
- func (c *Budgets) CreateNotification(input *CreateNotificationInput) (*CreateNotificationOutput, error)
- func (c *Budgets) CreateNotificationRequest(input *CreateNotificationInput) (req *request.Request, output *CreateNotificationOutput)
- func (c *Budgets) CreateNotificationWithContext(ctx aws.Context, input *CreateNotificationInput, opts ...request.Option) (*CreateNotificationOutput, error)
- func (c *Budgets) CreateSubscriber(input *CreateSubscriberInput) (*CreateSubscriberOutput, error)
- func (c *Budgets) CreateSubscriberRequest(input *CreateSubscriberInput) (req *request.Request, output *CreateSubscriberOutput)
- func (c *Budgets) CreateSubscriberWithContext(ctx aws.Context, input *CreateSubscriberInput, opts ...request.Option) (*CreateSubscriberOutput, error)
- func (c *Budgets) DeleteBudget(input *DeleteBudgetInput) (*DeleteBudgetOutput, error)
- func (c *Budgets) DeleteBudgetRequest(input *DeleteBudgetInput) (req *request.Request, output *DeleteBudgetOutput)
- func (c *Budgets) DeleteBudgetWithContext(ctx aws.Context, input *DeleteBudgetInput, opts ...request.Option) (*DeleteBudgetOutput, error)
- func (c *Budgets) DeleteNotification(input *DeleteNotificationInput) (*DeleteNotificationOutput, error)
- func (c *Budgets) DeleteNotificationRequest(input *DeleteNotificationInput) (req *request.Request, output *DeleteNotificationOutput)
- func (c *Budgets) DeleteNotificationWithContext(ctx aws.Context, input *DeleteNotificationInput, opts ...request.Option) (*DeleteNotificationOutput, error)
- func (c *Budgets) DeleteSubscriber(input *DeleteSubscriberInput) (*DeleteSubscriberOutput, error)
- func (c *Budgets) DeleteSubscriberRequest(input *DeleteSubscriberInput) (req *request.Request, output *DeleteSubscriberOutput)
- func (c *Budgets) DeleteSubscriberWithContext(ctx aws.Context, input *DeleteSubscriberInput, opts ...request.Option) (*DeleteSubscriberOutput, error)
- func (c *Budgets) DescribeBudget(input *DescribeBudgetInput) (*DescribeBudgetOutput, error)
- func (c *Budgets) DescribeBudgetRequest(input *DescribeBudgetInput) (req *request.Request, output *DescribeBudgetOutput)
- func (c *Budgets) DescribeBudgetWithContext(ctx aws.Context, input *DescribeBudgetInput, opts ...request.Option) (*DescribeBudgetOutput, error)
- func (c *Budgets) DescribeBudgets(input *DescribeBudgetsInput) (*DescribeBudgetsOutput, error)
- func (c *Budgets) DescribeBudgetsRequest(input *DescribeBudgetsInput) (req *request.Request, output *DescribeBudgetsOutput)
- func (c *Budgets) DescribeBudgetsWithContext(ctx aws.Context, input *DescribeBudgetsInput, opts ...request.Option) (*DescribeBudgetsOutput, error)
- func (c *Budgets) DescribeNotificationsForBudget(input *DescribeNotificationsForBudgetInput) (*DescribeNotificationsForBudgetOutput, error)
- func (c *Budgets) DescribeNotificationsForBudgetRequest(input *DescribeNotificationsForBudgetInput) (req *request.Request, output *DescribeNotificationsForBudgetOutput)
- func (c *Budgets) DescribeNotificationsForBudgetWithContext(ctx aws.Context, input *DescribeNotificationsForBudgetInput, ...) (*DescribeNotificationsForBudgetOutput, error)
- func (c *Budgets) DescribeSubscribersForNotification(input *DescribeSubscribersForNotificationInput) (*DescribeSubscribersForNotificationOutput, error)
- func (c *Budgets) DescribeSubscribersForNotificationRequest(input *DescribeSubscribersForNotificationInput) (req *request.Request, output *DescribeSubscribersForNotificationOutput)
- func (c *Budgets) DescribeSubscribersForNotificationWithContext(ctx aws.Context, input *DescribeSubscribersForNotificationInput, ...) (*DescribeSubscribersForNotificationOutput, error)
- func (c *Budgets) UpdateBudget(input *UpdateBudgetInput) (*UpdateBudgetOutput, error)
- func (c *Budgets) UpdateBudgetRequest(input *UpdateBudgetInput) (req *request.Request, output *UpdateBudgetOutput)
- func (c *Budgets) UpdateBudgetWithContext(ctx aws.Context, input *UpdateBudgetInput, opts ...request.Option) (*UpdateBudgetOutput, error)
- func (c *Budgets) UpdateNotification(input *UpdateNotificationInput) (*UpdateNotificationOutput, error)
- func (c *Budgets) UpdateNotificationRequest(input *UpdateNotificationInput) (req *request.Request, output *UpdateNotificationOutput)
- func (c *Budgets) UpdateNotificationWithContext(ctx aws.Context, input *UpdateNotificationInput, opts ...request.Option) (*UpdateNotificationOutput, error)
- func (c *Budgets) UpdateSubscriber(input *UpdateSubscriberInput) (*UpdateSubscriberOutput, error)
- func (c *Budgets) UpdateSubscriberRequest(input *UpdateSubscriberInput) (req *request.Request, output *UpdateSubscriberOutput)
- func (c *Budgets) UpdateSubscriberWithContext(ctx aws.Context, input *UpdateSubscriberInput, opts ...request.Option) (*UpdateSubscriberOutput, error)
- type CalculatedSpend
- type CostTypes
- func (s CostTypes) GoString() string
- func (s *CostTypes) SetIncludeCredit(v bool) *CostTypes
- func (s *CostTypes) SetIncludeDiscount(v bool) *CostTypes
- func (s *CostTypes) SetIncludeOtherSubscription(v bool) *CostTypes
- func (s *CostTypes) SetIncludeRecurring(v bool) *CostTypes
- func (s *CostTypes) SetIncludeRefund(v bool) *CostTypes
- func (s *CostTypes) SetIncludeSubscription(v bool) *CostTypes
- func (s *CostTypes) SetIncludeSupport(v bool) *CostTypes
- func (s *CostTypes) SetIncludeTax(v bool) *CostTypes
- func (s *CostTypes) SetIncludeUpfront(v bool) *CostTypes
- func (s *CostTypes) SetUseAmortized(v bool) *CostTypes
- func (s *CostTypes) SetUseBlended(v bool) *CostTypes
- func (s CostTypes) String() string
- type CreateBudgetInput
- func (s CreateBudgetInput) GoString() string
- func (s *CreateBudgetInput) SetAccountId(v string) *CreateBudgetInput
- func (s *CreateBudgetInput) SetBudget(v *Budget) *CreateBudgetInput
- func (s *CreateBudgetInput) SetNotificationsWithSubscribers(v []*NotificationWithSubscribers) *CreateBudgetInput
- func (s CreateBudgetInput) String() string
- func (s *CreateBudgetInput) Validate() error
- type CreateBudgetOutput
- type CreateNotificationInput
- func (s CreateNotificationInput) GoString() string
- func (s *CreateNotificationInput) SetAccountId(v string) *CreateNotificationInput
- func (s *CreateNotificationInput) SetBudgetName(v string) *CreateNotificationInput
- func (s *CreateNotificationInput) SetNotification(v *Notification) *CreateNotificationInput
- func (s *CreateNotificationInput) SetSubscribers(v []*Subscriber) *CreateNotificationInput
- func (s CreateNotificationInput) String() string
- func (s *CreateNotificationInput) Validate() error
- type CreateNotificationOutput
- type CreateSubscriberInput
- func (s CreateSubscriberInput) GoString() string
- func (s *CreateSubscriberInput) SetAccountId(v string) *CreateSubscriberInput
- func (s *CreateSubscriberInput) SetBudgetName(v string) *CreateSubscriberInput
- func (s *CreateSubscriberInput) SetNotification(v *Notification) *CreateSubscriberInput
- func (s *CreateSubscriberInput) SetSubscriber(v *Subscriber) *CreateSubscriberInput
- func (s CreateSubscriberInput) String() string
- func (s *CreateSubscriberInput) Validate() error
- type CreateSubscriberOutput
- type DeleteBudgetInput
- type DeleteBudgetOutput
- type DeleteNotificationInput
- func (s DeleteNotificationInput) GoString() string
- func (s *DeleteNotificationInput) SetAccountId(v string) *DeleteNotificationInput
- func (s *DeleteNotificationInput) SetBudgetName(v string) *DeleteNotificationInput
- func (s *DeleteNotificationInput) SetNotification(v *Notification) *DeleteNotificationInput
- func (s DeleteNotificationInput) String() string
- func (s *DeleteNotificationInput) Validate() error
- type DeleteNotificationOutput
- type DeleteSubscriberInput
- func (s DeleteSubscriberInput) GoString() string
- func (s *DeleteSubscriberInput) SetAccountId(v string) *DeleteSubscriberInput
- func (s *DeleteSubscriberInput) SetBudgetName(v string) *DeleteSubscriberInput
- func (s *DeleteSubscriberInput) SetNotification(v *Notification) *DeleteSubscriberInput
- func (s *DeleteSubscriberInput) SetSubscriber(v *Subscriber) *DeleteSubscriberInput
- func (s DeleteSubscriberInput) String() string
- func (s *DeleteSubscriberInput) Validate() error
- type DeleteSubscriberOutput
- type DescribeBudgetInput
- type DescribeBudgetOutput
- type DescribeBudgetsInput
- func (s DescribeBudgetsInput) GoString() string
- func (s *DescribeBudgetsInput) SetAccountId(v string) *DescribeBudgetsInput
- func (s *DescribeBudgetsInput) SetMaxResults(v int64) *DescribeBudgetsInput
- func (s *DescribeBudgetsInput) SetNextToken(v string) *DescribeBudgetsInput
- func (s DescribeBudgetsInput) String() string
- func (s *DescribeBudgetsInput) Validate() error
- type DescribeBudgetsOutput
- type DescribeNotificationsForBudgetInput
- func (s DescribeNotificationsForBudgetInput) GoString() string
- func (s *DescribeNotificationsForBudgetInput) SetAccountId(v string) *DescribeNotificationsForBudgetInput
- func (s *DescribeNotificationsForBudgetInput) SetBudgetName(v string) *DescribeNotificationsForBudgetInput
- func (s *DescribeNotificationsForBudgetInput) SetMaxResults(v int64) *DescribeNotificationsForBudgetInput
- func (s *DescribeNotificationsForBudgetInput) SetNextToken(v string) *DescribeNotificationsForBudgetInput
- func (s DescribeNotificationsForBudgetInput) String() string
- func (s *DescribeNotificationsForBudgetInput) Validate() error
- type DescribeNotificationsForBudgetOutput
- func (s DescribeNotificationsForBudgetOutput) GoString() string
- func (s *DescribeNotificationsForBudgetOutput) SetNextToken(v string) *DescribeNotificationsForBudgetOutput
- func (s *DescribeNotificationsForBudgetOutput) SetNotifications(v []*Notification) *DescribeNotificationsForBudgetOutput
- func (s DescribeNotificationsForBudgetOutput) String() string
- type DescribeSubscribersForNotificationInput
- func (s DescribeSubscribersForNotificationInput) GoString() string
- func (s *DescribeSubscribersForNotificationInput) SetAccountId(v string) *DescribeSubscribersForNotificationInput
- func (s *DescribeSubscribersForNotificationInput) SetBudgetName(v string) *DescribeSubscribersForNotificationInput
- func (s *DescribeSubscribersForNotificationInput) SetMaxResults(v int64) *DescribeSubscribersForNotificationInput
- func (s *DescribeSubscribersForNotificationInput) SetNextToken(v string) *DescribeSubscribersForNotificationInput
- func (s *DescribeSubscribersForNotificationInput) SetNotification(v *Notification) *DescribeSubscribersForNotificationInput
- func (s DescribeSubscribersForNotificationInput) String() string
- func (s *DescribeSubscribersForNotificationInput) Validate() error
- type DescribeSubscribersForNotificationOutput
- func (s DescribeSubscribersForNotificationOutput) GoString() string
- func (s *DescribeSubscribersForNotificationOutput) SetNextToken(v string) *DescribeSubscribersForNotificationOutput
- func (s *DescribeSubscribersForNotificationOutput) SetSubscribers(v []*Subscriber) *DescribeSubscribersForNotificationOutput
- func (s DescribeSubscribersForNotificationOutput) String() string
- type Notification
- func (s Notification) GoString() string
- func (s *Notification) SetComparisonOperator(v string) *Notification
- func (s *Notification) SetNotificationType(v string) *Notification
- func (s *Notification) SetThreshold(v float64) *Notification
- func (s *Notification) SetThresholdType(v string) *Notification
- func (s Notification) String() string
- func (s *Notification) Validate() error
- type NotificationWithSubscribers
- func (s NotificationWithSubscribers) GoString() string
- func (s *NotificationWithSubscribers) SetNotification(v *Notification) *NotificationWithSubscribers
- func (s *NotificationWithSubscribers) SetSubscribers(v []*Subscriber) *NotificationWithSubscribers
- func (s NotificationWithSubscribers) String() string
- func (s *NotificationWithSubscribers) Validate() error
- type Spend
- type Subscriber
- type TimePeriod
- type UpdateBudgetInput
- type UpdateBudgetOutput
- type UpdateNotificationInput
- func (s UpdateNotificationInput) GoString() string
- func (s *UpdateNotificationInput) SetAccountId(v string) *UpdateNotificationInput
- func (s *UpdateNotificationInput) SetBudgetName(v string) *UpdateNotificationInput
- func (s *UpdateNotificationInput) SetNewNotification(v *Notification) *UpdateNotificationInput
- func (s *UpdateNotificationInput) SetOldNotification(v *Notification) *UpdateNotificationInput
- func (s UpdateNotificationInput) String() string
- func (s *UpdateNotificationInput) Validate() error
- type UpdateNotificationOutput
- type UpdateSubscriberInput
- func (s UpdateSubscriberInput) GoString() string
- func (s *UpdateSubscriberInput) SetAccountId(v string) *UpdateSubscriberInput
- func (s *UpdateSubscriberInput) SetBudgetName(v string) *UpdateSubscriberInput
- func (s *UpdateSubscriberInput) SetNewSubscriber(v *Subscriber) *UpdateSubscriberInput
- func (s *UpdateSubscriberInput) SetNotification(v *Notification) *UpdateSubscriberInput
- func (s *UpdateSubscriberInput) SetOldSubscriber(v *Subscriber) *UpdateSubscriberInput
- func (s UpdateSubscriberInput) String() string
- func (s *UpdateSubscriberInput) Validate() error
- type UpdateSubscriberOutput
Constants ¶
const ( // BudgetTypeUsage is a BudgetType enum value BudgetTypeUsage = "USAGE" // BudgetTypeCost is a BudgetType enum value BudgetTypeCost = "COST" // BudgetTypeRiUtilization is a BudgetType enum value BudgetTypeRiUtilization = "RI_UTILIZATION" )
The type of a budget. It should be COST, USAGE, or RI_UTILIZATION.
const ( // ComparisonOperatorGreaterThan is a ComparisonOperator enum value ComparisonOperatorGreaterThan = "GREATER_THAN" // ComparisonOperatorLessThan is a ComparisonOperator enum value ComparisonOperatorLessThan = "LESS_THAN" // ComparisonOperatorEqualTo is a ComparisonOperator enum value ComparisonOperatorEqualTo = "EQUAL_TO" )
The comparison operator of a notification. Currently we support less than, equal to and greater than.
const ( // NotificationTypeActual is a NotificationType enum value NotificationTypeActual = "ACTUAL" // NotificationTypeForecasted is a NotificationType enum value NotificationTypeForecasted = "FORECASTED" )
The type of a notification. It should be ACTUAL or FORECASTED.
const ( // SubscriptionTypeSns is a SubscriptionType enum value SubscriptionTypeSns = "SNS" // SubscriptionTypeEmail is a SubscriptionType enum value SubscriptionTypeEmail = "EMAIL" )
The subscription type of the subscriber. It can be SMS or EMAIL.
const ( // ThresholdTypePercentage is a ThresholdType enum value ThresholdTypePercentage = "PERCENTAGE" // ThresholdTypeAbsoluteValue is a ThresholdType enum value ThresholdTypeAbsoluteValue = "ABSOLUTE_VALUE" )
The type of threshold for a notification. It can be PERCENTAGE or ABSOLUTE_VALUE.
const ( // TimeUnitDaily is a TimeUnit enum value TimeUnitDaily = "DAILY" // TimeUnitMonthly is a TimeUnit enum value TimeUnitMonthly = "MONTHLY" // TimeUnitQuarterly is a TimeUnit enum value TimeUnitQuarterly = "QUARTERLY" // TimeUnitAnnually is a TimeUnit enum value TimeUnitAnnually = "ANNUALLY" )
The time unit of the budget. e.g. MONTHLY, QUARTERLY, etc.
const ( // ErrCodeCreationLimitExceededException for service response error code // "CreationLimitExceededException". // // You've exceeded the notification or subscriber limit. ErrCodeCreationLimitExceededException = "CreationLimitExceededException" // ErrCodeDuplicateRecordException for service response error code // "DuplicateRecordException". // // The budget name already exists. Budget names must be unique within an account. ErrCodeDuplicateRecordException = "DuplicateRecordException" // ErrCodeExpiredNextTokenException for service response error code // "ExpiredNextTokenException". // // The pagination token expired. ErrCodeExpiredNextTokenException = "ExpiredNextTokenException" // ErrCodeInternalErrorException for service response error code // "InternalErrorException". // // An error on the server occurred during the processing of your request. Try // again later. ErrCodeInternalErrorException = "InternalErrorException" // ErrCodeInvalidNextTokenException for service response error code // "InvalidNextTokenException". // // The pagination token is invalid. ErrCodeInvalidNextTokenException = "InvalidNextTokenException" // ErrCodeInvalidParameterException for service response error code // "InvalidParameterException". // // An error on the client occurred. Typically, the cause is an invalid input // value. ErrCodeInvalidParameterException = "InvalidParameterException" // ErrCodeNotFoundException for service response error code // "NotFoundException". // // We can’t locate the resource that you specified. ErrCodeNotFoundException = "NotFoundException" )
const ( ServiceName = "budgets" // Service endpoint prefix API calls made to. EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata. )
Service information constants
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Budget ¶
type Budget struct { // The total amount of cost, usage, or RI utilization that you want to track // with your budget. // // BudgetLimit is required for cost or usage budgets, but optional for RI utilization // budgets. RI utilization budgets default to the only valid value for RI utilization // budgets, which is 100. BudgetLimit *Spend `type:"structure"` // The name of a budget. Unique within accounts. : and \ characters are not // allowed in the BudgetName. // // BudgetName is a required field BudgetName *string `type:"string" required:"true"` // Whether this budget tracks monetary costs, usage, or RI utilization. // // BudgetType is a required field BudgetType *string `type:"string" required:"true" enum:"BudgetType"` // The actual and forecasted cost or usage being tracked by a budget. CalculatedSpend *CalculatedSpend `type:"structure"` // The cost filters applied to a budget, such as service or region. CostFilters map[string][]*string `type:"map"` // The types of costs included in this budget. CostTypes *CostTypes `type:"structure"` // The period of time covered by a budget. 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. // // If you created your budget and didn't specify a start date, AWS defaults // to the start of your chosen time period (i.e. DAILY, MONTHLY, QUARTERLY, // ANNUALLY). For example, if you created your budget on January 24th 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 `type:"structure"` // The length of time until a budget resets the actual and forecasted spend. // // TimeUnit is a required field TimeUnit *string `type:"string" required:"true" enum:"TimeUnit"` // 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.
The ARN pattern for a budget is: arn:aws:budgetservice::AccountId:budget/budgetName
func (*Budget) SetBudgetLimit ¶
SetBudgetLimit sets the BudgetLimit field's value.
func (*Budget) SetBudgetName ¶
SetBudgetName sets the BudgetName field's value.
func (*Budget) SetBudgetType ¶
SetBudgetType sets the BudgetType field's value.
func (*Budget) SetCalculatedSpend ¶
func (s *Budget) SetCalculatedSpend(v *CalculatedSpend) *Budget
SetCalculatedSpend sets the CalculatedSpend field's value.
func (*Budget) SetCostFilters ¶
SetCostFilters sets the CostFilters field's value.
func (*Budget) SetCostTypes ¶
SetCostTypes sets the CostTypes field's value.
func (*Budget) SetTimePeriod ¶
func (s *Budget) SetTimePeriod(v *TimePeriod) *Budget
SetTimePeriod sets the TimePeriod field's value.
func (*Budget) SetTimeUnit ¶
SetTimeUnit sets the TimeUnit field's value.
type Budgets ¶
Budgets provides the API operation methods for making requests to AWS Budgets. See this package's package overview docs for details on the service.
Budgets methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
func New(p client.ConfigProvider, cfgs ...*aws.Config) *Budgets
New creates a new instance of the Budgets client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
// Create a Budgets client from just a session. svc := budgets.New(mySession) // Create a Budgets client with additional configuration svc := budgets.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*Budgets) CreateBudget ¶
func (c *Budgets) CreateBudget(input *CreateBudgetInput) (*CreateBudgetOutput, error)
CreateBudget API operation for AWS Budgets.
Creates a budget and, if included, notifications and subscribers.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Budgets's API operation CreateBudget for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameterException" An error on the client occurred. Typically, the cause is an invalid input value.
ErrCodeInternalErrorException "InternalErrorException" An error on the server occurred during the processing of your request. Try again later.
ErrCodeCreationLimitExceededException "CreationLimitExceededException" You've exceeded the notification or subscriber limit.
ErrCodeDuplicateRecordException "DuplicateRecordException" The budget name already exists. Budget names must be unique within an account.
func (*Budgets) CreateBudgetRequest ¶
func (c *Budgets) CreateBudgetRequest(input *CreateBudgetInput) (req *request.Request, output *CreateBudgetOutput)
CreateBudgetRequest generates a "aws/request.Request" representing the client's request for the CreateBudget operation. The "output" return value will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateBudget for more information on using the CreateBudget API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateBudgetRequest method. req, resp := client.CreateBudgetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*Budgets) CreateBudgetWithContext ¶
func (c *Budgets) CreateBudgetWithContext(ctx aws.Context, input *CreateBudgetInput, opts ...request.Option) (*CreateBudgetOutput, error)
CreateBudgetWithContext is the same as CreateBudget with the addition of the ability to pass a context and additional request options.
See CreateBudget for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Budgets) CreateNotification ¶
func (c *Budgets) CreateNotification(input *CreateNotificationInput) (*CreateNotificationOutput, error)
CreateNotification API operation for AWS Budgets.
Creates a notification. You must create the budget before you create the associated notification.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Budgets's API operation CreateNotification for usage and error information.
Returned Error Codes:
ErrCodeInternalErrorException "InternalErrorException" An error on the server occurred during the processing of your request. Try again later.
ErrCodeInvalidParameterException "InvalidParameterException" An error on the client occurred. Typically, the cause is an invalid input value.
ErrCodeNotFoundException "NotFoundException" We can’t locate the resource that you specified.
ErrCodeCreationLimitExceededException "CreationLimitExceededException" You've exceeded the notification or subscriber limit.
ErrCodeDuplicateRecordException "DuplicateRecordException" The budget name already exists. Budget names must be unique within an account.
func (*Budgets) CreateNotificationRequest ¶
func (c *Budgets) CreateNotificationRequest(input *CreateNotificationInput) (req *request.Request, output *CreateNotificationOutput)
CreateNotificationRequest generates a "aws/request.Request" representing the client's request for the CreateNotification operation. The "output" return value will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateNotification for more information on using the CreateNotification API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateNotificationRequest method. req, resp := client.CreateNotificationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*Budgets) CreateNotificationWithContext ¶
func (c *Budgets) CreateNotificationWithContext(ctx aws.Context, input *CreateNotificationInput, opts ...request.Option) (*CreateNotificationOutput, error)
CreateNotificationWithContext is the same as CreateNotification with the addition of the ability to pass a context and additional request options.
See CreateNotification for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Budgets) CreateSubscriber ¶
func (c *Budgets) CreateSubscriber(input *CreateSubscriberInput) (*CreateSubscriberOutput, error)
CreateSubscriber API operation for AWS Budgets.
Creates a subscriber. You must create the associated budget and notification before you create the subscriber.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Budgets's API operation CreateSubscriber for usage and error information.
Returned Error Codes:
ErrCodeInternalErrorException "InternalErrorException" An error on the server occurred during the processing of your request. Try again later.
ErrCodeInvalidParameterException "InvalidParameterException" An error on the client occurred. Typically, the cause is an invalid input value.
ErrCodeCreationLimitExceededException "CreationLimitExceededException" You've exceeded the notification or subscriber limit.
ErrCodeDuplicateRecordException "DuplicateRecordException" The budget name already exists. Budget names must be unique within an account.
ErrCodeNotFoundException "NotFoundException" We can’t locate the resource that you specified.
func (*Budgets) CreateSubscriberRequest ¶
func (c *Budgets) CreateSubscriberRequest(input *CreateSubscriberInput) (req *request.Request, output *CreateSubscriberOutput)
CreateSubscriberRequest generates a "aws/request.Request" representing the client's request for the CreateSubscriber operation. The "output" return value will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateSubscriber for more information on using the CreateSubscriber API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateSubscriberRequest method. req, resp := client.CreateSubscriberRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*Budgets) CreateSubscriberWithContext ¶
func (c *Budgets) CreateSubscriberWithContext(ctx aws.Context, input *CreateSubscriberInput, opts ...request.Option) (*CreateSubscriberOutput, error)
CreateSubscriberWithContext is the same as CreateSubscriber with the addition of the ability to pass a context and additional request options.
See CreateSubscriber for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Budgets) DeleteBudget ¶
func (c *Budgets) DeleteBudget(input *DeleteBudgetInput) (*DeleteBudgetOutput, error)
DeleteBudget API operation for AWS Budgets.
Deletes a budget. You can delete your budget at any time.
Deleting a budget also deletes the notifications and subscribers associated with that budget.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Budgets's API operation DeleteBudget for usage and error information.
Returned Error Codes:
ErrCodeInternalErrorException "InternalErrorException" An error on the server occurred during the processing of your request. Try again later.
ErrCodeInvalidParameterException "InvalidParameterException" An error on the client occurred. Typically, the cause is an invalid input value.
ErrCodeNotFoundException "NotFoundException" We can’t locate the resource that you specified.
func (*Budgets) DeleteBudgetRequest ¶
func (c *Budgets) DeleteBudgetRequest(input *DeleteBudgetInput) (req *request.Request, output *DeleteBudgetOutput)
DeleteBudgetRequest generates a "aws/request.Request" representing the client's request for the DeleteBudget operation. The "output" return value will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteBudget for more information on using the DeleteBudget API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteBudgetRequest method. req, resp := client.DeleteBudgetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*Budgets) DeleteBudgetWithContext ¶
func (c *Budgets) DeleteBudgetWithContext(ctx aws.Context, input *DeleteBudgetInput, opts ...request.Option) (*DeleteBudgetOutput, error)
DeleteBudgetWithContext is the same as DeleteBudget with the addition of the ability to pass a context and additional request options.
See DeleteBudget for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Budgets) DeleteNotification ¶
func (c *Budgets) DeleteNotification(input *DeleteNotificationInput) (*DeleteNotificationOutput, error)
DeleteNotification API operation for AWS Budgets.
Deletes a notification.
Deleting a notification also deletes the subscribers associated with the notification.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Budgets's API operation DeleteNotification for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterException "InvalidParameterException" An error on the client occurred. Typically, the cause is an invalid input value.
ErrCodeInternalErrorException "InternalErrorException" An error on the server occurred during the processing of your request. Try again later.
ErrCodeNotFoundException "NotFoundException" We can’t locate the resource that you specified.
func (*Budgets) DeleteNotificationRequest ¶
func (c *Budgets) DeleteNotificationRequest(input *DeleteNotificationInput) (req *request.Request, output *DeleteNotificationOutput)
DeleteNotificationRequest generates a "aws/request.Request" representing the client's request for the DeleteNotification operation. The "output" return value will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteNotification for more information on using the DeleteNotification API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteNotificationRequest method. req, resp := client.DeleteNotificationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*Budgets) DeleteNotificationWithContext ¶
func (c *Budgets) DeleteNotificationWithContext(ctx aws.Context, input *DeleteNotificationInput, opts ...request.Option) (*DeleteNotificationOutput, error)
DeleteNotificationWithContext is the same as DeleteNotification with the addition of the ability to pass a context and additional request options.
See DeleteNotification for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Budgets) DeleteSubscriber ¶
func (c *Budgets) DeleteSubscriber(input *DeleteSubscriberInput) (*DeleteSubscriberOutput, error)
DeleteSubscriber API operation for AWS Budgets.
Deletes a subscriber.
Deleting the last subscriber to a notification also deletes the notification.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Budgets's API operation DeleteSubscriber for usage and error information.
Returned Error Codes:
ErrCodeInternalErrorException "InternalErrorException" An error on the server occurred during the processing of your request. Try again later.
ErrCodeInvalidParameterException "InvalidParameterException" An error on the client occurred. Typically, the cause is an invalid input value.
ErrCodeNotFoundException "NotFoundException" We can’t locate the resource that you specified.
func (*Budgets) DeleteSubscriberRequest ¶
func (c *Budgets) DeleteSubscriberRequest(input *DeleteSubscriberInput) (req *request.Request, output *DeleteSubscriberOutput)
DeleteSubscriberRequest generates a "aws/request.Request" representing the client's request for the DeleteSubscriber operation. The "output" return value will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteSubscriber for more information on using the DeleteSubscriber API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteSubscriberRequest method. req, resp := client.DeleteSubscriberRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*Budgets) DeleteSubscriberWithContext ¶
func (c *Budgets) DeleteSubscriberWithContext(ctx aws.Context, input *DeleteSubscriberInput, opts ...request.Option) (*DeleteSubscriberOutput, error)
DeleteSubscriberWithContext is the same as DeleteSubscriber with the addition of the ability to pass a context and additional request options.
See DeleteSubscriber for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Budgets) DescribeBudget ¶
func (c *Budgets) DescribeBudget(input *DescribeBudgetInput) (*DescribeBudgetOutput, error)
DescribeBudget API operation for AWS Budgets.
Describes a budget.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Budgets's API operation DescribeBudget for usage and error information.
Returned Error Codes:
ErrCodeInternalErrorException "InternalErrorException" An error on the server occurred during the processing of your request. Try again later.
ErrCodeInvalidParameterException "InvalidParameterException" An error on the client occurred. Typically, the cause is an invalid input value.
ErrCodeNotFoundException "NotFoundException" We can’t locate the resource that you specified.
func (*Budgets) DescribeBudgetRequest ¶
func (c *Budgets) DescribeBudgetRequest(input *DescribeBudgetInput) (req *request.Request, output *DescribeBudgetOutput)
DescribeBudgetRequest generates a "aws/request.Request" representing the client's request for the DescribeBudget operation. The "output" return value will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeBudget for more information on using the DescribeBudget API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeBudgetRequest method. req, resp := client.DescribeBudgetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*Budgets) DescribeBudgetWithContext ¶
func (c *Budgets) DescribeBudgetWithContext(ctx aws.Context, input *DescribeBudgetInput, opts ...request.Option) (*DescribeBudgetOutput, error)
DescribeBudgetWithContext is the same as DescribeBudget with the addition of the ability to pass a context and additional request options.
See DescribeBudget for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Budgets) DescribeBudgets ¶
func (c *Budgets) DescribeBudgets(input *DescribeBudgetsInput) (*DescribeBudgetsOutput, error)
DescribeBudgets API operation for AWS Budgets.
Lists the budgets associated with an account.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Budgets's API operation DescribeBudgets for usage and error information.
Returned Error Codes:
ErrCodeInternalErrorException "InternalErrorException" An error on the server occurred during the processing of your request. Try again later.
ErrCodeInvalidParameterException "InvalidParameterException" An error on the client occurred. Typically, the cause is an invalid input value.
ErrCodeNotFoundException "NotFoundException" We can’t locate the resource that you specified.
ErrCodeInvalidNextTokenException "InvalidNextTokenException" The pagination token is invalid.
ErrCodeExpiredNextTokenException "ExpiredNextTokenException" The pagination token expired.
func (*Budgets) DescribeBudgetsRequest ¶
func (c *Budgets) DescribeBudgetsRequest(input *DescribeBudgetsInput) (req *request.Request, output *DescribeBudgetsOutput)
DescribeBudgetsRequest generates a "aws/request.Request" representing the client's request for the DescribeBudgets operation. The "output" return value will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeBudgets for more information on using the DescribeBudgets API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeBudgetsRequest method. req, resp := client.DescribeBudgetsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*Budgets) DescribeBudgetsWithContext ¶
func (c *Budgets) DescribeBudgetsWithContext(ctx aws.Context, input *DescribeBudgetsInput, opts ...request.Option) (*DescribeBudgetsOutput, error)
DescribeBudgetsWithContext is the same as DescribeBudgets with the addition of the ability to pass a context and additional request options.
See DescribeBudgets for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Budgets) DescribeNotificationsForBudget ¶
func (c *Budgets) DescribeNotificationsForBudget(input *DescribeNotificationsForBudgetInput) (*DescribeNotificationsForBudgetOutput, error)
DescribeNotificationsForBudget API operation for AWS Budgets.
Lists the notifications associated with a budget.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Budgets's API operation DescribeNotificationsForBudget for usage and error information.
Returned Error Codes:
ErrCodeInternalErrorException "InternalErrorException" An error on the server occurred during the processing of your request. Try again later.
ErrCodeInvalidParameterException "InvalidParameterException" An error on the client occurred. Typically, the cause is an invalid input value.
ErrCodeNotFoundException "NotFoundException" We can’t locate the resource that you specified.
ErrCodeInvalidNextTokenException "InvalidNextTokenException" The pagination token is invalid.
ErrCodeExpiredNextTokenException "ExpiredNextTokenException" The pagination token expired.
func (*Budgets) DescribeNotificationsForBudgetRequest ¶
func (c *Budgets) DescribeNotificationsForBudgetRequest(input *DescribeNotificationsForBudgetInput) (req *request.Request, output *DescribeNotificationsForBudgetOutput)
DescribeNotificationsForBudgetRequest generates a "aws/request.Request" representing the client's request for the DescribeNotificationsForBudget operation. The "output" return value will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeNotificationsForBudget for more information on using the DescribeNotificationsForBudget API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeNotificationsForBudgetRequest method. req, resp := client.DescribeNotificationsForBudgetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*Budgets) DescribeNotificationsForBudgetWithContext ¶
func (c *Budgets) DescribeNotificationsForBudgetWithContext(ctx aws.Context, input *DescribeNotificationsForBudgetInput, opts ...request.Option) (*DescribeNotificationsForBudgetOutput, error)
DescribeNotificationsForBudgetWithContext is the same as DescribeNotificationsForBudget with the addition of the ability to pass a context and additional request options.
See DescribeNotificationsForBudget for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Budgets) DescribeSubscribersForNotification ¶
func (c *Budgets) DescribeSubscribersForNotification(input *DescribeSubscribersForNotificationInput) (*DescribeSubscribersForNotificationOutput, error)
DescribeSubscribersForNotification API operation for AWS Budgets.
Lists the subscribers associated with a notification.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Budgets's API operation DescribeSubscribersForNotification for usage and error information.
Returned Error Codes:
ErrCodeInternalErrorException "InternalErrorException" An error on the server occurred during the processing of your request. Try again later.
ErrCodeNotFoundException "NotFoundException" We can’t locate the resource that you specified.
ErrCodeInvalidParameterException "InvalidParameterException" An error on the client occurred. Typically, the cause is an invalid input value.
ErrCodeInvalidNextTokenException "InvalidNextTokenException" The pagination token is invalid.
ErrCodeExpiredNextTokenException "ExpiredNextTokenException" The pagination token expired.
func (*Budgets) DescribeSubscribersForNotificationRequest ¶
func (c *Budgets) DescribeSubscribersForNotificationRequest(input *DescribeSubscribersForNotificationInput) (req *request.Request, output *DescribeSubscribersForNotificationOutput)
DescribeSubscribersForNotificationRequest generates a "aws/request.Request" representing the client's request for the DescribeSubscribersForNotification operation. The "output" return value will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeSubscribersForNotification for more information on using the DescribeSubscribersForNotification API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeSubscribersForNotificationRequest method. req, resp := client.DescribeSubscribersForNotificationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*Budgets) DescribeSubscribersForNotificationWithContext ¶
func (c *Budgets) DescribeSubscribersForNotificationWithContext(ctx aws.Context, input *DescribeSubscribersForNotificationInput, opts ...request.Option) (*DescribeSubscribersForNotificationOutput, error)
DescribeSubscribersForNotificationWithContext is the same as DescribeSubscribersForNotification with the addition of the ability to pass a context and additional request options.
See DescribeSubscribersForNotification for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Budgets) UpdateBudget ¶
func (c *Budgets) UpdateBudget(input *UpdateBudgetInput) (*UpdateBudgetOutput, error)
UpdateBudget API operation for AWS Budgets.
Updates a budget. You can change every part of a budget except for the budgetName and the calculatedSpend. When a budget is modified, the calculatedSpend drops to zero until AWS has new usage data to use for forecasting.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Budgets's API operation UpdateBudget for usage and error information.
Returned Error Codes:
ErrCodeInternalErrorException "InternalErrorException" An error on the server occurred during the processing of your request. Try again later.
ErrCodeInvalidParameterException "InvalidParameterException" An error on the client occurred. Typically, the cause is an invalid input value.
ErrCodeNotFoundException "NotFoundException" We can’t locate the resource that you specified.
func (*Budgets) UpdateBudgetRequest ¶
func (c *Budgets) UpdateBudgetRequest(input *UpdateBudgetInput) (req *request.Request, output *UpdateBudgetOutput)
UpdateBudgetRequest generates a "aws/request.Request" representing the client's request for the UpdateBudget operation. The "output" return value will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateBudget for more information on using the UpdateBudget API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateBudgetRequest method. req, resp := client.UpdateBudgetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*Budgets) UpdateBudgetWithContext ¶
func (c *Budgets) UpdateBudgetWithContext(ctx aws.Context, input *UpdateBudgetInput, opts ...request.Option) (*UpdateBudgetOutput, error)
UpdateBudgetWithContext is the same as UpdateBudget with the addition of the ability to pass a context and additional request options.
See UpdateBudget for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Budgets) UpdateNotification ¶
func (c *Budgets) UpdateNotification(input *UpdateNotificationInput) (*UpdateNotificationOutput, error)
UpdateNotification API operation for AWS Budgets.
Updates a notification.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Budgets's API operation UpdateNotification for usage and error information.
Returned Error Codes:
ErrCodeInternalErrorException "InternalErrorException" An error on the server occurred during the processing of your request. Try again later.
ErrCodeInvalidParameterException "InvalidParameterException" An error on the client occurred. Typically, the cause is an invalid input value.
ErrCodeNotFoundException "NotFoundException" We can’t locate the resource that you specified.
ErrCodeDuplicateRecordException "DuplicateRecordException" The budget name already exists. Budget names must be unique within an account.
func (*Budgets) UpdateNotificationRequest ¶
func (c *Budgets) UpdateNotificationRequest(input *UpdateNotificationInput) (req *request.Request, output *UpdateNotificationOutput)
UpdateNotificationRequest generates a "aws/request.Request" representing the client's request for the UpdateNotification operation. The "output" return value will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateNotification for more information on using the UpdateNotification API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateNotificationRequest method. req, resp := client.UpdateNotificationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*Budgets) UpdateNotificationWithContext ¶
func (c *Budgets) UpdateNotificationWithContext(ctx aws.Context, input *UpdateNotificationInput, opts ...request.Option) (*UpdateNotificationOutput, error)
UpdateNotificationWithContext is the same as UpdateNotification with the addition of the ability to pass a context and additional request options.
See UpdateNotification for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*Budgets) UpdateSubscriber ¶
func (c *Budgets) UpdateSubscriber(input *UpdateSubscriberInput) (*UpdateSubscriberOutput, error)
UpdateSubscriber API operation for AWS Budgets.
Updates a subscriber.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Budgets's API operation UpdateSubscriber for usage and error information.
Returned Error Codes:
ErrCodeInternalErrorException "InternalErrorException" An error on the server occurred during the processing of your request. Try again later.
ErrCodeInvalidParameterException "InvalidParameterException" An error on the client occurred. Typically, the cause is an invalid input value.
ErrCodeNotFoundException "NotFoundException" We can’t locate the resource that you specified.
ErrCodeDuplicateRecordException "DuplicateRecordException" The budget name already exists. Budget names must be unique within an account.
func (*Budgets) UpdateSubscriberRequest ¶
func (c *Budgets) UpdateSubscriberRequest(input *UpdateSubscriberInput) (req *request.Request, output *UpdateSubscriberOutput)
UpdateSubscriberRequest generates a "aws/request.Request" representing the client's request for the UpdateSubscriber operation. The "output" return value will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateSubscriber for more information on using the UpdateSubscriber API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateSubscriberRequest method. req, resp := client.UpdateSubscriberRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*Budgets) UpdateSubscriberWithContext ¶
func (c *Budgets) UpdateSubscriberWithContext(ctx aws.Context, input *UpdateSubscriberInput, opts ...request.Option) (*UpdateSubscriberOutput, error)
UpdateSubscriberWithContext is the same as UpdateSubscriber with the addition of the ability to pass a context and additional request options.
See UpdateSubscriber for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
type CalculatedSpend ¶
type CalculatedSpend struct { // The amount of cost, usage, or RI units that you have used. // // ActualSpend is a required field ActualSpend *Spend `type:"structure" required:"true"` // The amount of cost, usage, or RI units that you are forecasted to use. ForecastedSpend *Spend `type:"structure"` // contains filtered or unexported fields }
The spend objects 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.
func (CalculatedSpend) GoString ¶
func (s CalculatedSpend) GoString() string
GoString returns the string representation
func (*CalculatedSpend) SetActualSpend ¶
func (s *CalculatedSpend) SetActualSpend(v *Spend) *CalculatedSpend
SetActualSpend sets the ActualSpend field's value.
func (*CalculatedSpend) SetForecastedSpend ¶
func (s *CalculatedSpend) SetForecastedSpend(v *Spend) *CalculatedSpend
SetForecastedSpend sets the ForecastedSpend field's value.
func (CalculatedSpend) String ¶
func (s CalculatedSpend) String() string
String returns the string representation
func (*CalculatedSpend) Validate ¶
func (s *CalculatedSpend) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CostTypes ¶
type CostTypes struct { // Specifies whether a budget includes credits. // // The default value is true. IncludeCredit *bool `type:"boolean"` // Specifies whether a budget includes discounts. // // The default value is true. IncludeDiscount *bool `type:"boolean"` // Specifies whether a budget includes non-RI subscription costs. // // The default value is true. IncludeOtherSubscription *bool `type:"boolean"` // Specifies whether a budget includes recurring fees such as monthly RI fees. // // The default value is true. IncludeRecurring *bool `type:"boolean"` // Specifies whether a budget includes refunds. // // The default value is true. IncludeRefund *bool `type:"boolean"` // Specifies whether a budget includes subscriptions. // // The default value is true. IncludeSubscription *bool `type:"boolean"` // Specifies whether a budget includes support subscription fees. // // The default value is true. IncludeSupport *bool `type:"boolean"` // Specifies whether a budget includes taxes. // // The default value is true. IncludeTax *bool `type:"boolean"` // Specifies whether a budget includes upfront RI costs. // // The default value is true. IncludeUpfront *bool `type:"boolean"` // Specifies whether a budget uses the amortized rate. // // The default value is false. UseAmortized *bool `type:"boolean"` // Specifies whether a budget uses blended rate. // // The default value is false. UseBlended *bool `type:"boolean"` // contains filtered or unexported fields }
The types of cost included in a budget, such as tax and subscriptions.
func (*CostTypes) SetIncludeCredit ¶
SetIncludeCredit sets the IncludeCredit field's value.
func (*CostTypes) SetIncludeDiscount ¶
SetIncludeDiscount sets the IncludeDiscount field's value.
func (*CostTypes) SetIncludeOtherSubscription ¶
SetIncludeOtherSubscription sets the IncludeOtherSubscription field's value.
func (*CostTypes) SetIncludeRecurring ¶
SetIncludeRecurring sets the IncludeRecurring field's value.
func (*CostTypes) SetIncludeRefund ¶
SetIncludeRefund sets the IncludeRefund field's value.
func (*CostTypes) SetIncludeSubscription ¶
SetIncludeSubscription sets the IncludeSubscription field's value.
func (*CostTypes) SetIncludeSupport ¶
SetIncludeSupport sets the IncludeSupport field's value.
func (*CostTypes) SetIncludeTax ¶
SetIncludeTax sets the IncludeTax field's value.
func (*CostTypes) SetIncludeUpfront ¶
SetIncludeUpfront sets the IncludeUpfront field's value.
func (*CostTypes) SetUseAmortized ¶
SetUseAmortized sets the UseAmortized field's value.
func (*CostTypes) SetUseBlended ¶
SetUseBlended sets the UseBlended field's value.
type CreateBudgetInput ¶
type CreateBudgetInput struct { // The accountId that is associated with the budget. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` // The budget object that you want to create. // // Budget is a required field Budget *Budget `type:"structure" required:"true"` // 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 ten email subscribers. If you include notifications and subscribers // in your CreateBudget call, AWS creates the notifications and subscribers // for you. NotificationsWithSubscribers []*NotificationWithSubscribers `type:"list"` // contains filtered or unexported fields }
Request of CreateBudget
func (CreateBudgetInput) GoString ¶
func (s CreateBudgetInput) GoString() string
GoString returns the string representation
func (*CreateBudgetInput) SetAccountId ¶
func (s *CreateBudgetInput) SetAccountId(v string) *CreateBudgetInput
SetAccountId sets the AccountId field's value.
func (*CreateBudgetInput) SetBudget ¶
func (s *CreateBudgetInput) SetBudget(v *Budget) *CreateBudgetInput
SetBudget sets the Budget field's value.
func (*CreateBudgetInput) SetNotificationsWithSubscribers ¶
func (s *CreateBudgetInput) SetNotificationsWithSubscribers(v []*NotificationWithSubscribers) *CreateBudgetInput
SetNotificationsWithSubscribers sets the NotificationsWithSubscribers field's value.
func (CreateBudgetInput) String ¶
func (s CreateBudgetInput) String() string
String returns the string representation
func (*CreateBudgetInput) Validate ¶
func (s *CreateBudgetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateBudgetOutput ¶
type CreateBudgetOutput struct {
// contains filtered or unexported fields
}
Response of CreateBudget
func (CreateBudgetOutput) GoString ¶
func (s CreateBudgetOutput) GoString() string
GoString returns the string representation
func (CreateBudgetOutput) String ¶
func (s CreateBudgetOutput) String() string
String returns the string representation
type CreateNotificationInput ¶
type CreateNotificationInput struct { // The accountId that is associated with the budget that you want to create // a notification for. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` // The name of the budget that you want AWS to notified you about. Budget names // must be unique within an account. // // BudgetName is a required field BudgetName *string `type:"string" required:"true"` // The notification that you want to create. // // Notification is a required field Notification *Notification `type:"structure" required:"true"` // A list of subscribers that you want to associate with the notification. Each // notification can have one SNS subscriber and up to ten email subscribers. // // Subscribers is a required field Subscribers []*Subscriber `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
Request of CreateNotification
func (CreateNotificationInput) GoString ¶
func (s CreateNotificationInput) GoString() string
GoString returns the string representation
func (*CreateNotificationInput) SetAccountId ¶
func (s *CreateNotificationInput) SetAccountId(v string) *CreateNotificationInput
SetAccountId sets the AccountId field's value.
func (*CreateNotificationInput) SetBudgetName ¶
func (s *CreateNotificationInput) SetBudgetName(v string) *CreateNotificationInput
SetBudgetName sets the BudgetName field's value.
func (*CreateNotificationInput) SetNotification ¶
func (s *CreateNotificationInput) SetNotification(v *Notification) *CreateNotificationInput
SetNotification sets the Notification field's value.
func (*CreateNotificationInput) SetSubscribers ¶
func (s *CreateNotificationInput) SetSubscribers(v []*Subscriber) *CreateNotificationInput
SetSubscribers sets the Subscribers field's value.
func (CreateNotificationInput) String ¶
func (s CreateNotificationInput) String() string
String returns the string representation
func (*CreateNotificationInput) Validate ¶
func (s *CreateNotificationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateNotificationOutput ¶
type CreateNotificationOutput struct {
// contains filtered or unexported fields
}
Response of CreateNotification
func (CreateNotificationOutput) GoString ¶
func (s CreateNotificationOutput) GoString() string
GoString returns the string representation
func (CreateNotificationOutput) String ¶
func (s CreateNotificationOutput) String() string
String returns the string representation
type CreateSubscriberInput ¶
type CreateSubscriberInput struct { // The accountId associated with the budget that you want to create a subscriber // for. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` // The name of the budget that you want to subscribe to. Budget names must be // unique within an account. // // BudgetName is a required field BudgetName *string `type:"string" required:"true"` // The notification that you want to create a subscriber for. // // Notification is a required field Notification *Notification `type:"structure" required:"true"` // The subscriber that you want to associate with a budget notification. // // Subscriber is a required field Subscriber *Subscriber `type:"structure" required:"true"` // contains filtered or unexported fields }
Request of CreateSubscriber
func (CreateSubscriberInput) GoString ¶
func (s CreateSubscriberInput) GoString() string
GoString returns the string representation
func (*CreateSubscriberInput) SetAccountId ¶
func (s *CreateSubscriberInput) SetAccountId(v string) *CreateSubscriberInput
SetAccountId sets the AccountId field's value.
func (*CreateSubscriberInput) SetBudgetName ¶
func (s *CreateSubscriberInput) SetBudgetName(v string) *CreateSubscriberInput
SetBudgetName sets the BudgetName field's value.
func (*CreateSubscriberInput) SetNotification ¶
func (s *CreateSubscriberInput) SetNotification(v *Notification) *CreateSubscriberInput
SetNotification sets the Notification field's value.
func (*CreateSubscriberInput) SetSubscriber ¶
func (s *CreateSubscriberInput) SetSubscriber(v *Subscriber) *CreateSubscriberInput
SetSubscriber sets the Subscriber field's value.
func (CreateSubscriberInput) String ¶
func (s CreateSubscriberInput) String() string
String returns the string representation
func (*CreateSubscriberInput) Validate ¶
func (s *CreateSubscriberInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateSubscriberOutput ¶
type CreateSubscriberOutput struct {
// contains filtered or unexported fields
}
Response of CreateSubscriber
func (CreateSubscriberOutput) GoString ¶
func (s CreateSubscriberOutput) GoString() string
GoString returns the string representation
func (CreateSubscriberOutput) String ¶
func (s CreateSubscriberOutput) String() string
String returns the string representation
type DeleteBudgetInput ¶
type DeleteBudgetInput struct { // The accountId that is associated with the budget that you want to delete. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` // The name of the budget that you want to delete. // // BudgetName is a required field BudgetName *string `type:"string" required:"true"` // contains filtered or unexported fields }
Request of DeleteBudget
func (DeleteBudgetInput) GoString ¶
func (s DeleteBudgetInput) GoString() string
GoString returns the string representation
func (*DeleteBudgetInput) SetAccountId ¶
func (s *DeleteBudgetInput) SetAccountId(v string) *DeleteBudgetInput
SetAccountId sets the AccountId field's value.
func (*DeleteBudgetInput) SetBudgetName ¶
func (s *DeleteBudgetInput) SetBudgetName(v string) *DeleteBudgetInput
SetBudgetName sets the BudgetName field's value.
func (DeleteBudgetInput) String ¶
func (s DeleteBudgetInput) String() string
String returns the string representation
func (*DeleteBudgetInput) Validate ¶
func (s *DeleteBudgetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteBudgetOutput ¶
type DeleteBudgetOutput struct {
// contains filtered or unexported fields
}
Response of DeleteBudget
func (DeleteBudgetOutput) GoString ¶
func (s DeleteBudgetOutput) GoString() string
GoString returns the string representation
func (DeleteBudgetOutput) String ¶
func (s DeleteBudgetOutput) String() string
String returns the string representation
type DeleteNotificationInput ¶
type DeleteNotificationInput struct { // The accountId that is associated with the budget whose notification you want // to delete. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` // The name of the budget whose notification you want to delete. // // BudgetName is a required field BudgetName *string `type:"string" required:"true"` // The notification that you want to delete. // // Notification is a required field Notification *Notification `type:"structure" required:"true"` // contains filtered or unexported fields }
Request of DeleteNotification
func (DeleteNotificationInput) GoString ¶
func (s DeleteNotificationInput) GoString() string
GoString returns the string representation
func (*DeleteNotificationInput) SetAccountId ¶
func (s *DeleteNotificationInput) SetAccountId(v string) *DeleteNotificationInput
SetAccountId sets the AccountId field's value.
func (*DeleteNotificationInput) SetBudgetName ¶
func (s *DeleteNotificationInput) SetBudgetName(v string) *DeleteNotificationInput
SetBudgetName sets the BudgetName field's value.
func (*DeleteNotificationInput) SetNotification ¶
func (s *DeleteNotificationInput) SetNotification(v *Notification) *DeleteNotificationInput
SetNotification sets the Notification field's value.
func (DeleteNotificationInput) String ¶
func (s DeleteNotificationInput) String() string
String returns the string representation
func (*DeleteNotificationInput) Validate ¶
func (s *DeleteNotificationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteNotificationOutput ¶
type DeleteNotificationOutput struct {
// contains filtered or unexported fields
}
Response of DeleteNotification
func (DeleteNotificationOutput) GoString ¶
func (s DeleteNotificationOutput) GoString() string
GoString returns the string representation
func (DeleteNotificationOutput) String ¶
func (s DeleteNotificationOutput) String() string
String returns the string representation
type DeleteSubscriberInput ¶
type DeleteSubscriberInput struct { // The accountId that is associated with the budget whose subscriber you want // to delete. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` // The name of the budget whose subscriber you want to delete. // // BudgetName is a required field BudgetName *string `type:"string" required:"true"` // The notification whose subscriber you want to delete. // // Notification is a required field Notification *Notification `type:"structure" required:"true"` // The subscriber that you want to delete. // // Subscriber is a required field Subscriber *Subscriber `type:"structure" required:"true"` // contains filtered or unexported fields }
Request of DeleteSubscriber
func (DeleteSubscriberInput) GoString ¶
func (s DeleteSubscriberInput) GoString() string
GoString returns the string representation
func (*DeleteSubscriberInput) SetAccountId ¶
func (s *DeleteSubscriberInput) SetAccountId(v string) *DeleteSubscriberInput
SetAccountId sets the AccountId field's value.
func (*DeleteSubscriberInput) SetBudgetName ¶
func (s *DeleteSubscriberInput) SetBudgetName(v string) *DeleteSubscriberInput
SetBudgetName sets the BudgetName field's value.
func (*DeleteSubscriberInput) SetNotification ¶
func (s *DeleteSubscriberInput) SetNotification(v *Notification) *DeleteSubscriberInput
SetNotification sets the Notification field's value.
func (*DeleteSubscriberInput) SetSubscriber ¶
func (s *DeleteSubscriberInput) SetSubscriber(v *Subscriber) *DeleteSubscriberInput
SetSubscriber sets the Subscriber field's value.
func (DeleteSubscriberInput) String ¶
func (s DeleteSubscriberInput) String() string
String returns the string representation
func (*DeleteSubscriberInput) Validate ¶
func (s *DeleteSubscriberInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteSubscriberOutput ¶
type DeleteSubscriberOutput struct {
// contains filtered or unexported fields
}
Response of DeleteSubscriber
func (DeleteSubscriberOutput) GoString ¶
func (s DeleteSubscriberOutput) GoString() string
GoString returns the string representation
func (DeleteSubscriberOutput) String ¶
func (s DeleteSubscriberOutput) String() string
String returns the string representation
type DescribeBudgetInput ¶
type DescribeBudgetInput struct { // The accountId that is associated with the budget that you want a description // of. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` // The name of the budget that you want a description of. // // BudgetName is a required field BudgetName *string `type:"string" required:"true"` // contains filtered or unexported fields }
Request of DescribeBudget
func (DescribeBudgetInput) GoString ¶
func (s DescribeBudgetInput) GoString() string
GoString returns the string representation
func (*DescribeBudgetInput) SetAccountId ¶
func (s *DescribeBudgetInput) SetAccountId(v string) *DescribeBudgetInput
SetAccountId sets the AccountId field's value.
func (*DescribeBudgetInput) SetBudgetName ¶
func (s *DescribeBudgetInput) SetBudgetName(v string) *DescribeBudgetInput
SetBudgetName sets the BudgetName field's value.
func (DescribeBudgetInput) String ¶
func (s DescribeBudgetInput) String() string
String returns the string representation
func (*DescribeBudgetInput) Validate ¶
func (s *DescribeBudgetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeBudgetOutput ¶
type DescribeBudgetOutput struct { // The description of the budget. Budget *Budget `type:"structure"` // contains filtered or unexported fields }
Response of DescribeBudget
func (DescribeBudgetOutput) GoString ¶
func (s DescribeBudgetOutput) GoString() string
GoString returns the string representation
func (*DescribeBudgetOutput) SetBudget ¶
func (s *DescribeBudgetOutput) SetBudget(v *Budget) *DescribeBudgetOutput
SetBudget sets the Budget field's value.
func (DescribeBudgetOutput) String ¶
func (s DescribeBudgetOutput) String() string
String returns the string representation
type DescribeBudgetsInput ¶
type DescribeBudgetsInput struct { // The accountId that is associated with the budgets that you want descriptions // of. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` // Optional integer. Specifies the maximum number of results to return in response. MaxResults *int64 `min:"1" type:"integer"` // The pagination token that indicates the next set of results to retrieve. NextToken *string `type:"string"` // contains filtered or unexported fields }
Request of DescribeBudgets
func (DescribeBudgetsInput) GoString ¶
func (s DescribeBudgetsInput) GoString() string
GoString returns the string representation
func (*DescribeBudgetsInput) SetAccountId ¶
func (s *DescribeBudgetsInput) SetAccountId(v string) *DescribeBudgetsInput
SetAccountId sets the AccountId field's value.
func (*DescribeBudgetsInput) SetMaxResults ¶
func (s *DescribeBudgetsInput) SetMaxResults(v int64) *DescribeBudgetsInput
SetMaxResults sets the MaxResults field's value.
func (*DescribeBudgetsInput) SetNextToken ¶
func (s *DescribeBudgetsInput) SetNextToken(v string) *DescribeBudgetsInput
SetNextToken sets the NextToken field's value.
func (DescribeBudgetsInput) String ¶
func (s DescribeBudgetsInput) String() string
String returns the string representation
func (*DescribeBudgetsInput) Validate ¶
func (s *DescribeBudgetsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeBudgetsOutput ¶
type DescribeBudgetsOutput struct { // A list of budgets. Budgets []*Budget `type:"list"` // The pagination token that indicates the next set of results that you can // retrieve. NextToken *string `type:"string"` // contains filtered or unexported fields }
Response of DescribeBudgets
func (DescribeBudgetsOutput) GoString ¶
func (s DescribeBudgetsOutput) GoString() string
GoString returns the string representation
func (*DescribeBudgetsOutput) SetBudgets ¶
func (s *DescribeBudgetsOutput) SetBudgets(v []*Budget) *DescribeBudgetsOutput
SetBudgets sets the Budgets field's value.
func (*DescribeBudgetsOutput) SetNextToken ¶
func (s *DescribeBudgetsOutput) SetNextToken(v string) *DescribeBudgetsOutput
SetNextToken sets the NextToken field's value.
func (DescribeBudgetsOutput) String ¶
func (s DescribeBudgetsOutput) String() string
String returns the string representation
type DescribeNotificationsForBudgetInput ¶
type DescribeNotificationsForBudgetInput struct { // The accountId that is associated with the budget whose notifications you // want descriptions of. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` // The name of the budget whose notifications you want descriptions of. // // BudgetName is a required field BudgetName *string `type:"string" required:"true"` // Optional integer. Specifies the maximum number of results to return in response. MaxResults *int64 `min:"1" type:"integer"` // The pagination token that indicates the next set of results to retrieve. NextToken *string `type:"string"` // contains filtered or unexported fields }
Request of DescribeNotificationsForBudget
func (DescribeNotificationsForBudgetInput) GoString ¶
func (s DescribeNotificationsForBudgetInput) GoString() string
GoString returns the string representation
func (*DescribeNotificationsForBudgetInput) SetAccountId ¶
func (s *DescribeNotificationsForBudgetInput) SetAccountId(v string) *DescribeNotificationsForBudgetInput
SetAccountId sets the AccountId field's value.
func (*DescribeNotificationsForBudgetInput) SetBudgetName ¶
func (s *DescribeNotificationsForBudgetInput) SetBudgetName(v string) *DescribeNotificationsForBudgetInput
SetBudgetName sets the BudgetName field's value.
func (*DescribeNotificationsForBudgetInput) SetMaxResults ¶
func (s *DescribeNotificationsForBudgetInput) SetMaxResults(v int64) *DescribeNotificationsForBudgetInput
SetMaxResults sets the MaxResults field's value.
func (*DescribeNotificationsForBudgetInput) SetNextToken ¶
func (s *DescribeNotificationsForBudgetInput) SetNextToken(v string) *DescribeNotificationsForBudgetInput
SetNextToken sets the NextToken field's value.
func (DescribeNotificationsForBudgetInput) String ¶
func (s DescribeNotificationsForBudgetInput) String() string
String returns the string representation
func (*DescribeNotificationsForBudgetInput) Validate ¶
func (s *DescribeNotificationsForBudgetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeNotificationsForBudgetOutput ¶
type DescribeNotificationsForBudgetOutput struct { // The pagination token that indicates the next set of results that you can // retrieve. NextToken *string `type:"string"` // A list of notifications associated with a budget. Notifications []*Notification `type:"list"` // contains filtered or unexported fields }
Response of GetNotificationsForBudget
func (DescribeNotificationsForBudgetOutput) GoString ¶
func (s DescribeNotificationsForBudgetOutput) GoString() string
GoString returns the string representation
func (*DescribeNotificationsForBudgetOutput) SetNextToken ¶
func (s *DescribeNotificationsForBudgetOutput) SetNextToken(v string) *DescribeNotificationsForBudgetOutput
SetNextToken sets the NextToken field's value.
func (*DescribeNotificationsForBudgetOutput) SetNotifications ¶
func (s *DescribeNotificationsForBudgetOutput) SetNotifications(v []*Notification) *DescribeNotificationsForBudgetOutput
SetNotifications sets the Notifications field's value.
func (DescribeNotificationsForBudgetOutput) String ¶
func (s DescribeNotificationsForBudgetOutput) String() string
String returns the string representation
type DescribeSubscribersForNotificationInput ¶
type DescribeSubscribersForNotificationInput struct { // The accountId that is associated with the budget whose subscribers you want // descriptions of. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` // The name of the budget whose subscribers you want descriptions of. // // BudgetName is a required field BudgetName *string `type:"string" required:"true"` // Optional integer. Specifies the maximum number of results to return in response. MaxResults *int64 `min:"1" type:"integer"` // The pagination token that indicates the next set of results to retrieve. NextToken *string `type:"string"` // The notification whose subscribers you want to list. // // Notification is a required field Notification *Notification `type:"structure" required:"true"` // contains filtered or unexported fields }
Request of DescribeSubscribersForNotification
func (DescribeSubscribersForNotificationInput) GoString ¶
func (s DescribeSubscribersForNotificationInput) GoString() string
GoString returns the string representation
func (*DescribeSubscribersForNotificationInput) SetAccountId ¶
func (s *DescribeSubscribersForNotificationInput) SetAccountId(v string) *DescribeSubscribersForNotificationInput
SetAccountId sets the AccountId field's value.
func (*DescribeSubscribersForNotificationInput) SetBudgetName ¶
func (s *DescribeSubscribersForNotificationInput) SetBudgetName(v string) *DescribeSubscribersForNotificationInput
SetBudgetName sets the BudgetName field's value.
func (*DescribeSubscribersForNotificationInput) SetMaxResults ¶
func (s *DescribeSubscribersForNotificationInput) SetMaxResults(v int64) *DescribeSubscribersForNotificationInput
SetMaxResults sets the MaxResults field's value.
func (*DescribeSubscribersForNotificationInput) SetNextToken ¶
func (s *DescribeSubscribersForNotificationInput) SetNextToken(v string) *DescribeSubscribersForNotificationInput
SetNextToken sets the NextToken field's value.
func (*DescribeSubscribersForNotificationInput) SetNotification ¶
func (s *DescribeSubscribersForNotificationInput) SetNotification(v *Notification) *DescribeSubscribersForNotificationInput
SetNotification sets the Notification field's value.
func (DescribeSubscribersForNotificationInput) String ¶
func (s DescribeSubscribersForNotificationInput) String() string
String returns the string representation
func (*DescribeSubscribersForNotificationInput) Validate ¶
func (s *DescribeSubscribersForNotificationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeSubscribersForNotificationOutput ¶
type DescribeSubscribersForNotificationOutput struct { // The pagination token that indicates the next set of results that you can // retrieve. NextToken *string `type:"string"` // A list of subscribers associated with a notification. Subscribers []*Subscriber `min:"1" type:"list"` // contains filtered or unexported fields }
Response of DescribeSubscribersForNotification
func (DescribeSubscribersForNotificationOutput) GoString ¶
func (s DescribeSubscribersForNotificationOutput) GoString() string
GoString returns the string representation
func (*DescribeSubscribersForNotificationOutput) SetNextToken ¶
func (s *DescribeSubscribersForNotificationOutput) SetNextToken(v string) *DescribeSubscribersForNotificationOutput
SetNextToken sets the NextToken field's value.
func (*DescribeSubscribersForNotificationOutput) SetSubscribers ¶
func (s *DescribeSubscribersForNotificationOutput) SetSubscribers(v []*Subscriber) *DescribeSubscribersForNotificationOutput
SetSubscribers sets the Subscribers field's value.
func (DescribeSubscribersForNotificationOutput) String ¶
func (s DescribeSubscribersForNotificationOutput) String() string
String returns the string representation
type Notification ¶
type Notification struct { // The comparison used for this notification. // // ComparisonOperator is a required field ComparisonOperator *string `type:"string" required:"true" enum:"ComparisonOperator"` // Whether the notification is for how much you have spent (ACTUAL) or for how // much you are forecasted to spend (FORECASTED). // // NotificationType is a required field NotificationType *string `type:"string" required:"true" enum:"NotificationType"` // The threshold associated with a notification. Thresholds are always a percentage. // // Threshold is a required field Threshold *float64 `min:"0.1" type:"double" required:"true"` // The type of threshold for a notification. For ACTUAL thresholds, AWS notifies // you when you go over the threshold, and for FORECASTED thresholds AWS notifies // you when you are forecasted to go over the threshold. ThresholdType *string `type:"string" enum:"ThresholdType"` // contains filtered or unexported fields }
A notification 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 ten 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 comparisonOperator of GREATER_THAN
A notification threshold of 80
func (Notification) GoString ¶
func (s Notification) GoString() string
GoString returns the string representation
func (*Notification) SetComparisonOperator ¶
func (s *Notification) SetComparisonOperator(v string) *Notification
SetComparisonOperator sets the ComparisonOperator field's value.
func (*Notification) SetNotificationType ¶
func (s *Notification) SetNotificationType(v string) *Notification
SetNotificationType sets the NotificationType field's value.
func (*Notification) SetThreshold ¶
func (s *Notification) SetThreshold(v float64) *Notification
SetThreshold sets the Threshold field's value.
func (*Notification) SetThresholdType ¶
func (s *Notification) SetThresholdType(v string) *Notification
SetThresholdType sets the ThresholdType field's value.
func (Notification) String ¶
func (s Notification) String() string
String returns the string representation
func (*Notification) Validate ¶
func (s *Notification) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type NotificationWithSubscribers ¶
type NotificationWithSubscribers struct { // The notification associated with a budget. // // Notification is a required field Notification *Notification `type:"structure" required:"true"` // A list of subscribers who are subscribed to this notification. // // Subscribers is a required field Subscribers []*Subscriber `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
A notification with subscribers. A notification can have one SNS subscriber and up to ten email subscribers, for a total of 11 subscribers.
func (NotificationWithSubscribers) GoString ¶
func (s NotificationWithSubscribers) GoString() string
GoString returns the string representation
func (*NotificationWithSubscribers) SetNotification ¶
func (s *NotificationWithSubscribers) SetNotification(v *Notification) *NotificationWithSubscribers
SetNotification sets the Notification field's value.
func (*NotificationWithSubscribers) SetSubscribers ¶
func (s *NotificationWithSubscribers) SetSubscribers(v []*Subscriber) *NotificationWithSubscribers
SetSubscribers sets the Subscribers field's value.
func (NotificationWithSubscribers) String ¶
func (s NotificationWithSubscribers) String() string
String returns the string representation
func (*NotificationWithSubscribers) Validate ¶
func (s *NotificationWithSubscribers) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Spend ¶
type Spend struct { // The cost or usage amount associated with a budget forecast, actual spend, // or budget threshold. // // Amount is a required field Amount *string `type:"string" required:"true"` // The unit of measurement used for the budget forecast, actual spend, or budget // threshold, such as dollars or GB. // // Unit is a required field Unit *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The amount of cost or usage being 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. // // Address is a required field Address *string `min:"1" type:"string" required:"true"` // The type of notification that AWS sends to a subscriber. // // SubscriptionType is a required field SubscriptionType *string `type:"string" required:"true" enum:"SubscriptionType"` // contains filtered or unexported fields }
The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon Simple Notification Service 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
func (Subscriber) GoString ¶
func (s Subscriber) GoString() string
GoString returns the string representation
func (*Subscriber) SetAddress ¶
func (s *Subscriber) SetAddress(v string) *Subscriber
SetAddress sets the Address field's value.
func (*Subscriber) SetSubscriptionType ¶
func (s *Subscriber) SetSubscriptionType(v string) *Subscriber
SetSubscriptionType sets the SubscriptionType field's value.
func (Subscriber) String ¶
func (s Subscriber) String() string
String returns the string representation
func (*Subscriber) Validate ¶
func (s *Subscriber) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TimePeriod ¶
type TimePeriod struct { // 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 `type:"timestamp" timestampFormat:"unix"` // 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 (i.e. // DAILY, MONTHLY, QUARTERLY, ANNUALLY). For example, if you created your budget // on January 24th 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 `type:"timestamp" timestampFormat:"unix"` // contains filtered or unexported fields }
The period of time covered by a budget. 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.
func (TimePeriod) GoString ¶
func (s TimePeriod) GoString() string
GoString returns the string representation
func (*TimePeriod) SetEnd ¶
func (s *TimePeriod) SetEnd(v time.Time) *TimePeriod
SetEnd sets the End field's value.
func (*TimePeriod) SetStart ¶
func (s *TimePeriod) SetStart(v time.Time) *TimePeriod
SetStart sets the Start field's value.
func (TimePeriod) String ¶
func (s TimePeriod) String() string
String returns the string representation
type UpdateBudgetInput ¶
type UpdateBudgetInput struct { // The accountId that is associated with the budget that you want to update. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` // The budget that you want to update your budget to. // // NewBudget is a required field NewBudget *Budget `type:"structure" required:"true"` // contains filtered or unexported fields }
Request of UpdateBudget
func (UpdateBudgetInput) GoString ¶
func (s UpdateBudgetInput) GoString() string
GoString returns the string representation
func (*UpdateBudgetInput) SetAccountId ¶
func (s *UpdateBudgetInput) SetAccountId(v string) *UpdateBudgetInput
SetAccountId sets the AccountId field's value.
func (*UpdateBudgetInput) SetNewBudget ¶
func (s *UpdateBudgetInput) SetNewBudget(v *Budget) *UpdateBudgetInput
SetNewBudget sets the NewBudget field's value.
func (UpdateBudgetInput) String ¶
func (s UpdateBudgetInput) String() string
String returns the string representation
func (*UpdateBudgetInput) Validate ¶
func (s *UpdateBudgetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateBudgetOutput ¶
type UpdateBudgetOutput struct {
// contains filtered or unexported fields
}
Response of UpdateBudget
func (UpdateBudgetOutput) GoString ¶
func (s UpdateBudgetOutput) GoString() string
GoString returns the string representation
func (UpdateBudgetOutput) String ¶
func (s UpdateBudgetOutput) String() string
String returns the string representation
type UpdateNotificationInput ¶
type UpdateNotificationInput struct { // The accountId that is associated with the budget whose notification you want // to update. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` // The name of the budget whose notification you want to update. // // BudgetName is a required field BudgetName *string `type:"string" required:"true"` // The updated notification to be associated with a budget. // // NewNotification is a required field NewNotification *Notification `type:"structure" required:"true"` // The previous notification associated with a budget. // // OldNotification is a required field OldNotification *Notification `type:"structure" required:"true"` // contains filtered or unexported fields }
Request of UpdateNotification
func (UpdateNotificationInput) GoString ¶
func (s UpdateNotificationInput) GoString() string
GoString returns the string representation
func (*UpdateNotificationInput) SetAccountId ¶
func (s *UpdateNotificationInput) SetAccountId(v string) *UpdateNotificationInput
SetAccountId sets the AccountId field's value.
func (*UpdateNotificationInput) SetBudgetName ¶
func (s *UpdateNotificationInput) SetBudgetName(v string) *UpdateNotificationInput
SetBudgetName sets the BudgetName field's value.
func (*UpdateNotificationInput) SetNewNotification ¶
func (s *UpdateNotificationInput) SetNewNotification(v *Notification) *UpdateNotificationInput
SetNewNotification sets the NewNotification field's value.
func (*UpdateNotificationInput) SetOldNotification ¶
func (s *UpdateNotificationInput) SetOldNotification(v *Notification) *UpdateNotificationInput
SetOldNotification sets the OldNotification field's value.
func (UpdateNotificationInput) String ¶
func (s UpdateNotificationInput) String() string
String returns the string representation
func (*UpdateNotificationInput) Validate ¶
func (s *UpdateNotificationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateNotificationOutput ¶
type UpdateNotificationOutput struct {
// contains filtered or unexported fields
}
Response of UpdateNotification
func (UpdateNotificationOutput) GoString ¶
func (s UpdateNotificationOutput) GoString() string
GoString returns the string representation
func (UpdateNotificationOutput) String ¶
func (s UpdateNotificationOutput) String() string
String returns the string representation
type UpdateSubscriberInput ¶
type UpdateSubscriberInput struct { // The accountId that is associated with the budget whose subscriber you want // to update. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` // The name of the budget whose subscriber you want to update. // // BudgetName is a required field BudgetName *string `type:"string" required:"true"` // The updated subscriber associated with a budget notification. // // NewSubscriber is a required field NewSubscriber *Subscriber `type:"structure" required:"true"` // The notification whose subscriber you want to update. // // Notification is a required field Notification *Notification `type:"structure" required:"true"` // The previous subscriber associated with a budget notification. // // OldSubscriber is a required field OldSubscriber *Subscriber `type:"structure" required:"true"` // contains filtered or unexported fields }
Request of UpdateSubscriber
func (UpdateSubscriberInput) GoString ¶
func (s UpdateSubscriberInput) GoString() string
GoString returns the string representation
func (*UpdateSubscriberInput) SetAccountId ¶
func (s *UpdateSubscriberInput) SetAccountId(v string) *UpdateSubscriberInput
SetAccountId sets the AccountId field's value.
func (*UpdateSubscriberInput) SetBudgetName ¶
func (s *UpdateSubscriberInput) SetBudgetName(v string) *UpdateSubscriberInput
SetBudgetName sets the BudgetName field's value.
func (*UpdateSubscriberInput) SetNewSubscriber ¶
func (s *UpdateSubscriberInput) SetNewSubscriber(v *Subscriber) *UpdateSubscriberInput
SetNewSubscriber sets the NewSubscriber field's value.
func (*UpdateSubscriberInput) SetNotification ¶
func (s *UpdateSubscriberInput) SetNotification(v *Notification) *UpdateSubscriberInput
SetNotification sets the Notification field's value.
func (*UpdateSubscriberInput) SetOldSubscriber ¶
func (s *UpdateSubscriberInput) SetOldSubscriber(v *Subscriber) *UpdateSubscriberInput
SetOldSubscriber sets the OldSubscriber field's value.
func (UpdateSubscriberInput) String ¶
func (s UpdateSubscriberInput) String() string
String returns the string representation
func (*UpdateSubscriberInput) Validate ¶
func (s *UpdateSubscriberInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateSubscriberOutput ¶
type UpdateSubscriberOutput struct {
// contains filtered or unexported fields
}
Response of UpdateSubscriber
func (UpdateSubscriberOutput) GoString ¶
func (s UpdateSubscriberOutput) GoString() string
GoString returns the string representation
func (UpdateSubscriberOutput) String ¶
func (s UpdateSubscriberOutput) String() string
String returns the string representation
Directories
¶
Path | Synopsis |
---|---|
Package budgetsiface provides an interface to enable mocking the AWS Budgets service client for testing your code.
|
Package budgetsiface provides an interface to enable mocking the AWS Budgets service client for testing your code. |