budgets - ActiveState ActiveGo 1.8
...

Package budgets

import "github.com/aws/aws-sdk-go/service/budgets"
Overview
Index
Subdirectories

Overview ▾

Package budgets provides the client and types for making API requests to AWS Budgets.

All public APIs for AWS Budgets

See budgets package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/budgets/

Using the Client

To use the client for AWS Budgets you will first need to create a new instance of it.

When creating a client for an AWS service you'll first need to have a Session already created. The Session provides configuration that can be shared between multiple service clients. Additional configuration can be applied to the Session and service's client when they are constructed. The aws package's Config type contains several fields such as Region for the AWS Region the client should make API requests too. The optional Config value can be provided as the variadic argument for Sessions and client creation.

Once the service's client is created you can use it to make API requests the AWS service. These clients are safe to use concurrently.

// Create a session to share configuration, and load external configuration.
sess := session.Must(session.NewSession())

// Create the service's client with the session.
svc := budgets.New(sess)

See the SDK's documentation for more information on how to use service clients. https://docs.aws.amazon.com/sdk-for-go/api/

See aws package's Config type for more information on configuration options. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Budgets client Budgets for more information on creating the service's client. https://docs.aws.amazon.com/sdk-for-go/api/service/budgets/#New

Once the client is created you can make an API request to the service. Each API method takes a input parameter, and returns the service response and an error.

The API method will document which error codes the service can be returned by the operation if the service models the API operation's errors. These errors will also be available as const strings prefixed with "ErrCode".

result, err := svc.CreateBudget(params)
if err != nil {
    // Cast err to awserr.Error to handle specific error codes.
    aerr, ok := err.(awserr.Error)
    if ok && aerr.Code() == <error code to check for> {
        // Specific error code handling
    }
    return err
}

fmt.Println("CreateBudget result:")
fmt.Println(result)

Using the Client with Context

The service's client also provides methods to make API requests with a Context value. This allows you to control the timeout, and cancellation of pending requests. These methods also take request Option as variadic parameter to apply additional configuration to the API request.

ctx := context.Background()

result, err := svc.CreateBudgetWithContext(ctx, params)

See the request package documentation for more information on using Context pattern with the SDK. https://docs.aws.amazon.com/sdk-for-go/api/aws/request/

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 New(p client.ConfigProvider, cfgs ...*aws.Config) *Budgets
    func (c *Budgets) CreateBudget(input *CreateBudgetInput) (*CreateBudgetOutput, error)
    func (c *Budgets) CreateBudgetRequest(input *CreateBudgetInput) (req *request.Request, output *CreateBudgetOutput)
    func (c *Budgets) CreateBudgetWithContext(ctx aws.Context, input *CreateBudgetInput, opts ...request.Option) (*CreateBudgetOutput, error)
    func (c *Budgets) CreateNotification(input *CreateNotificationInput) (*CreateNotificationOutput, error)
    func (c *Budgets) CreateNotificationRequest(input *CreateNotificationInput) (req *request.Request, output *CreateNotificationOutput)
    func (c *Budgets) CreateNotificationWithContext(ctx aws.Context, input *CreateNotificationInput, opts ...request.Option) (*CreateNotificationOutput, error)
    func (c *Budgets) CreateSubscriber(input *CreateSubscriberInput) (*CreateSubscriberOutput, error)
    func (c *Budgets) CreateSubscriberRequest(input *CreateSubscriberInput) (req *request.Request, output *CreateSubscriberOutput)
    func (c *Budgets) CreateSubscriberWithContext(ctx aws.Context, input *CreateSubscriberInput, opts ...request.Option) (*CreateSubscriberOutput, error)
    func (c *Budgets) DeleteBudget(input *DeleteBudgetInput) (*DeleteBudgetOutput, error)
    func (c *Budgets) DeleteBudgetRequest(input *DeleteBudgetInput) (req *request.Request, output *DeleteBudgetOutput)
    func (c *Budgets) DeleteBudgetWithContext(ctx aws.Context, input *DeleteBudgetInput, opts ...request.Option) (*DeleteBudgetOutput, error)
    func (c *Budgets) DeleteNotification(input *DeleteNotificationInput) (*DeleteNotificationOutput, error)
    func (c *Budgets) DeleteNotificationRequest(input *DeleteNotificationInput) (req *request.Request, output *DeleteNotificationOutput)
    func (c *Budgets) DeleteNotificationWithContext(ctx aws.Context, input *DeleteNotificationInput, opts ...request.Option) (*DeleteNotificationOutput, error)
    func (c *Budgets) DeleteSubscriber(input *DeleteSubscriberInput) (*DeleteSubscriberOutput, error)
    func (c *Budgets) DeleteSubscriberRequest(input *DeleteSubscriberInput) (req *request.Request, output *DeleteSubscriberOutput)
    func (c *Budgets) DeleteSubscriberWithContext(ctx aws.Context, input *DeleteSubscriberInput, opts ...request.Option) (*DeleteSubscriberOutput, error)
    func (c *Budgets) DescribeBudget(input *DescribeBudgetInput) (*DescribeBudgetOutput, error)
    func (c *Budgets) DescribeBudgetRequest(input *DescribeBudgetInput) (req *request.Request, output *DescribeBudgetOutput)
    func (c *Budgets) DescribeBudgetWithContext(ctx aws.Context, input *DescribeBudgetInput, opts ...request.Option) (*DescribeBudgetOutput, error)
    func (c *Budgets) DescribeBudgets(input *DescribeBudgetsInput) (*DescribeBudgetsOutput, error)
    func (c *Budgets) DescribeBudgetsRequest(input *DescribeBudgetsInput) (req *request.Request, output *DescribeBudgetsOutput)
    func (c *Budgets) DescribeBudgetsWithContext(ctx aws.Context, input *DescribeBudgetsInput, opts ...request.Option) (*DescribeBudgetsOutput, error)
    func (c *Budgets) DescribeNotificationsForBudget(input *DescribeNotificationsForBudgetInput) (*DescribeNotificationsForBudgetOutput, error)
    func (c *Budgets) DescribeNotificationsForBudgetRequest(input *DescribeNotificationsForBudgetInput) (req *request.Request, output *DescribeNotificationsForBudgetOutput)
    func (c *Budgets) DescribeNotificationsForBudgetWithContext(ctx aws.Context, input *DescribeNotificationsForBudgetInput, opts ...request.Option) (*DescribeNotificationsForBudgetOutput, error)
    func (c *Budgets) DescribeSubscribersForNotification(input *DescribeSubscribersForNotificationInput) (*DescribeSubscribersForNotificationOutput, error)
    func (c *Budgets) DescribeSubscribersForNotificationRequest(input *DescribeSubscribersForNotificationInput) (req *request.Request, output *DescribeSubscribersForNotificationOutput)
    func (c *Budgets) DescribeSubscribersForNotificationWithContext(ctx aws.Context, input *DescribeSubscribersForNotificationInput, opts ...request.Option) (*DescribeSubscribersForNotificationOutput, error)
    func (c *Budgets) UpdateBudget(input *UpdateBudgetInput) (*UpdateBudgetOutput, error)
    func (c *Budgets) UpdateBudgetRequest(input *UpdateBudgetInput) (req *request.Request, output *UpdateBudgetOutput)
    func (c *Budgets) UpdateBudgetWithContext(ctx aws.Context, input *UpdateBudgetInput, opts ...request.Option) (*UpdateBudgetOutput, error)
    func (c *Budgets) UpdateNotification(input *UpdateNotificationInput) (*UpdateNotificationOutput, error)
    func (c *Budgets) UpdateNotificationRequest(input *UpdateNotificationInput) (req *request.Request, output *UpdateNotificationOutput)
    func (c *Budgets) UpdateNotificationWithContext(ctx aws.Context, input *UpdateNotificationInput, opts ...request.Option) (*UpdateNotificationOutput, error)
    func (c *Budgets) UpdateSubscriber(input *UpdateSubscriberInput) (*UpdateSubscriberOutput, error)
    func (c *Budgets) UpdateSubscriberRequest(input *UpdateSubscriberInput) (req *request.Request, output *UpdateSubscriberOutput)
    func (c *Budgets) UpdateSubscriberWithContext(ctx aws.Context, input *UpdateSubscriberInput, opts ...request.Option) (*UpdateSubscriberOutput, error)
