budgets

package module
v1.1.6 Latest Latest
Warning

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

 Go to latest Published: May 7, 2021 License: Apache-2.0 Imports: 27 Imported by: 24

Documentation

Overview

Package budgets provides the API client, operations, and parameter types for AWS Budgets.

The AWS Budgets API enables you to use AWS Budgets to plan your service usage, service costs, and instance reservations. The API reference provides descriptions, syntax, and usage examples for each of the actions and data types for AWS Budgets. Budgets provide you with a way to see the following information:

* How close your plan is to your budgeted amount or to the free tier limits

* Your usage-to-date, including how much you've used of your Reserved Instances (RIs)

* Your current estimated charges from AWS, and how much your predicted usage will accrue in charges by the end of the month

* How much of your budget has been used

AWS updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:

* Cost budgets - Plan how much you want to spend on a service.

* Usage budgets - Plan how much you want to use one or more services.

* RI utilization budgets - Define a utilization threshold, and receive alerts when your RI usage falls below that threshold. This lets you see if your RIs are unused or under-utilized.

* RI coverage budgets - Define a coverage threshold, and receive alerts when the number of your instance hours that are covered by RIs fall below that threshold. This lets you see how much of your instance usage is covered by a reservation.

Service Endpoint The AWS Budgets API provides the following endpoint:

* https://budgets.amazonaws.com

