Documentation ¶
Overview ¶
Package budgets provides a client for AWS Budgets.
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) CreateNotification(input *CreateNotificationInput) (*CreateNotificationOutput, error)
- func (c *Budgets) CreateNotificationRequest(input *CreateNotificationInput) (req *request.Request, output *CreateNotificationOutput)
- func (c *Budgets) CreateSubscriber(input *CreateSubscriberInput) (*CreateSubscriberOutput, error)
- func (c *Budgets) CreateSubscriberRequest(input *CreateSubscriberInput) (req *request.Request, output *CreateSubscriberOutput)
- func (c *Budgets) DeleteBudget(input *DeleteBudgetInput) (*DeleteBudgetOutput, error)
- func (c *Budgets) DeleteBudgetRequest(input *DeleteBudgetInput) (req *request.Request, output *DeleteBudgetOutput)
- func (c *Budgets) DeleteNotification(input *DeleteNotificationInput) (*DeleteNotificationOutput, error)
- func (c *Budgets) DeleteNotificationRequest(input *DeleteNotificationInput) (req *request.Request, output *DeleteNotificationOutput)
- func (c *Budgets) DeleteSubscriber(input *DeleteSubscriberInput) (*DeleteSubscriberOutput, error)
- func (c *Budgets) DeleteSubscriberRequest(input *DeleteSubscriberInput) (req *request.Request, output *DeleteSubscriberOutput)
- func (c *Budgets) DescribeBudget(input *DescribeBudgetInput) (*DescribeBudgetOutput, error)
- func (c *Budgets) DescribeBudgetRequest(input *DescribeBudgetInput) (req *request.Request, output *DescribeBudgetOutput)
- func (c *Budgets) DescribeBudgets(input *DescribeBudgetsInput) (*DescribeBudgetsOutput, error)
- func (c *Budgets) DescribeBudgetsRequest(input *DescribeBudgetsInput) (req *request.Request, output *DescribeBudgetsOutput)
- func (c *Budgets) DescribeNotificationsForBudget(input *DescribeNotificationsForBudgetInput) (*DescribeNotificationsForBudgetOutput, error)
- func (c *Budgets) DescribeNotificationsForBudgetRequest(input *DescribeNotificationsForBudgetInput) (req *request.Request, output *DescribeNotificationsForBudgetOutput)
- func (c *Budgets) DescribeSubscribersForNotification(input *DescribeSubscribersForNotificationInput) (*DescribeSubscribersForNotificationOutput, error)
- func (c *Budgets) DescribeSubscribersForNotificationRequest(input *DescribeSubscribersForNotificationInput) (req *request.Request, output *DescribeSubscribersForNotificationOutput)
- func (c *Budgets) UpdateBudget(input *UpdateBudgetInput) (*UpdateBudgetOutput, error)
- func (c *Budgets) UpdateBudgetRequest(input *UpdateBudgetInput) (req *request.Request, output *UpdateBudgetOutput)
- func (c *Budgets) UpdateNotification(input *UpdateNotificationInput) (*UpdateNotificationOutput, error)
- func (c *Budgets) UpdateNotificationRequest(input *UpdateNotificationInput) (req *request.Request, output *UpdateNotificationOutput)
- func (c *Budgets) UpdateSubscriber(input *UpdateSubscriberInput) (*UpdateSubscriberOutput, error)
- func (c *Budgets) UpdateSubscriberRequest(input *UpdateSubscriberInput) (req *request.Request, output *UpdateSubscriberOutput)
- type CalculatedSpend
- type CostTypes
- 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) 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
Examples ¶
- Budgets.CreateBudget
- Budgets.CreateNotification
- Budgets.CreateSubscriber
- Budgets.DeleteBudget
- Budgets.DeleteNotification
- Budgets.DeleteSubscriber
- Budgets.DescribeBudget
- Budgets.DescribeBudgets
- Budgets.DescribeNotificationsForBudget
- Budgets.DescribeSubscribersForNotification
- Budgets.UpdateBudget
- Budgets.UpdateNotification
- Budgets.UpdateSubscriber
Constants ¶
const ( // BudgetTypeUsage is a BudgetType enum value BudgetTypeUsage = "USAGE" // BudgetTypeCost is a BudgetType enum value BudgetTypeCost = "COST" )
The type of a budget. Can be COST or USAGE.
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 ( // 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. weekly, monthly, etc.
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 { // A structure represent either a cost spend or usage spend. Contains an amount // and a unit. // // BudgetLimit is a required field BudgetLimit *Spend `type:"structure" required:"true"` // A string represents the budget name. No ":" character is allowed. // // BudgetName is a required field BudgetName *string `type:"string" required:"true"` // The type of a budget. Can be COST or USAGE. // // BudgetType is a required field BudgetType *string `type:"string" required:"true" enum:"BudgetType"` // A structure holds the actual and forecasted spend for a budget. CalculatedSpend *CalculatedSpend `type:"structure"` // A map represents the cost filters applied to the budget. CostFilters map[string][]*string `type:"map"` // This includes the options for getting the cost of a budget. // // CostTypes is a required field CostTypes *CostTypes `type:"structure" required:"true"` // A time period indicated the start date and end date of a budget. // // TimePeriod is a required field TimePeriod *TimePeriod `type:"structure" required:"true"` // The time unit of the budget. e.g. weekly, monthly, etc. // // TimeUnit is a required field TimeUnit *string `type:"string" required:"true" enum:"TimeUnit"` // contains filtered or unexported fields }
AWS Budget model
func (*Budget) SetBudgetLimit ¶ added in v1.5.1
SetBudgetLimit sets the BudgetLimit field's value.
func (*Budget) SetBudgetName ¶ added in v1.5.1
SetBudgetName sets the BudgetName field's value.
func (*Budget) SetBudgetType ¶ added in v1.5.1
SetBudgetType sets the BudgetType field's value.
func (*Budget) SetCalculatedSpend ¶ added in v1.5.1
func (s *Budget) SetCalculatedSpend(v *CalculatedSpend) *Budget
SetCalculatedSpend sets the CalculatedSpend field's value.
func (*Budget) SetCostFilters ¶ added in v1.5.1
SetCostFilters sets the CostFilters field's value.
func (*Budget) SetCostTypes ¶ added in v1.5.1
SetCostTypes sets the CostTypes field's value.
func (*Budget) SetTimePeriod ¶ added in v1.5.1
func (s *Budget) SetTimePeriod(v *TimePeriod) *Budget
SetTimePeriod sets the TimePeriod field's value.
func (*Budget) SetTimeUnit ¶ added in v1.5.1
SetTimeUnit sets the TimeUnit field's value.
type Budgets ¶
All public APIs for AWS Budgets The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client'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.
Create a new 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 CreateBudget for usage and error information.
Returned Error Codes:
InvalidParameterException This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.
InternalErrorException This exception is thrown on an unknown internal failure.
CreationLimitExceededException The exception is thrown when customer tries to create a record (e.g. budget), but the number this record already exceeds the limitation.
DuplicateRecordException The exception is thrown when customer tries to create a record (e.g. budget) that already exists.
Example ¶
package main import ( "fmt" "time" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/budgets" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := budgets.New(sess) params := &budgets.CreateBudgetInput{ AccountId: aws.String("AccountId"), // Required Budget: &budgets.Budget{ // Required BudgetLimit: &budgets.Spend{ // Required Amount: aws.String("NumericValue"), // Required Unit: aws.String("GenericString"), // Required }, BudgetName: aws.String("BudgetName"), // Required BudgetType: aws.String("BudgetType"), // Required CostTypes: &budgets.CostTypes{ // Required IncludeSubscription: aws.Bool(true), // Required IncludeTax: aws.Bool(true), // Required UseBlended: aws.Bool(true), // Required }, TimePeriod: &budgets.TimePeriod{ // Required End: aws.Time(time.Now()), // Required Start: aws.Time(time.Now()), // Required }, TimeUnit: aws.String("TimeUnit"), // Required CalculatedSpend: &budgets.CalculatedSpend{ ActualSpend: &budgets.Spend{ // Required Amount: aws.String("NumericValue"), // Required Unit: aws.String("GenericString"), // Required }, ForecastedSpend: &budgets.Spend{ Amount: aws.String("NumericValue"), // Required Unit: aws.String("GenericString"), // Required }, }, CostFilters: map[string][]*string{ "Key": { // Required aws.String("GenericString"), // Required // More values... }, // More values... }, }, NotificationsWithSubscribers: []*budgets.NotificationWithSubscribers{ { // Required Notification: &budgets.Notification{ // Required ComparisonOperator: aws.String("ComparisonOperator"), // Required NotificationType: aws.String("NotificationType"), // Required Threshold: aws.Float64(1.0), // Required }, Subscribers: []*budgets.Subscriber{ // Required { // Required Address: aws.String("GenericString"), // Required SubscriptionType: aws.String("SubscriptionType"), // Required }, // More values... }, }, // More values... }, } resp, err := svc.CreateBudget(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
See CreateBudget for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateBudget method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) CreateNotification ¶
func (c *Budgets) CreateNotification(input *CreateNotificationInput) (*CreateNotificationOutput, error)
CreateNotification API operation for AWS Budgets.
Create a new Notification with subscribers for 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 CreateNotification for usage and error information.
Returned Error Codes:
InternalErrorException This exception is thrown on an unknown internal failure.
InvalidParameterException This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.
NotFoundException This exception is thrown if a requested entity is not found. E.g., if a budget id doesn't exist for an account ID.
CreationLimitExceededException The exception is thrown when customer tries to create a record (e.g. budget), but the number this record already exceeds the limitation.
DuplicateRecordException The exception is thrown when customer tries to create a record (e.g. budget) that already exists.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/budgets" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := budgets.New(sess) params := &budgets.CreateNotificationInput{ AccountId: aws.String("AccountId"), // Required BudgetName: aws.String("BudgetName"), // Required Notification: &budgets.Notification{ // Required ComparisonOperator: aws.String("ComparisonOperator"), // Required NotificationType: aws.String("NotificationType"), // Required Threshold: aws.Float64(1.0), // Required }, Subscribers: []*budgets.Subscriber{ // Required { // Required Address: aws.String("GenericString"), // Required SubscriptionType: aws.String("SubscriptionType"), // Required }, // More values... }, } resp, err := svc.CreateNotification(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
See CreateNotification for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateNotification method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) CreateSubscriber ¶
func (c *Budgets) CreateSubscriber(input *CreateSubscriberInput) (*CreateSubscriberOutput, error)
CreateSubscriber API operation for AWS Budgets.
Create a new Subscriber for 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 CreateSubscriber for usage and error information.
Returned Error Codes:
InternalErrorException This exception is thrown on an unknown internal failure.
InvalidParameterException This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.
CreationLimitExceededException The exception is thrown when customer tries to create a record (e.g. budget), but the number this record already exceeds the limitation.
DuplicateRecordException The exception is thrown when customer tries to create a record (e.g. budget) that already exists.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/budgets" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := budgets.New(sess) params := &budgets.CreateSubscriberInput{ AccountId: aws.String("AccountId"), // Required BudgetName: aws.String("BudgetName"), // Required Notification: &budgets.Notification{ // Required ComparisonOperator: aws.String("ComparisonOperator"), // Required NotificationType: aws.String("NotificationType"), // Required Threshold: aws.Float64(1.0), // Required }, Subscriber: &budgets.Subscriber{ // Required Address: aws.String("GenericString"), // Required SubscriptionType: aws.String("SubscriptionType"), // Required }, } resp, err := svc.CreateSubscriber(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
See CreateSubscriber for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateSubscriber method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) DeleteBudget ¶
func (c *Budgets) DeleteBudget(input *DeleteBudgetInput) (*DeleteBudgetOutput, error)
DeleteBudget API operation for AWS Budgets.
Delete a budget and related notifications ¶
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:
InternalErrorException This exception is thrown on an unknown internal failure.
InvalidParameterException This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.
NotFoundException This exception is thrown if a requested entity is not found. E.g., if a budget id doesn't exist for an account ID.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/budgets" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := budgets.New(sess) params := &budgets.DeleteBudgetInput{ AccountId: aws.String("AccountId"), // Required BudgetName: aws.String("BudgetName"), // Required } resp, err := svc.DeleteBudget(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
See DeleteBudget for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteBudget method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) DeleteNotification ¶
func (c *Budgets) DeleteNotification(input *DeleteNotificationInput) (*DeleteNotificationOutput, error)
DeleteNotification API operation for AWS Budgets.
Delete a notification and related 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 DeleteNotification for usage and error information.
Returned Error Codes:
InvalidParameterException This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.
InternalErrorException This exception is thrown on an unknown internal failure.
NotFoundException This exception is thrown if a requested entity is not found. E.g., if a budget id doesn't exist for an account ID.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/budgets" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := budgets.New(sess) params := &budgets.DeleteNotificationInput{ AccountId: aws.String("AccountId"), // Required BudgetName: aws.String("BudgetName"), // Required Notification: &budgets.Notification{ // Required ComparisonOperator: aws.String("ComparisonOperator"), // Required NotificationType: aws.String("NotificationType"), // Required Threshold: aws.Float64(1.0), // Required }, } resp, err := svc.DeleteNotification(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
See DeleteNotification for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteNotification method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) DeleteSubscriber ¶
func (c *Budgets) DeleteSubscriber(input *DeleteSubscriberInput) (*DeleteSubscriberOutput, error)
DeleteSubscriber API operation for AWS Budgets.
Delete a Subscriber for 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 DeleteSubscriber for usage and error information.
Returned Error Codes:
InternalErrorException This exception is thrown on an unknown internal failure.
InvalidParameterException This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.
NotFoundException This exception is thrown if a requested entity is not found. E.g., if a budget id doesn't exist for an account ID.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/budgets" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := budgets.New(sess) params := &budgets.DeleteSubscriberInput{ AccountId: aws.String("AccountId"), // Required BudgetName: aws.String("BudgetName"), // Required Notification: &budgets.Notification{ // Required ComparisonOperator: aws.String("ComparisonOperator"), // Required NotificationType: aws.String("NotificationType"), // Required Threshold: aws.Float64(1.0), // Required }, Subscriber: &budgets.Subscriber{ // Required Address: aws.String("GenericString"), // Required SubscriptionType: aws.String("SubscriptionType"), // Required }, } resp, err := svc.DeleteSubscriber(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
See DeleteSubscriber for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteSubscriber method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) DescribeBudget ¶
func (c *Budgets) DescribeBudget(input *DescribeBudgetInput) (*DescribeBudgetOutput, error)
DescribeBudget API operation for AWS Budgets.
Get a single 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:
InternalErrorException This exception is thrown on an unknown internal failure.
InvalidParameterException This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.
NotFoundException This exception is thrown if a requested entity is not found. E.g., if a budget id doesn't exist for an account ID.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/budgets" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := budgets.New(sess) params := &budgets.DescribeBudgetInput{ AccountId: aws.String("AccountId"), // Required BudgetName: aws.String("BudgetName"), // Required } resp, err := svc.DescribeBudget(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
See DescribeBudget for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeBudget method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) DescribeBudgets ¶
func (c *Budgets) DescribeBudgets(input *DescribeBudgetsInput) (*DescribeBudgetsOutput, error)
DescribeBudgets API operation for AWS Budgets.
Get all budgets for 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:
InternalErrorException This exception is thrown on an unknown internal failure.
InvalidParameterException This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.
NotFoundException This exception is thrown if a requested entity is not found. E.g., if a budget id doesn't exist for an account ID.
InvalidNextTokenException This exception is thrown if paging token signature didn't match the token, or the paging token isn't for this request
ExpiredNextTokenException This exception is thrown if the paging token is expired - past its TTL
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/budgets" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := budgets.New(sess) params := &budgets.DescribeBudgetsInput{ AccountId: aws.String("AccountId"), // Required MaxResults: aws.Int64(1), NextToken: aws.String("GenericString"), } resp, err := svc.DescribeBudgets(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
See DescribeBudgets for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeBudgets method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) DescribeNotificationsForBudget ¶
func (c *Budgets) DescribeNotificationsForBudget(input *DescribeNotificationsForBudgetInput) (*DescribeNotificationsForBudgetOutput, error)
DescribeNotificationsForBudget API operation for AWS Budgets.
Get notifications of 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:
InternalErrorException This exception is thrown on an unknown internal failure.
InvalidParameterException This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.
NotFoundException This exception is thrown if a requested entity is not found. E.g., if a budget id doesn't exist for an account ID.
InvalidNextTokenException This exception is thrown if paging token signature didn't match the token, or the paging token isn't for this request
ExpiredNextTokenException This exception is thrown if the paging token is expired - past its TTL
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/budgets" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := budgets.New(sess) params := &budgets.DescribeNotificationsForBudgetInput{ AccountId: aws.String("AccountId"), // Required BudgetName: aws.String("BudgetName"), // Required MaxResults: aws.Int64(1), NextToken: aws.String("GenericString"), } resp, err := svc.DescribeNotificationsForBudget(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
See DescribeNotificationsForBudget for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeNotificationsForBudget method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) DescribeSubscribersForNotification ¶
func (c *Budgets) DescribeSubscribersForNotification(input *DescribeSubscribersForNotificationInput) (*DescribeSubscribersForNotificationOutput, error)
DescribeSubscribersForNotification API operation for AWS Budgets.
Get subscribers of 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:
InternalErrorException This exception is thrown on an unknown internal failure.
NotFoundException This exception is thrown if a requested entity is not found. E.g., if a budget id doesn't exist for an account ID.
InvalidParameterException This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.
InvalidNextTokenException This exception is thrown if paging token signature didn't match the token, or the paging token isn't for this request
ExpiredNextTokenException This exception is thrown if the paging token is expired - past its TTL
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/budgets" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := budgets.New(sess) params := &budgets.DescribeSubscribersForNotificationInput{ AccountId: aws.String("AccountId"), // Required BudgetName: aws.String("BudgetName"), // Required Notification: &budgets.Notification{ // Required ComparisonOperator: aws.String("ComparisonOperator"), // Required NotificationType: aws.String("NotificationType"), // Required Threshold: aws.Float64(1.0), // Required }, MaxResults: aws.Int64(1), NextToken: aws.String("GenericString"), } resp, err := svc.DescribeSubscribersForNotification(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
See DescribeSubscribersForNotification for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeSubscribersForNotification method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) UpdateBudget ¶
func (c *Budgets) UpdateBudget(input *UpdateBudgetInput) (*UpdateBudgetOutput, error)
UpdateBudget API operation for AWS Budgets.
Update the information of a budget already created ¶
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:
InternalErrorException This exception is thrown on an unknown internal failure.
InvalidParameterException This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.
NotFoundException This exception is thrown if a requested entity is not found. E.g., if a budget id doesn't exist for an account ID.
Example ¶
package main import ( "fmt" "time" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/budgets" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := budgets.New(sess) params := &budgets.UpdateBudgetInput{ AccountId: aws.String("AccountId"), // Required NewBudget: &budgets.Budget{ // Required BudgetLimit: &budgets.Spend{ // Required Amount: aws.String("NumericValue"), // Required Unit: aws.String("GenericString"), // Required }, BudgetName: aws.String("BudgetName"), // Required BudgetType: aws.String("BudgetType"), // Required CostTypes: &budgets.CostTypes{ // Required IncludeSubscription: aws.Bool(true), // Required IncludeTax: aws.Bool(true), // Required UseBlended: aws.Bool(true), // Required }, TimePeriod: &budgets.TimePeriod{ // Required End: aws.Time(time.Now()), // Required Start: aws.Time(time.Now()), // Required }, TimeUnit: aws.String("TimeUnit"), // Required CalculatedSpend: &budgets.CalculatedSpend{ ActualSpend: &budgets.Spend{ // Required Amount: aws.String("NumericValue"), // Required Unit: aws.String("GenericString"), // Required }, ForecastedSpend: &budgets.Spend{ Amount: aws.String("NumericValue"), // Required Unit: aws.String("GenericString"), // Required }, }, CostFilters: map[string][]*string{ "Key": { // Required aws.String("GenericString"), // Required // More values... }, // More values... }, }, } resp, err := svc.UpdateBudget(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
See UpdateBudget for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateBudget method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) UpdateNotification ¶
func (c *Budgets) UpdateNotification(input *UpdateNotificationInput) (*UpdateNotificationOutput, error)
UpdateNotification API operation for AWS Budgets.
Update the information about a notification already created ¶
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:
InternalErrorException This exception is thrown on an unknown internal failure.
InvalidParameterException This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.
NotFoundException This exception is thrown if a requested entity is not found. E.g., if a budget id doesn't exist for an account ID.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/budgets" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := budgets.New(sess) params := &budgets.UpdateNotificationInput{ AccountId: aws.String("AccountId"), // Required BudgetName: aws.String("BudgetName"), // Required NewNotification: &budgets.Notification{ // Required ComparisonOperator: aws.String("ComparisonOperator"), // Required NotificationType: aws.String("NotificationType"), // Required Threshold: aws.Float64(1.0), // Required }, OldNotification: &budgets.Notification{ // Required ComparisonOperator: aws.String("ComparisonOperator"), // Required NotificationType: aws.String("NotificationType"), // Required Threshold: aws.Float64(1.0), // Required }, } resp, err := svc.UpdateNotification(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
See UpdateNotification for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateNotification method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) UpdateSubscriber ¶
func (c *Budgets) UpdateSubscriber(input *UpdateSubscriberInput) (*UpdateSubscriberOutput, error)
UpdateSubscriber API operation for AWS Budgets.
Update 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:
InternalErrorException This exception is thrown on an unknown internal failure.
InvalidParameterException This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.
NotFoundException This exception is thrown if a requested entity is not found. E.g., if a budget id doesn't exist for an account ID.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/budgets" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := budgets.New(sess) params := &budgets.UpdateSubscriberInput{ AccountId: aws.String("AccountId"), // Required BudgetName: aws.String("BudgetName"), // Required NewSubscriber: &budgets.Subscriber{ // Required Address: aws.String("GenericString"), // Required SubscriptionType: aws.String("SubscriptionType"), // Required }, Notification: &budgets.Notification{ // Required ComparisonOperator: aws.String("ComparisonOperator"), // Required NotificationType: aws.String("NotificationType"), // Required Threshold: aws.Float64(1.0), // Required }, OldSubscriber: &budgets.Subscriber{ // Required Address: aws.String("GenericString"), // Required SubscriptionType: aws.String("SubscriptionType"), // Required }, } resp, err := svc.UpdateSubscriber(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
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 can be used to capture response data after the request's "Send" method is called.
See UpdateSubscriber for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateSubscriber method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
type CalculatedSpend ¶
type CalculatedSpend struct { // A structure represent either a cost spend or usage spend. Contains an amount // and a unit. // // ActualSpend is a required field ActualSpend *Spend `type:"structure" required:"true"` // A structure represent either a cost spend or usage spend. Contains an amount // and a unit. ForecastedSpend *Spend `type:"structure"` // contains filtered or unexported fields }
A structure holds the actual and forecasted spend for a budget.
func (CalculatedSpend) GoString ¶
func (s CalculatedSpend) GoString() string
GoString returns the string representation
func (*CalculatedSpend) SetActualSpend ¶ added in v1.5.1
func (s *CalculatedSpend) SetActualSpend(v *Spend) *CalculatedSpend
SetActualSpend sets the ActualSpend field's value.
func (*CalculatedSpend) SetForecastedSpend ¶ added in v1.5.1
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 { // A generic boolean value. // // IncludeSubscription is a required field IncludeSubscription *bool `type:"boolean" required:"true"` // A generic boolean value. // // IncludeTax is a required field IncludeTax *bool `type:"boolean" required:"true"` // A generic boolean value. // // UseBlended is a required field UseBlended *bool `type:"boolean" required:"true"` // contains filtered or unexported fields }
This includes the options for getting the cost of a budget.
func (*CostTypes) SetIncludeSubscription ¶ added in v1.5.1
SetIncludeSubscription sets the IncludeSubscription field's value.
func (*CostTypes) SetIncludeTax ¶ added in v1.5.1
SetIncludeTax sets the IncludeTax field's value.
func (*CostTypes) SetUseBlended ¶ added in v1.5.1
SetUseBlended sets the UseBlended field's value.
type CreateBudgetInput ¶
type CreateBudgetInput struct { // Account Id of the customer. It should be a 12 digit number. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` // AWS Budget model // // Budget is a required field Budget *Budget `type:"structure" required:"true"` // A list of Notifications, each with a list of subscribers. 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 ¶ added in v1.5.1
func (s *CreateBudgetInput) SetAccountId(v string) *CreateBudgetInput
SetAccountId sets the AccountId field's value.
func (*CreateBudgetInput) SetBudget ¶ added in v1.5.1
func (s *CreateBudgetInput) SetBudget(v *Budget) *CreateBudgetInput
SetBudget sets the Budget field's value.
func (*CreateBudgetInput) SetNotificationsWithSubscribers ¶ added in v1.5.1
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 { // Account Id of the customer. It should be a 12 digit number. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` // A string represents the budget name. No ":" character is allowed. // // BudgetName is a required field BudgetName *string `type:"string" required:"true"` // Notification model. Each budget may contain multiple notifications with different // settings. // // Notification is a required field Notification *Notification `type:"structure" required:"true"` // A list of 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 ¶ added in v1.5.1
func (s *CreateNotificationInput) SetAccountId(v string) *CreateNotificationInput
SetAccountId sets the AccountId field's value.
func (*CreateNotificationInput) SetBudgetName ¶ added in v1.5.1
func (s *CreateNotificationInput) SetBudgetName(v string) *CreateNotificationInput
SetBudgetName sets the BudgetName field's value.
func (*CreateNotificationInput) SetNotification ¶ added in v1.5.1
func (s *CreateNotificationInput) SetNotification(v *Notification) *CreateNotificationInput
SetNotification sets the Notification field's value.
func (*CreateNotificationInput) SetSubscribers ¶ added in v1.5.1
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 { // Account Id of the customer. It should be a 12 digit number. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` // A string represents the budget name. No ":" character is allowed. // // BudgetName is a required field BudgetName *string `type:"string" required:"true"` // Notification model. Each budget may contain multiple notifications with different // settings. // // Notification is a required field Notification *Notification `type:"structure" required:"true"` // Subscriber model. Each notification may contain multiple subscribers with // different addresses. // // 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 ¶ added in v1.5.1
func (s *CreateSubscriberInput) SetAccountId(v string) *CreateSubscriberInput
SetAccountId sets the AccountId field's value.
func (*CreateSubscriberInput) SetBudgetName ¶ added in v1.5.1
func (s *CreateSubscriberInput) SetBudgetName(v string) *CreateSubscriberInput
SetBudgetName sets the BudgetName field's value.
func (*CreateSubscriberInput) SetNotification ¶ added in v1.5.1
func (s *CreateSubscriberInput) SetNotification(v *Notification) *CreateSubscriberInput
SetNotification sets the Notification field's value.
func (*CreateSubscriberInput) SetSubscriber ¶ added in v1.5.1
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 { // Account Id of the customer. It should be a 12 digit number. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` // A string represents the budget name. No ":" character is allowed. // // 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 ¶ added in v1.5.1
func (s *DeleteBudgetInput) SetAccountId(v string) *DeleteBudgetInput
SetAccountId sets the AccountId field's value.
func (*DeleteBudgetInput) SetBudgetName ¶ added in v1.5.1
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 { // Account Id of the customer. It should be a 12 digit number. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` // A string represents the budget name. No ":" character is allowed. // // BudgetName is a required field BudgetName *string `type:"string" required:"true"` // Notification model. Each budget may contain multiple notifications with different // settings. // // 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 ¶ added in v1.5.1
func (s *DeleteNotificationInput) SetAccountId(v string) *DeleteNotificationInput
SetAccountId sets the AccountId field's value.
func (*DeleteNotificationInput) SetBudgetName ¶ added in v1.5.1
func (s *DeleteNotificationInput) SetBudgetName(v string) *DeleteNotificationInput
SetBudgetName sets the BudgetName field's value.
func (*DeleteNotificationInput) SetNotification ¶ added in v1.5.1
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 { // Account Id of the customer. It should be a 12 digit number. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` // A string represents the budget name. No ":" character is allowed. // // BudgetName is a required field BudgetName *string `type:"string" required:"true"` // Notification model. Each budget may contain multiple notifications with different // settings. // // Notification is a required field Notification *Notification `type:"structure" required:"true"` // Subscriber model. Each notification may contain multiple subscribers with // different addresses. // // 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 ¶ added in v1.5.1
func (s *DeleteSubscriberInput) SetAccountId(v string) *DeleteSubscriberInput
SetAccountId sets the AccountId field's value.
func (*DeleteSubscriberInput) SetBudgetName ¶ added in v1.5.1
func (s *DeleteSubscriberInput) SetBudgetName(v string) *DeleteSubscriberInput
SetBudgetName sets the BudgetName field's value.
func (*DeleteSubscriberInput) SetNotification ¶ added in v1.5.1
func (s *DeleteSubscriberInput) SetNotification(v *Notification) *DeleteSubscriberInput
SetNotification sets the Notification field's value.
func (*DeleteSubscriberInput) SetSubscriber ¶ added in v1.5.1
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 { // Account Id of the customer. It should be a 12 digit number. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` // A string represents the budget name. No ":" character is allowed. // // 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 ¶ added in v1.5.1
func (s *DescribeBudgetInput) SetAccountId(v string) *DescribeBudgetInput
SetAccountId sets the AccountId field's value.
func (*DescribeBudgetInput) SetBudgetName ¶ added in v1.5.1
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 { // AWS Budget model 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 ¶ added in v1.5.1
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 { // Account Id of the customer. It should be a 12 digit number. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` // An integer to represent how many entries should a pagianted response contains. // Maxium is set to 100. MaxResults *int64 `min:"1" type:"integer"` // A generic String. 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 ¶ added in v1.5.1
func (s *DescribeBudgetsInput) SetAccountId(v string) *DescribeBudgetsInput
SetAccountId sets the AccountId field's value.
func (*DescribeBudgetsInput) SetMaxResults ¶ added in v1.5.1
func (s *DescribeBudgetsInput) SetMaxResults(v int64) *DescribeBudgetsInput
SetMaxResults sets the MaxResults field's value.
func (*DescribeBudgetsInput) SetNextToken ¶ added in v1.5.1
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"` // A generic String. 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 ¶ added in v1.5.1
func (s *DescribeBudgetsOutput) SetBudgets(v []*Budget) *DescribeBudgetsOutput
SetBudgets sets the Budgets field's value.
func (*DescribeBudgetsOutput) SetNextToken ¶ added in v1.5.1
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 { // Account Id of the customer. It should be a 12 digit number. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` // A string represents the budget name. No ":" character is allowed. // // BudgetName is a required field BudgetName *string `type:"string" required:"true"` // An integer to represent how many entries should a pagianted response contains. // Maxium is set to 100. MaxResults *int64 `min:"1" type:"integer"` // A generic String. 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 ¶ added in v1.5.1
func (s *DescribeNotificationsForBudgetInput) SetAccountId(v string) *DescribeNotificationsForBudgetInput
SetAccountId sets the AccountId field's value.
func (*DescribeNotificationsForBudgetInput) SetBudgetName ¶ added in v1.5.1
func (s *DescribeNotificationsForBudgetInput) SetBudgetName(v string) *DescribeNotificationsForBudgetInput
SetBudgetName sets the BudgetName field's value.
func (*DescribeNotificationsForBudgetInput) SetMaxResults ¶ added in v1.5.1
func (s *DescribeNotificationsForBudgetInput) SetMaxResults(v int64) *DescribeNotificationsForBudgetInput
SetMaxResults sets the MaxResults field's value.
func (*DescribeNotificationsForBudgetInput) SetNextToken ¶ added in v1.5.1
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 { // A generic String. NextToken *string `type:"string"` // A list of notifications. 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 ¶ added in v1.5.1
func (s *DescribeNotificationsForBudgetOutput) SetNextToken(v string) *DescribeNotificationsForBudgetOutput
SetNextToken sets the NextToken field's value.
func (*DescribeNotificationsForBudgetOutput) SetNotifications ¶ added in v1.5.1
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 { // Account Id of the customer. It should be a 12 digit number. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` // A string represents the budget name. No ":" character is allowed. // // BudgetName is a required field BudgetName *string `type:"string" required:"true"` // An integer to represent how many entries should a pagianted response contains. // Maxium is set to 100. MaxResults *int64 `min:"1" type:"integer"` // A generic String. NextToken *string `type:"string"` // Notification model. Each budget may contain multiple notifications with different // settings. // // 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 ¶ added in v1.5.1
func (s *DescribeSubscribersForNotificationInput) SetAccountId(v string) *DescribeSubscribersForNotificationInput
SetAccountId sets the AccountId field's value.
func (*DescribeSubscribersForNotificationInput) SetBudgetName ¶ added in v1.5.1
func (s *DescribeSubscribersForNotificationInput) SetBudgetName(v string) *DescribeSubscribersForNotificationInput
SetBudgetName sets the BudgetName field's value.
func (*DescribeSubscribersForNotificationInput) SetMaxResults ¶ added in v1.5.1
func (s *DescribeSubscribersForNotificationInput) SetMaxResults(v int64) *DescribeSubscribersForNotificationInput
SetMaxResults sets the MaxResults field's value.
func (*DescribeSubscribersForNotificationInput) SetNextToken ¶ added in v1.5.1
func (s *DescribeSubscribersForNotificationInput) SetNextToken(v string) *DescribeSubscribersForNotificationInput
SetNextToken sets the NextToken field's value.
func (*DescribeSubscribersForNotificationInput) SetNotification ¶ added in v1.5.1
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 { // A generic String. NextToken *string `type:"string"` // A list of subscribers. 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 ¶ added in v1.5.1
func (s *DescribeSubscribersForNotificationOutput) SetNextToken(v string) *DescribeSubscribersForNotificationOutput
SetNextToken sets the NextToken field's value.
func (*DescribeSubscribersForNotificationOutput) SetSubscribers ¶ added in v1.5.1
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 operator of a notification. Currently we support less than, // equal to and greater than. // // ComparisonOperator is a required field ComparisonOperator *string `type:"string" required:"true" enum:"ComparisonOperator"` // The type of a notification. It should be ACTUAL or FORECASTED. // // NotificationType is a required field NotificationType *string `type:"string" required:"true" enum:"NotificationType"` // The threshold of the a notification. It should be a number between 0 and // 100. // // Threshold is a required field Threshold *float64 `min:"0.1" type:"double" required:"true"` // contains filtered or unexported fields }
Notification model. Each budget may contain multiple notifications with different settings.
func (Notification) GoString ¶
func (s Notification) GoString() string
GoString returns the string representation
func (*Notification) SetComparisonOperator ¶ added in v1.5.1
func (s *Notification) SetComparisonOperator(v string) *Notification
SetComparisonOperator sets the ComparisonOperator field's value.
func (*Notification) SetNotificationType ¶ added in v1.5.1
func (s *Notification) SetNotificationType(v string) *Notification
SetNotificationType sets the NotificationType field's value.
func (*Notification) SetThreshold ¶ added in v1.5.1
func (s *Notification) SetThreshold(v float64) *Notification
SetThreshold sets the Threshold 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 { // Notification model. Each budget may contain multiple notifications with different // settings. // // Notification is a required field Notification *Notification `type:"structure" required:"true"` // A list of subscribers. // // Subscribers is a required field Subscribers []*Subscriber `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
A structure to relate notification and a list of subscribers who belong to the notification.
func (NotificationWithSubscribers) GoString ¶
func (s NotificationWithSubscribers) GoString() string
GoString returns the string representation
func (*NotificationWithSubscribers) SetNotification ¶ added in v1.5.1
func (s *NotificationWithSubscribers) SetNotification(v *Notification) *NotificationWithSubscribers
SetNotification sets the Notification field's value.
func (*NotificationWithSubscribers) SetSubscribers ¶ added in v1.5.1
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 { // A string to represent NumericValue. // // Amount is a required field Amount *string `type:"string" required:"true"` // A generic String. // // Unit is a required field Unit *string `type:"string" required:"true"` // contains filtered or unexported fields }
A structure represent either a cost spend or usage spend. Contains an amount and a unit.
type Subscriber ¶
type Subscriber struct { // A generic String. // // Address is a required field Address *string `type:"string" required:"true"` // The subscription type of the subscriber. It can be SMS or EMAIL. // // SubscriptionType is a required field SubscriptionType *string `type:"string" required:"true" enum:"SubscriptionType"` // contains filtered or unexported fields }
Subscriber model. Each notification may contain multiple subscribers with different addresses.
func (Subscriber) GoString ¶
func (s Subscriber) GoString() string
GoString returns the string representation
func (*Subscriber) SetAddress ¶ added in v1.5.1
func (s *Subscriber) SetAddress(v string) *Subscriber
SetAddress sets the Address field's value.
func (*Subscriber) SetSubscriptionType ¶ added in v1.5.1
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 { // A generic timestamp. In Java it is transformed to a Date object. // // End is a required field End *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"` // A generic timestamp. In Java it is transformed to a Date object. // // Start is a required field Start *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"` // contains filtered or unexported fields }
A time period indicated the start date and end date of a budget.
func (TimePeriod) GoString ¶
func (s TimePeriod) GoString() string
GoString returns the string representation
func (*TimePeriod) SetEnd ¶ added in v1.5.1
func (s *TimePeriod) SetEnd(v time.Time) *TimePeriod
SetEnd sets the End field's value.
func (*TimePeriod) SetStart ¶ added in v1.5.1
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
func (*TimePeriod) Validate ¶
func (s *TimePeriod) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateBudgetInput ¶
type UpdateBudgetInput struct { // Account Id of the customer. It should be a 12 digit number. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` // AWS Budget model // // 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 ¶ added in v1.5.1
func (s *UpdateBudgetInput) SetAccountId(v string) *UpdateBudgetInput
SetAccountId sets the AccountId field's value.
func (*UpdateBudgetInput) SetNewBudget ¶ added in v1.5.1
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 { // Account Id of the customer. It should be a 12 digit number. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` // A string represents the budget name. No ":" character is allowed. // // BudgetName is a required field BudgetName *string `type:"string" required:"true"` // Notification model. Each budget may contain multiple notifications with different // settings. // // NewNotification is a required field NewNotification *Notification `type:"structure" required:"true"` // Notification model. Each budget may contain multiple notifications with different // settings. // // 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 ¶ added in v1.5.1
func (s *UpdateNotificationInput) SetAccountId(v string) *UpdateNotificationInput
SetAccountId sets the AccountId field's value.
func (*UpdateNotificationInput) SetBudgetName ¶ added in v1.5.1
func (s *UpdateNotificationInput) SetBudgetName(v string) *UpdateNotificationInput
SetBudgetName sets the BudgetName field's value.
func (*UpdateNotificationInput) SetNewNotification ¶ added in v1.5.1
func (s *UpdateNotificationInput) SetNewNotification(v *Notification) *UpdateNotificationInput
SetNewNotification sets the NewNotification field's value.
func (*UpdateNotificationInput) SetOldNotification ¶ added in v1.5.1
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 { // Account Id of the customer. It should be a 12 digit number. // // AccountId is a required field AccountId *string `min:"12" type:"string" required:"true"` // A string represents the budget name. No ":" character is allowed. // // BudgetName is a required field BudgetName *string `type:"string" required:"true"` // Subscriber model. Each notification may contain multiple subscribers with // different addresses. // // NewSubscriber is a required field NewSubscriber *Subscriber `type:"structure" required:"true"` // Notification model. Each budget may contain multiple notifications with different // settings. // // Notification is a required field Notification *Notification `type:"structure" required:"true"` // Subscriber model. Each notification may contain multiple subscribers with // different addresses. // // 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 ¶ added in v1.5.1
func (s *UpdateSubscriberInput) SetAccountId(v string) *UpdateSubscriberInput
SetAccountId sets the AccountId field's value.
func (*UpdateSubscriberInput) SetBudgetName ¶ added in v1.5.1
func (s *UpdateSubscriberInput) SetBudgetName(v string) *UpdateSubscriberInput
SetBudgetName sets the BudgetName field's value.
func (*UpdateSubscriberInput) SetNewSubscriber ¶ added in v1.5.1
func (s *UpdateSubscriberInput) SetNewSubscriber(v *Subscriber) *UpdateSubscriberInput
SetNewSubscriber sets the NewSubscriber field's value.
func (*UpdateSubscriberInput) SetNotification ¶ added in v1.5.1
func (s *UpdateSubscriberInput) SetNotification(v *Notification) *UpdateSubscriberInput
SetNotification sets the Notification field's value.
func (*UpdateSubscriberInput) SetOldSubscriber ¶ added in v1.5.1
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. |