type CalculatedSpend
    func (s CalculatedSpend) GoString() string
    func (s *CalculatedSpend) SetActualSpend(v *Spend) *CalculatedSpend
    func (s *CalculatedSpend) SetForecastedSpend(v *Spend) *CalculatedSpend
    func (s CalculatedSpend) String() string
    func (s *CalculatedSpend) Validate() error
type CostTypes
    func (s CostTypes) GoString() string
    func (s *CostTypes) SetIncludeSubscription(v bool) *CostTypes
    func (s *CostTypes) SetIncludeTax(v bool) *CostTypes
    func (s *CostTypes) SetUseBlended(v bool) *CostTypes
    func (s CostTypes) String() string
    func (s *CostTypes) Validate() error
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
    func (s CreateBudgetOutput) GoString() string
    func (s CreateBudgetOutput) String() string
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
    func (s CreateNotificationOutput) GoString() string
    func (s CreateNotificationOutput) String() string
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
    func (s CreateSubscriberOutput) GoString() string
    func (s CreateSubscriberOutput) String() string
type DeleteBudgetInput
    func (s DeleteBudgetInput) GoString() string
    func (s *DeleteBudgetInput) SetAccountId(v string) *DeleteBudgetInput
    func (s *DeleteBudgetInput) SetBudgetName(v string) *DeleteBudgetInput
    func (s DeleteBudgetInput) String() string
    func (s *DeleteBudgetInput) Validate() error
type DeleteBudgetOutput
    func (s DeleteBudgetOutput) GoString() string
    func (s DeleteBudgetOutput) String() string
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
    func (s DeleteNotificationOutput) GoString() string
    func (s DeleteNotificationOutput) String() string
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
    func (s DeleteSubscriberOutput) GoString() string
    func (s DeleteSubscriberOutput) String() string
type DescribeBudgetInput
    func (s DescribeBudgetInput) GoString() string
    func (s *DescribeBudgetInput) SetAccountId(v string) *DescribeBudgetInput
    func (s *DescribeBudgetInput) SetBudgetName(v string) *DescribeBudgetInput
    func (s DescribeBudgetInput) String() string
    func (s *DescribeBudgetInput) Validate() error
type DescribeBudgetOutput
    func (s DescribeBudgetOutput) GoString() string
    func (s *DescribeBudgetOutput) SetBudget(v *Budget) *DescribeBudgetOutput
    func (s DescribeBudgetOutput) String() string
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
    func (s DescribeBudgetsOutput) GoString() string
    func (s *DescribeBudgetsOutput) SetBudgets(v []*Budget) *DescribeBudgetsOutput
    func (s *DescribeBudgetsOutput) SetNextToken(v string) *DescribeBudgetsOutput
    func (s DescribeBudgetsOutput) String() string
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
    func (s Spend) GoString() string
    func (s *Spend) SetAmount(v string) *Spend
    func (s *Spend) SetUnit(v string) *Spend
    func (s Spend) String() string
    func (s *Spend) Validate() error
type Subscriber
    func (s Subscriber) GoString() string
    func (s *Subscriber) SetAddress(v string) *Subscriber
    func (s *Subscriber) SetSubscriptionType(v string) *Subscriber
    func (s Subscriber) String() string
    func (s *Subscriber) Validate() error
type TimePeriod
    func (s TimePeriod) GoString() string
    func (s *TimePeriod) SetEnd(v time.Time) *TimePeriod
    func (s *TimePeriod) SetStart(v time.Time) *TimePeriod
    func (s TimePeriod) String() string
    func (s *TimePeriod) Validate() error
type UpdateBudgetInput
    func (s UpdateBudgetInput) GoString() string
    func (s *UpdateBudgetInput) SetAccountId(v string) *UpdateBudgetInput
    func (s *UpdateBudgetInput) SetNewBudget(v *Budget) *UpdateBudgetInput
    func (s UpdateBudgetInput) String() string
    func (s *UpdateBudgetInput) Validate() error
type UpdateBudgetOutput
    func (s UpdateBudgetOutput) GoString() string
    func (s UpdateBudgetOutput) String() string
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
    func (s UpdateNotificationOutput) GoString() string
    func (s UpdateNotificationOutput) String() string
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
    func (s UpdateSubscriberOutput) GoString() string
    func (s UpdateSubscriberOutput) String() string

Package files

api.go doc.go errors.go service.go

Constants

The type of a budget. Can be COST or USAGE.

const (
    // BudgetTypeUsage is a BudgetType enum value
    BudgetTypeUsage = "USAGE"

    // BudgetTypeCost is a BudgetType enum value
    BudgetTypeCost = "COST"
)

The comparison operator of a notification. Currently we support less than, equal to and greater than.

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 type of a notification. It should be ACTUAL or FORECASTED.

const (
    // NotificationTypeActual is a NotificationType enum value
    NotificationTypeActual = "ACTUAL"

    // NotificationTypeForecasted is a NotificationType enum value
    NotificationTypeForecasted = "FORECASTED"
)