For information about costs that are associated with the AWS Budgets API, see AWS Cost Management Pricing (https://aws.amazon.com/aws-cost-management/pricing/).

Index

Constants

View Source 
const ServiceAPIVersion = "2016-10-20"
View Source 
const ServiceID = "Budgets"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver 

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

Types

type Client 

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

Client provides the API client to make operations call for AWS Budgets.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CreateBudget 

func (c *Client) CreateBudget(ctx context.Context, params *CreateBudgetInput, optFns ...func(*Options)) (*CreateBudgetOutput, error)

Creates a budget and, if included, notifications and subscribers. Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_CreateBudget.html#API_CreateBudget_Examples) section.

func (*Client) CreateBudgetAction added in v0.29.0 

func (c *Client) CreateBudgetAction(ctx context.Context, params *CreateBudgetActionInput, optFns ...func(*Options)) (*CreateBudgetActionOutput, error)

Creates a budget action.

func (*Client) CreateNotification 

func (c *Client) CreateNotification(ctx context.Context, params *CreateNotificationInput, optFns ...func(*Options)) (*CreateNotificationOutput, error)

Creates a notification. You must create the budget before you create the associated notification.

func (*Client) CreateSubscriber 

func (c *Client) CreateSubscriber(ctx context.Context, params *CreateSubscriberInput, optFns ...func(*Options)) (*CreateSubscriberOutput, error)

Creates a subscriber. You must create the associated budget and notification before you create the subscriber.

func (*Client) DeleteBudget 

func (c *Client) DeleteBudget(ctx context.Context, params *DeleteBudgetInput, optFns ...func(*Options)) (*DeleteBudgetOutput, error)

Deletes a budget. You can delete your budget at any time. Deleting a budget also deletes the notifications and subscribers that are associated with that budget.

func (*Client) DeleteBudgetAction added in v0.29.0 

func (c *Client) DeleteBudgetAction(ctx context.Context, params *DeleteBudgetActionInput, optFns ...func(*Options)) (*DeleteBudgetActionOutput, error)

Deletes a budget action.

func (*Client) DeleteNotification 

func (c *Client) DeleteNotification(ctx context.Context, params *DeleteNotificationInput, optFns ...func(*Options)) (*DeleteNotificationOutput, error)

Deletes a notification. Deleting a notification also deletes the subscribers that are associated with the notification.

func (*Client) DeleteSubscriber 

func (c *Client) DeleteSubscriber(ctx context.Context, params *DeleteSubscriberInput, optFns ...func(*Options)) (*DeleteSubscriberOutput, error)

Deletes a subscriber. Deleting the last subscriber to a notification also deletes the notification.

func (*Client) DescribeBudget 

func (c *Client) DescribeBudget(ctx context.Context, params *DescribeBudgetInput, optFns ...func(*Options)) (*DescribeBudgetOutput, error)

Describes a budget. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_DescribeBudget.html#API_DescribeBudget_Examples) section.

func (*Client) DescribeBudgetAction added in v0.29.0 

func (c *Client) DescribeBudgetAction(ctx context.Context, params *DescribeBudgetActionInput, optFns ...func(*Options)) (*DescribeBudgetActionOutput, error)

Describes a budget action detail.

func (*Client) DescribeBudgetActionHistories added in v0.29.0 

func (c *Client) DescribeBudgetActionHistories(ctx context.Context, params *DescribeBudgetActionHistoriesInput, optFns ...func(*Options)) (*DescribeBudgetActionHistoriesOutput, error)

Describes a budget action history detail.

func (*Client) DescribeBudgetActionsForAccount added in v0.29.0 

func (c *Client) DescribeBudgetActionsForAccount(ctx context.Context, params *DescribeBudgetActionsForAccountInput, optFns ...func(*Options)) (*DescribeBudgetActionsForAccountOutput, error)

Describes all of the budget actions for an account.

func (*Client) DescribeBudgetActionsForBudget added in v0.29.0 

func (c *Client) DescribeBudgetActionsForBudget(ctx context.Context, params *DescribeBudgetActionsForBudgetInput, optFns ...func(*Options)) (*DescribeBudgetActionsForBudgetOutput, error)

Describes all of the budget actions for a budget.

func (*Client) DescribeBudgetPerformanceHistory 

func (c *Client) DescribeBudgetPerformanceHistory(ctx context.Context, params *DescribeBudgetPerformanceHistoryInput, optFns ...func(*Options)) (*DescribeBudgetPerformanceHistoryOutput, error)

Describes the history for DAILY, MONTHLY, and QUARTERLY budgets. Budget history isn't available for ANNUAL budgets.

func (*Client) DescribeBudgets 

func (c *Client) DescribeBudgets(ctx context.Context, params *DescribeBudgetsInput, optFns ...func(*Options)) (*DescribeBudgetsOutput, error)

Lists the budgets that are associated with an account. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_DescribeBudgets.html#API_DescribeBudgets_Examples) section.

func (*Client) DescribeNotificationsForBudget 

func (c *Client) DescribeNotificationsForBudget(ctx context.Context, params *DescribeNotificationsForBudgetInput, optFns ...func(*Options)) (*DescribeNotificationsForBudgetOutput, error)

Lists the notifications that are associated with a budget.

func (*Client) DescribeSubscribersForNotification 

func (c *Client) DescribeSubscribersForNotification(ctx context.Context, params *DescribeSubscribersForNotificationInput, optFns ...func(*Options)) (*DescribeSubscribersForNotificationOutput, error)

Lists the subscribers that are associated with a notification.

func (*Client) ExecuteBudgetAction added in v0.29.0 

func (c *Client) ExecuteBudgetAction(ctx context.Context, params *ExecuteBudgetActionInput, optFns ...func(*Options)) (*ExecuteBudgetActionOutput, error)

Executes a budget action.

func (*Client) UpdateBudget 

func (c *Client) UpdateBudget(ctx context.Context, params *UpdateBudgetInput, optFns ...func(*Options)) (*UpdateBudgetOutput, error)

Updates a budget. You can change every part of a budget except for the budgetName and the calculatedSpend. When you modify a budget, the calculatedSpend drops to zero until AWS has new usage data to use for forecasting. Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples (https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_UpdateBudget.html#API_UpdateBudget_Examples) section.

func (*Client) UpdateBudgetAction added in v0.29.0 

func (c *Client) UpdateBudgetAction(ctx context.Context, params *UpdateBudgetActionInput, optFns ...func(*Options)) (*UpdateBudgetActionOutput, error)

Updates a budget action.

func (*Client) UpdateNotification 

func (c *Client) UpdateNotification(ctx context.Context, params *UpdateNotificationInput, optFns ...func(*Options)) (*UpdateNotificationOutput, error)

Updates a notification.

func (*Client) UpdateSubscriber 

func (c *Client) UpdateSubscriber(ctx context.Context, params *UpdateSubscriberInput, optFns ...func(*Options)) (*UpdateSubscriberOutput, error)

Updates a subscriber.

type CreateBudgetActionInput added in v0.29.0 

type CreateBudgetActionInput struct {

	// The account ID of the user. It should be a 12-digit number.
	//
	// This member is required.
	AccountId *string

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

	// The type of action. This defines the type of tasks that can be carried out by
	// this action. This field also determines the format for definition.
	//
	// This member is required.
	ActionType types.ActionType

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

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

	// Specifies all of the type-specific parameters.
	//
	// This member is required.
	Definition *types.Definition

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

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

	// A list of subscribers.
	//
	// This member is required.
	Subscribers []types.Subscriber
}

type CreateBudgetActionOutput added in v0.29.0 

type CreateBudgetActionOutput struct {

	// The account ID of the user. It should be a 12-digit number.
	//
	// This member is required.
	AccountId *string

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateBudgetInput 

type CreateBudgetInput struct {

	// The accountId that is associated with the budget.
	//
	// This member is required.
	AccountId *string

	// The budget object that you want to create.
	//
	// This member is required.
	Budget *types.Budget

	// A notification that you want to associate with a budget. A budget can have up to
	// five notifications, and each notification can have one SNS subscriber and up to
	// 10 email subscribers. If you include notifications and subscribers in your
	// CreateBudget call, AWS creates the notifications and subscribers for you.
	NotificationsWithSubscribers []types.NotificationWithSubscribers
}

Request of CreateBudget

type CreateBudgetOutput 

type CreateBudgetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Response of CreateBudget

type CreateNotificationInput 

type CreateNotificationInput struct {

	// The accountId that is associated with the budget that you want to create a
	// notification for.
	//
	// This member is required.
	AccountId *string

	// The name of the budget that you want AWS to notify you about. Budget names must
	// be unique within an account.
	//
	// This member is required.
	BudgetName *string

	// The notification that you want to create.
	//
	// This member is required.
	Notification *types.Notification

	// A list of subscribers that you want to associate with the notification. Each
	// notification can have one SNS subscriber and up to 10 email subscribers.
	//
	// This member is required.
	Subscribers []types.Subscriber
}

Request of CreateNotification

type CreateNotificationOutput 

type CreateNotificationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Response of CreateNotification

type CreateSubscriberInput 

type CreateSubscriberInput struct {

	// The accountId that is associated with the budget that you want to create a
	// subscriber for.
	//
	// This member is required.
	AccountId *string

	// The name of the budget that you want to subscribe to. Budget names must be
	// unique within an account.
	//
	// This member is required.
	BudgetName *string

	// The notification that you want to create a subscriber for.
	//
	// This member is required.
	Notification *types.Notification

	// The subscriber that you want to associate with a budget notification.
	//
	// This member is required.
	Subscriber *types.Subscriber
}

Request of CreateSubscriber

type CreateSubscriberOutput 

type CreateSubscriberOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Response of CreateSubscriber

type DeleteBudgetActionInput added in v0.29.0 

type DeleteBudgetActionInput struct {

	// The account ID of the user. It should be a 12-digit number.
	//
	// This member is required.
	AccountId *string

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

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

type DeleteBudgetActionOutput added in v0.29.0 

type DeleteBudgetActionOutput struct {

	// The account ID of the user. It should be a 12-digit number.
	//
	// This member is required.
	AccountId *string

	// A budget action resource.
	//
	// This member is required.
	Action *types.Action

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteBudgetInput 

type DeleteBudgetInput struct {

	// The accountId that is associated with the budget that you want to delete.
	//
	// This member is required.
	AccountId *string

	// The name of the budget that you want to delete.
	//
	// This member is required.
	BudgetName *string
}

Request of DeleteBudget

type DeleteBudgetOutput 

type DeleteBudgetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Response of DeleteBudget

type DeleteNotificationInput 

type DeleteNotificationInput struct {

	// The accountId that is associated with the budget whose notification you want to
	// delete.
	//
	// This member is required.
	AccountId *string

	// The name of the budget whose notification you want to delete.
	//
	// This member is required.
	BudgetName *string

	// The notification that you want to delete.
	//
	// This member is required.
	Notification *types.Notification
}

Request of DeleteNotification

type DeleteNotificationOutput 

type DeleteNotificationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Response of DeleteNotification

type DeleteSubscriberInput 

type DeleteSubscriberInput struct {

	// The accountId that is associated with the budget whose subscriber you want to
	// delete.
	//
	// This member is required.
	AccountId *string

	// The name of the budget whose subscriber you want to delete.
	//
	// This member is required.
	BudgetName *string

	// The notification whose subscriber you want to delete.
	//
	// This member is required.
	Notification *types.Notification

	// The subscriber that you want to delete.
	//
	// This member is required.
	Subscriber *types.Subscriber
}

Request of DeleteSubscriber

type DeleteSubscriberOutput 

type DeleteSubscriberOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Response of DeleteSubscriber

type DescribeBudgetActionHistoriesAPIClient added in v0.30.0 

type DescribeBudgetActionHistoriesAPIClient interface {
	DescribeBudgetActionHistories(context.Context, *DescribeBudgetActionHistoriesInput, ...func(*Options)) (*DescribeBudgetActionHistoriesOutput, error)
}

DescribeBudgetActionHistoriesAPIClient is a client that implements the DescribeBudgetActionHistories operation.

type DescribeBudgetActionHistoriesInput added in v0.29.0 

type DescribeBudgetActionHistoriesInput struct {

	// The account ID of the user. It should be a 12-digit number.
	//
	// This member is required.
	AccountId *string

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

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

	// An integer that represents how many entries a paginated response contains. The
	// maximum is 100.
	MaxResults *int32

	// A generic string.
	NextToken *string

	// The period of time that is covered by a budget. The period has a start date and
	// an end date. The start date must come before the end date. There are no
	// restrictions on the end date.
	TimePeriod *types.TimePeriod
}

type DescribeBudgetActionHistoriesOutput added in v0.29.0 

type DescribeBudgetActionHistoriesOutput struct {

	// The historical record of the budget action resource.
	//
	// This member is required.
	ActionHistories []types.ActionHistory

	// A generic string.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeBudgetActionHistoriesPaginator added in v0.30.0 

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

DescribeBudgetActionHistoriesPaginator is a paginator for DescribeBudgetActionHistories

func NewDescribeBudgetActionHistoriesPaginator added in v0.30.0 

func NewDescribeBudgetActionHistoriesPaginator(client DescribeBudgetActionHistoriesAPIClient, params *DescribeBudgetActionHistoriesInput, optFns ...func(*DescribeBudgetActionHistoriesPaginatorOptions)) *DescribeBudgetActionHistoriesPaginator

NewDescribeBudgetActionHistoriesPaginator returns a new DescribeBudgetActionHistoriesPaginator

func (*DescribeBudgetActionHistoriesPaginator) HasMorePages added in v0.30.0 

func (p *DescribeBudgetActionHistoriesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeBudgetActionHistoriesPaginator) NextPage added in v0.30.0 

func (p *DescribeBudgetActionHistoriesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeBudgetActionHistoriesOutput, error)

NextPage retrieves the next DescribeBudgetActionHistories page.

type DescribeBudgetActionHistoriesPaginatorOptions added in v0.30.0 

type DescribeBudgetActionHistoriesPaginatorOptions struct {
	// An integer that represents how many entries a paginated response contains. The
	// maximum is 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeBudgetActionHistoriesPaginatorOptions is the paginator options for DescribeBudgetActionHistories

type DescribeBudgetActionInput added in v0.29.0 

type DescribeBudgetActionInput struct {

	// The account ID of the user. It should be a 12-digit number.
	//
	// This member is required.
	AccountId *string

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

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

type DescribeBudgetActionOutput added in v0.29.0 

type DescribeBudgetActionOutput struct {

	// The account ID of the user. It should be a 12-digit number.
	//
	// This member is required.
	AccountId *string

	// A budget action resource.
	//
	// This member is required.
	Action *types.Action

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeBudgetActionsForAccountAPIClient added in v0.30.0 

type DescribeBudgetActionsForAccountAPIClient interface {
	DescribeBudgetActionsForAccount(context.Context, *DescribeBudgetActionsForAccountInput, ...func(*Options)) (*DescribeBudgetActionsForAccountOutput, error)
}

DescribeBudgetActionsForAccountAPIClient is a client that implements the DescribeBudgetActionsForAccount operation.

type DescribeBudgetActionsForAccountInput added in v0.29.0 

type DescribeBudgetActionsForAccountInput struct {

	// The account ID of the user. It should be a 12-digit number.
	//
	// This member is required.
	AccountId *string

	// An integer that represents how many entries a paginated response contains. The
	// maximum is 100.
	MaxResults *int32

	// A generic string.
	NextToken *string
}

type DescribeBudgetActionsForAccountOutput added in v0.29.0 

type DescribeBudgetActionsForAccountOutput struct {

	// A list of the budget action resources information.
	//
	// This member is required.
	Actions []types.Action

	// A generic string.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeBudgetActionsForAccountPaginator added in v0.30.0 

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

DescribeBudgetActionsForAccountPaginator is a paginator for DescribeBudgetActionsForAccount

func NewDescribeBudgetActionsForAccountPaginator added in v0.30.0 

func NewDescribeBudgetActionsForAccountPaginator(client DescribeBudgetActionsForAccountAPIClient, params *DescribeBudgetActionsForAccountInput, optFns ...func(*DescribeBudgetActionsForAccountPaginatorOptions)) *DescribeBudgetActionsForAccountPaginator

NewDescribeBudgetActionsForAccountPaginator returns a new DescribeBudgetActionsForAccountPaginator

func (*DescribeBudgetActionsForAccountPaginator) HasMorePages added in v0.30.0 

func (p *DescribeBudgetActionsForAccountPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeBudgetActionsForAccountPaginator) NextPage added in v0.30.0 

func (p *DescribeBudgetActionsForAccountPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeBudgetActionsForAccountOutput, error)

NextPage retrieves the next DescribeBudgetActionsForAccount page.

type DescribeBudgetActionsForAccountPaginatorOptions added in v0.30.0 

type DescribeBudgetActionsForAccountPaginatorOptions struct {
	// An integer that represents how many entries a paginated response contains. The
	// maximum is 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeBudgetActionsForAccountPaginatorOptions is the paginator options for DescribeBudgetActionsForAccount

type DescribeBudgetActionsForBudgetAPIClient added in v0.30.0 

type DescribeBudgetActionsForBudgetAPIClient interface {
	DescribeBudgetActionsForBudget(context.Context, *DescribeBudgetActionsForBudgetInput, ...func(*Options)) (*DescribeBudgetActionsForBudgetOutput, error)
}

DescribeBudgetActionsForBudgetAPIClient is a client that implements the DescribeBudgetActionsForBudget operation.

type DescribeBudgetActionsForBudgetInput added in v0.29.0 

type DescribeBudgetActionsForBudgetInput struct {

	// The account ID of the user. It should be a 12-digit number.
	//
	// This member is required.
	AccountId *string

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

	// An integer that represents how many entries a paginated response contains. The
	// maximum is 100.
	MaxResults *int32

	// A generic string.
	NextToken *string
}

type DescribeBudgetActionsForBudgetOutput added in v0.29.0 

type DescribeBudgetActionsForBudgetOutput struct {

	// A list of the budget action resources information.
	//
	// This member is required.
	Actions []types.Action

	// A generic string.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeBudgetActionsForBudgetPaginator added in v0.30.0 

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

DescribeBudgetActionsForBudgetPaginator is a paginator for DescribeBudgetActionsForBudget

func NewDescribeBudgetActionsForBudgetPaginator added in v0.30.0 

func NewDescribeBudgetActionsForBudgetPaginator(client DescribeBudgetActionsForBudgetAPIClient, params *DescribeBudgetActionsForBudgetInput, optFns ...func(*DescribeBudgetActionsForBudgetPaginatorOptions)) *DescribeBudgetActionsForBudgetPaginator

NewDescribeBudgetActionsForBudgetPaginator returns a new DescribeBudgetActionsForBudgetPaginator

func (*DescribeBudgetActionsForBudgetPaginator) HasMorePages added in v0.30.0 

func (p *DescribeBudgetActionsForBudgetPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeBudgetActionsForBudgetPaginator) NextPage added in v0.30.0 

func (p *DescribeBudgetActionsForBudgetPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeBudgetActionsForBudgetOutput, error)

NextPage retrieves the next DescribeBudgetActionsForBudget page.

type DescribeBudgetActionsForBudgetPaginatorOptions added in v0.30.0 

type DescribeBudgetActionsForBudgetPaginatorOptions struct {
	// An integer that represents how many entries a paginated response contains. The
	// maximum is 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeBudgetActionsForBudgetPaginatorOptions is the paginator options for DescribeBudgetActionsForBudget

type DescribeBudgetInput 

type DescribeBudgetInput struct {

	// The accountId that is associated with the budget that you want a description of.
	//
	// This member is required.
	AccountId *string

	// The name of the budget that you want a description of.
	//
	// This member is required.
	BudgetName *string
}

Request of DescribeBudget

type DescribeBudgetOutput 

type DescribeBudgetOutput struct {

	// The description of the budget.
	Budget *types.Budget

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Response of DescribeBudget

type DescribeBudgetPerformanceHistoryAPIClient added in v0.31.0 

type DescribeBudgetPerformanceHistoryAPIClient interface {
	DescribeBudgetPerformanceHistory(context.Context, *DescribeBudgetPerformanceHistoryInput, ...func(*Options)) (*DescribeBudgetPerformanceHistoryOutput, error)
}

DescribeBudgetPerformanceHistoryAPIClient is a client that implements the DescribeBudgetPerformanceHistory operation.

type DescribeBudgetPerformanceHistoryInput 

type DescribeBudgetPerformanceHistoryInput struct {

	// The account ID of the user. It should be a 12-digit number.
	//
	// This member is required.
	AccountId *string

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

	// An integer that represents how many entries a paginated response contains. The
	// maximum is 100.
	MaxResults *int32

	// A generic string.
	NextToken *string

	// Retrieves how often the budget went into an ALARM state for the specified time
	// period.
	TimePeriod *types.TimePeriod
}

type DescribeBudgetPerformanceHistoryOutput 

type DescribeBudgetPerformanceHistoryOutput struct {

	// The history of how often the budget has gone into an ALARM state. For DAILY
	// budgets, the history saves the state of the budget for the last 60 days. For
	// MONTHLY budgets, the history saves the state of the budget for the current month
	// plus the last 12 months. For QUARTERLY budgets, the history saves the state of
	// the budget for the last four quarters.
	BudgetPerformanceHistory *types.BudgetPerformanceHistory

	// A generic string.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeBudgetPerformanceHistoryPaginator added in v0.31.0 

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

DescribeBudgetPerformanceHistoryPaginator is a paginator for DescribeBudgetPerformanceHistory

func NewDescribeBudgetPerformanceHistoryPaginator added in v0.31.0 

func NewDescribeBudgetPerformanceHistoryPaginator(client DescribeBudgetPerformanceHistoryAPIClient, params *DescribeBudgetPerformanceHistoryInput, optFns ...func(*DescribeBudgetPerformanceHistoryPaginatorOptions)) *DescribeBudgetPerformanceHistoryPaginator

NewDescribeBudgetPerformanceHistoryPaginator returns a new DescribeBudgetPerformanceHistoryPaginator

func (*DescribeBudgetPerformanceHistoryPaginator) HasMorePages added in v0.31.0 

func (p *DescribeBudgetPerformanceHistoryPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeBudgetPerformanceHistoryPaginator) NextPage added in v0.31.0 

func (p *DescribeBudgetPerformanceHistoryPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeBudgetPerformanceHistoryOutput, error)

NextPage retrieves the next DescribeBudgetPerformanceHistory page.

type DescribeBudgetPerformanceHistoryPaginatorOptions added in v0.31.0 

type DescribeBudgetPerformanceHistoryPaginatorOptions struct {
	// An integer that represents how many entries a paginated response contains. The
	// maximum is 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeBudgetPerformanceHistoryPaginatorOptions is the paginator options for DescribeBudgetPerformanceHistory

type DescribeBudgetsAPIClient added in v0.30.0 

type DescribeBudgetsAPIClient interface {
	DescribeBudgets(context.Context, *DescribeBudgetsInput, ...func(*Options)) (*DescribeBudgetsOutput, error)
}

DescribeBudgetsAPIClient is a client that implements the DescribeBudgets operation.

type DescribeBudgetsInput 

type DescribeBudgetsInput struct {

	// The accountId that is associated with the budgets that you want descriptions of.
	//
	// This member is required.
	AccountId *string

	// An optional integer that represents how many entries a paginated response
	// contains. The maximum is 100.
	MaxResults *int32

	// The pagination token that you include in your request to indicate the next set
	// of results that you want to retrieve.
	NextToken *string
}

Request of DescribeBudgets

type DescribeBudgetsOutput 

type DescribeBudgetsOutput struct {

	// A list of budgets.
	Budgets []types.Budget

	// The pagination token in the service response that indicates the next set of
	// results that you can retrieve.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Response of DescribeBudgets

type DescribeBudgetsPaginator added in v0.30.0 

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

DescribeBudgetsPaginator is a paginator for DescribeBudgets

func NewDescribeBudgetsPaginator added in v0.30.0 

func NewDescribeBudgetsPaginator(client DescribeBudgetsAPIClient, params *DescribeBudgetsInput, optFns ...func(*DescribeBudgetsPaginatorOptions)) *DescribeBudgetsPaginator

NewDescribeBudgetsPaginator returns a new DescribeBudgetsPaginator

func (*DescribeBudgetsPaginator) HasMorePages added in v0.30.0 

func (p *DescribeBudgetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeBudgetsPaginator) NextPage added in v0.30.0 

func (p *DescribeBudgetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeBudgetsOutput, error)

NextPage retrieves the next DescribeBudgets page.

type DescribeBudgetsPaginatorOptions added in v0.30.0 

type DescribeBudgetsPaginatorOptions struct {
	// An optional integer that represents how many entries a paginated response
	// contains. The maximum is 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeBudgetsPaginatorOptions is the paginator options for DescribeBudgets

type DescribeNotificationsForBudgetAPIClient added in v0.30.0 

type DescribeNotificationsForBudgetAPIClient interface {
	DescribeNotificationsForBudget(context.Context, *DescribeNotificationsForBudgetInput, ...func(*Options)) (*DescribeNotificationsForBudgetOutput, error)
}

DescribeNotificationsForBudgetAPIClient is a client that implements the DescribeNotificationsForBudget operation.

type DescribeNotificationsForBudgetInput 

type DescribeNotificationsForBudgetInput struct {

	// The accountId that is associated with the budget whose notifications you want
	// descriptions of.
	//
	// This member is required.
	AccountId *string

	// The name of the budget whose notifications you want descriptions of.
	//
	// This member is required.
	BudgetName *string

	// An optional integer that represents how many entries a paginated response
	// contains. The maximum is 100.
	MaxResults *int32

	// The pagination token that you include in your request to indicate the next set
	// of results that you want to retrieve.
	NextToken *string
}

Request of DescribeNotificationsForBudget

type DescribeNotificationsForBudgetOutput 

type DescribeNotificationsForBudgetOutput struct {

	// The pagination token in the service response that indicates the next set of
	// results that you can retrieve.
	NextToken *string

	// A list of notifications that are associated with a budget.
	Notifications []types.Notification

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Response of GetNotificationsForBudget

type DescribeNotificationsForBudgetPaginator added in v0.30.0 

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

DescribeNotificationsForBudgetPaginator is a paginator for DescribeNotificationsForBudget

func NewDescribeNotificationsForBudgetPaginator added in v0.30.0 

func NewDescribeNotificationsForBudgetPaginator(client DescribeNotificationsForBudgetAPIClient, params *DescribeNotificationsForBudgetInput, optFns ...func(*DescribeNotificationsForBudgetPaginatorOptions)) *DescribeNotificationsForBudgetPaginator

NewDescribeNotificationsForBudgetPaginator returns a new DescribeNotificationsForBudgetPaginator

func (*DescribeNotificationsForBudgetPaginator) HasMorePages added in v0.30.0 

func (p *DescribeNotificationsForBudgetPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeNotificationsForBudgetPaginator) NextPage added in v0.30.0 

func (p *DescribeNotificationsForBudgetPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeNotificationsForBudgetOutput, error)

NextPage retrieves the next DescribeNotificationsForBudget page.

type DescribeNotificationsForBudgetPaginatorOptions added in v0.30.0 

type DescribeNotificationsForBudgetPaginatorOptions struct {
	// An optional integer that represents how many entries a paginated response
	// contains. The maximum is 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeNotificationsForBudgetPaginatorOptions is the paginator options for DescribeNotificationsForBudget

type DescribeSubscribersForNotificationAPIClient added in v0.30.0 

type DescribeSubscribersForNotificationAPIClient interface {
	DescribeSubscribersForNotification(context.Context, *DescribeSubscribersForNotificationInput, ...func(*Options)) (*DescribeSubscribersForNotificationOutput, error)
}

DescribeSubscribersForNotificationAPIClient is a client that implements the DescribeSubscribersForNotification operation.

type DescribeSubscribersForNotificationInput 

type DescribeSubscribersForNotificationInput struct {

	// The accountId that is associated with the budget whose subscribers you want
	// descriptions of.
	//
	// This member is required.
	AccountId *string

	// The name of the budget whose subscribers you want descriptions of.
	//
	// This member is required.
	BudgetName *string

	// The notification whose subscribers you want to list.
	//
	// This member is required.
	Notification *types.Notification

	// An optional integer that represents how many entries a paginated response
	// contains. The maximum is 100.
	MaxResults *int32

	// The pagination token that you include in your request to indicate the next set
	// of results that you want to retrieve.
	NextToken *string
}

Request of DescribeSubscribersForNotification

type DescribeSubscribersForNotificationOutput 

type DescribeSubscribersForNotificationOutput struct {

	// The pagination token in the service response that indicates the next set of
	// results that you can retrieve.
	NextToken *string

	// A list of subscribers that are associated with a notification.
	Subscribers []types.Subscriber

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Response of DescribeSubscribersForNotification

type DescribeSubscribersForNotificationPaginator added in v0.30.0 

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

DescribeSubscribersForNotificationPaginator is a paginator for DescribeSubscribersForNotification

func NewDescribeSubscribersForNotificationPaginator added in v0.30.0 

func NewDescribeSubscribersForNotificationPaginator(client DescribeSubscribersForNotificationAPIClient, params *DescribeSubscribersForNotificationInput, optFns ...func(*DescribeSubscribersForNotificationPaginatorOptions)) *DescribeSubscribersForNotificationPaginator

NewDescribeSubscribersForNotificationPaginator returns a new DescribeSubscribersForNotificationPaginator

func (*DescribeSubscribersForNotificationPaginator) HasMorePages added in v0.30.0 

func (p *DescribeSubscribersForNotificationPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeSubscribersForNotificationPaginator) NextPage added in v0.30.0 

func (p *DescribeSubscribersForNotificationPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeSubscribersForNotificationOutput, error)

NextPage retrieves the next DescribeSubscribersForNotification page.

type DescribeSubscribersForNotificationPaginatorOptions added in v0.30.0 

type DescribeSubscribersForNotificationPaginatorOptions struct {
	// An optional integer that represents how many entries a paginated response
	// contains. The maximum is 100.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

DescribeSubscribersForNotificationPaginatorOptions is the paginator options for DescribeSubscribersForNotification

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type ExecuteBudgetActionInput added in v0.29.0 

type ExecuteBudgetActionInput struct {

	// The account ID of the user. It should be a 12-digit number.
	//
	// This member is required.
	AccountId *string

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

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

	// The type of execution.
	//
	// This member is required.
	ExecutionType types.ExecutionType
}

type ExecuteBudgetActionOutput added in v0.29.0 

type ExecuteBudgetActionOutput struct {

	// The account ID of the user. It should be a 12-digit number.
	//
	// This member is required.
	AccountId *string

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

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

	// The type of execution.
	//
	// This member is required.
	ExecutionType types.ExecutionType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer aws.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type UpdateBudgetActionInput added in v0.29.0 

type UpdateBudgetActionInput struct {

	// The account ID of the user. It should be a 12-digit number.
	//
	// This member is required.
	AccountId *string

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

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

	// The trigger threshold of the action.
	ActionThreshold *types.ActionThreshold

	// This specifies if the action needs manual or automatic approval.
	ApprovalModel types.ApprovalModel

	// Specifies all of the type-specific parameters.
	Definition *types.Definition

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

	// The type of a notification. It must be ACTUAL or FORECASTED.
	NotificationType types.NotificationType

	// A list of subscribers.
	Subscribers []types.Subscriber
}

type UpdateBudgetActionOutput added in v0.29.0 

type UpdateBudgetActionOutput struct {

	// The account ID of the user. It should be a 12-digit number.
	//
	// This member is required.
	AccountId *string

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

	// The updated action resource information.
	//
	// This member is required.
	NewAction *types.Action

	// The previous action resource information.
	//
	// This member is required.
	OldAction *types.Action

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateBudgetInput 

type UpdateBudgetInput struct {

	// The accountId that is associated with the budget that you want to update.
	//
	// This member is required.
	AccountId *string

	// The budget that you want to update your budget to.
	//
	// This member is required.
	NewBudget *types.Budget
}

Request of UpdateBudget

type UpdateBudgetOutput 

type UpdateBudgetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Response of UpdateBudget

type UpdateNotificationInput 

type UpdateNotificationInput struct {

	// The accountId that is associated with the budget whose notification you want to
	// update.
	//
	// This member is required.
	AccountId *string

	// The name of the budget whose notification you want to update.
	//
	// This member is required.
	BudgetName *string

	// The updated notification to be associated with a budget.
	//
	// This member is required.
	NewNotification *types.Notification

	// The previous notification that is associated with a budget.
	//
	// This member is required.
	OldNotification *types.Notification
}

Request of UpdateNotification

type UpdateNotificationOutput 

type UpdateNotificationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Response of UpdateNotification

type UpdateSubscriberInput 

type UpdateSubscriberInput struct {

	// The accountId that is associated with the budget whose subscriber you want to
	// update.
	//
	// This member is required.
	AccountId *string

	// The name of the budget whose subscriber you want to update.
	//
	// This member is required.
	BudgetName *string

	// The updated subscriber that is associated with a budget notification.
	//
	// This member is required.
	NewSubscriber *types.Subscriber

	// The notification whose subscriber you want to update.
	//
	// This member is required.
	Notification *types.Notification

	// The previous subscriber that is associated with a budget notification.
	//
	// This member is required.
	OldSubscriber *types.Subscriber
}

Request of UpdateSubscriber

type UpdateSubscriberOutput 

type UpdateSubscriberOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Response of UpdateSubscriber

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

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