The subscription type of the subscriber. It can be SMS or EMAIL.

const (
    // SubscriptionTypeSns is a SubscriptionType enum value
    SubscriptionTypeSns = "SNS"

    // SubscriptionTypeEmail is a SubscriptionType enum value
    SubscriptionTypeEmail = "EMAIL"
)

The time unit of the budget. e.g. weekly, monthly, etc.

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"
)
const (

    // ErrCodeCreationLimitExceededException for service response error code
    // "CreationLimitExceededException".
    //
    // The exception is thrown when customer tries to create a record (e.g. budget),
    // but the number this record already exceeds the limitation.
    ErrCodeCreationLimitExceededException = "CreationLimitExceededException"

    // ErrCodeDuplicateRecordException for service response error code
    // "DuplicateRecordException".
    //
    // The exception is thrown when customer tries to create a record (e.g. budget)
    // that already exists.
    ErrCodeDuplicateRecordException = "DuplicateRecordException"

    // ErrCodeExpiredNextTokenException for service response error code
    // "ExpiredNextTokenException".
    //
    // This exception is thrown if the paging token is expired - past its TTL
    ErrCodeExpiredNextTokenException = "ExpiredNextTokenException"

    // ErrCodeInternalErrorException for service response error code
    // "InternalErrorException".
    //
    // This exception is thrown on an unknown internal failure.
    ErrCodeInternalErrorException = "InternalErrorException"

    // ErrCodeInvalidNextTokenException for service response error code
    // "InvalidNextTokenException".
    //
    // This exception is thrown if paging token signature didn't match the token,
    // or the paging token isn't for this request
    ErrCodeInvalidNextTokenException = "InvalidNextTokenException"

    // ErrCodeInvalidParameterException for service response error code
    // "InvalidParameterException".
    //
    // This exception is thrown if any request is given an invalid parameter. E.g.,
    // if a required Date field is null.
    ErrCodeInvalidParameterException = "InvalidParameterException"

    // ErrCodeNotFoundException for service response error code
    // "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.
    ErrCodeNotFoundException = "NotFoundException"
)

Service information constants

const (
    ServiceName = "budgets"   // Service endpoint prefix API calls made to.
    EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

type Budget

AWS Budget model

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
}

func (Budget) GoString

func (s Budget) GoString() string

GoString returns the string representation

func (*Budget) SetBudgetLimit

func (s *Budget) SetBudgetLimit(v *Spend) *Budget

SetBudgetLimit sets the BudgetLimit field's value.

func (*Budget) SetBudgetName

func (s *Budget) SetBudgetName(v string) *Budget

SetBudgetName sets the BudgetName field's value.

func (*Budget) SetBudgetType

func (s *Budget) SetBudgetType(v string) *Budget

SetBudgetType sets the BudgetType field's value.

func (*Budget) SetCalculatedSpend

func (s *Budget) SetCalculatedSpend(v *CalculatedSpend) *Budget

SetCalculatedSpend sets the CalculatedSpend field's value.

func (*Budget) SetCostFilters

func (s *Budget) SetCostFilters(v map[string][]*string) *Budget

SetCostFilters sets the CostFilters field's value.

func (*Budget) SetCostTypes

func (s *Budget) SetCostTypes(v *CostTypes) *Budget

SetCostTypes sets the CostTypes field's value.

func (*Budget) SetTimePeriod

func (s *Budget) SetTimePeriod(v *TimePeriod) *Budget

SetTimePeriod sets the TimePeriod field's value.

func (*Budget) SetTimeUnit

func (s *Budget) SetTimeUnit(v string) *Budget

SetTimeUnit sets the TimeUnit field's value.

func (Budget) String

func (s Budget) String() string

String returns the string representation

func (*Budget) Validate

func (s *Budget) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Budgets

Budgets provides the API operation methods for making requests to AWS Budgets. See this package's package overview docs for details on the service.

Budgets methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

type Budgets struct {
    *client.Client
}

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:

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown if any request is given an invalid parameter. E.g.,
if a required Date field is null.

* ErrCodeInternalErrorException "InternalErrorException"
This exception is thrown on an unknown internal failure.

* ErrCodeCreationLimitExceededException "CreationLimitExceededException"
The exception is thrown when customer tries to create a record (e.g. budget),
but the number this record already exceeds the limitation.

* ErrCodeDuplicateRecordException "DuplicateRecordException"
The exception is thrown when customer tries to create a record (e.g. budget)
that already exists.

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) CreateBudgetWithContext

func (c *Budgets) CreateBudgetWithContext(ctx aws.Context, input *CreateBudgetInput, opts ...request.Option) (*CreateBudgetOutput, error)

CreateBudgetWithContext is the same as CreateBudget with the addition of the ability to pass a context and additional request options.

See CreateBudget for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Budgets) CreateNotification

func (c *Budgets) CreateNotification(input *CreateNotificationInput) (*CreateNotificationOutput, error)

CreateNotification API operation for AWS Budgets.

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:

* ErrCodeInternalErrorException "InternalErrorException"
This exception is thrown on an unknown internal failure.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown if any request is given an invalid parameter. E.g.,
if a required Date field is null.

* ErrCodeNotFoundException "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.

* ErrCodeCreationLimitExceededException "CreationLimitExceededException"
The exception is thrown when customer tries to create a record (e.g. budget),
but the number this record already exceeds the limitation.

* ErrCodeDuplicateRecordException "DuplicateRecordException"
The exception is thrown when customer tries to create a record (e.g. budget)
that already exists.

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) CreateNotificationWithContext

func (c *Budgets) CreateNotificationWithContext(ctx aws.Context, input *CreateNotificationInput, opts ...request.Option) (*CreateNotificationOutput, error)

CreateNotificationWithContext is the same as CreateNotification with the addition of the ability to pass a context and additional request options.

See CreateNotification for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Budgets) CreateSubscriber

func (c *Budgets) CreateSubscriber(input *CreateSubscriberInput) (*CreateSubscriberOutput, error)

CreateSubscriber API operation for AWS Budgets.

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:

* ErrCodeInternalErrorException "InternalErrorException"
This exception is thrown on an unknown internal failure.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown if any request is given an invalid parameter. E.g.,
if a required Date field is null.

* ErrCodeCreationLimitExceededException "CreationLimitExceededException"
The exception is thrown when customer tries to create a record (e.g. budget),
but the number this record already exceeds the limitation.

* ErrCodeDuplicateRecordException "DuplicateRecordException"
The exception is thrown when customer tries to create a record (e.g. budget)
that already exists.

* ErrCodeNotFoundException "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.

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) CreateSubscriberWithContext

func (c *Budgets) CreateSubscriberWithContext(ctx aws.Context, input *CreateSubscriberInput, opts ...request.Option) (*CreateSubscriberOutput, error)

CreateSubscriberWithContext is the same as CreateSubscriber with the addition of the ability to pass a context and additional request options.

See CreateSubscriber for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Budgets) DeleteBudget

func (c *Budgets) DeleteBudget(input *DeleteBudgetInput) (*DeleteBudgetOutput, error)

DeleteBudget API operation for AWS Budgets.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Budgets's API operation DeleteBudget for usage and error information.

Returned Error Codes:

* ErrCodeInternalErrorException "InternalErrorException"
This exception is thrown on an unknown internal failure.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown if any request is given an invalid parameter. E.g.,
if a required Date field is null.

* ErrCodeNotFoundException "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.

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) DeleteBudgetWithContext

func (c *Budgets) DeleteBudgetWithContext(ctx aws.Context, input *DeleteBudgetInput, opts ...request.Option) (*DeleteBudgetOutput, error)

DeleteBudgetWithContext is the same as DeleteBudget with the addition of the ability to pass a context and additional request options.

See DeleteBudget for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Budgets) DeleteNotification

func (c *Budgets) DeleteNotification(input *DeleteNotificationInput) (*DeleteNotificationOutput, error)

DeleteNotification API operation for AWS Budgets.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Budgets's API operation DeleteNotification for usage and error information.

Returned Error Codes:

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown if any request is given an invalid parameter. E.g.,
if a required Date field is null.

* ErrCodeInternalErrorException "InternalErrorException"
This exception is thrown on an unknown internal failure.

* ErrCodeNotFoundException "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.

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) DeleteNotificationWithContext

func (c *Budgets) DeleteNotificationWithContext(ctx aws.Context, input *DeleteNotificationInput, opts ...request.Option) (*DeleteNotificationOutput, error)

DeleteNotificationWithContext is the same as DeleteNotification with the addition of the ability to pass a context and additional request options.

See DeleteNotification for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Budgets) DeleteSubscriber

func (c *Budgets) DeleteSubscriber(input *DeleteSubscriberInput) (*DeleteSubscriberOutput, error)

DeleteSubscriber API operation for AWS Budgets.

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:

* ErrCodeInternalErrorException "InternalErrorException"
This exception is thrown on an unknown internal failure.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown if any request is given an invalid parameter. E.g.,
if a required Date field is null.

* ErrCodeNotFoundException "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.

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) DeleteSubscriberWithContext

func (c *Budgets) DeleteSubscriberWithContext(ctx aws.Context, input *DeleteSubscriberInput, opts ...request.Option) (*DeleteSubscriberOutput, error)

DeleteSubscriberWithContext is the same as DeleteSubscriber with the addition of the ability to pass a context and additional request options.

See DeleteSubscriber for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Budgets) DescribeBudget

func (c *Budgets) DescribeBudget(input *DescribeBudgetInput) (*DescribeBudgetOutput, error)

DescribeBudget API operation for AWS Budgets.

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:

* ErrCodeInternalErrorException "InternalErrorException"
This exception is thrown on an unknown internal failure.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown if any request is given an invalid parameter. E.g.,
if a required Date field is null.

* ErrCodeNotFoundException "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.

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) DescribeBudgetWithContext

func (c *Budgets) DescribeBudgetWithContext(ctx aws.Context, input *DescribeBudgetInput, opts ...request.Option) (*DescribeBudgetOutput, error)

DescribeBudgetWithContext is the same as DescribeBudget with the addition of the ability to pass a context and additional request options.

See DescribeBudget for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Budgets) DescribeBudgets

func (c *Budgets) DescribeBudgets(input *DescribeBudgetsInput) (*DescribeBudgetsOutput, error)

DescribeBudgets API operation for AWS Budgets.

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:

* ErrCodeInternalErrorException "InternalErrorException"
This exception is thrown on an unknown internal failure.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown if any request is given an invalid parameter. E.g.,
if a required Date field is null.

* ErrCodeNotFoundException "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.

* ErrCodeInvalidNextTokenException "InvalidNextTokenException"
This exception is thrown if paging token signature didn't match the token,
or the paging token isn't for this request

* ErrCodeExpiredNextTokenException "ExpiredNextTokenException"
This exception is thrown if the paging token is expired - past its TTL

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) DescribeBudgetsWithContext

func (c *Budgets) DescribeBudgetsWithContext(ctx aws.Context, input *DescribeBudgetsInput, opts ...request.Option) (*DescribeBudgetsOutput, error)

DescribeBudgetsWithContext is the same as DescribeBudgets with the addition of the ability to pass a context and additional request options.

See DescribeBudgets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Budgets) DescribeNotificationsForBudget

func (c *Budgets) DescribeNotificationsForBudget(input *DescribeNotificationsForBudgetInput) (*DescribeNotificationsForBudgetOutput, error)

DescribeNotificationsForBudget API operation for AWS Budgets.

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:

* ErrCodeInternalErrorException "InternalErrorException"
This exception is thrown on an unknown internal failure.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown if any request is given an invalid parameter. E.g.,
if a required Date field is null.

* ErrCodeNotFoundException "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.

* ErrCodeInvalidNextTokenException "InvalidNextTokenException"
This exception is thrown if paging token signature didn't match the token,
or the paging token isn't for this request

* ErrCodeExpiredNextTokenException "ExpiredNextTokenException"
This exception is thrown if the paging token is expired - past its TTL

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) DescribeNotificationsForBudgetWithContext

func (c *Budgets) DescribeNotificationsForBudgetWithContext(ctx aws.Context, input *DescribeNotificationsForBudgetInput, opts ...request.Option) (*DescribeNotificationsForBudgetOutput, error)

DescribeNotificationsForBudgetWithContext is the same as DescribeNotificationsForBudget with the addition of the ability to pass a context and additional request options.

See DescribeNotificationsForBudget for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Budgets) DescribeSubscribersForNotification

func (c *Budgets) DescribeSubscribersForNotification(input *DescribeSubscribersForNotificationInput) (*DescribeSubscribersForNotificationOutput, error)

DescribeSubscribersForNotification API operation for AWS Budgets.

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:

* ErrCodeInternalErrorException "InternalErrorException"
This exception is thrown on an unknown internal failure.

* ErrCodeNotFoundException "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.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown if any request is given an invalid parameter. E.g.,
if a required Date field is null.

* ErrCodeInvalidNextTokenException "InvalidNextTokenException"
This exception is thrown if paging token signature didn't match the token,
or the paging token isn't for this request

* ErrCodeExpiredNextTokenException "ExpiredNextTokenException"
This exception is thrown if the paging token is expired - past its TTL

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) DescribeSubscribersForNotificationWithContext

func (c *Budgets) DescribeSubscribersForNotificationWithContext(ctx aws.Context, input *DescribeSubscribersForNotificationInput, opts ...request.Option) (*DescribeSubscribersForNotificationOutput, error)

DescribeSubscribersForNotificationWithContext is the same as DescribeSubscribersForNotification with the addition of the ability to pass a context and additional request options.

See DescribeSubscribersForNotification for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Budgets) UpdateBudget

func (c *Budgets) UpdateBudget(input *UpdateBudgetInput) (*UpdateBudgetOutput, error)

UpdateBudget API operation for AWS Budgets.

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:

* ErrCodeInternalErrorException "InternalErrorException"
This exception is thrown on an unknown internal failure.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown if any request is given an invalid parameter. E.g.,
if a required Date field is null.

* ErrCodeNotFoundException "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.

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) UpdateBudgetWithContext

func (c *Budgets) UpdateBudgetWithContext(ctx aws.Context, input *UpdateBudgetInput, opts ...request.Option) (*UpdateBudgetOutput, error)

UpdateBudgetWithContext is the same as UpdateBudget with the addition of the ability to pass a context and additional request options.

See UpdateBudget for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Budgets) UpdateNotification

func (c *Budgets) UpdateNotification(input *UpdateNotificationInput) (*UpdateNotificationOutput, error)

UpdateNotification API operation for AWS Budgets.

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:

* ErrCodeInternalErrorException "InternalErrorException"
This exception is thrown on an unknown internal failure.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown if any request is given an invalid parameter. E.g.,
if a required Date field is null.

* ErrCodeNotFoundException "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.

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) UpdateNotificationWithContext

func (c *Budgets) UpdateNotificationWithContext(ctx aws.Context, input *UpdateNotificationInput, opts ...request.Option) (*UpdateNotificationOutput, error)

UpdateNotificationWithContext is the same as UpdateNotification with the addition of the ability to pass a context and additional request options.

See UpdateNotification for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Budgets) UpdateSubscriber

func (c *Budgets) UpdateSubscriber(input *UpdateSubscriberInput) (*UpdateSubscriberOutput, error)

UpdateSubscriber API operation for AWS Budgets.

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:

* ErrCodeInternalErrorException "InternalErrorException"
This exception is thrown on an unknown internal failure.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown if any request is given an invalid parameter. E.g.,
if a required Date field is null.

* ErrCodeNotFoundException "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.

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)
}

func (*Budgets) UpdateSubscriberWithContext

func (c *Budgets) UpdateSubscriberWithContext(ctx aws.Context, input *UpdateSubscriberInput, opts ...request.Option) (*UpdateSubscriberOutput, error)

UpdateSubscriberWithContext is the same as UpdateSubscriber with the addition of the ability to pass a context and additional request options.

See UpdateSubscriber for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type CalculatedSpend

A structure holds the actual and forecasted spend for a budget.

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
}

func (CalculatedSpend) GoString

func (s CalculatedSpend) GoString() string

GoString returns the string representation

func (*CalculatedSpend) SetActualSpend

func (s *CalculatedSpend) SetActualSpend(v *Spend) *CalculatedSpend

SetActualSpend sets the ActualSpend field's value.

func (*CalculatedSpend) SetForecastedSpend

func (s *CalculatedSpend) SetForecastedSpend(v *Spend) *CalculatedSpend

SetForecastedSpend sets the ForecastedSpend field's value.

func (CalculatedSpend) String

func (s CalculatedSpend) String() string

String returns the string representation

func (*CalculatedSpend) Validate

func (s *CalculatedSpend) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CostTypes

This includes the options for getting the cost of a budget.

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
}

func (CostTypes) GoString

func (s CostTypes) GoString() string

GoString returns the string representation

func (*CostTypes) SetIncludeSubscription

func (s *CostTypes) SetIncludeSubscription(v bool) *CostTypes

SetIncludeSubscription sets the IncludeSubscription field's value.

func (*CostTypes) SetIncludeTax

func (s *CostTypes) SetIncludeTax(v bool) *CostTypes

SetIncludeTax sets the IncludeTax field's value.

func (*CostTypes) SetUseBlended

func (s *CostTypes) SetUseBlended(v bool) *CostTypes

SetUseBlended sets the UseBlended field's value.

func (CostTypes) String

func (s CostTypes) String() string

String returns the string representation

func (*CostTypes) Validate

func (s *CostTypes) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateBudgetInput

Request of CreateBudget

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
}

func (CreateBudgetInput) GoString

func (s CreateBudgetInput) GoString() string

GoString returns the string representation

func (*CreateBudgetInput) SetAccountId

func (s *CreateBudgetInput) SetAccountId(v string) *CreateBudgetInput

SetAccountId sets the AccountId field's value.

func (*CreateBudgetInput) SetBudget

func (s *CreateBudgetInput) SetBudget(v *Budget) *CreateBudgetInput

SetBudget sets the Budget field's value.

func (*CreateBudgetInput) SetNotificationsWithSubscribers

func (s *CreateBudgetInput) SetNotificationsWithSubscribers(v []*NotificationWithSubscribers) *CreateBudgetInput

SetNotificationsWithSubscribers sets the NotificationsWithSubscribers field's value.

func (CreateBudgetInput) String

func (s CreateBudgetInput) String() string

String returns the string representation

func (*CreateBudgetInput) Validate

func (s *CreateBudgetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateBudgetOutput

Response of CreateBudget

type CreateBudgetOutput struct {
    // contains filtered or unexported fields
}

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

Request of CreateNotification

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
}

func (CreateNotificationInput) GoString

func (s CreateNotificationInput) GoString() string

GoString returns the string representation

func (*CreateNotificationInput) SetAccountId

func (s *CreateNotificationInput) SetAccountId(v string) *CreateNotificationInput

SetAccountId sets the AccountId field's value.

func (*CreateNotificationInput) SetBudgetName

func (s *CreateNotificationInput) SetBudgetName(v string) *CreateNotificationInput

SetBudgetName sets the BudgetName field's value.

func (*CreateNotificationInput) SetNotification

func (s *CreateNotificationInput) SetNotification(v *Notification) *CreateNotificationInput

SetNotification sets the Notification field's value.

func (*CreateNotificationInput) SetSubscribers

func (s *CreateNotificationInput) SetSubscribers(v []*Subscriber) *CreateNotificationInput

SetSubscribers sets the Subscribers field's value.

func (CreateNotificationInput) String

func (s CreateNotificationInput) String() string

String returns the string representation

func (*CreateNotificationInput) Validate

func (s *CreateNotificationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateNotificationOutput

Response of CreateNotification

type CreateNotificationOutput struct {
    // contains filtered or unexported fields
}

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

Request of CreateSubscriber

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
}

func (CreateSubscriberInput) GoString

func (s CreateSubscriberInput) GoString() string

GoString returns the string representation

func (*CreateSubscriberInput) SetAccountId

func (s *CreateSubscriberInput) SetAccountId(v string) *CreateSubscriberInput

SetAccountId sets the AccountId field's value.

func (*CreateSubscriberInput) SetBudgetName

func (s *CreateSubscriberInput) SetBudgetName(v string) *CreateSubscriberInput

SetBudgetName sets the BudgetName field's value.

func (*CreateSubscriberInput) SetNotification

func (s *CreateSubscriberInput) SetNotification(v *Notification) *CreateSubscriberInput

SetNotification sets the Notification field's value.

func (*CreateSubscriberInput) SetSubscriber

func (s *CreateSubscriberInput) SetSubscriber(v *Subscriber) *CreateSubscriberInput

SetSubscriber sets the Subscriber field's value.

func (CreateSubscriberInput) String

func (s CreateSubscriberInput) String() string

String returns the string representation

func (*CreateSubscriberInput) Validate

func (s *CreateSubscriberInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateSubscriberOutput

Response of CreateSubscriber

type CreateSubscriberOutput struct {
    // contains filtered or unexported fields
}

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

Request of DeleteBudget

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
}

func (DeleteBudgetInput) GoString

func (s DeleteBudgetInput) GoString() string

GoString returns the string representation

func (*DeleteBudgetInput) SetAccountId

func (s *DeleteBudgetInput) SetAccountId(v string) *DeleteBudgetInput

SetAccountId sets the AccountId field's value.

func (*DeleteBudgetInput) SetBudgetName

func (s *DeleteBudgetInput) SetBudgetName(v string) *DeleteBudgetInput

SetBudgetName sets the BudgetName field's value.

func (DeleteBudgetInput) String

func (s DeleteBudgetInput) String() string

String returns the string representation

func (*DeleteBudgetInput) Validate

func (s *DeleteBudgetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteBudgetOutput

Response of DeleteBudget

type DeleteBudgetOutput struct {
    // contains filtered or unexported fields
}

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

Request of DeleteNotification

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
}

func (DeleteNotificationInput) GoString

func (s DeleteNotificationInput) GoString() string

GoString returns the string representation

func (*DeleteNotificationInput) SetAccountId

func (s *DeleteNotificationInput) SetAccountId(v string) *DeleteNotificationInput

SetAccountId sets the AccountId field's value.

func (*DeleteNotificationInput) SetBudgetName

func (s *DeleteNotificationInput) SetBudgetName(v string) *DeleteNotificationInput

SetBudgetName sets the BudgetName field's value.

func (*DeleteNotificationInput) SetNotification

func (s *DeleteNotificationInput) SetNotification(v *Notification) *DeleteNotificationInput

SetNotification sets the Notification field's value.

func (DeleteNotificationInput) String

func (s DeleteNotificationInput) String() string

String returns the string representation

func (*DeleteNotificationInput) Validate

func (s *DeleteNotificationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteNotificationOutput

Response of DeleteNotification

type DeleteNotificationOutput struct {
    // contains filtered or unexported fields
}

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

Request of DeleteSubscriber

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
}

func (DeleteSubscriberInput) GoString

func (s DeleteSubscriberInput) GoString() string

GoString returns the string representation

func (*DeleteSubscriberInput) SetAccountId

func (s *DeleteSubscriberInput) SetAccountId(v string) *DeleteSubscriberInput

SetAccountId sets the AccountId field's value.

func (*DeleteSubscriberInput) SetBudgetName

func (s *DeleteSubscriberInput) SetBudgetName(v string) *DeleteSubscriberInput

SetBudgetName sets the BudgetName field's value.

func (*DeleteSubscriberInput) SetNotification

func (s *DeleteSubscriberInput) SetNotification(v *Notification) *DeleteSubscriberInput

SetNotification sets the Notification field's value.

func (*DeleteSubscriberInput) SetSubscriber

func (s *DeleteSubscriberInput) SetSubscriber(v *Subscriber) *DeleteSubscriberInput

SetSubscriber sets the Subscriber field's value.

func (DeleteSubscriberInput) String

func (s DeleteSubscriberInput) String() string

String returns the string representation

func (*DeleteSubscriberInput) Validate

func (s *DeleteSubscriberInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteSubscriberOutput

Response of DeleteSubscriber

type DeleteSubscriberOutput struct {
    // contains filtered or unexported fields
}

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

Request of DescribeBudget

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
}

func (DescribeBudgetInput) GoString

func (s DescribeBudgetInput) GoString() string

GoString returns the string representation

func (*DescribeBudgetInput) SetAccountId

func (s *DescribeBudgetInput) SetAccountId(v string) *DescribeBudgetInput

SetAccountId sets the AccountId field's value.

func (*DescribeBudgetInput) SetBudgetName

func (s *DescribeBudgetInput) SetBudgetName(v string) *DescribeBudgetInput

SetBudgetName sets the BudgetName field's value.

func (DescribeBudgetInput) String

func (s DescribeBudgetInput) String() string

String returns the string representation

func (*DescribeBudgetInput) Validate

func (s *DescribeBudgetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeBudgetOutput

Response of DescribeBudget

type DescribeBudgetOutput struct {

    // AWS Budget model
    Budget *Budget `type:"structure"`
    // contains filtered or unexported fields
}

func (DescribeBudgetOutput) GoString

func (s DescribeBudgetOutput) GoString() string

GoString returns the string representation

func (*DescribeBudgetOutput) SetBudget

func (s *DescribeBudgetOutput) SetBudget(v *Budget) *DescribeBudgetOutput

SetBudget sets the Budget field's value.

func (DescribeBudgetOutput) String

func (s DescribeBudgetOutput) String() string

String returns the string representation

type DescribeBudgetsInput

Request of DescribeBudgets

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
}

func (DescribeBudgetsInput) GoString

func (s DescribeBudgetsInput) GoString() string

GoString returns the string representation

func (*DescribeBudgetsInput) SetAccountId

func (s *DescribeBudgetsInput) SetAccountId(v string) *DescribeBudgetsInput

SetAccountId sets the AccountId field's value.

func (*DescribeBudgetsInput) SetMaxResults

func (s *DescribeBudgetsInput) SetMaxResults(v int64) *DescribeBudgetsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeBudgetsInput) SetNextToken

func (s *DescribeBudgetsInput) SetNextToken(v string) *DescribeBudgetsInput

SetNextToken sets the NextToken field's value.

func (DescribeBudgetsInput) String

func (s DescribeBudgetsInput) String() string

String returns the string representation

func (*DescribeBudgetsInput) Validate

func (s *DescribeBudgetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeBudgetsOutput

Response of DescribeBudgets

type DescribeBudgetsOutput struct {

    // A list of budgets
    Budgets []*Budget `type:"list"`

    // A generic String.
    NextToken *string `type:"string"`
    // contains filtered or unexported fields
}

func (DescribeBudgetsOutput) GoString

func (s DescribeBudgetsOutput) GoString() string

GoString returns the string representation

func (*DescribeBudgetsOutput) SetBudgets

func (s *DescribeBudgetsOutput) SetBudgets(v []*Budget) *DescribeBudgetsOutput

SetBudgets sets the Budgets field's value.

func (*DescribeBudgetsOutput) SetNextToken

func (s *DescribeBudgetsOutput) SetNextToken(v string) *DescribeBudgetsOutput

SetNextToken sets the NextToken field's value.

func (DescribeBudgetsOutput) String

func (s DescribeBudgetsOutput) String() string

String returns the string representation

type DescribeNotificationsForBudgetInput

Request of DescribeNotificationsForBudget

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
}

func (DescribeNotificationsForBudgetInput) GoString

func (s DescribeNotificationsForBudgetInput) GoString() string

GoString returns the string representation

func (*DescribeNotificationsForBudgetInput) SetAccountId

func (s *DescribeNotificationsForBudgetInput) SetAccountId(v string) *DescribeNotificationsForBudgetInput

SetAccountId sets the AccountId field's value.

func (*DescribeNotificationsForBudgetInput) SetBudgetName

func (s *DescribeNotificationsForBudgetInput) SetBudgetName(v string) *DescribeNotificationsForBudgetInput

SetBudgetName sets the BudgetName field's value.

func (*DescribeNotificationsForBudgetInput) SetMaxResults

func (s *DescribeNotificationsForBudgetInput) SetMaxResults(v int64) *DescribeNotificationsForBudgetInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeNotificationsForBudgetInput) SetNextToken

func (s *DescribeNotificationsForBudgetInput) SetNextToken(v string) *DescribeNotificationsForBudgetInput

SetNextToken sets the NextToken field's value.

func (DescribeNotificationsForBudgetInput) String

func (s DescribeNotificationsForBudgetInput) String() string

String returns the string representation

func (*DescribeNotificationsForBudgetInput) Validate

func (s *DescribeNotificationsForBudgetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeNotificationsForBudgetOutput

Response of GetNotificationsForBudget

type DescribeNotificationsForBudgetOutput struct {

    // A generic String.
    NextToken *string `type:"string"`

    // A list of notifications.
    Notifications []*Notification `type:"list"`
    // contains filtered or unexported fields
}

func (DescribeNotificationsForBudgetOutput) GoString

func (s DescribeNotificationsForBudgetOutput) GoString() string

GoString returns the string representation

func (*DescribeNotificationsForBudgetOutput) SetNextToken

func (s *DescribeNotificationsForBudgetOutput) SetNextToken(v string) *DescribeNotificationsForBudgetOutput

SetNextToken sets the NextToken field's value.

func (*DescribeNotificationsForBudgetOutput) SetNotifications

func (s *DescribeNotificationsForBudgetOutput) SetNotifications(v []*Notification) *DescribeNotificationsForBudgetOutput

SetNotifications sets the Notifications field's value.

func (DescribeNotificationsForBudgetOutput) String

func (s DescribeNotificationsForBudgetOutput) String() string

String returns the string representation

type DescribeSubscribersForNotificationInput

Request of DescribeSubscribersForNotification

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
}

func (DescribeSubscribersForNotificationInput) GoString

func (s DescribeSubscribersForNotificationInput) GoString() string

GoString returns the string representation

func (*DescribeSubscribersForNotificationInput) SetAccountId

func (s *DescribeSubscribersForNotificationInput) SetAccountId(v string) *DescribeSubscribersForNotificationInput

SetAccountId sets the AccountId field's value.

func (*DescribeSubscribersForNotificationInput) SetBudgetName

func (s *DescribeSubscribersForNotificationInput) SetBudgetName(v string) *DescribeSubscribersForNotificationInput

SetBudgetName sets the BudgetName field's value.

func (*DescribeSubscribersForNotificationInput) SetMaxResults

func (s *DescribeSubscribersForNotificationInput) SetMaxResults(v int64) *DescribeSubscribersForNotificationInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeSubscribersForNotificationInput) SetNextToken

func (s *DescribeSubscribersForNotificationInput) SetNextToken(v string) *DescribeSubscribersForNotificationInput

SetNextToken sets the NextToken field's value.

func (*DescribeSubscribersForNotificationInput) SetNotification

func (s *DescribeSubscribersForNotificationInput) SetNotification(v *Notification) *DescribeSubscribersForNotificationInput

SetNotification sets the Notification field's value.

func (DescribeSubscribersForNotificationInput) String

func (s DescribeSubscribersForNotificationInput) String() string

String returns the string representation

func (*DescribeSubscribersForNotificationInput) Validate

func (s *DescribeSubscribersForNotificationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeSubscribersForNotificationOutput

Response of DescribeSubscribersForNotification

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
}

func (DescribeSubscribersForNotificationOutput) GoString

func (s DescribeSubscribersForNotificationOutput) GoString() string

GoString returns the string representation

func (*DescribeSubscribersForNotificationOutput) SetNextToken

func (s *DescribeSubscribersForNotificationOutput) SetNextToken(v string) *DescribeSubscribersForNotificationOutput

SetNextToken sets the NextToken field's value.

func (*DescribeSubscribersForNotificationOutput) SetSubscribers

func (s *DescribeSubscribersForNotificationOutput) SetSubscribers(v []*Subscriber) *DescribeSubscribersForNotificationOutput

SetSubscribers sets the Subscribers field's value.

func (DescribeSubscribersForNotificationOutput) String

func (s DescribeSubscribersForNotificationOutput) String() string

String returns the string representation

type Notification

Notification model. Each budget may contain multiple notifications with different settings.

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
}

func (Notification) GoString

func (s Notification) GoString() string

GoString returns the string representation

func (*Notification) SetComparisonOperator

func (s *Notification) SetComparisonOperator(v string) *Notification

SetComparisonOperator sets the ComparisonOperator field's value.

func (*Notification) SetNotificationType

func (s *Notification) SetNotificationType(v string) *Notification

SetNotificationType sets the NotificationType field's value.

func (*Notification) SetThreshold

func (s *Notification) SetThreshold(v float64) *Notification

SetThreshold sets the Threshold field's value.

func (Notification) 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

A structure to relate notification and a list of subscribers who belong to the notification.

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
}

func (NotificationWithSubscribers) GoString

func (s NotificationWithSubscribers) GoString() string

GoString returns the string representation

func (*NotificationWithSubscribers) SetNotification

func (s *NotificationWithSubscribers) SetNotification(v *Notification) *NotificationWithSubscribers

SetNotification sets the Notification field's value.

func (*NotificationWithSubscribers) SetSubscribers

func (s *NotificationWithSubscribers) SetSubscribers(v []*Subscriber) *NotificationWithSubscribers

SetSubscribers sets the Subscribers field's value.

func (NotificationWithSubscribers) String

func (s NotificationWithSubscribers) String() string

String returns the string representation

func (*NotificationWithSubscribers) Validate

func (s *NotificationWithSubscribers) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Spend

A structure represent either a cost spend or usage spend. Contains an amount and a unit.

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
}

func (Spend) GoString

func (s Spend) GoString() string

GoString returns the string representation

func (*Spend) SetAmount

func (s *Spend) SetAmount(v string) *Spend

SetAmount sets the Amount field's value.

func (*Spend) SetUnit

func (s *Spend) SetUnit(v string) *Spend

SetUnit sets the Unit field's value.

func (Spend) String

func (s Spend) String() string

String returns the string representation

func (*Spend) Validate

func (s *Spend) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Subscriber

Subscriber model. Each notification may contain multiple subscribers with different addresses.

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
}

func (Subscriber) GoString

func (s Subscriber) GoString() string

GoString returns the string representation

func (*Subscriber) SetAddress

func (s *Subscriber) SetAddress(v string) *Subscriber

SetAddress sets the Address field's value.

func (*Subscriber) SetSubscriptionType

func (s *Subscriber) SetSubscriptionType(v string) *Subscriber

SetSubscriptionType sets the SubscriptionType field's value.

func (Subscriber) String

func (s Subscriber) String() string

String returns the string representation

func (*Subscriber) Validate

func (s *Subscriber) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TimePeriod

A time period indicated the start date and end date of a budget.

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
}

func (TimePeriod) GoString

func (s TimePeriod) GoString() string

GoString returns the string representation

func (*TimePeriod) SetEnd

func (s *TimePeriod) SetEnd(v time.Time) *TimePeriod

SetEnd sets the End field's value.

func (*TimePeriod) SetStart

func (s *TimePeriod) SetStart(v time.Time) *TimePeriod

SetStart sets the Start field's value.

func (TimePeriod) String

func (s TimePeriod) String() string

String returns the string representation

func (*TimePeriod) Validate

func (s *TimePeriod) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateBudgetInput

Request of UpdateBudget

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
}

func (UpdateBudgetInput) GoString

func (s UpdateBudgetInput) GoString() string

GoString returns the string representation

func (*UpdateBudgetInput) SetAccountId

func (s *UpdateBudgetInput) SetAccountId(v string) *UpdateBudgetInput

SetAccountId sets the AccountId field's value.

func (*UpdateBudgetInput) SetNewBudget

func (s *UpdateBudgetInput) SetNewBudget(v *Budget) *UpdateBudgetInput

SetNewBudget sets the NewBudget field's value.

func (UpdateBudgetInput) String

func (s UpdateBudgetInput) String() string

String returns the string representation

func (*UpdateBudgetInput) Validate

func (s *UpdateBudgetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateBudgetOutput

Response of UpdateBudget

type UpdateBudgetOutput struct {
    // contains filtered or unexported fields
}

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

Request of UpdateNotification

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
}

func (UpdateNotificationInput) GoString

func (s UpdateNotificationInput) GoString() string

GoString returns the string representation

func (*UpdateNotificationInput) SetAccountId

func (s *UpdateNotificationInput) SetAccountId(v string) *UpdateNotificationInput

SetAccountId sets the AccountId field's value.

func (*UpdateNotificationInput) SetBudgetName

func (s *UpdateNotificationInput) SetBudgetName(v string) *UpdateNotificationInput

SetBudgetName sets the BudgetName field's value.

func (*UpdateNotificationInput) SetNewNotification

func (s *UpdateNotificationInput) SetNewNotification(v *Notification) *UpdateNotificationInput

SetNewNotification sets the NewNotification field's value.

func (*UpdateNotificationInput) SetOldNotification

func (s *UpdateNotificationInput) SetOldNotification(v *Notification) *UpdateNotificationInput

SetOldNotification sets the OldNotification field's value.

func (UpdateNotificationInput) String

func (s UpdateNotificationInput) String() string

String returns the string representation

func (*UpdateNotificationInput) Validate

func (s *UpdateNotificationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateNotificationOutput

Response of UpdateNotification

type UpdateNotificationOutput struct {
    // contains filtered or unexported fields
}

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

Request of UpdateSubscriber

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
}

func (UpdateSubscriberInput) GoString

func (s UpdateSubscriberInput) GoString() string

GoString returns the string representation

func (*UpdateSubscriberInput) SetAccountId

func (s *UpdateSubscriberInput) SetAccountId(v string) *UpdateSubscriberInput

SetAccountId sets the AccountId field's value.

func (*UpdateSubscriberInput) SetBudgetName

func (s *UpdateSubscriberInput) SetBudgetName(v string) *UpdateSubscriberInput

SetBudgetName sets the BudgetName field's value.

func (*UpdateSubscriberInput) SetNewSubscriber

func (s *UpdateSubscriberInput) SetNewSubscriber(v *Subscriber) *UpdateSubscriberInput

SetNewSubscriber sets the NewSubscriber field's value.

func (*UpdateSubscriberInput) SetNotification

func (s *UpdateSubscriberInput) SetNotification(v *Notification) *UpdateSubscriberInput

SetNotification sets the Notification field's value.

func (*UpdateSubscriberInput) SetOldSubscriber

func (s *UpdateSubscriberInput) SetOldSubscriber(v *Subscriber) *UpdateSubscriberInput

SetOldSubscriber sets the OldSubscriber field's value.

func (UpdateSubscriberInput) String

func (s UpdateSubscriberInput) String() string

String returns the string representation

func (*UpdateSubscriberInput) Validate

func (s *UpdateSubscriberInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateSubscriberOutput

Response of UpdateSubscriber

type UpdateSubscriberOutput struct {
    // contains filtered or unexported fields
}

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

Subdirectories

Name Synopsis
..
budgetsiface Package budgetsiface provides an interface to enable mocking the AWS Budgets service client for testing your code.