budgets

package
v1.45.15 Latest Latest
Warning

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

 Go to latest Published: Sep 22, 2023 License: Apache-2.0 Imports: 10 Imported by: 77

Documentation

Overview

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

Use the Amazon Web Services Budgets API to plan your service usage, service costs, and instance reservations. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for the Amazon Web Services Budgets feature.

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 Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month

  • How much of your budget has been used

Amazon Web Services 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 Amazon Web Services Budgets API provides the following endpoint:

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

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

Using the Client

To contact AWS Budgets with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

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

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

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

Index

Constants

View Source 
const (
	// ActionStatusStandby is a ActionStatus enum value
	ActionStatusStandby = "STANDBY"

	// ActionStatusPending is a ActionStatus enum value
	ActionStatusPending = "PENDING"

	// ActionStatusExecutionInProgress is a ActionStatus enum value
	ActionStatusExecutionInProgress = "EXECUTION_IN_PROGRESS"

	// ActionStatusExecutionSuccess is a ActionStatus enum value
	ActionStatusExecutionSuccess = "EXECUTION_SUCCESS"

	// ActionStatusExecutionFailure is a ActionStatus enum value
	ActionStatusExecutionFailure = "EXECUTION_FAILURE"

	// ActionStatusReverseInProgress is a ActionStatus enum value
	ActionStatusReverseInProgress = "REVERSE_IN_PROGRESS"

	// ActionStatusReverseSuccess is a ActionStatus enum value
	ActionStatusReverseSuccess = "REVERSE_SUCCESS"

	// ActionStatusReverseFailure is a ActionStatus enum value
	ActionStatusReverseFailure = "REVERSE_FAILURE"

	// ActionStatusResetInProgress is a ActionStatus enum value
	ActionStatusResetInProgress = "RESET_IN_PROGRESS"

	// ActionStatusResetFailure is a ActionStatus enum value
	ActionStatusResetFailure = "RESET_FAILURE"
)
View Source 
const (
	// ActionSubTypeStopEc2Instances is a ActionSubType enum value
	ActionSubTypeStopEc2Instances = "STOP_EC2_INSTANCES"

	// ActionSubTypeStopRdsInstances is a ActionSubType enum value
	ActionSubTypeStopRdsInstances = "STOP_RDS_INSTANCES"
)
View Source 
const (
	// ActionTypeApplyIamPolicy is a ActionType enum value
	ActionTypeApplyIamPolicy = "APPLY_IAM_POLICY"

	// ActionTypeApplyScpPolicy is a ActionType enum value
	ActionTypeApplyScpPolicy = "APPLY_SCP_POLICY"

	// ActionTypeRunSsmDocuments is a ActionType enum value
	ActionTypeRunSsmDocuments = "RUN_SSM_DOCUMENTS"
)
View Source 
const (
	// ApprovalModelAutomatic is a ApprovalModel enum value
	ApprovalModelAutomatic = "AUTOMATIC"

	// ApprovalModelManual is a ApprovalModel enum value
	ApprovalModelManual = "MANUAL"
)
View Source 
const (
	// AutoAdjustTypeHistorical is a AutoAdjustType enum value
	AutoAdjustTypeHistorical = "HISTORICAL"

	// AutoAdjustTypeForecast is a AutoAdjustType enum value
	AutoAdjustTypeForecast = "FORECAST"
)
View Source 
const (
	// BudgetTypeUsage is a BudgetType enum value
	BudgetTypeUsage = "USAGE"

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

	// BudgetTypeRiUtilization is a BudgetType enum value
	BudgetTypeRiUtilization = "RI_UTILIZATION"

	// BudgetTypeRiCoverage is a BudgetType enum value
	BudgetTypeRiCoverage = "RI_COVERAGE"

	// BudgetTypeSavingsPlansUtilization is a BudgetType enum value
	BudgetTypeSavingsPlansUtilization = "SAVINGS_PLANS_UTILIZATION"

	// BudgetTypeSavingsPlansCoverage is a BudgetType enum value
	BudgetTypeSavingsPlansCoverage = "SAVINGS_PLANS_COVERAGE"
)

The type of a budget. It must be one of the following types:

COST, USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, or SAVINGS_PLANS_COVERAGE.

View Source 
const (
	// ComparisonOperatorGreaterThan is a ComparisonOperator enum value
	ComparisonOperatorGreaterThan = "GREATER_THAN"

	// ComparisonOperatorLessThan is a ComparisonOperator enum value
	ComparisonOperatorLessThan = "LESS_THAN"

	// ComparisonOperatorEqualTo is a ComparisonOperator enum value
	ComparisonOperatorEqualTo = "EQUAL_TO"
)

The comparison operator of a notification. Currently, the service supports the following operators:

GREATER_THAN, LESS_THAN, EQUAL_TO

View Source 
const (
	// EventTypeSystem is a EventType enum value
	EventTypeSystem = "SYSTEM"

	// EventTypeCreateAction is a EventType enum value
	EventTypeCreateAction = "CREATE_ACTION"

	// EventTypeDeleteAction is a EventType enum value
	EventTypeDeleteAction = "DELETE_ACTION"

	// EventTypeUpdateAction is a EventType enum value
	EventTypeUpdateAction = "UPDATE_ACTION"

	// EventTypeExecuteAction is a EventType enum value
	EventTypeExecuteAction = "EXECUTE_ACTION"
)
View Source 
const (
	// ExecutionTypeApproveBudgetAction is a ExecutionType enum value
	ExecutionTypeApproveBudgetAction = "APPROVE_BUDGET_ACTION"

	// ExecutionTypeRetryBudgetAction is a ExecutionType enum value
	ExecutionTypeRetryBudgetAction = "RETRY_BUDGET_ACTION"

	// ExecutionTypeReverseBudgetAction is a ExecutionType enum value
	ExecutionTypeReverseBudgetAction = "REVERSE_BUDGET_ACTION"

	// ExecutionTypeResetBudgetAction is a ExecutionType enum value
	ExecutionTypeResetBudgetAction = "RESET_BUDGET_ACTION"
)
View Source 
const (
	// NotificationStateOk is a NotificationState enum value
	NotificationStateOk = "OK"

	// NotificationStateAlarm is a NotificationState enum value
	NotificationStateAlarm = "ALARM"
)
View Source 
const (
	// NotificationTypeActual is a NotificationType enum value
	NotificationTypeActual = "ACTUAL"

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

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

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

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

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

View Source 
const (
	// ThresholdTypePercentage is a ThresholdType enum value
	ThresholdTypePercentage = "PERCENTAGE"

	// ThresholdTypeAbsoluteValue is a ThresholdType enum value
	ThresholdTypeAbsoluteValue = "ABSOLUTE_VALUE"
)

The type of threshold for a notification.

View Source 
const (
	// TimeUnitDaily is a TimeUnit enum value
	TimeUnitDaily = "DAILY"

	// TimeUnitMonthly is a TimeUnit enum value
	TimeUnitMonthly = "MONTHLY"

	// TimeUnitQuarterly is a TimeUnit enum value
	TimeUnitQuarterly = "QUARTERLY"

	// TimeUnitAnnually is a TimeUnit enum value
	TimeUnitAnnually = "ANNUALLY"
)

The time unit of the budget, such as MONTHLY or QUARTERLY.

View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You are not authorized to use this operation with the given parameters.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeCreationLimitExceededException for service response error code
	// "CreationLimitExceededException".
	//
	// You've exceeded the notification or subscriber limit.
	ErrCodeCreationLimitExceededException = "CreationLimitExceededException"

	// ErrCodeDuplicateRecordException for service response error code
	// "DuplicateRecordException".
	//
	// The budget name already exists. Budget names must be unique within an account.
	ErrCodeDuplicateRecordException = "DuplicateRecordException"

	// ErrCodeExpiredNextTokenException for service response error code
	// "ExpiredNextTokenException".
	//
	// The pagination token expired.
	ErrCodeExpiredNextTokenException = "ExpiredNextTokenException"

	// ErrCodeInternalErrorException for service response error code
	// "InternalErrorException".
	//
	// An error on the server occurred during the processing of your request. Try
	// again later.
	ErrCodeInternalErrorException = "InternalErrorException"

	// ErrCodeInvalidNextTokenException for service response error code
	// "InvalidNextTokenException".
	//
	// The pagination token is invalid.
	ErrCodeInvalidNextTokenException = "InvalidNextTokenException"

	// ErrCodeInvalidParameterException for service response error code
	// "InvalidParameterException".
	//
	// An error on the client occurred. Typically, the cause is an invalid input
	// value.
	ErrCodeInvalidParameterException = "InvalidParameterException"

	// ErrCodeNotFoundException for service response error code
	// "NotFoundException".
	//
	// We can’t locate the resource that you specified.
	ErrCodeNotFoundException = "NotFoundException"

	// ErrCodeResourceLockedException for service response error code
	// "ResourceLockedException".
	//
	// The request was received and recognized by the server, but the server rejected
	// that particular method for the requested resource.
	ErrCodeResourceLockedException = "ResourceLockedException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The number of API requests has exceeded the maximum allowed API request throttling
	// limit for the account.
	ErrCodeThrottlingException = "ThrottlingException"
)
View Source 
const (
	ServiceName = "budgets"   // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "Budgets"   // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func ActionStatus_Values added in v1.35.8 

func ActionStatus_Values() []string

ActionStatus_Values returns all elements of the ActionStatus enum

func ActionSubType_Values added in v1.35.8 

func ActionSubType_Values() []string

ActionSubType_Values returns all elements of the ActionSubType enum

func ActionType_Values added in v1.35.8 

func ActionType_Values() []string

ActionType_Values returns all elements of the ActionType enum

func ApprovalModel_Values added in v1.35.8 

func ApprovalModel_Values() []string

ApprovalModel_Values returns all elements of the ApprovalModel enum

func AutoAdjustType_Values added in v1.43.0 

func AutoAdjustType_Values() []string

AutoAdjustType_Values returns all elements of the AutoAdjustType enum

func BudgetType_Values added in v1.34.3 

func BudgetType_Values() []string

BudgetType_Values returns all elements of the BudgetType enum

func ComparisonOperator_Values added in v1.34.3 

func ComparisonOperator_Values() []string

ComparisonOperator_Values returns all elements of the ComparisonOperator enum

func EventType_Values added in v1.35.8 

func EventType_Values() []string

EventType_Values returns all elements of the EventType enum

func ExecutionType_Values added in v1.35.8 

func ExecutionType_Values() []string

ExecutionType_Values returns all elements of the ExecutionType enum

func NotificationState_Values added in v1.34.3 

func NotificationState_Values() []string

NotificationState_Values returns all elements of the NotificationState enum

func NotificationType_Values added in v1.34.3 

func NotificationType_Values() []string

NotificationType_Values returns all elements of the NotificationType enum

func SubscriptionType_Values added in v1.34.3 

func SubscriptionType_Values() []string

SubscriptionType_Values returns all elements of the SubscriptionType enum

func ThresholdType_Values added in v1.34.3 

func ThresholdType_Values() []string

ThresholdType_Values returns all elements of the ThresholdType enum

func TimeUnit_Values added in v1.34.3 

func TimeUnit_Values() []string

TimeUnit_Values returns all elements of the TimeUnit enum

Types

type AccessDeniedException added in v1.28.0 

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error message the exception carries.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

You are not authorized to use this operation with the given parameters.

func (*AccessDeniedException) Code added in v1.28.0 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error added in v1.28.0 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString added in v1.28.0 

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message added in v1.28.0 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr added in v1.28.0 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID added in v1.28.0 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode added in v1.28.0 

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String added in v1.28.0 

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Action added in v1.35.8 

type Action struct {

	// A system-generated universally unique identifier (UUID) for the action.
	//
	// ActionId is a required field
	ActionId *string `min:"36" type:"string" required:"true"`

	// The trigger threshold of the action.
	//
	// ActionThreshold is a required field
	ActionThreshold *ActionThreshold `type:"structure" required:"true"`

	// 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.
	//
	// ActionType is a required field
	ActionType *string `type:"string" required:"true" enum:"ActionType"`

	// This specifies if the action needs manual or automatic approval.
	//
	// ApprovalModel is a required field
	ApprovalModel *string `type:"string" required:"true" enum:"ApprovalModel"`

	// A string that represents the budget name. The ":" and "\" characters, and
	// the "/action/" substring, aren't allowed.
	//
	// BudgetName is a required field
	BudgetName *string `min:"1" type:"string" required:"true"`

	// Where you specify all of the type-specific parameters.
	//
	// Definition is a required field
	Definition *Definition `type:"structure" required:"true"`

	// The role passed for action execution and reversion. Roles and actions must
	// be in the same account.
	//
	// ExecutionRoleArn is a required field
	ExecutionRoleArn *string `min:"32" type:"string" required:"true"`

	// The type of a notification. It must be ACTUAL or FORECASTED.
	//
	// NotificationType is a required field
	NotificationType *string `type:"string" required:"true" enum:"NotificationType"`

	// The status of the action.
	//
	// Status is a required field
	Status *string `type:"string" required:"true" enum:"ActionStatus"`

	// A list of subscribers.
	//
	// Subscribers is a required field
	Subscribers []*Subscriber `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

A budget action resource.

func (Action) GoString added in v1.35.8 

func (s Action) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Action) SetActionId added in v1.35.8 

func (s *Action) SetActionId(v string) *Action

SetActionId sets the ActionId field's value.

func (*Action) SetActionThreshold added in v1.35.8 

func (s *Action) SetActionThreshold(v *ActionThreshold) *Action

SetActionThreshold sets the ActionThreshold field's value.

func (*Action) SetActionType added in v1.35.8 

func (s *Action) SetActionType(v string) *Action

SetActionType sets the ActionType field's value.

func (*Action) SetApprovalModel added in v1.35.8 

func (s *Action) SetApprovalModel(v string) *Action

SetApprovalModel sets the ApprovalModel field's value.

func (*Action) SetBudgetName added in v1.35.8 

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

SetBudgetName sets the BudgetName field's value.

func (*Action) SetDefinition added in v1.35.8 

func (s *Action) SetDefinition(v *Definition) *Action

SetDefinition sets the Definition field's value.

func (*Action) SetExecutionRoleArn added in v1.35.8 

func (s *Action) SetExecutionRoleArn(v string) *Action

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*Action) SetNotificationType added in v1.35.8 

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

SetNotificationType sets the NotificationType field's value.

func (*Action) SetStatus added in v1.35.8 

func (s *Action) SetStatus(v string) *Action

SetStatus sets the Status field's value.

func (*Action) SetSubscribers added in v1.35.8 

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

SetSubscribers sets the Subscribers field's value.

func (Action) String added in v1.35.8 

func (s Action) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ActionHistory added in v1.35.8 

type ActionHistory struct {

	// The description of the details for the event.
	//
	// ActionHistoryDetails is a required field
	ActionHistoryDetails *ActionHistoryDetails `type:"structure" required:"true"`

	// This distinguishes between whether the events are triggered by the user or
	// are generated by the system.
	//
	// EventType is a required field
	EventType *string `type:"string" required:"true" enum:"EventType"`

	// The status of action at the time of the event.
	//
	// Status is a required field
	Status *string `type:"string" required:"true" enum:"ActionStatus"`

	// A generic time stamp. In Java, it's transformed to a Date object.
	//
	// Timestamp is a required field
	Timestamp *time.Time `type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

The historical records for a budget action.

func (ActionHistory) GoString added in v1.35.8 

func (s ActionHistory) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActionHistory) SetActionHistoryDetails added in v1.35.8 

func (s *ActionHistory) SetActionHistoryDetails(v *ActionHistoryDetails) *ActionHistory

SetActionHistoryDetails sets the ActionHistoryDetails field's value.

func (*ActionHistory) SetEventType added in v1.35.8 

func (s *ActionHistory) SetEventType(v string) *ActionHistory

SetEventType sets the EventType field's value.

func (*ActionHistory) SetStatus added in v1.35.8 

func (s *ActionHistory) SetStatus(v string) *ActionHistory

SetStatus sets the Status field's value.

func (*ActionHistory) SetTimestamp added in v1.35.8 

func (s *ActionHistory) SetTimestamp(v time.Time) *ActionHistory

SetTimestamp sets the Timestamp field's value.

func (ActionHistory) String added in v1.35.8 

func (s ActionHistory) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ActionHistoryDetails added in v1.35.8 

type ActionHistoryDetails struct {

	// The budget action resource.
	//
	// Action is a required field
	Action *Action `type:"structure" required:"true"`

	// A generic string.
	//
	// Message is a required field
	Message *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The description of the details for the event.

func (ActionHistoryDetails) GoString added in v1.35.8 

func (s ActionHistoryDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActionHistoryDetails) SetAction added in v1.35.8 

func (s *ActionHistoryDetails) SetAction(v *Action) *ActionHistoryDetails

SetAction sets the Action field's value.

func (*ActionHistoryDetails) SetMessage added in v1.35.8 

func (s *ActionHistoryDetails) SetMessage(v string) *ActionHistoryDetails

SetMessage sets the Message field's value.

func (ActionHistoryDetails) String added in v1.35.8 

func (s ActionHistoryDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ActionThreshold added in v1.35.8 

type ActionThreshold struct {

	// The type of threshold for a notification.
	//
	// ActionThresholdType is a required field
	ActionThresholdType *string `type:"string" required:"true" enum:"ThresholdType"`

	// The threshold of a notification.
	//
	// ActionThresholdValue is a required field
	ActionThresholdValue *float64 `type:"double" required:"true"`
	// contains filtered or unexported fields
}

The trigger threshold of the action.

func (ActionThreshold) GoString added in v1.35.8 

func (s ActionThreshold) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActionThreshold) SetActionThresholdType added in v1.35.8 

func (s *ActionThreshold) SetActionThresholdType(v string) *ActionThreshold

SetActionThresholdType sets the ActionThresholdType field's value.

func (*ActionThreshold) SetActionThresholdValue added in v1.35.8 

func (s *ActionThreshold) SetActionThresholdValue(v float64) *ActionThreshold

SetActionThresholdValue sets the ActionThresholdValue field's value.

func (ActionThreshold) String added in v1.35.8 

func (s ActionThreshold) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActionThreshold) Validate added in v1.35.8 

func (s *ActionThreshold) Validate() error

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

type AutoAdjustData added in v1.43.0 

type AutoAdjustData struct {

	// The string that defines whether your budget auto-adjusts based on historical
	// or forecasted data.
	//
	// AutoAdjustType is a required field
	AutoAdjustType *string `type:"string" required:"true" enum:"AutoAdjustType"`

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

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

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

func (AutoAdjustData) GoString added in v1.43.0 

func (s AutoAdjustData) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoAdjustData) SetAutoAdjustType added in v1.43.0 

func (s *AutoAdjustData) SetAutoAdjustType(v string) *AutoAdjustData

SetAutoAdjustType sets the AutoAdjustType field's value.

func (*AutoAdjustData) SetHistoricalOptions added in v1.43.0 

func (s *AutoAdjustData) SetHistoricalOptions(v *HistoricalOptions) *AutoAdjustData

SetHistoricalOptions sets the HistoricalOptions field's value.

func (*AutoAdjustData) SetLastAutoAdjustTime added in v1.43.0 

func (s *AutoAdjustData) SetLastAutoAdjustTime(v time.Time) *AutoAdjustData

SetLastAutoAdjustTime sets the LastAutoAdjustTime field's value.

func (AutoAdjustData) String added in v1.43.0 

func (s AutoAdjustData) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AutoAdjustData) Validate added in v1.43.0 

func (s *AutoAdjustData) Validate() error

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

type Budget 

type Budget struct {

	// The parameters that determine the budget amount for an auto-adjusting budget.
	AutoAdjustData *AutoAdjustData `type:"structure"`

	// The total amount of cost, usage, RI utilization, RI coverage, Savings Plans
	// utilization, or Savings Plans coverage that you want to track with your budget.
	//
	// BudgetLimit is required for cost or usage budgets, but optional for RI or
	// Savings Plans utilization or coverage budgets. RI and Savings Plans utilization
	// or coverage budgets default to 100. This is the only valid value for RI or
	// Savings Plans utilization or coverage budgets. You can't use BudgetLimit
	// with PlannedBudgetLimits for CreateBudget and UpdateBudget actions.
	BudgetLimit *Spend `type:"structure"`

	// The name of a budget. The name must be unique within an account. The : and
	// \ characters, and the "/action/" substring, aren't allowed in BudgetName.
	//
	// BudgetName is a required field
	BudgetName *string `min:"1" type:"string" required:"true"`

	// Specifies whether this budget tracks costs, usage, RI utilization, RI coverage,
	// Savings Plans utilization, or Savings Plans coverage.
	//
	// BudgetType is a required field
	BudgetType *string `type:"string" required:"true" enum:"BudgetType"`

	// The actual and forecasted cost or usage that the budget tracks.
	CalculatedSpend *CalculatedSpend `type:"structure"`

	// The cost filters, such as Region, Service, member account, Tag, or Cost Category,
	// that are applied to a budget.
	//
	// Amazon Web Services Budgets supports the following services as a Service
	// filter for RI budgets:
	//
	//    * Amazon EC2
	//
	//    * Amazon Redshift
	//
	//    * Amazon Relational Database Service
	//
	//    * Amazon ElastiCache
	//
	//    * Amazon OpenSearch Service
	CostFilters map[string][]*string `type:"map"`

	// The types of costs that are included in this COST budget.
	//
	// USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, and SAVINGS_PLANS_COVERAGE
	// budgets do not have CostTypes.
	CostTypes *CostTypes `type:"structure"`

	// The last time that you updated this budget.
	LastUpdatedTime *time.Time `type:"timestamp"`

	// A map containing multiple BudgetLimit, including current or future limits.
	//
	// PlannedBudgetLimits is available for cost or usage budget and supports both
	// monthly and quarterly TimeUnit.
	//
	// For monthly budgets, provide 12 months of PlannedBudgetLimits values. This
	// must start from the current month and include the next 11 months. The key
	// is the start of the month, UTC in epoch seconds.
	//
	// For quarterly budgets, provide four quarters of PlannedBudgetLimits value
	// entries in standard calendar quarter increments. This must start from the
	// current quarter and include the next three quarters. The key is the start
	// of the quarter, UTC in epoch seconds.
	//
	// If the planned budget expires before 12 months for monthly or four quarters
	// for quarterly, provide the PlannedBudgetLimits values only for the remaining
	// periods.
	//
	// If the budget begins at a date in the future, provide PlannedBudgetLimits
	// values from the start date of the budget.
	//
	// After all of the BudgetLimit values in PlannedBudgetLimits are used, the
	// budget continues to use the last limit as the BudgetLimit. At that point,
	// the planned budget provides the same experience as a fixed budget.
	//
	// DescribeBudget and DescribeBudgets response along with PlannedBudgetLimits
	// also contain BudgetLimit representing the current month or quarter limit
	// present in PlannedBudgetLimits. This only applies to budgets that are created
	// with PlannedBudgetLimits. Budgets that are created without PlannedBudgetLimits
	// only contain BudgetLimit. They don't contain PlannedBudgetLimits.
	PlannedBudgetLimits map[string]*Spend `type:"map"`

	// The period of time that's covered by a budget. You setthe start date and
	// end date. The start date must come before the end date. The end date must
	// come before 06/15/87 00:00 UTC.
	//
	// If you create your budget and don't specify a start date, Amazon Web Services
	// defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY,
	// or ANNUALLY). For example, if you created your budget on January 24, 2018,
	// chose DAILY, and didn't set a start date, Amazon Web Services set your start
	// date to 01/24/18 00:00 UTC. If you chose MONTHLY, Amazon Web Services set
	// your start date to 01/01/18 00:00 UTC. If you didn't specify an end date,
	// Amazon Web Services set your end date to 06/15/87 00:00 UTC. The defaults
	// are the same for the Billing and Cost Management console and the API.
	//
	// You can change either date with the UpdateBudget operation.
	//
	// After the end date, Amazon Web Services deletes the budget and all the associated
	// notifications and subscribers.
	TimePeriod *TimePeriod `type:"structure"`

	// The length of time until a budget resets the actual and forecasted spend.
	//
	// TimeUnit is a required field
	TimeUnit *string `type:"string" required:"true" enum:"TimeUnit"`
	// contains filtered or unexported fields
}

Represents the output of the CreateBudget operation. The content consists of the detailed metadata and data file information, and the current status of the budget object.

This is the Amazon Resource Name (ARN) pattern for a budget:

arn:aws:budgets::AccountId:budget/budgetName

func (Budget) GoString 

func (s Budget) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Budget) SetAutoAdjustData added in v1.43.0 

func (s *Budget) SetAutoAdjustData(v *AutoAdjustData) *Budget

SetAutoAdjustData sets the AutoAdjustData field's value.

func (*Budget) SetBudgetLimit added in v1.5.0 

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

SetBudgetLimit sets the BudgetLimit field's value.

func (*Budget) SetBudgetName added in v1.5.0 

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

SetBudgetName sets the BudgetName field's value.

func (*Budget) SetBudgetType added in v1.5.0 

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

SetBudgetType sets the BudgetType field's value.

func (*Budget) SetCalculatedSpend added in v1.5.0 

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

SetCalculatedSpend sets the CalculatedSpend field's value.

func (*Budget) SetCostFilters added in v1.5.0 

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

SetCostFilters sets the CostFilters field's value.

func (*Budget) SetCostTypes added in v1.5.0 

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

SetCostTypes sets the CostTypes field's value.

func (*Budget) SetLastUpdatedTime added in v1.15.74 

func (s *Budget) SetLastUpdatedTime(v time.Time) *Budget

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*Budget) SetPlannedBudgetLimits added in v1.19.36 

func (s *Budget) SetPlannedBudgetLimits(v map[string]*Spend) *Budget

SetPlannedBudgetLimits sets the PlannedBudgetLimits field's value.

func (*Budget) SetTimePeriod added in v1.5.0 

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

SetTimePeriod sets the TimePeriod field's value.

func (*Budget) SetTimeUnit added in v1.5.0 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Budget) Validate 

func (s *Budget) Validate() error

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

type BudgetNotificationsForAccount added in v1.43.2 

type BudgetNotificationsForAccount struct {

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

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

The budget name and associated notifications for an account.

func (BudgetNotificationsForAccount) GoString added in v1.43.2 

func (s BudgetNotificationsForAccount) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BudgetNotificationsForAccount) SetBudgetName added in v1.43.2 

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

SetBudgetName sets the BudgetName field's value.

func (*BudgetNotificationsForAccount) SetNotifications added in v1.43.2 

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

SetNotifications sets the Notifications field's value.

func (BudgetNotificationsForAccount) String added in v1.43.2 

func (s BudgetNotificationsForAccount) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BudgetPerformanceHistory added in v1.15.74 

type BudgetPerformanceHistory struct {

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

	// The type of a budget. It must be one of the following types:
	//
	// COST, USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, or SAVINGS_PLANS_COVERAGE.
	BudgetType *string `type:"string" enum:"BudgetType"`

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

	// The history of the cost filters for a budget during the specified time period.
	CostFilters map[string][]*string `type:"map"`

	// The history of the cost types for a budget during the specified time period.
	CostTypes *CostTypes `type:"structure"`

	// The time unit of the budget, such as MONTHLY or QUARTERLY.
	TimeUnit *string `type:"string" enum:"TimeUnit"`
	// contains filtered or unexported fields
}

A history of the state of a budget at the end of the budget's specified time period.

func (BudgetPerformanceHistory) GoString added in v1.15.74 

func (s BudgetPerformanceHistory) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BudgetPerformanceHistory) SetBudgetName added in v1.15.74 

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

SetBudgetName sets the BudgetName field's value.

func (*BudgetPerformanceHistory) SetBudgetType added in v1.15.74 

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

SetBudgetType sets the BudgetType field's value.

func (*BudgetPerformanceHistory) SetBudgetedAndActualAmountsList added in v1.15.74 

func (s *BudgetPerformanceHistory) SetBudgetedAndActualAmountsList(v []*BudgetedAndActualAmounts) *BudgetPerformanceHistory

SetBudgetedAndActualAmountsList sets the BudgetedAndActualAmountsList field's value.

func (*BudgetPerformanceHistory) SetCostFilters added in v1.15.74 

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

SetCostFilters sets the CostFilters field's value.

func (*BudgetPerformanceHistory) SetCostTypes added in v1.15.74 

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

SetCostTypes sets the CostTypes field's value.

func (*BudgetPerformanceHistory) SetTimeUnit added in v1.15.74 

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

SetTimeUnit sets the TimeUnit field's value.

func (BudgetPerformanceHistory) String added in v1.15.74 

func (s BudgetPerformanceHistory) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BudgetedAndActualAmounts added in v1.15.74 

type BudgetedAndActualAmounts struct {

	// Your actual costs or usage for a budget period.
	ActualAmount *Spend `type:"structure"`

	// The amount of cost or usage that you created the budget for.
	BudgetedAmount *Spend `type:"structure"`

	// The time period that's covered by this budget comparison.
	TimePeriod *TimePeriod `type:"structure"`
	// contains filtered or unexported fields
}

The amount of cost or usage that you created the budget for, compared to your actual costs or usage.

func (BudgetedAndActualAmounts) GoString added in v1.15.74 

func (s BudgetedAndActualAmounts) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BudgetedAndActualAmounts) SetActualAmount added in v1.15.74 

func (s *BudgetedAndActualAmounts) SetActualAmount(v *Spend) *BudgetedAndActualAmounts

SetActualAmount sets the ActualAmount field's value.

func (*BudgetedAndActualAmounts) SetBudgetedAmount added in v1.15.74 

func (s *BudgetedAndActualAmounts) SetBudgetedAmount(v *Spend) *BudgetedAndActualAmounts

SetBudgetedAmount sets the BudgetedAmount field's value.

func (*BudgetedAndActualAmounts) SetTimePeriod added in v1.15.74 

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

SetTimePeriod sets the TimePeriod field's value.

func (BudgetedAndActualAmounts) String added in v1.15.74 

func (s BudgetedAndActualAmounts) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Budgets 

type Budgets struct {
	*client.Client
}

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

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

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *Budgets

New creates a new instance of the Budgets client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a Budgets client from just a session.
svc := budgets.New(mySession)

// Create a Budgets client with additional configuration
svc := budgets.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*Budgets) CreateBudget 

func (c *Budgets) CreateBudget(input *CreateBudgetInput) (*CreateBudgetOutput, error)

CreateBudget API operation for AWS Budgets.

Creates a budget and, if included, notifications and subscribers.

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.

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 Types:

  • InvalidParameterException An error on the client occurred. Typically, the cause is an invalid input value.

  • InternalErrorException An error on the server occurred during the processing of your request. Try again later.

  • CreationLimitExceededException You've exceeded the notification or subscriber limit.

  • DuplicateRecordException The budget name already exists. Budget names must be unique within an account.

  • AccessDeniedException You are not authorized to use this operation with the given parameters.

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

func (*Budgets) CreateBudgetAction added in v1.35.8 

func (c *Budgets) CreateBudgetAction(input *CreateBudgetActionInput) (*CreateBudgetActionOutput, error)

CreateBudgetAction API operation for AWS Budgets.

Creates a budget action.

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 CreateBudgetAction for usage and error information.

Returned Error Types:

  • InvalidParameterException An error on the client occurred. Typically, the cause is an invalid input value.

  • InternalErrorException An error on the server occurred during the processing of your request. Try again later.

  • CreationLimitExceededException You've exceeded the notification or subscriber limit.

  • DuplicateRecordException The budget name already exists. Budget names must be unique within an account.

  • NotFoundException We can’t locate the resource that you specified.

  • AccessDeniedException You are not authorized to use this operation with the given parameters.

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

func (*Budgets) CreateBudgetActionRequest added in v1.35.8 

func (c *Budgets) CreateBudgetActionRequest(input *CreateBudgetActionInput) (req *request.Request, output *CreateBudgetActionOutput)

CreateBudgetActionRequest generates a "aws/request.Request" representing the client's request for the CreateBudgetAction operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateBudgetAction for more information on using the CreateBudgetAction API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateBudgetActionRequest method.
req, resp := client.CreateBudgetActionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Budgets) CreateBudgetActionWithContext added in v1.35.8 

func (c *Budgets) CreateBudgetActionWithContext(ctx aws.Context, input *CreateBudgetActionInput, opts ...request.Option) (*CreateBudgetActionOutput, error)

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

See CreateBudgetAction 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) CreateBudgetRequest 

func (c *Budgets) CreateBudgetRequest(input *CreateBudgetInput) (req *request.Request, output *CreateBudgetOutput)

CreateBudgetRequest generates a "aws/request.Request" representing the client's request for the CreateBudget operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateBudget for more information on using the CreateBudget API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateBudgetRequest method.
req, resp := client.CreateBudgetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Budgets) CreateBudgetWithContext added in v1.8.0 

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

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

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

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

func (*Budgets) CreateNotification 

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

CreateNotification API operation for AWS Budgets.

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

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

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

Returned Error Types:

  • InternalErrorException An error on the server occurred during the processing of your request. Try again later.

  • InvalidParameterException An error on the client occurred. Typically, the cause is an invalid input value.

  • NotFoundException We can’t locate the resource that you specified.

  • CreationLimitExceededException You've exceeded the notification or subscriber limit.

  • DuplicateRecordException The budget name already exists. Budget names must be unique within an account.

  • AccessDeniedException You are not authorized to use this operation with the given parameters.

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

func (*Budgets) CreateNotificationRequest 

func (c *Budgets) CreateNotificationRequest(input *CreateNotificationInput) (req *request.Request, output *CreateNotificationOutput)

CreateNotificationRequest generates a "aws/request.Request" representing the client's request for the CreateNotification operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateNotification for more information on using the CreateNotification API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateNotificationRequest method.
req, resp := client.CreateNotificationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Budgets) CreateNotificationWithContext added in v1.8.0 

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

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

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

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

func (*Budgets) CreateSubscriber 

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

CreateSubscriber API operation for AWS Budgets.

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

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

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

Returned Error Types:

  • InternalErrorException An error on the server occurred during the processing of your request. Try again later.

  • InvalidParameterException An error on the client occurred. Typically, the cause is an invalid input value.

  • CreationLimitExceededException You've exceeded the notification or subscriber limit.

  • DuplicateRecordException The budget name already exists. Budget names must be unique within an account.

  • NotFoundException We can’t locate the resource that you specified.

  • AccessDeniedException You are not authorized to use this operation with the given parameters.

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

func (*Budgets) CreateSubscriberRequest 

func (c *Budgets) CreateSubscriberRequest(input *CreateSubscriberInput) (req *request.Request, output *CreateSubscriberOutput)

CreateSubscriberRequest generates a "aws/request.Request" representing the client's request for the CreateSubscriber operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateSubscriber for more information on using the CreateSubscriber API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateSubscriberRequest method.
req, resp := client.CreateSubscriberRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Budgets) CreateSubscriberWithContext added in v1.8.0 

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

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

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

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

func (*Budgets) DeleteBudget 

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

DeleteBudget API operation for AWS Budgets.

Deletes a budget. You can delete your budget at any time.

Deleting a budget also deletes the notifications and subscribers that are associated with that budget.

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

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

Returned Error Types:

  • InternalErrorException An error on the server occurred during the processing of your request. Try again later.

  • InvalidParameterException An error on the client occurred. Typically, the cause is an invalid input value.

  • NotFoundException We can’t locate the resource that you specified.

  • AccessDeniedException You are not authorized to use this operation with the given parameters.

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

func (*Budgets) DeleteBudgetAction added in v1.35.8 

func (c *Budgets) DeleteBudgetAction(input *DeleteBudgetActionInput) (*DeleteBudgetActionOutput, error)

DeleteBudgetAction API operation for AWS Budgets.

Deletes a budget action.

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 DeleteBudgetAction for usage and error information.

Returned Error Types:

  • InternalErrorException An error on the server occurred during the processing of your request. Try again later.

  • InvalidParameterException An error on the client occurred. Typically, the cause is an invalid input value.

  • NotFoundException We can’t locate the resource that you specified.

  • AccessDeniedException You are not authorized to use this operation with the given parameters.

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

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

func (*Budgets) DeleteBudgetActionRequest added in v1.35.8 

func (c *Budgets) DeleteBudgetActionRequest(input *DeleteBudgetActionInput) (req *request.Request, output *DeleteBudgetActionOutput)

DeleteBudgetActionRequest generates a "aws/request.Request" representing the client's request for the DeleteBudgetAction operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteBudgetAction for more information on using the DeleteBudgetAction API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteBudgetActionRequest method.
req, resp := client.DeleteBudgetActionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Budgets) DeleteBudgetActionWithContext added in v1.35.8 

func (c *Budgets) DeleteBudgetActionWithContext(ctx aws.Context, input *DeleteBudgetActionInput, opts ...request.Option) (*DeleteBudgetActionOutput, error)

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

See DeleteBudgetAction 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) DeleteBudgetRequest 

func (c *Budgets) DeleteBudgetRequest(input *DeleteBudgetInput) (req *request.Request, output *DeleteBudgetOutput)

DeleteBudgetRequest generates a "aws/request.Request" representing the client's request for the DeleteBudget operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteBudget for more information on using the DeleteBudget API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteBudgetRequest method.
req, resp := client.DeleteBudgetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Budgets) DeleteBudgetWithContext added in v1.8.0 

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

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

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

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

func (*Budgets) DeleteNotification 

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

DeleteNotification API operation for AWS Budgets.

Deletes a notification.

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

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

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

Returned Error Types:

  • InvalidParameterException An error on the client occurred. Typically, the cause is an invalid input value.

  • InternalErrorException An error on the server occurred during the processing of your request. Try again later.

  • NotFoundException We can’t locate the resource that you specified.

  • AccessDeniedException You are not authorized to use this operation with the given parameters.

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

func (*Budgets) DeleteNotificationRequest 

func (c *Budgets) DeleteNotificationRequest(input *DeleteNotificationInput) (req *request.Request, output *DeleteNotificationOutput)

DeleteNotificationRequest generates a "aws/request.Request" representing the client's request for the DeleteNotification operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteNotification for more information on using the DeleteNotification API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteNotificationRequest method.
req, resp := client.DeleteNotificationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Budgets) DeleteNotificationWithContext added in v1.8.0 

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

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

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

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

func (*Budgets) DeleteSubscriber 

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

DeleteSubscriber API operation for AWS Budgets.

Deletes a subscriber.

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

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

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

Returned Error Types:

  • InternalErrorException An error on the server occurred during the processing of your request. Try again later.

  • InvalidParameterException An error on the client occurred. Typically, the cause is an invalid input value.

  • NotFoundException We can’t locate the resource that you specified.

  • AccessDeniedException You are not authorized to use this operation with the given parameters.

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

func (*Budgets) DeleteSubscriberRequest 

func (c *Budgets) DeleteSubscriberRequest(input *DeleteSubscriberInput) (req *request.Request, output *DeleteSubscriberOutput)

DeleteSubscriberRequest generates a "aws/request.Request" representing the client's request for the DeleteSubscriber operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteSubscriber for more information on using the DeleteSubscriber API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteSubscriberRequest method.
req, resp := client.DeleteSubscriberRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Budgets) DeleteSubscriberWithContext added in v1.8.0 

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

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

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

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

func (*Budgets) DescribeBudget 

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

DescribeBudget API operation for AWS Budgets.

Describes a budget.

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.

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 Types:

  • InternalErrorException An error on the server occurred during the processing of your request. Try again later.

  • InvalidParameterException An error on the client occurred. Typically, the cause is an invalid input value.

  • NotFoundException We can’t locate the resource that you specified.

  • AccessDeniedException You are not authorized to use this operation with the given parameters.

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

func (*Budgets) DescribeBudgetAction added in v1.35.8 

func (c *Budgets) DescribeBudgetAction(input *DescribeBudgetActionInput) (*DescribeBudgetActionOutput, error)

DescribeBudgetAction API operation for AWS Budgets.

Describes a budget action detail.

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 DescribeBudgetAction for usage and error information.

Returned Error Types:

  • InternalErrorException An error on the server occurred during the processing of your request. Try again later.

  • InvalidParameterException An error on the client occurred. Typically, the cause is an invalid input value.

  • NotFoundException We can’t locate the resource that you specified.

  • AccessDeniedException You are not authorized to use this operation with the given parameters.

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

func (*Budgets) DescribeBudgetActionHistories added in v1.35.8 

func (c *Budgets) DescribeBudgetActionHistories(input *DescribeBudgetActionHistoriesInput) (*DescribeBudgetActionHistoriesOutput, error)

DescribeBudgetActionHistories API operation for AWS Budgets.

Describes a budget action history detail.

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 DescribeBudgetActionHistories for usage and error information.

Returned Error Types:

  • InternalErrorException An error on the server occurred during the processing of your request. Try again later.

  • InvalidParameterException An error on the client occurred. Typically, the cause is an invalid input value.

  • NotFoundException We can’t locate the resource that you specified.

  • AccessDeniedException You are not authorized to use this operation with the given parameters.

  • InvalidNextTokenException The pagination token is invalid.

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

func (*Budgets) DescribeBudgetActionHistoriesPages added in v1.35.8 

func (c *Budgets) DescribeBudgetActionHistoriesPages(input *DescribeBudgetActionHistoriesInput, fn func(*DescribeBudgetActionHistoriesOutput, bool) bool) error

DescribeBudgetActionHistoriesPages iterates over the pages of a DescribeBudgetActionHistories operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeBudgetActionHistories method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeBudgetActionHistories operation.
pageNum := 0
err := client.DescribeBudgetActionHistoriesPages(params,
    func(page *budgets.DescribeBudgetActionHistoriesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Budgets) DescribeBudgetActionHistoriesPagesWithContext added in v1.35.8 

func (c *Budgets) DescribeBudgetActionHistoriesPagesWithContext(ctx aws.Context, input *DescribeBudgetActionHistoriesInput, fn func(*DescribeBudgetActionHistoriesOutput, bool) bool, opts ...request.Option) error

DescribeBudgetActionHistoriesPagesWithContext same as DescribeBudgetActionHistoriesPages except it takes a Context and allows setting request options on the pages.

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) DescribeBudgetActionHistoriesRequest added in v1.35.8 

func (c *Budgets) DescribeBudgetActionHistoriesRequest(input *DescribeBudgetActionHistoriesInput) (req *request.Request, output *DescribeBudgetActionHistoriesOutput)

DescribeBudgetActionHistoriesRequest generates a "aws/request.Request" representing the client's request for the DescribeBudgetActionHistories operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeBudgetActionHistories for more information on using the DescribeBudgetActionHistories API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeBudgetActionHistoriesRequest method.
req, resp := client.DescribeBudgetActionHistoriesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Budgets) DescribeBudgetActionHistoriesWithContext added in v1.35.8 

func (c *Budgets) DescribeBudgetActionHistoriesWithContext(ctx aws.Context, input *DescribeBudgetActionHistoriesInput, opts ...request.Option) (*DescribeBudgetActionHistoriesOutput, error)

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

See DescribeBudgetActionHistories 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) DescribeBudgetActionRequest added in v1.35.8 

func (c *Budgets) DescribeBudgetActionRequest(input *DescribeBudgetActionInput) (req *request.Request, output *DescribeBudgetActionOutput)

DescribeBudgetActionRequest generates a "aws/request.Request" representing the client's request for the DescribeBudgetAction operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeBudgetAction for more information on using the DescribeBudgetAction API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeBudgetActionRequest method.
req, resp := client.DescribeBudgetActionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Budgets) DescribeBudgetActionWithContext added in v1.35.8 

func (c *Budgets) DescribeBudgetActionWithContext(ctx aws.Context, input *DescribeBudgetActionInput, opts ...request.Option) (*DescribeBudgetActionOutput, error)

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

See DescribeBudgetAction 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) DescribeBudgetActionsForAccount added in v1.35.8 

func (c *Budgets) DescribeBudgetActionsForAccount(input *DescribeBudgetActionsForAccountInput) (*DescribeBudgetActionsForAccountOutput, error)

DescribeBudgetActionsForAccount API operation for AWS Budgets.

Describes all of the budget actions 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 DescribeBudgetActionsForAccount for usage and error information.

Returned Error Types:

  • InternalErrorException An error on the server occurred during the processing of your request. Try again later.

  • InvalidParameterException An error on the client occurred. Typically, the cause is an invalid input value.

  • AccessDeniedException You are not authorized to use this operation with the given parameters.

  • InvalidNextTokenException The pagination token is invalid.

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

func (*Budgets) DescribeBudgetActionsForAccountPages added in v1.35.8 

func (c *Budgets) DescribeBudgetActionsForAccountPages(input *DescribeBudgetActionsForAccountInput, fn func(*DescribeBudgetActionsForAccountOutput, bool) bool) error

DescribeBudgetActionsForAccountPages iterates over the pages of a DescribeBudgetActionsForAccount operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeBudgetActionsForAccount method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeBudgetActionsForAccount operation.
pageNum := 0
err := client.DescribeBudgetActionsForAccountPages(params,
    func(page *budgets.DescribeBudgetActionsForAccountOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Budgets) DescribeBudgetActionsForAccountPagesWithContext added in v1.35.8 

func (c *Budgets) DescribeBudgetActionsForAccountPagesWithContext(ctx aws.Context, input *DescribeBudgetActionsForAccountInput, fn func(*DescribeBudgetActionsForAccountOutput, bool) bool, opts ...request.Option) error

DescribeBudgetActionsForAccountPagesWithContext same as DescribeBudgetActionsForAccountPages except it takes a Context and allows setting request options on the pages.

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) DescribeBudgetActionsForAccountRequest added in v1.35.8 

func (c *Budgets) DescribeBudgetActionsForAccountRequest(input *DescribeBudgetActionsForAccountInput) (req *request.Request, output *DescribeBudgetActionsForAccountOutput)

DescribeBudgetActionsForAccountRequest generates a "aws/request.Request" representing the client's request for the DescribeBudgetActionsForAccount operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeBudgetActionsForAccount for more information on using the DescribeBudgetActionsForAccount API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeBudgetActionsForAccountRequest method.
req, resp := client.DescribeBudgetActionsForAccountRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Budgets) DescribeBudgetActionsForAccountWithContext added in v1.35.8 

func (c *Budgets) DescribeBudgetActionsForAccountWithContext(ctx aws.Context, input *DescribeBudgetActionsForAccountInput, opts ...request.Option) (*DescribeBudgetActionsForAccountOutput, error)

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

See DescribeBudgetActionsForAccount 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) DescribeBudgetActionsForBudget added in v1.35.8 

func (c *Budgets) DescribeBudgetActionsForBudget(input *DescribeBudgetActionsForBudgetInput) (*DescribeBudgetActionsForBudgetOutput, error)

DescribeBudgetActionsForBudget API operation for AWS Budgets.

Describes all of the budget actions 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 DescribeBudgetActionsForBudget for usage and error information.

Returned Error Types:

  • InternalErrorException An error on the server occurred during the processing of your request. Try again later.

  • InvalidParameterException An error on the client occurred. Typically, the cause is an invalid input value.

  • NotFoundException We can’t locate the resource that you specified.

  • AccessDeniedException You are not authorized to use this operation with the given parameters.

  • InvalidNextTokenException The pagination token is invalid.

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

func (*Budgets) DescribeBudgetActionsForBudgetPages added in v1.35.8 

func (c *Budgets) DescribeBudgetActionsForBudgetPages(input *DescribeBudgetActionsForBudgetInput, fn func(*DescribeBudgetActionsForBudgetOutput, bool) bool) error

DescribeBudgetActionsForBudgetPages iterates over the pages of a DescribeBudgetActionsForBudget operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeBudgetActionsForBudget method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeBudgetActionsForBudget operation.
pageNum := 0
err := client.DescribeBudgetActionsForBudgetPages(params,
    func(page *budgets.DescribeBudgetActionsForBudgetOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Budgets) DescribeBudgetActionsForBudgetPagesWithContext added in v1.35.8 

func (c *Budgets) DescribeBudgetActionsForBudgetPagesWithContext(ctx aws.Context, input *DescribeBudgetActionsForBudgetInput, fn func(*DescribeBudgetActionsForBudgetOutput, bool) bool, opts ...request.Option) error

DescribeBudgetActionsForBudgetPagesWithContext same as DescribeBudgetActionsForBudgetPages except it takes a Context and allows setting request options on the pages.

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) DescribeBudgetActionsForBudgetRequest added in v1.35.8 

func (c *Budgets) DescribeBudgetActionsForBudgetRequest(input *DescribeBudgetActionsForBudgetInput) (req *request.Request, output *DescribeBudgetActionsForBudgetOutput)

DescribeBudgetActionsForBudgetRequest generates a "aws/request.Request" representing the client's request for the DescribeBudgetActionsForBudget operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeBudgetActionsForBudget for more information on using the DescribeBudgetActionsForBudget API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeBudgetActionsForBudgetRequest method.
req, resp := client.DescribeBudgetActionsForBudgetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Budgets) DescribeBudgetActionsForBudgetWithContext added in v1.35.8 

func (c *Budgets) DescribeBudgetActionsForBudgetWithContext(ctx aws.Context, input *DescribeBudgetActionsForBudgetInput, opts ...request.Option) (*DescribeBudgetActionsForBudgetOutput, error)

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

See DescribeBudgetActionsForBudget 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) DescribeBudgetNotificationsForAccount added in v1.43.2 

func (c *Budgets) DescribeBudgetNotificationsForAccount(input *DescribeBudgetNotificationsForAccountInput) (*DescribeBudgetNotificationsForAccountOutput, error)

DescribeBudgetNotificationsForAccount API operation for AWS Budgets.

Lists the budget names and notifications that are associated with an account.

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

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

Returned Error Types:

  • InternalErrorException An error on the server occurred during the processing of your request. Try again later.

  • InvalidParameterException An error on the client occurred. Typically, the cause is an invalid input value.

  • NotFoundException We can’t locate the resource that you specified.

  • InvalidNextTokenException The pagination token is invalid.

  • ExpiredNextTokenException The pagination token expired.

  • AccessDeniedException You are not authorized to use this operation with the given parameters.

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

func (*Budgets) DescribeBudgetNotificationsForAccountPages added in v1.43.2 

func (c *Budgets) DescribeBudgetNotificationsForAccountPages(input *DescribeBudgetNotificationsForAccountInput, fn func(*DescribeBudgetNotificationsForAccountOutput, bool) bool) error

DescribeBudgetNotificationsForAccountPages iterates over the pages of a DescribeBudgetNotificationsForAccount operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeBudgetNotificationsForAccount method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeBudgetNotificationsForAccount operation.
pageNum := 0
err := client.DescribeBudgetNotificationsForAccountPages(params,
    func(page *budgets.DescribeBudgetNotificationsForAccountOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Budgets) DescribeBudgetNotificationsForAccountPagesWithContext added in v1.43.2 

func (c *Budgets) DescribeBudgetNotificationsForAccountPagesWithContext(ctx aws.Context, input *DescribeBudgetNotificationsForAccountInput, fn func(*DescribeBudgetNotificationsForAccountOutput, bool) bool, opts ...request.Option) error

DescribeBudgetNotificationsForAccountPagesWithContext same as DescribeBudgetNotificationsForAccountPages except it takes a Context and allows setting request options on the pages.

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) DescribeBudgetNotificationsForAccountRequest added in v1.43.2 

func (c *Budgets) DescribeBudgetNotificationsForAccountRequest(input *DescribeBudgetNotificationsForAccountInput) (req *request.Request, output *DescribeBudgetNotificationsForAccountOutput)

DescribeBudgetNotificationsForAccountRequest generates a "aws/request.Request" representing the client's request for the DescribeBudgetNotificationsForAccount operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeBudgetNotificationsForAccount for more information on using the DescribeBudgetNotificationsForAccount API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeBudgetNotificationsForAccountRequest method.
req, resp := client.DescribeBudgetNotificationsForAccountRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Budgets) DescribeBudgetNotificationsForAccountWithContext added in v1.43.2 

func (c *Budgets) DescribeBudgetNotificationsForAccountWithContext(ctx aws.Context, input *DescribeBudgetNotificationsForAccountInput, opts ...request.Option) (*DescribeBudgetNotificationsForAccountOutput, error)

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

See DescribeBudgetNotificationsForAccount 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) DescribeBudgetPerformanceHistory added in v1.15.74 

func (c *Budgets) DescribeBudgetPerformanceHistory(input *DescribeBudgetPerformanceHistoryInput) (*DescribeBudgetPerformanceHistoryOutput, error)

DescribeBudgetPerformanceHistory API operation for AWS Budgets.

Describes the history for DAILY, MONTHLY, and QUARTERLY budgets. Budget history isn't available for ANNUAL 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 DescribeBudgetPerformanceHistory for usage and error information.

Returned Error Types:

  • InternalErrorException An error on the server occurred during the processing of your request. Try again later.

  • InvalidParameterException An error on the client occurred. Typically, the cause is an invalid input value.

  • NotFoundException We can’t locate the resource that you specified.

  • InvalidNextTokenException The pagination token is invalid.

  • ExpiredNextTokenException The pagination token expired.

  • AccessDeniedException You are not authorized to use this operation with the given parameters.

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

func (*Budgets) DescribeBudgetPerformanceHistoryPages added in v1.34.24 

func (c *Budgets) DescribeBudgetPerformanceHistoryPages(input *DescribeBudgetPerformanceHistoryInput, fn func(*DescribeBudgetPerformanceHistoryOutput, bool) bool) error

DescribeBudgetPerformanceHistoryPages iterates over the pages of a DescribeBudgetPerformanceHistory operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeBudgetPerformanceHistory method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeBudgetPerformanceHistory operation.
pageNum := 0
err := client.DescribeBudgetPerformanceHistoryPages(params,
    func(page *budgets.DescribeBudgetPerformanceHistoryOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Budgets) DescribeBudgetPerformanceHistoryPagesWithContext added in v1.34.24 

func (c *Budgets) DescribeBudgetPerformanceHistoryPagesWithContext(ctx aws.Context, input *DescribeBudgetPerformanceHistoryInput, fn func(*DescribeBudgetPerformanceHistoryOutput, bool) bool, opts ...request.Option) error

DescribeBudgetPerformanceHistoryPagesWithContext same as DescribeBudgetPerformanceHistoryPages except it takes a Context and allows setting request options on the pages.

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) DescribeBudgetPerformanceHistoryRequest added in v1.15.74 

func (c *Budgets) DescribeBudgetPerformanceHistoryRequest(input *DescribeBudgetPerformanceHistoryInput) (req *request.Request, output *DescribeBudgetPerformanceHistoryOutput)

DescribeBudgetPerformanceHistoryRequest generates a "aws/request.Request" representing the client's request for the DescribeBudgetPerformanceHistory operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeBudgetPerformanceHistory for more information on using the DescribeBudgetPerformanceHistory API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeBudgetPerformanceHistoryRequest method.
req, resp := client.DescribeBudgetPerformanceHistoryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Budgets) DescribeBudgetPerformanceHistoryWithContext added in v1.15.74 

func (c *Budgets) DescribeBudgetPerformanceHistoryWithContext(ctx aws.Context, input *DescribeBudgetPerformanceHistoryInput, opts ...request.Option) (*DescribeBudgetPerformanceHistoryOutput, error)

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

See DescribeBudgetPerformanceHistory 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) DescribeBudgetRequest 

func (c *Budgets) DescribeBudgetRequest(input *DescribeBudgetInput) (req *request.Request, output *DescribeBudgetOutput)

DescribeBudgetRequest generates a "aws/request.Request" representing the client's request for the DescribeBudget operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeBudget for more information on using the DescribeBudget API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeBudgetRequest method.
req, resp := client.DescribeBudgetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Budgets) DescribeBudgetWithContext added in v1.8.0 

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

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

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

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

func (*Budgets) DescribeBudgets 

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

DescribeBudgets API operation for AWS Budgets.

Lists the budgets 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.

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 Types:

  • InternalErrorException An error on the server occurred during the processing of your request. Try again later.

  • InvalidParameterException An error on the client occurred. Typically, the cause is an invalid input value.

  • NotFoundException We can’t locate the resource that you specified.

  • InvalidNextTokenException The pagination token is invalid.

  • ExpiredNextTokenException The pagination token expired.

  • AccessDeniedException You are not authorized to use this operation with the given parameters.

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

func (*Budgets) DescribeBudgetsPages added in v1.34.24 

func (c *Budgets) DescribeBudgetsPages(input *DescribeBudgetsInput, fn func(*DescribeBudgetsOutput, bool) bool) error

DescribeBudgetsPages iterates over the pages of a DescribeBudgets operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeBudgets method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeBudgets operation.
pageNum := 0
err := client.DescribeBudgetsPages(params,
    func(page *budgets.DescribeBudgetsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Budgets) DescribeBudgetsPagesWithContext added in v1.34.24 

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

DescribeBudgetsPagesWithContext same as DescribeBudgetsPages except it takes a Context and allows setting request options on the pages.

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

func (c *Budgets) DescribeBudgetsRequest(input *DescribeBudgetsInput) (req *request.Request, output *DescribeBudgetsOutput)

DescribeBudgetsRequest generates a "aws/request.Request" representing the client's request for the DescribeBudgets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeBudgets for more information on using the DescribeBudgets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeBudgetsRequest method.
req, resp := client.DescribeBudgetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Budgets) DescribeBudgetsWithContext added in v1.8.0 

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

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

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

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

func (*Budgets) DescribeNotificationsForBudget 

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

DescribeNotificationsForBudget API operation for AWS Budgets.

Lists the notifications that are associated with a budget.

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

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

Returned Error Types:

  • InternalErrorException An error on the server occurred during the processing of your request. Try again later.

  • InvalidParameterException An error on the client occurred. Typically, the cause is an invalid input value.

  • NotFoundException We can’t locate the resource that you specified.

  • InvalidNextTokenException The pagination token is invalid.

  • ExpiredNextTokenException The pagination token expired.

  • AccessDeniedException You are not authorized to use this operation with the given parameters.

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

func (*Budgets) DescribeNotificationsForBudgetPages added in v1.34.24 

func (c *Budgets) DescribeNotificationsForBudgetPages(input *DescribeNotificationsForBudgetInput, fn func(*DescribeNotificationsForBudgetOutput, bool) bool) error

DescribeNotificationsForBudgetPages iterates over the pages of a DescribeNotificationsForBudget operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeNotificationsForBudget method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeNotificationsForBudget operation.
pageNum := 0
err := client.DescribeNotificationsForBudgetPages(params,
    func(page *budgets.DescribeNotificationsForBudgetOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Budgets) DescribeNotificationsForBudgetPagesWithContext added in v1.34.24 

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

DescribeNotificationsForBudgetPagesWithContext same as DescribeNotificationsForBudgetPages except it takes a Context and allows setting request options on the pages.

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

func (c *Budgets) DescribeNotificationsForBudgetRequest(input *DescribeNotificationsForBudgetInput) (req *request.Request, output *DescribeNotificationsForBudgetOutput)

DescribeNotificationsForBudgetRequest generates a "aws/request.Request" representing the client's request for the DescribeNotificationsForBudget operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeNotificationsForBudget for more information on using the DescribeNotificationsForBudget API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeNotificationsForBudgetRequest method.
req, resp := client.DescribeNotificationsForBudgetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Budgets) DescribeNotificationsForBudgetWithContext added in v1.8.0 

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

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

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

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

func (*Budgets) DescribeSubscribersForNotification 

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

DescribeSubscribersForNotification API operation for AWS Budgets.

Lists the subscribers that are associated with a notification.

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

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

Returned Error Types:

  • InternalErrorException An error on the server occurred during the processing of your request. Try again later.

  • NotFoundException We can’t locate the resource that you specified.

  • InvalidParameterException An error on the client occurred. Typically, the cause is an invalid input value.

  • InvalidNextTokenException The pagination token is invalid.

  • ExpiredNextTokenException The pagination token expired.

  • AccessDeniedException You are not authorized to use this operation with the given parameters.

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

func (*Budgets) DescribeSubscribersForNotificationPages added in v1.34.24 

func (c *Budgets) DescribeSubscribersForNotificationPages(input *DescribeSubscribersForNotificationInput, fn func(*DescribeSubscribersForNotificationOutput, bool) bool) error

DescribeSubscribersForNotificationPages iterates over the pages of a DescribeSubscribersForNotification operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeSubscribersForNotification method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a DescribeSubscribersForNotification operation.
pageNum := 0
err := client.DescribeSubscribersForNotificationPages(params,
    func(page *budgets.DescribeSubscribersForNotificationOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Budgets) DescribeSubscribersForNotificationPagesWithContext added in v1.34.24 

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

DescribeSubscribersForNotificationPagesWithContext same as DescribeSubscribersForNotificationPages except it takes a Context and allows setting request options on the pages.

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

func (c *Budgets) DescribeSubscribersForNotificationRequest(input *DescribeSubscribersForNotificationInput) (req *request.Request, output *DescribeSubscribersForNotificationOutput)

DescribeSubscribersForNotificationRequest generates a "aws/request.Request" representing the client's request for the DescribeSubscribersForNotification operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeSubscribersForNotification for more information on using the DescribeSubscribersForNotification API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeSubscribersForNotificationRequest method.
req, resp := client.DescribeSubscribersForNotificationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Budgets) DescribeSubscribersForNotificationWithContext added in v1.8.0 

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) ExecuteBudgetAction added in v1.35.8 

func (c *Budgets) ExecuteBudgetAction(input *ExecuteBudgetActionInput) (*ExecuteBudgetActionOutput, error)

ExecuteBudgetAction API operation for AWS Budgets.

Executes a budget action.

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 ExecuteBudgetAction for usage and error information.

Returned Error Types:

  • InternalErrorException An error on the server occurred during the processing of your request. Try again later.

  • InvalidParameterException An error on the client occurred. Typically, the cause is an invalid input value.

  • NotFoundException We can’t locate the resource that you specified.

  • AccessDeniedException You are not authorized to use this operation with the given parameters.

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

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

func (*Budgets) ExecuteBudgetActionRequest added in v1.35.8 

func (c *Budgets) ExecuteBudgetActionRequest(input *ExecuteBudgetActionInput) (req *request.Request, output *ExecuteBudgetActionOutput)

ExecuteBudgetActionRequest generates a "aws/request.Request" representing the client's request for the ExecuteBudgetAction operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ExecuteBudgetAction for more information on using the ExecuteBudgetAction API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ExecuteBudgetActionRequest method.
req, resp := client.ExecuteBudgetActionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Budgets) ExecuteBudgetActionWithContext added in v1.35.8 

func (c *Budgets) ExecuteBudgetActionWithContext(ctx aws.Context, input *ExecuteBudgetActionInput, opts ...request.Option) (*ExecuteBudgetActionOutput, error)

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

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

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

func (*Budgets) UpdateBudget 

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

UpdateBudget API operation for AWS Budgets.

Updates a budget. You can change every part of a budget except for the budgetName and the calculatedSpend. When you modify a budget, the calculatedSpend drops to zero until Amazon Web Services 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.

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 Types:

  • InternalErrorException An error on the server occurred during the processing of your request. Try again later.

  • InvalidParameterException An error on the client occurred. Typically, the cause is an invalid input value.

  • NotFoundException We can’t locate the resource that you specified.

  • AccessDeniedException You are not authorized to use this operation with the given parameters.

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

func (*Budgets) UpdateBudgetAction added in v1.35.8 

func (c *Budgets) UpdateBudgetAction(input *UpdateBudgetActionInput) (*UpdateBudgetActionOutput, error)

UpdateBudgetAction API operation for AWS Budgets.

Updates a budget action.

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 UpdateBudgetAction for usage and error information.

Returned Error Types:

  • InternalErrorException An error on the server occurred during the processing of your request. Try again later.

  • InvalidParameterException An error on the client occurred. Typically, the cause is an invalid input value.

  • NotFoundException We can’t locate the resource that you specified.

  • AccessDeniedException You are not authorized to use this operation with the given parameters.

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

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

func (*Budgets) UpdateBudgetActionRequest added in v1.35.8 

func (c *Budgets) UpdateBudgetActionRequest(input *UpdateBudgetActionInput) (req *request.Request, output *UpdateBudgetActionOutput)

UpdateBudgetActionRequest generates a "aws/request.Request" representing the client's request for the UpdateBudgetAction operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateBudgetAction for more information on using the UpdateBudgetAction API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateBudgetActionRequest method.
req, resp := client.UpdateBudgetActionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Budgets) UpdateBudgetActionWithContext added in v1.35.8 

func (c *Budgets) UpdateBudgetActionWithContext(ctx aws.Context, input *UpdateBudgetActionInput, opts ...request.Option) (*UpdateBudgetActionOutput, error)

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

See UpdateBudgetAction 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) UpdateBudgetRequest 

func (c *Budgets) UpdateBudgetRequest(input *UpdateBudgetInput) (req *request.Request, output *UpdateBudgetOutput)

UpdateBudgetRequest generates a "aws/request.Request" representing the client's request for the UpdateBudget operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateBudget for more information on using the UpdateBudget API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateBudgetRequest method.
req, resp := client.UpdateBudgetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Budgets) UpdateBudgetWithContext added in v1.8.0 

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

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

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

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

func (*Budgets) UpdateNotification 

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

UpdateNotification API operation for AWS Budgets.

Updates a notification.

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

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

Returned Error Types:

  • InternalErrorException An error on the server occurred during the processing of your request. Try again later.

  • InvalidParameterException An error on the client occurred. Typically, the cause is an invalid input value.

  • NotFoundException We can’t locate the resource that you specified.

  • DuplicateRecordException The budget name already exists. Budget names must be unique within an account.

  • AccessDeniedException You are not authorized to use this operation with the given parameters.

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

func (*Budgets) UpdateNotificationRequest 

func (c *Budgets) UpdateNotificationRequest(input *UpdateNotificationInput) (req *request.Request, output *UpdateNotificationOutput)

UpdateNotificationRequest generates a "aws/request.Request" representing the client's request for the UpdateNotification operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateNotification for more information on using the UpdateNotification API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateNotificationRequest method.
req, resp := client.UpdateNotificationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Budgets) UpdateNotificationWithContext added in v1.8.0 

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

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

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

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

func (*Budgets) UpdateSubscriber 

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

UpdateSubscriber API operation for AWS Budgets.

Updates a subscriber.

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

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

Returned Error Types:

  • InternalErrorException An error on the server occurred during the processing of your request. Try again later.

  • InvalidParameterException An error on the client occurred. Typically, the cause is an invalid input value.

  • NotFoundException We can’t locate the resource that you specified.

  • DuplicateRecordException The budget name already exists. Budget names must be unique within an account.

  • AccessDeniedException You are not authorized to use this operation with the given parameters.

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

func (*Budgets) UpdateSubscriberRequest 

func (c *Budgets) UpdateSubscriberRequest(input *UpdateSubscriberInput) (req *request.Request, output *UpdateSubscriberOutput)

UpdateSubscriberRequest generates a "aws/request.Request" representing the client's request for the UpdateSubscriber operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateSubscriber for more information on using the UpdateSubscriber API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateSubscriberRequest method.
req, resp := client.UpdateSubscriberRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

func (*Budgets) UpdateSubscriberWithContext added in v1.8.0 

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

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

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

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

type CalculatedSpend 

type CalculatedSpend struct {

	// The amount of cost, usage, RI units, or Savings Plans units that you used.
	//
	// ActualSpend is a required field
	ActualSpend *Spend `type:"structure" required:"true"`

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

The spend objects that are associated with this budget. The actualSpend tracks how much you've used, cost, usage, RI units, or Savings Plans units and the forecastedSpend tracks how much that you're predicted to spend based on your historical usage profile.

For example, if it's the 20th of the month and you have spent 50 dollars on Amazon EC2, your actualSpend is 50 USD, and your forecastedSpend is 75 USD.

func (CalculatedSpend) GoString 

func (s CalculatedSpend) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CalculatedSpend) SetActualSpend added in v1.5.0 

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

SetActualSpend sets the ActualSpend field's value.

func (*CalculatedSpend) SetForecastedSpend added in v1.5.0 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CalculatedSpend) Validate 

func (s *CalculatedSpend) Validate() error

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

type CostTypes 

type CostTypes struct {

	// Specifies whether a budget includes credits.
	//
	// The default value is true.
	IncludeCredit *bool `type:"boolean"`

	// Specifies whether a budget includes discounts.
	//
	// The default value is true.
	IncludeDiscount *bool `type:"boolean"`

	// Specifies whether a budget includes non-RI subscription costs.
	//
	// The default value is true.
	IncludeOtherSubscription *bool `type:"boolean"`

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

	// Specifies whether a budget includes refunds.
	//
	// The default value is true.
	IncludeRefund *bool `type:"boolean"`

	// Specifies whether a budget includes subscriptions.
	//
	// The default value is true.
	IncludeSubscription *bool `type:"boolean"`

	// Specifies whether a budget includes support subscription fees.
	//
	// The default value is true.
	IncludeSupport *bool `type:"boolean"`

	// Specifies whether a budget includes taxes.
	//
	// The default value is true.
	IncludeTax *bool `type:"boolean"`

	// Specifies whether a budget includes upfront RI costs.
	//
	// The default value is true.
	IncludeUpfront *bool `type:"boolean"`

	// Specifies whether a budget uses the amortized rate.
	//
	// The default value is false.
	UseAmortized *bool `type:"boolean"`

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

The types of cost that are included in a COST budget, such as tax and subscriptions.

USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, and SAVINGS_PLANS_COVERAGE budgets don't have CostTypes.

func (CostTypes) GoString 

func (s CostTypes) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CostTypes) SetIncludeCredit added in v1.12.40 

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

SetIncludeCredit sets the IncludeCredit field's value.

func (*CostTypes) SetIncludeDiscount added in v1.12.67 

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

SetIncludeDiscount sets the IncludeDiscount field's value.

func (*CostTypes) SetIncludeOtherSubscription added in v1.12.40 

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

SetIncludeOtherSubscription sets the IncludeOtherSubscription field's value.

func (*CostTypes) SetIncludeRecurring added in v1.12.40 

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

SetIncludeRecurring sets the IncludeRecurring field's value.

func (*CostTypes) SetIncludeRefund added in v1.12.40 

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

SetIncludeRefund sets the IncludeRefund field's value.

func (*CostTypes) SetIncludeSubscription added in v1.5.0 

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

SetIncludeSubscription sets the IncludeSubscription field's value.

func (*CostTypes) SetIncludeSupport added in v1.12.40 

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

SetIncludeSupport sets the IncludeSupport field's value.

func (*CostTypes) SetIncludeTax added in v1.5.0 

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

SetIncludeTax sets the IncludeTax field's value.

func (*CostTypes) SetIncludeUpfront added in v1.12.40 

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

SetIncludeUpfront sets the IncludeUpfront field's value.

func (*CostTypes) SetUseAmortized added in v1.12.67 

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

SetUseAmortized sets the UseAmortized field's value.

func (*CostTypes) SetUseBlended added in v1.5.0 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateBudgetActionInput added in v1.35.8 

type CreateBudgetActionInput struct {

	// The account ID of the user. It's a 12-digit number.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// The trigger threshold of the action.
	//
	// ActionThreshold is a required field
	ActionThreshold *ActionThreshold `type:"structure" required:"true"`

	// 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.
	//
	// ActionType is a required field
	ActionType *string `type:"string" required:"true" enum:"ActionType"`

	// This specifies if the action needs manual or automatic approval.
	//
	// ApprovalModel is a required field
	ApprovalModel *string `type:"string" required:"true" enum:"ApprovalModel"`

	// A string that represents the budget name. The ":" and "\" characters, and
	// the "/action/" substring, aren't allowed.
	//
	// BudgetName is a required field
	BudgetName *string `min:"1" type:"string" required:"true"`

	// Specifies all of the type-specific parameters.
	//
	// Definition is a required field
	Definition *Definition `type:"structure" required:"true"`

	// The role passed for action execution and reversion. Roles and actions must
	// be in the same account.
	//
	// ExecutionRoleArn is a required field
	ExecutionRoleArn *string `min:"32" type:"string" required:"true"`

	// The type of a notification. It must be ACTUAL or FORECASTED.
	//
	// NotificationType is a required field
	NotificationType *string `type:"string" required:"true" enum:"NotificationType"`

	// A list of subscribers.
	//
	// Subscribers is a required field
	Subscribers []*Subscriber `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (CreateBudgetActionInput) GoString added in v1.35.8 

func (s CreateBudgetActionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateBudgetActionInput) SetAccountId added in v1.35.8 

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

SetAccountId sets the AccountId field's value.

func (*CreateBudgetActionInput) SetActionThreshold added in v1.35.8 

func (s *CreateBudgetActionInput) SetActionThreshold(v *ActionThreshold) *CreateBudgetActionInput

SetActionThreshold sets the ActionThreshold field's value.

func (*CreateBudgetActionInput) SetActionType added in v1.35.8 

func (s *CreateBudgetActionInput) SetActionType(v string) *CreateBudgetActionInput

SetActionType sets the ActionType field's value.

func (*CreateBudgetActionInput) SetApprovalModel added in v1.35.8 

func (s *CreateBudgetActionInput) SetApprovalModel(v string) *CreateBudgetActionInput

SetApprovalModel sets the ApprovalModel field's value.

func (*CreateBudgetActionInput) SetBudgetName added in v1.35.8 

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

SetBudgetName sets the BudgetName field's value.

func (*CreateBudgetActionInput) SetDefinition added in v1.35.8 

func (s *CreateBudgetActionInput) SetDefinition(v *Definition) *CreateBudgetActionInput

SetDefinition sets the Definition field's value.

func (*CreateBudgetActionInput) SetExecutionRoleArn added in v1.35.8 

func (s *CreateBudgetActionInput) SetExecutionRoleArn(v string) *CreateBudgetActionInput

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*CreateBudgetActionInput) SetNotificationType added in v1.35.8 

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

SetNotificationType sets the NotificationType field's value.

func (*CreateBudgetActionInput) SetSubscribers added in v1.35.8 

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

SetSubscribers sets the Subscribers field's value.

func (CreateBudgetActionInput) String added in v1.35.8 

func (s CreateBudgetActionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateBudgetActionInput) Validate added in v1.35.8 

func (s *CreateBudgetActionInput) Validate() error

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

type CreateBudgetActionOutput added in v1.35.8 

type CreateBudgetActionOutput struct {

	// The account ID of the user. It's a 12-digit number.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// A system-generated universally unique identifier (UUID) for the action.
	//
	// ActionId is a required field
	ActionId *string `min:"36" type:"string" required:"true"`

	// A string that represents the budget name. The ":" and "\" characters, and
	// the "/action/" substring, aren't allowed.
	//
	// BudgetName is a required field
	BudgetName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateBudgetActionOutput) GoString added in v1.35.8 

func (s CreateBudgetActionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateBudgetActionOutput) SetAccountId added in v1.35.8 

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

SetAccountId sets the AccountId field's value.

func (*CreateBudgetActionOutput) SetActionId added in v1.35.8 

func (s *CreateBudgetActionOutput) SetActionId(v string) *CreateBudgetActionOutput

SetActionId sets the ActionId field's value.

func (*CreateBudgetActionOutput) SetBudgetName added in v1.35.8 

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

SetBudgetName sets the BudgetName field's value.

func (CreateBudgetActionOutput) String added in v1.35.8 

func (s CreateBudgetActionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateBudgetInput 

type CreateBudgetInput struct {

	// The accountId that is associated with the budget.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// The budget object that you want to create.
	//
	// Budget is a required field
	Budget *Budget `type:"structure" required:"true"`

	// A notification that you want to associate with a budget. A budget can have
	// up to five notifications, and each notification can have one SNS subscriber
	// and up to 10 email subscribers. If you include notifications and subscribers
	// in your CreateBudget call, Amazon Web Services creates the notifications
	// and subscribers for you.
	NotificationsWithSubscribers []*NotificationWithSubscribers `type:"list"`
	// contains filtered or unexported fields
}

Request of CreateBudget

func (CreateBudgetInput) GoString 

func (s CreateBudgetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateBudgetInput) SetAccountId added in v1.5.0 

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

SetAccountId sets the AccountId field's value.

func (*CreateBudgetInput) SetBudget added in v1.5.0 

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

SetBudget sets the Budget field's value.

func (*CreateBudgetInput) SetNotificationsWithSubscribers added in v1.5.0 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateBudgetInput) Validate 

func (s *CreateBudgetInput) Validate() error

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

type CreateBudgetOutput 

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

Response of CreateBudget

func (CreateBudgetOutput) GoString 

func (s CreateBudgetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CreateBudgetOutput) String 

func (s CreateBudgetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateNotificationInput 

type CreateNotificationInput struct {

	// The accountId that is associated with the budget that you want to create
	// a notification for.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// The name of the budget that you want Amazon Web Services to notify you about.
	// Budget names must be unique within an account.
	//
	// BudgetName is a required field
	BudgetName *string `min:"1" type:"string" required:"true"`

	// The notification that you want to create.
	//
	// Notification is a required field
	Notification *Notification `type:"structure" required:"true"`

	// A list of subscribers that you want to associate with the notification. Each
	// notification can have one SNS subscriber and up to 10 email subscribers.
	//
	// Subscribers is a required field
	Subscribers []*Subscriber `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Request of CreateNotification

func (CreateNotificationInput) GoString 

func (s CreateNotificationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateNotificationInput) SetAccountId added in v1.5.0 

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

SetAccountId sets the AccountId field's value.

func (*CreateNotificationInput) SetBudgetName added in v1.5.0 

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

SetBudgetName sets the BudgetName field's value.

func (*CreateNotificationInput) SetNotification added in v1.5.0 

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

SetNotification sets the Notification field's value.

func (*CreateNotificationInput) SetSubscribers added in v1.5.0 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateNotificationInput) Validate 

func (s *CreateNotificationInput) Validate() error

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

type CreateNotificationOutput 

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

Response of CreateNotification

func (CreateNotificationOutput) GoString 

func (s CreateNotificationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CreateNotificationOutput) String 

func (s CreateNotificationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateSubscriberInput 

type CreateSubscriberInput struct {

	// The accountId that is associated with the budget that you want to create
	// a subscriber for.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// The name of the budget that you want to subscribe to. Budget names must be
	// unique within an account.
	//
	// BudgetName is a required field
	BudgetName *string `min:"1" type:"string" required:"true"`

	// The notification that you want to create a subscriber for.
	//
	// Notification is a required field
	Notification *Notification `type:"structure" required:"true"`

	// The subscriber that you want to associate with a budget notification.
	//
	// Subscriber is a required field
	Subscriber *Subscriber `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Request of CreateSubscriber

func (CreateSubscriberInput) GoString 

func (s CreateSubscriberInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSubscriberInput) SetAccountId added in v1.5.0 

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

SetAccountId sets the AccountId field's value.

func (*CreateSubscriberInput) SetBudgetName added in v1.5.0 

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

SetBudgetName sets the BudgetName field's value.

func (*CreateSubscriberInput) SetNotification added in v1.5.0 

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

SetNotification sets the Notification field's value.

func (*CreateSubscriberInput) SetSubscriber added in v1.5.0 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSubscriberInput) Validate 

func (s *CreateSubscriberInput) Validate() error

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

type CreateSubscriberOutput 

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

Response of CreateSubscriber

func (CreateSubscriberOutput) GoString 

func (s CreateSubscriberOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CreateSubscriberOutput) String 

func (s CreateSubscriberOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreationLimitExceededException added in v1.28.0 

type CreationLimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error message the exception carries.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

You've exceeded the notification or subscriber limit.

func (*CreationLimitExceededException) Code added in v1.28.0 

func (s *CreationLimitExceededException) Code() string

Code returns the exception type name.

func (*CreationLimitExceededException) Error added in v1.28.0 

func (s *CreationLimitExceededException) Error() string

func (CreationLimitExceededException) GoString added in v1.28.0 

func (s CreationLimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreationLimitExceededException) Message added in v1.28.0 

func (s *CreationLimitExceededException) Message() string

Message returns the exception's message.

func (*CreationLimitExceededException) OrigErr added in v1.28.0 

func (s *CreationLimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*CreationLimitExceededException) RequestID added in v1.28.0 

func (s *CreationLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*CreationLimitExceededException) StatusCode added in v1.28.0 

func (s *CreationLimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (CreationLimitExceededException) String added in v1.28.0 

func (s CreationLimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Definition added in v1.35.8 

type Definition struct {

	// The Identity and Access Management (IAM) action definition details.
	IamActionDefinition *IamActionDefinition `type:"structure"`

	// The service control policies (SCPs) action definition details.
	ScpActionDefinition *ScpActionDefinition `type:"structure"`

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

Specifies all of the type-specific parameters.

func (Definition) GoString added in v1.35.8 

func (s Definition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Definition) SetIamActionDefinition added in v1.35.8 

func (s *Definition) SetIamActionDefinition(v *IamActionDefinition) *Definition

SetIamActionDefinition sets the IamActionDefinition field's value.

func (*Definition) SetScpActionDefinition added in v1.35.8 

func (s *Definition) SetScpActionDefinition(v *ScpActionDefinition) *Definition

SetScpActionDefinition sets the ScpActionDefinition field's value.

func (*Definition) SetSsmActionDefinition added in v1.35.8 

func (s *Definition) SetSsmActionDefinition(v *SsmActionDefinition) *Definition

SetSsmActionDefinition sets the SsmActionDefinition field's value.

func (Definition) String added in v1.35.8 

func (s Definition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Definition) Validate added in v1.35.8 

func (s *Definition) Validate() error

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

type DeleteBudgetActionInput added in v1.35.8 

type DeleteBudgetActionInput struct {

	// The account ID of the user. It's a 12-digit number.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// A system-generated universally unique identifier (UUID) for the action.
	//
	// ActionId is a required field
	ActionId *string `min:"36" type:"string" required:"true"`

	// A string that represents the budget name. The ":" and "\" characters, and
	// the "/action/" substring, aren't allowed.
	//
	// BudgetName is a required field
	BudgetName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBudgetActionInput) GoString added in v1.35.8 

func (s DeleteBudgetActionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteBudgetActionInput) SetAccountId added in v1.35.8 

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

SetAccountId sets the AccountId field's value.

func (*DeleteBudgetActionInput) SetActionId added in v1.35.8 

func (s *DeleteBudgetActionInput) SetActionId(v string) *DeleteBudgetActionInput

SetActionId sets the ActionId field's value.

func (*DeleteBudgetActionInput) SetBudgetName added in v1.35.8 

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

SetBudgetName sets the BudgetName field's value.

func (DeleteBudgetActionInput) String added in v1.35.8 

func (s DeleteBudgetActionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteBudgetActionInput) Validate added in v1.35.8 

func (s *DeleteBudgetActionInput) Validate() error

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

type DeleteBudgetActionOutput added in v1.35.8 

type DeleteBudgetActionOutput struct {

	// The account ID of the user. It's a 12-digit number.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// A budget action resource.
	//
	// Action is a required field
	Action *Action `type:"structure" required:"true"`

	// A string that represents the budget name. The ":" and "\" characters, and
	// the "/action/" substring, aren't allowed.
	//
	// BudgetName is a required field
	BudgetName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBudgetActionOutput) GoString added in v1.35.8 

func (s DeleteBudgetActionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteBudgetActionOutput) SetAccountId added in v1.35.8 

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

SetAccountId sets the AccountId field's value.

func (*DeleteBudgetActionOutput) SetAction added in v1.35.8 

func (s *DeleteBudgetActionOutput) SetAction(v *Action) *DeleteBudgetActionOutput

SetAction sets the Action field's value.

func (*DeleteBudgetActionOutput) SetBudgetName added in v1.35.8 

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

SetBudgetName sets the BudgetName field's value.

func (DeleteBudgetActionOutput) String added in v1.35.8 

func (s DeleteBudgetActionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteBudgetInput 

type DeleteBudgetInput struct {

	// The accountId that is associated with the budget that you want to delete.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// The name of the budget that you want to delete.
	//
	// BudgetName is a required field
	BudgetName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request of DeleteBudget

func (DeleteBudgetInput) GoString 

func (s DeleteBudgetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteBudgetInput) SetAccountId added in v1.5.0 

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

SetAccountId sets the AccountId field's value.

func (*DeleteBudgetInput) SetBudgetName added in v1.5.0 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteBudgetInput) Validate 

func (s *DeleteBudgetInput) Validate() error

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

type DeleteBudgetOutput 

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

Response of DeleteBudget

func (DeleteBudgetOutput) GoString 

func (s DeleteBudgetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteBudgetOutput) String 

func (s DeleteBudgetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteNotificationInput 

type DeleteNotificationInput struct {

	// The accountId that is associated with the budget whose notification you want
	// to delete.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// The name of the budget whose notification you want to delete.
	//
	// BudgetName is a required field
	BudgetName *string `min:"1" type:"string" required:"true"`

	// The notification that you want to delete.
	//
	// Notification is a required field
	Notification *Notification `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Request of DeleteNotification

func (DeleteNotificationInput) GoString 

func (s DeleteNotificationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteNotificationInput) SetAccountId added in v1.5.0 

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

SetAccountId sets the AccountId field's value.

func (*DeleteNotificationInput) SetBudgetName added in v1.5.0 

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

SetBudgetName sets the BudgetName field's value.

func (*DeleteNotificationInput) SetNotification added in v1.5.0 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteNotificationInput) Validate 

func (s *DeleteNotificationInput) Validate() error

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

type DeleteNotificationOutput 

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

Response of DeleteNotification

func (DeleteNotificationOutput) GoString 

func (s DeleteNotificationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteNotificationOutput) String 

func (s DeleteNotificationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteSubscriberInput 

type DeleteSubscriberInput struct {

	// The accountId that is associated with the budget whose subscriber you want
	// to delete.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// The name of the budget whose subscriber you want to delete.
	//
	// BudgetName is a required field
	BudgetName *string `min:"1" type:"string" required:"true"`

	// The notification whose subscriber you want to delete.
	//
	// Notification is a required field
	Notification *Notification `type:"structure" required:"true"`

	// The subscriber that you want to delete.
	//
	// Subscriber is a required field
	Subscriber *Subscriber `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Request of DeleteSubscriber

func (DeleteSubscriberInput) GoString 

func (s DeleteSubscriberInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSubscriberInput) SetAccountId added in v1.5.0 

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

SetAccountId sets the AccountId field's value.

func (*DeleteSubscriberInput) SetBudgetName added in v1.5.0 

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

SetBudgetName sets the BudgetName field's value.

func (*DeleteSubscriberInput) SetNotification added in v1.5.0 

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

SetNotification sets the Notification field's value.

func (*DeleteSubscriberInput) SetSubscriber added in v1.5.0 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSubscriberInput) Validate 

func (s *DeleteSubscriberInput) Validate() error

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

type DeleteSubscriberOutput 

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

Response of DeleteSubscriber

func (DeleteSubscriberOutput) GoString 

func (s DeleteSubscriberOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteSubscriberOutput) String 

func (s DeleteSubscriberOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeBudgetActionHistoriesInput added in v1.35.8 

type DescribeBudgetActionHistoriesInput struct {

	// The account ID of the user. It's a 12-digit number.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// A system-generated universally unique identifier (UUID) for the action.
	//
	// ActionId is a required field
	ActionId *string `min:"36" type:"string" required:"true"`

	// A string that represents the budget name. The ":" and "\" characters, and
	// the "/action/" substring, aren't allowed.
	//
	// BudgetName is a required field
	BudgetName *string `min:"1" type:"string" required:"true"`

	// An integer that represents how many entries a paginated response contains.
	// The maximum is 100.
	MaxResults *int64 `min:"1" type:"integer"`

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

	// The period of time that's covered by a budget. The period has a start date
	// and an end date. The start date must come before the end date. There are
	// no restrictions on the end date.
	TimePeriod *TimePeriod `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeBudgetActionHistoriesInput) GoString added in v1.35.8 

func (s DescribeBudgetActionHistoriesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBudgetActionHistoriesInput) SetAccountId added in v1.35.8 

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

SetAccountId sets the AccountId field's value.

func (*DescribeBudgetActionHistoriesInput) SetActionId added in v1.35.8 

func (s *DescribeBudgetActionHistoriesInput) SetActionId(v string) *DescribeBudgetActionHistoriesInput

SetActionId sets the ActionId field's value.

func (*DescribeBudgetActionHistoriesInput) SetBudgetName added in v1.35.8 

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

SetBudgetName sets the BudgetName field's value.

func (*DescribeBudgetActionHistoriesInput) SetMaxResults added in v1.35.8 

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

SetMaxResults sets the MaxResults field's value.

func (*DescribeBudgetActionHistoriesInput) SetNextToken added in v1.35.8 

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

SetNextToken sets the NextToken field's value.

func (*DescribeBudgetActionHistoriesInput) SetTimePeriod added in v1.35.8 

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

SetTimePeriod sets the TimePeriod field's value.

func (DescribeBudgetActionHistoriesInput) String added in v1.35.8 

func (s DescribeBudgetActionHistoriesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBudgetActionHistoriesInput) Validate added in v1.35.8 

func (s *DescribeBudgetActionHistoriesInput) Validate() error

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

type DescribeBudgetActionHistoriesOutput added in v1.35.8 

type DescribeBudgetActionHistoriesOutput struct {

	// The historical record of the budget action resource.
	//
	// ActionHistories is a required field
	ActionHistories []*ActionHistory `type:"list" required:"true"`

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

func (DescribeBudgetActionHistoriesOutput) GoString added in v1.35.8 

func (s DescribeBudgetActionHistoriesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBudgetActionHistoriesOutput) SetActionHistories added in v1.35.8 

func (s *DescribeBudgetActionHistoriesOutput) SetActionHistories(v []*ActionHistory) *DescribeBudgetActionHistoriesOutput

SetActionHistories sets the ActionHistories field's value.

func (*DescribeBudgetActionHistoriesOutput) SetNextToken added in v1.35.8 

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

SetNextToken sets the NextToken field's value.

func (DescribeBudgetActionHistoriesOutput) String added in v1.35.8 

func (s DescribeBudgetActionHistoriesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeBudgetActionInput added in v1.35.8 

type DescribeBudgetActionInput struct {

	// The account ID of the user. It's a 12-digit number.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// A system-generated universally unique identifier (UUID) for the action.
	//
	// ActionId is a required field
	ActionId *string `min:"36" type:"string" required:"true"`

	// A string that represents the budget name. The ":" and "\" characters, and
	// the "/action/" substring, aren't allowed.
	//
	// BudgetName is a required field
	BudgetName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeBudgetActionInput) GoString added in v1.35.8 

func (s DescribeBudgetActionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBudgetActionInput) SetAccountId added in v1.35.8 

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

SetAccountId sets the AccountId field's value.

func (*DescribeBudgetActionInput) SetActionId added in v1.35.8 

func (s *DescribeBudgetActionInput) SetActionId(v string) *DescribeBudgetActionInput

SetActionId sets the ActionId field's value.

func (*DescribeBudgetActionInput) SetBudgetName added in v1.35.8 

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

SetBudgetName sets the BudgetName field's value.

func (DescribeBudgetActionInput) String added in v1.35.8 

func (s DescribeBudgetActionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBudgetActionInput) Validate added in v1.35.8 

func (s *DescribeBudgetActionInput) Validate() error

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

type DescribeBudgetActionOutput added in v1.35.8 

type DescribeBudgetActionOutput struct {

	// The account ID of the user. It's a 12-digit number.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// A budget action resource.
	//
	// Action is a required field
	Action *Action `type:"structure" required:"true"`

	// A string that represents the budget name. The ":" and "\" characters, and
	// the "/action/" substring, aren't allowed.
	//
	// BudgetName is a required field
	BudgetName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeBudgetActionOutput) GoString added in v1.35.8 

func (s DescribeBudgetActionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBudgetActionOutput) SetAccountId added in v1.35.8 

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

SetAccountId sets the AccountId field's value.

func (*DescribeBudgetActionOutput) SetAction added in v1.35.8 

func (s *DescribeBudgetActionOutput) SetAction(v *Action) *DescribeBudgetActionOutput

SetAction sets the Action field's value.

func (*DescribeBudgetActionOutput) SetBudgetName added in v1.35.8 

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

SetBudgetName sets the BudgetName field's value.

func (DescribeBudgetActionOutput) String added in v1.35.8 

func (s DescribeBudgetActionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeBudgetActionsForAccountInput added in v1.35.8 

type DescribeBudgetActionsForAccountInput struct {

	// The account ID of the user. It's a 12-digit number.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// An integer that represents how many entries a paginated response contains.
	// The maximum is 100.
	MaxResults *int64 `min:"1" type:"integer"`

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

func (DescribeBudgetActionsForAccountInput) GoString added in v1.35.8 

func (s DescribeBudgetActionsForAccountInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBudgetActionsForAccountInput) SetAccountId added in v1.35.8 

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

SetAccountId sets the AccountId field's value.

func (*DescribeBudgetActionsForAccountInput) SetMaxResults added in v1.35.8 

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

SetMaxResults sets the MaxResults field's value.

func (*DescribeBudgetActionsForAccountInput) SetNextToken added in v1.35.8 

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

SetNextToken sets the NextToken field's value.

func (DescribeBudgetActionsForAccountInput) String added in v1.35.8 

func (s DescribeBudgetActionsForAccountInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBudgetActionsForAccountInput) Validate added in v1.35.8 

func (s *DescribeBudgetActionsForAccountInput) Validate() error

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

type DescribeBudgetActionsForAccountOutput added in v1.35.8 

type DescribeBudgetActionsForAccountOutput struct {

	// A list of the budget action resources information.
	//
	// Actions is a required field
	Actions []*Action `type:"list" required:"true"`

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

func (DescribeBudgetActionsForAccountOutput) GoString added in v1.35.8 

func (s DescribeBudgetActionsForAccountOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBudgetActionsForAccountOutput) SetActions added in v1.35.8 

func (s *DescribeBudgetActionsForAccountOutput) SetActions(v []*Action) *DescribeBudgetActionsForAccountOutput

SetActions sets the Actions field's value.

func (*DescribeBudgetActionsForAccountOutput) SetNextToken added in v1.35.8 

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

SetNextToken sets the NextToken field's value.

func (DescribeBudgetActionsForAccountOutput) String added in v1.35.8 

func (s DescribeBudgetActionsForAccountOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeBudgetActionsForBudgetInput added in v1.35.8 

type DescribeBudgetActionsForBudgetInput struct {

	// The account ID of the user. It's a 12-digit number.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// A string that represents the budget name. The ":" and "\" characters, and
	// the "/action/" substring, aren't allowed.
	//
	// BudgetName is a required field
	BudgetName *string `min:"1" type:"string" required:"true"`

	// An integer that represents how many entries a paginated response contains.
	// The maximum is 100.
	MaxResults *int64 `min:"1" type:"integer"`

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

func (DescribeBudgetActionsForBudgetInput) GoString added in v1.35.8 

func (s DescribeBudgetActionsForBudgetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBudgetActionsForBudgetInput) SetAccountId added in v1.35.8 

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

SetAccountId sets the AccountId field's value.

func (*DescribeBudgetActionsForBudgetInput) SetBudgetName added in v1.35.8 

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

SetBudgetName sets the BudgetName field's value.

func (*DescribeBudgetActionsForBudgetInput) SetMaxResults added in v1.35.8 

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

SetMaxResults sets the MaxResults field's value.

func (*DescribeBudgetActionsForBudgetInput) SetNextToken added in v1.35.8 

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

SetNextToken sets the NextToken field's value.

func (DescribeBudgetActionsForBudgetInput) String added in v1.35.8 

func (s DescribeBudgetActionsForBudgetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBudgetActionsForBudgetInput) Validate added in v1.35.8 

func (s *DescribeBudgetActionsForBudgetInput) Validate() error

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

type DescribeBudgetActionsForBudgetOutput added in v1.35.8 

type DescribeBudgetActionsForBudgetOutput struct {

	// A list of the budget action resources information.
	//
	// Actions is a required field
	Actions []*Action `type:"list" required:"true"`

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

func (DescribeBudgetActionsForBudgetOutput) GoString added in v1.35.8 

func (s DescribeBudgetActionsForBudgetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBudgetActionsForBudgetOutput) SetActions added in v1.35.8 

func (s *DescribeBudgetActionsForBudgetOutput) SetActions(v []*Action) *DescribeBudgetActionsForBudgetOutput

SetActions sets the Actions field's value.

func (*DescribeBudgetActionsForBudgetOutput) SetNextToken added in v1.35.8 

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

SetNextToken sets the NextToken field's value.

func (DescribeBudgetActionsForBudgetOutput) String added in v1.35.8 

func (s DescribeBudgetActionsForBudgetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeBudgetInput 

type DescribeBudgetInput struct {

	// The accountId that is associated with the budget that you want a description
	// of.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// The name of the budget that you want a description of.
	//
	// BudgetName is a required field
	BudgetName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request of DescribeBudget

func (DescribeBudgetInput) GoString 

func (s DescribeBudgetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBudgetInput) SetAccountId added in v1.5.0 

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

SetAccountId sets the AccountId field's value.

func (*DescribeBudgetInput) SetBudgetName added in v1.5.0 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBudgetInput) Validate 

func (s *DescribeBudgetInput) Validate() error

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

type DescribeBudgetNotificationsForAccountInput added in v1.43.2 

type DescribeBudgetNotificationsForAccountInput struct {

	// The account ID of the user. It's a 12-digit number.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// An integer that shows how many budget name entries a paginated response contains.
	MaxResults *int64 `min:"1" type:"integer"`

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

func (DescribeBudgetNotificationsForAccountInput) GoString added in v1.43.2 

func (s DescribeBudgetNotificationsForAccountInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBudgetNotificationsForAccountInput) SetAccountId added in v1.43.2 

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

SetAccountId sets the AccountId field's value.

func (*DescribeBudgetNotificationsForAccountInput) SetMaxResults added in v1.43.2 

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

SetMaxResults sets the MaxResults field's value.

func (*DescribeBudgetNotificationsForAccountInput) SetNextToken added in v1.43.2 

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

SetNextToken sets the NextToken field's value.

func (DescribeBudgetNotificationsForAccountInput) String added in v1.43.2 

func (s DescribeBudgetNotificationsForAccountInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBudgetNotificationsForAccountInput) Validate added in v1.43.2 

func (s *DescribeBudgetNotificationsForAccountInput) Validate() error

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

type DescribeBudgetNotificationsForAccountOutput added in v1.43.2 

type DescribeBudgetNotificationsForAccountOutput struct {

	// A list of budget names and associated notifications for an account.
	BudgetNotificationsForAccount []*BudgetNotificationsForAccount `type:"list"`

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

func (DescribeBudgetNotificationsForAccountOutput) GoString added in v1.43.2 

func (s DescribeBudgetNotificationsForAccountOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBudgetNotificationsForAccountOutput) SetBudgetNotificationsForAccount added in v1.43.2 

func (s *DescribeBudgetNotificationsForAccountOutput) SetBudgetNotificationsForAccount(v []*BudgetNotificationsForAccount) *DescribeBudgetNotificationsForAccountOutput

SetBudgetNotificationsForAccount sets the BudgetNotificationsForAccount field's value.

func (*DescribeBudgetNotificationsForAccountOutput) SetNextToken added in v1.43.2 

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

SetNextToken sets the NextToken field's value.

func (DescribeBudgetNotificationsForAccountOutput) String added in v1.43.2 

func (s DescribeBudgetNotificationsForAccountOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeBudgetOutput 

type DescribeBudgetOutput struct {

	// The description of the budget.
	Budget *Budget `type:"structure"`
	// contains filtered or unexported fields
}

Response of DescribeBudget

func (DescribeBudgetOutput) GoString 

func (s DescribeBudgetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBudgetOutput) SetBudget added in v1.5.0 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeBudgetPerformanceHistoryInput added in v1.15.74 

type DescribeBudgetPerformanceHistoryInput struct {

	// The account ID of the user. It's a 12-digit number.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// A string that represents the budget name. The ":" and "\" characters, and
	// the "/action/" substring, aren't allowed.
	//
	// BudgetName is a required field
	BudgetName *string `min:"1" type:"string" required:"true"`

	// An integer that represents how many entries a paginated response contains.
	// The maximum is 100.
	MaxResults *int64 `min:"1" type:"integer"`

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

	// Retrieves how often the budget went into an ALARM state for the specified
	// time period.
	TimePeriod *TimePeriod `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeBudgetPerformanceHistoryInput) GoString added in v1.15.74 

func (s DescribeBudgetPerformanceHistoryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBudgetPerformanceHistoryInput) SetAccountId added in v1.15.74 

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

SetAccountId sets the AccountId field's value.

func (*DescribeBudgetPerformanceHistoryInput) SetBudgetName added in v1.15.74 

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

SetBudgetName sets the BudgetName field's value.

func (*DescribeBudgetPerformanceHistoryInput) SetMaxResults added in v1.15.74 

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

SetMaxResults sets the MaxResults field's value.

func (*DescribeBudgetPerformanceHistoryInput) SetNextToken added in v1.15.74 

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

SetNextToken sets the NextToken field's value.

func (*DescribeBudgetPerformanceHistoryInput) SetTimePeriod added in v1.15.74 

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

SetTimePeriod sets the TimePeriod field's value.

func (DescribeBudgetPerformanceHistoryInput) String added in v1.15.74 

func (s DescribeBudgetPerformanceHistoryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBudgetPerformanceHistoryInput) Validate added in v1.15.74 

func (s *DescribeBudgetPerformanceHistoryInput) Validate() error

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

type DescribeBudgetPerformanceHistoryOutput added in v1.15.74 

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 *BudgetPerformanceHistory `type:"structure"`

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

func (DescribeBudgetPerformanceHistoryOutput) GoString added in v1.15.74 

func (s DescribeBudgetPerformanceHistoryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBudgetPerformanceHistoryOutput) SetBudgetPerformanceHistory added in v1.15.74 

func (s *DescribeBudgetPerformanceHistoryOutput) SetBudgetPerformanceHistory(v *BudgetPerformanceHistory) *DescribeBudgetPerformanceHistoryOutput

SetBudgetPerformanceHistory sets the BudgetPerformanceHistory field's value.

func (*DescribeBudgetPerformanceHistoryOutput) SetNextToken added in v1.15.74 

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

SetNextToken sets the NextToken field's value.

func (DescribeBudgetPerformanceHistoryOutput) String added in v1.15.74 

func (s DescribeBudgetPerformanceHistoryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeBudgetsInput 

type DescribeBudgetsInput struct {

	// The accountId that is associated with the budgets that you want descriptions
	// of.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// An optional integer that represents how many entries a paginated response
	// contains. The maximum is 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token that you include in your request to indicate the next
	// set of results that you want to retrieve.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Request of DescribeBudgets

func (DescribeBudgetsInput) GoString 

func (s DescribeBudgetsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBudgetsInput) SetAccountId added in v1.5.0 

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

SetAccountId sets the AccountId field's value.

func (*DescribeBudgetsInput) SetMaxResults added in v1.5.0 

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

SetMaxResults sets the MaxResults field's value.

func (*DescribeBudgetsInput) SetNextToken added in v1.5.0 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBudgetsInput) Validate 

func (s *DescribeBudgetsInput) Validate() error

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

type DescribeBudgetsOutput 

type DescribeBudgetsOutput struct {

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

	// The pagination token in the service response that indicates the next set
	// of results that you can retrieve.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Response of DescribeBudgets

func (DescribeBudgetsOutput) GoString 

func (s DescribeBudgetsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBudgetsOutput) SetBudgets added in v1.5.0 

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

SetBudgets sets the Budgets field's value.

func (*DescribeBudgetsOutput) SetNextToken added in v1.5.0 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeNotificationsForBudgetInput 

type DescribeNotificationsForBudgetInput struct {

	// The accountId that is associated with the budget whose notifications you
	// want descriptions of.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// The name of the budget whose notifications you want descriptions of.
	//
	// BudgetName is a required field
	BudgetName *string `min:"1" type:"string" required:"true"`

	// An optional integer that represents how many entries a paginated response
	// contains. The maximum is 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token that you include in your request to indicate the next
	// set of results that you want to retrieve.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Request of DescribeNotificationsForBudget

func (DescribeNotificationsForBudgetInput) GoString 

func (s DescribeNotificationsForBudgetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeNotificationsForBudgetInput) SetAccountId added in v1.5.0 

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

SetAccountId sets the AccountId field's value.

func (*DescribeNotificationsForBudgetInput) SetBudgetName added in v1.5.0 

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

SetBudgetName sets the BudgetName field's value.

func (*DescribeNotificationsForBudgetInput) SetMaxResults added in v1.5.0 

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

SetMaxResults sets the MaxResults field's value.

func (*DescribeNotificationsForBudgetInput) SetNextToken added in v1.5.0 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeNotificationsForBudgetInput) Validate 

func (s *DescribeNotificationsForBudgetInput) Validate() error

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

type DescribeNotificationsForBudgetOutput 

type DescribeNotificationsForBudgetOutput struct {

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

	// A list of notifications that are associated with a budget.
	Notifications []*Notification `type:"list"`
	// contains filtered or unexported fields
}

Response of GetNotificationsForBudget

func (DescribeNotificationsForBudgetOutput) GoString 

func (s DescribeNotificationsForBudgetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeNotificationsForBudgetOutput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (*DescribeNotificationsForBudgetOutput) SetNotifications added in v1.5.0 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeSubscribersForNotificationInput 

type DescribeSubscribersForNotificationInput struct {

	// The accountId that is associated with the budget whose subscribers you want
	// descriptions of.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// The name of the budget whose subscribers you want descriptions of.
	//
	// BudgetName is a required field
	BudgetName *string `min:"1" type:"string" required:"true"`

	// An optional integer that represents how many entries a paginated response
	// contains. The maximum is 100.
	MaxResults *int64 `min:"1" type:"integer"`

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

	// The notification whose subscribers you want to list.
	//
	// Notification is a required field
	Notification *Notification `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Request of DescribeSubscribersForNotification

func (DescribeSubscribersForNotificationInput) GoString 

func (s DescribeSubscribersForNotificationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSubscribersForNotificationInput) SetAccountId added in v1.5.0 

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

SetAccountId sets the AccountId field's value.

func (*DescribeSubscribersForNotificationInput) SetBudgetName added in v1.5.0 

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

SetBudgetName sets the BudgetName field's value.

func (*DescribeSubscribersForNotificationInput) SetMaxResults added in v1.5.0 

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

SetMaxResults sets the MaxResults field's value.

func (*DescribeSubscribersForNotificationInput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (*DescribeSubscribersForNotificationInput) SetNotification added in v1.5.0 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSubscribersForNotificationInput) Validate 

func (s *DescribeSubscribersForNotificationInput) Validate() error

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

type DescribeSubscribersForNotificationOutput 

type DescribeSubscribersForNotificationOutput struct {

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

	// A list of subscribers that are associated with a notification.
	Subscribers []*Subscriber `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Response of DescribeSubscribersForNotification

func (DescribeSubscribersForNotificationOutput) GoString 

func (s DescribeSubscribersForNotificationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeSubscribersForNotificationOutput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (*DescribeSubscribersForNotificationOutput) SetSubscribers added in v1.5.0 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DuplicateRecordException added in v1.28.0 

type DuplicateRecordException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error message the exception carries.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The budget name already exists. Budget names must be unique within an account.

func (*DuplicateRecordException) Code added in v1.28.0 

func (s *DuplicateRecordException) Code() string

Code returns the exception type name.

func (*DuplicateRecordException) Error added in v1.28.0 

func (s *DuplicateRecordException) Error() string

func (DuplicateRecordException) GoString added in v1.28.0 

func (s DuplicateRecordException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DuplicateRecordException) Message added in v1.28.0 

func (s *DuplicateRecordException) Message() string

Message returns the exception's message.

func (*DuplicateRecordException) OrigErr added in v1.28.0 

func (s *DuplicateRecordException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DuplicateRecordException) RequestID added in v1.28.0 

func (s *DuplicateRecordException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DuplicateRecordException) StatusCode added in v1.28.0 

func (s *DuplicateRecordException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DuplicateRecordException) String added in v1.28.0 

func (s DuplicateRecordException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExecuteBudgetActionInput added in v1.35.8 

type ExecuteBudgetActionInput struct {

	// The account ID of the user. It's a 12-digit number.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// A system-generated universally unique identifier (UUID) for the action.
	//
	// ActionId is a required field
	ActionId *string `min:"36" type:"string" required:"true"`

	// A string that represents the budget name. The ":" and "\" characters, and
	// the "/action/" substring, aren't allowed.
	//
	// BudgetName is a required field
	BudgetName *string `min:"1" type:"string" required:"true"`

	// The type of execution.
	//
	// ExecutionType is a required field
	ExecutionType *string `type:"string" required:"true" enum:"ExecutionType"`
	// contains filtered or unexported fields
}

func (ExecuteBudgetActionInput) GoString added in v1.35.8 

func (s ExecuteBudgetActionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecuteBudgetActionInput) SetAccountId added in v1.35.8 

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

SetAccountId sets the AccountId field's value.

func (*ExecuteBudgetActionInput) SetActionId added in v1.35.8 

func (s *ExecuteBudgetActionInput) SetActionId(v string) *ExecuteBudgetActionInput

SetActionId sets the ActionId field's value.

func (*ExecuteBudgetActionInput) SetBudgetName added in v1.35.8 

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

SetBudgetName sets the BudgetName field's value.

func (*ExecuteBudgetActionInput) SetExecutionType added in v1.35.8 

func (s *ExecuteBudgetActionInput) SetExecutionType(v string) *ExecuteBudgetActionInput

SetExecutionType sets the ExecutionType field's value.

func (ExecuteBudgetActionInput) String added in v1.35.8 

func (s ExecuteBudgetActionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecuteBudgetActionInput) Validate added in v1.35.8 

func (s *ExecuteBudgetActionInput) Validate() error

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

type ExecuteBudgetActionOutput added in v1.35.8 

type ExecuteBudgetActionOutput struct {

	// The account ID of the user. It's a 12-digit number.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// A system-generated universally unique identifier (UUID) for the action.
	//
	// ActionId is a required field
	ActionId *string `min:"36" type:"string" required:"true"`

	// A string that represents the budget name. The ":" and "\" characters, and
	// the "/action/" substring, aren't allowed.
	//
	// BudgetName is a required field
	BudgetName *string `min:"1" type:"string" required:"true"`

	// The type of execution.
	//
	// ExecutionType is a required field
	ExecutionType *string `type:"string" required:"true" enum:"ExecutionType"`
	// contains filtered or unexported fields
}

func (ExecuteBudgetActionOutput) GoString added in v1.35.8 

func (s ExecuteBudgetActionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecuteBudgetActionOutput) SetAccountId added in v1.35.8 

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

SetAccountId sets the AccountId field's value.

func (*ExecuteBudgetActionOutput) SetActionId added in v1.35.8 

func (s *ExecuteBudgetActionOutput) SetActionId(v string) *ExecuteBudgetActionOutput

SetActionId sets the ActionId field's value.

func (*ExecuteBudgetActionOutput) SetBudgetName added in v1.35.8 

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

SetBudgetName sets the BudgetName field's value.

func (*ExecuteBudgetActionOutput) SetExecutionType added in v1.35.8 

func (s *ExecuteBudgetActionOutput) SetExecutionType(v string) *ExecuteBudgetActionOutput

SetExecutionType sets the ExecutionType field's value.

func (ExecuteBudgetActionOutput) String added in v1.35.8 

func (s ExecuteBudgetActionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExpiredNextTokenException added in v1.28.0 

type ExpiredNextTokenException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error message the exception carries.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The pagination token expired.

func (*ExpiredNextTokenException) Code added in v1.28.0 

func (s *ExpiredNextTokenException) Code() string

Code returns the exception type name.

func (*ExpiredNextTokenException) Error added in v1.28.0 

func (s *ExpiredNextTokenException) Error() string

func (ExpiredNextTokenException) GoString added in v1.28.0 

func (s ExpiredNextTokenException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExpiredNextTokenException) Message added in v1.28.0 

func (s *ExpiredNextTokenException) Message() string

Message returns the exception's message.

func (*ExpiredNextTokenException) OrigErr added in v1.28.0 

func (s *ExpiredNextTokenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ExpiredNextTokenException) RequestID added in v1.28.0 

func (s *ExpiredNextTokenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ExpiredNextTokenException) StatusCode added in v1.28.0 

func (s *ExpiredNextTokenException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ExpiredNextTokenException) String added in v1.28.0 

func (s ExpiredNextTokenException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type HistoricalOptions added in v1.43.0 

type HistoricalOptions struct {

	// The number of budget periods included in the moving-average calculation that
	// determines your auto-adjusted budget amount. The maximum value depends on
	// the TimeUnit granularity of the budget:
	//
	//    * For the DAILY granularity, the maximum value is 60.
	//
	//    * For the MONTHLY granularity, the maximum value is 12.
	//
	//    * For the QUARTERLY granularity, the maximum value is 4.
	//
	//    * For the ANNUALLY granularity, the maximum value is 1.
	//
	// BudgetAdjustmentPeriod is a required field
	BudgetAdjustmentPeriod *int64 `min:"1" type:"integer" required:"true"`

	// The integer that describes how many budget periods in your BudgetAdjustmentPeriod
	// are included in the calculation of your current BudgetLimit. If the first
	// budget period in your BudgetAdjustmentPeriod has no cost data, then that
	// budget period isn’t included in the average that determines your budget
	// limit.
	//
	// For example, if you set BudgetAdjustmentPeriod as 4 quarters, but your account
	// had no cost data in the first quarter, then only the last three quarters
	// are included in the calculation. In this scenario, LookBackAvailablePeriods
	// returns 3.
	//
	// You can’t set your own LookBackAvailablePeriods. The value is automatically
	// calculated from the BudgetAdjustmentPeriod and your historical cost data.
	LookBackAvailablePeriods *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

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

func (HistoricalOptions) GoString added in v1.43.0 

func (s HistoricalOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HistoricalOptions) SetBudgetAdjustmentPeriod added in v1.43.0 

func (s *HistoricalOptions) SetBudgetAdjustmentPeriod(v int64) *HistoricalOptions

SetBudgetAdjustmentPeriod sets the BudgetAdjustmentPeriod field's value.

func (*HistoricalOptions) SetLookBackAvailablePeriods added in v1.43.0 

func (s *HistoricalOptions) SetLookBackAvailablePeriods(v int64) *HistoricalOptions

SetLookBackAvailablePeriods sets the LookBackAvailablePeriods field's value.

func (HistoricalOptions) String added in v1.43.0 

func (s HistoricalOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HistoricalOptions) Validate added in v1.43.0 

func (s *HistoricalOptions) Validate() error

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

type IamActionDefinition added in v1.35.8 

type IamActionDefinition struct {

	// A list of groups to be attached. There must be at least one group.
	Groups []*string `min:"1" type:"list"`

	// The Amazon Resource Name (ARN) of the policy to be attached.
	//
	// PolicyArn is a required field
	PolicyArn *string `min:"25" type:"string" required:"true"`

	// A list of roles to be attached. There must be at least one role.
	Roles []*string `min:"1" type:"list"`

	// A list of users to be attached. There must be at least one user.
	Users []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

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

func (IamActionDefinition) GoString added in v1.35.8 

func (s IamActionDefinition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IamActionDefinition) SetGroups added in v1.35.8 

func (s *IamActionDefinition) SetGroups(v []*string) *IamActionDefinition

SetGroups sets the Groups field's value.

func (*IamActionDefinition) SetPolicyArn added in v1.35.8 

func (s *IamActionDefinition) SetPolicyArn(v string) *IamActionDefinition

SetPolicyArn sets the PolicyArn field's value.

func (*IamActionDefinition) SetRoles added in v1.35.8 

func (s *IamActionDefinition) SetRoles(v []*string) *IamActionDefinition

SetRoles sets the Roles field's value.

func (*IamActionDefinition) SetUsers added in v1.35.8 

func (s *IamActionDefinition) SetUsers(v []*string) *IamActionDefinition

SetUsers sets the Users field's value.

func (IamActionDefinition) String added in v1.35.8 

func (s IamActionDefinition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IamActionDefinition) Validate added in v1.35.8 

func (s *IamActionDefinition) Validate() error

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

type InternalErrorException added in v1.28.0 

type InternalErrorException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error message the exception carries.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

An error on the server occurred during the processing of your request. Try again later.

func (*InternalErrorException) Code added in v1.28.0 

func (s *InternalErrorException) Code() string

Code returns the exception type name.

func (*InternalErrorException) Error added in v1.28.0 

func (s *InternalErrorException) Error() string

func (InternalErrorException) GoString added in v1.28.0 

func (s InternalErrorException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalErrorException) Message added in v1.28.0 

func (s *InternalErrorException) Message() string

Message returns the exception's message.

func (*InternalErrorException) OrigErr added in v1.28.0 

func (s *InternalErrorException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalErrorException) RequestID added in v1.28.0 

func (s *InternalErrorException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalErrorException) StatusCode added in v1.28.0 

func (s *InternalErrorException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalErrorException) String added in v1.28.0 

func (s InternalErrorException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidNextTokenException added in v1.28.0 

type InvalidNextTokenException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error message the exception carries.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The pagination token is invalid.

func (*InvalidNextTokenException) Code added in v1.28.0 

func (s *InvalidNextTokenException) Code() string

Code returns the exception type name.

func (*InvalidNextTokenException) Error added in v1.28.0 

func (s *InvalidNextTokenException) Error() string

func (InvalidNextTokenException) GoString added in v1.28.0 

func (s InvalidNextTokenException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidNextTokenException) Message added in v1.28.0 

func (s *InvalidNextTokenException) Message() string

Message returns the exception's message.

func (*InvalidNextTokenException) OrigErr added in v1.28.0 

func (s *InvalidNextTokenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidNextTokenException) RequestID added in v1.28.0 

func (s *InvalidNextTokenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidNextTokenException) StatusCode added in v1.28.0 

func (s *InvalidNextTokenException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidNextTokenException) String added in v1.28.0 

func (s InvalidNextTokenException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidParameterException added in v1.28.0 

type InvalidParameterException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error message the exception carries.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

An error on the client occurred. Typically, the cause is an invalid input value.

func (*InvalidParameterException) Code added in v1.28.0 

func (s *InvalidParameterException) Code() string

Code returns the exception type name.

func (*InvalidParameterException) Error added in v1.28.0 

func (s *InvalidParameterException) Error() string

func (InvalidParameterException) GoString added in v1.28.0 

func (s InvalidParameterException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidParameterException) Message added in v1.28.0 

func (s *InvalidParameterException) Message() string

Message returns the exception's message.

func (*InvalidParameterException) OrigErr added in v1.28.0 

func (s *InvalidParameterException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidParameterException) RequestID added in v1.28.0 

func (s *InvalidParameterException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidParameterException) StatusCode added in v1.28.0 

func (s *InvalidParameterException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidParameterException) String added in v1.28.0 

func (s InvalidParameterException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NotFoundException added in v1.28.0 

type NotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error message the exception carries.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

We can’t locate the resource that you specified.

func (*NotFoundException) Code added in v1.28.0 

func (s *NotFoundException) Code() string

Code returns the exception type name.

func (*NotFoundException) Error added in v1.28.0 

func (s *NotFoundException) Error() string

func (NotFoundException) GoString added in v1.28.0 

func (s NotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotFoundException) Message added in v1.28.0 

func (s *NotFoundException) Message() string

Message returns the exception's message.

func (*NotFoundException) OrigErr added in v1.28.0 

func (s *NotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotFoundException) RequestID added in v1.28.0 

func (s *NotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotFoundException) StatusCode added in v1.28.0 

func (s *NotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NotFoundException) String added in v1.28.0 

func (s NotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Notification 

type Notification struct {

	// The comparison that's used for this notification.
	//
	// ComparisonOperator is a required field
	ComparisonOperator *string `type:"string" required:"true" enum:"ComparisonOperator"`

	// Specifies whether this notification is in alarm. If a budget notification
	// is in the ALARM state, you passed the set threshold for the budget.
	NotificationState *string `type:"string" enum:"NotificationState"`

	// Specifies whether the notification is for how much you have spent (ACTUAL)
	// or for how much that you're forecasted to spend (FORECASTED).
	//
	// NotificationType is a required field
	NotificationType *string `type:"string" required:"true" enum:"NotificationType"`

	// The threshold that's associated with a notification. Thresholds are always
	// a percentage, and many customers find value being alerted between 50% - 200%
	// of the budgeted amount. The maximum limit for your threshold is 1,000,000%
	// above the budgeted amount.
	//
	// Threshold is a required field
	Threshold *float64 `type:"double" required:"true"`

	// The type of threshold for a notification. For ABSOLUTE_VALUE thresholds,
	// Amazon Web Services notifies you when you go over or are forecasted to go
	// over your total cost threshold. For PERCENTAGE thresholds, Amazon Web Services
	// notifies you when you go over or are forecasted to go over a certain percentage
	// of your forecasted spend. For example, if you have a budget for 200 dollars
	// and you have a PERCENTAGE threshold of 80%, Amazon Web Services notifies
	// you when you go over 160 dollars.
	ThresholdType *string `type:"string" enum:"ThresholdType"`
	// contains filtered or unexported fields
}

A notification that's associated with a budget. A budget can have up to ten notifications.

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

For example, if you have a budget for 200 dollars and you want to be notified when you go over 160 dollars, create a notification with the following parameters:

  • A notificationType of ACTUAL

  • A thresholdType of PERCENTAGE

  • A comparisonOperator of GREATER_THAN

  • A notification threshold of 80

func (Notification) GoString 

func (s Notification) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Notification) SetComparisonOperator added in v1.5.0 

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

SetComparisonOperator sets the ComparisonOperator field's value.

func (*Notification) SetNotificationState added in v1.15.74 

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

SetNotificationState sets the NotificationState field's value.

func (*Notification) SetNotificationType added in v1.5.0 

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

SetNotificationType sets the NotificationType field's value.

func (*Notification) SetThreshold added in v1.5.0 

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

SetThreshold sets the Threshold field's value.

func (*Notification) SetThresholdType added in v1.10.39 

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

SetThresholdType sets the ThresholdType field's value.

func (Notification) String 

func (s Notification) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Notification) Validate 

func (s *Notification) Validate() error

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

type NotificationWithSubscribers 

type NotificationWithSubscribers struct {

	// The notification that's associated with a budget.
	//
	// Notification is a required field
	Notification *Notification `type:"structure" required:"true"`

	// A list of subscribers who are subscribed to this notification.
	//
	// Subscribers is a required field
	Subscribers []*Subscriber `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

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

func (NotificationWithSubscribers) GoString 

func (s NotificationWithSubscribers) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotificationWithSubscribers) SetNotification added in v1.5.0 

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

SetNotification sets the Notification field's value.

func (*NotificationWithSubscribers) SetSubscribers added in v1.5.0 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotificationWithSubscribers) Validate 

func (s *NotificationWithSubscribers) Validate() error

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

type ResourceLockedException added in v1.35.8 

type ResourceLockedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error message the exception carries.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*ResourceLockedException) Code added in v1.35.8 

func (s *ResourceLockedException) Code() string

Code returns the exception type name.

func (*ResourceLockedException) Error added in v1.35.8 

func (s *ResourceLockedException) Error() string

func (ResourceLockedException) GoString added in v1.35.8 

func (s ResourceLockedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceLockedException) Message added in v1.35.8 

func (s *ResourceLockedException) Message() string

Message returns the exception's message.

func (*ResourceLockedException) OrigErr added in v1.35.8 

func (s *ResourceLockedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceLockedException) RequestID added in v1.35.8 

func (s *ResourceLockedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceLockedException) StatusCode added in v1.35.8 

func (s *ResourceLockedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceLockedException) String added in v1.35.8 

func (s ResourceLockedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ScpActionDefinition added in v1.35.8 

type ScpActionDefinition struct {

	// The policy ID attached.
	//
	// PolicyId is a required field
	PolicyId *string `min:"10" type:"string" required:"true"`

	// A list of target IDs.
	//
	// TargetIds is a required field
	TargetIds []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The service control policies (SCP) action definition details.

func (ScpActionDefinition) GoString added in v1.35.8 

func (s ScpActionDefinition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScpActionDefinition) SetPolicyId added in v1.35.8 

func (s *ScpActionDefinition) SetPolicyId(v string) *ScpActionDefinition

SetPolicyId sets the PolicyId field's value.

func (*ScpActionDefinition) SetTargetIds added in v1.35.8 

func (s *ScpActionDefinition) SetTargetIds(v []*string) *ScpActionDefinition

SetTargetIds sets the TargetIds field's value.

func (ScpActionDefinition) String added in v1.35.8 

func (s ScpActionDefinition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScpActionDefinition) Validate added in v1.35.8 

func (s *ScpActionDefinition) Validate() error

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

type Spend 

type Spend struct {

	// The cost or usage amount that's associated with a budget forecast, actual
	// spend, or budget threshold.
	//
	// Amount is a required field
	Amount *string `min:"1" type:"string" required:"true"`

	// The unit of measurement that's used for the budget forecast, actual spend,
	// or budget threshold, such as USD or GBP.
	//
	// Unit is a required field
	Unit *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The amount of cost or usage that's measured for a budget.

For example, a Spend for 3 GB of S3 usage has the following parameters:

  • An Amount of 3

  • A unit of GB

func (Spend) GoString 

func (s Spend) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Spend) SetAmount added in v1.5.0 

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

SetAmount sets the Amount field's value.

func (*Spend) SetUnit added in v1.5.0 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Spend) Validate 

func (s *Spend) Validate() error

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

type SsmActionDefinition added in v1.35.8 

type SsmActionDefinition struct {

	// The action subType.
	//
	// ActionSubType is a required field
	ActionSubType *string `type:"string" required:"true" enum:"ActionSubType"`

	// The EC2 and RDS instance IDs.
	//
	// InstanceIds is a required field
	InstanceIds []*string `min:"1" type:"list" required:"true"`

	// The Region to run the SSM document.
	//
	// Region is a required field
	Region *string `min:"9" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (SsmActionDefinition) GoString added in v1.35.8 

func (s SsmActionDefinition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SsmActionDefinition) SetActionSubType added in v1.35.8 

func (s *SsmActionDefinition) SetActionSubType(v string) *SsmActionDefinition

SetActionSubType sets the ActionSubType field's value.

func (*SsmActionDefinition) SetInstanceIds added in v1.35.8 

func (s *SsmActionDefinition) SetInstanceIds(v []*string) *SsmActionDefinition

SetInstanceIds sets the InstanceIds field's value.

func (*SsmActionDefinition) SetRegion added in v1.35.8 

func (s *SsmActionDefinition) SetRegion(v string) *SsmActionDefinition

SetRegion sets the Region field's value.

func (SsmActionDefinition) String added in v1.35.8 

func (s SsmActionDefinition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SsmActionDefinition) Validate added in v1.35.8 

func (s *SsmActionDefinition) Validate() error

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

type Subscriber 

type Subscriber struct {

	// The address that Amazon Web Services sends budget notifications to, either
	// an SNS topic or an email.
	//
	// When you create a subscriber, the value of Address can't contain line breaks.
	//
	// Address is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Subscriber's
	// String and GoString methods.
	//
	// Address is a required field
	Address *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// The type of notification that Amazon Web Services sends to a subscriber.
	//
	// SubscriptionType is a required field
	SubscriptionType *string `type:"string" required:"true" enum:"SubscriptionType"`
	// contains filtered or unexported fields
}

The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon SNS topic or an email address.

For example, an email subscriber has the following parameters:

  • A subscriptionType of EMAIL

  • An address of example@example.com

func (Subscriber) GoString 

func (s Subscriber) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Subscriber) SetAddress added in v1.5.0 

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

SetAddress sets the Address field's value.

func (*Subscriber) SetSubscriptionType added in v1.5.0 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Subscriber) Validate 

func (s *Subscriber) Validate() error

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

type ThrottlingException added in v1.44.34 

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The error message the exception carries.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*ThrottlingException) Code added in v1.44.34 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error added in v1.44.34 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString added in v1.44.34 

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message added in v1.44.34 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr added in v1.44.34 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID added in v1.44.34 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode added in v1.44.34 

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String added in v1.44.34 

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TimePeriod 

type TimePeriod struct {

	// The end date for a budget. If you didn't specify an end date, Amazon Web
	// Services set your end date to 06/15/87 00:00 UTC. The defaults are the same
	// for the Billing and Cost Management console and the API.
	//
	// After the end date, Amazon Web Services deletes the budget and all the associated
	// notifications and subscribers. You can change your end date with the UpdateBudget
	// operation.
	End *time.Time `type:"timestamp"`

	// The start date for a budget. If you created your budget and didn't specify
	// a start date, Amazon Web Services defaults to the start of your chosen time
	// period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created
	// your budget on January 24, 2018, chose DAILY, and didn't set a start date,
	// Amazon Web Services set your start date to 01/24/18 00:00 UTC. If you chose
	// MONTHLY, Amazon Web Services set your start date to 01/01/18 00:00 UTC. The
	// defaults are the same for the Billing and Cost Management console and the
	// API.
	//
	// You can change your start date with the UpdateBudget operation.
	Start *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

The period of time that's covered by a budget. The period has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date.

func (TimePeriod) GoString 

func (s TimePeriod) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimePeriod) SetEnd added in v1.5.0 

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

SetEnd sets the End field's value.

func (*TimePeriod) SetStart added in v1.5.0 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateBudgetActionInput added in v1.35.8 

type UpdateBudgetActionInput struct {

	// The account ID of the user. It's a 12-digit number.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// A system-generated universally unique identifier (UUID) for the action.
	//
	// ActionId is a required field
	ActionId *string `min:"36" type:"string" required:"true"`

	// The trigger threshold of the action.
	ActionThreshold *ActionThreshold `type:"structure"`

	// This specifies if the action needs manual or automatic approval.
	ApprovalModel *string `type:"string" enum:"ApprovalModel"`

	// A string that represents the budget name. The ":" and "\" characters, and
	// the "/action/" substring, aren't allowed.
	//
	// BudgetName is a required field
	BudgetName *string `min:"1" type:"string" required:"true"`

	// Specifies all of the type-specific parameters.
	Definition *Definition `type:"structure"`

	// The role passed for action execution and reversion. Roles and actions must
	// be in the same account.
	ExecutionRoleArn *string `min:"32" type:"string"`

	// The type of a notification. It must be ACTUAL or FORECASTED.
	NotificationType *string `type:"string" enum:"NotificationType"`

	// A list of subscribers.
	Subscribers []*Subscriber `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (UpdateBudgetActionInput) GoString added in v1.35.8 

func (s UpdateBudgetActionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateBudgetActionInput) SetAccountId added in v1.35.8 

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

SetAccountId sets the AccountId field's value.

func (*UpdateBudgetActionInput) SetActionId added in v1.35.8 

func (s *UpdateBudgetActionInput) SetActionId(v string) *UpdateBudgetActionInput

SetActionId sets the ActionId field's value.

func (*UpdateBudgetActionInput) SetActionThreshold added in v1.35.8 

func (s *UpdateBudgetActionInput) SetActionThreshold(v *ActionThreshold) *UpdateBudgetActionInput

SetActionThreshold sets the ActionThreshold field's value.

func (*UpdateBudgetActionInput) SetApprovalModel added in v1.35.8 

func (s *UpdateBudgetActionInput) SetApprovalModel(v string) *UpdateBudgetActionInput

SetApprovalModel sets the ApprovalModel field's value.

func (*UpdateBudgetActionInput) SetBudgetName added in v1.35.8 

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

SetBudgetName sets the BudgetName field's value.

func (*UpdateBudgetActionInput) SetDefinition added in v1.35.8 

func (s *UpdateBudgetActionInput) SetDefinition(v *Definition) *UpdateBudgetActionInput

SetDefinition sets the Definition field's value.

func (*UpdateBudgetActionInput) SetExecutionRoleArn added in v1.35.8 

func (s *UpdateBudgetActionInput) SetExecutionRoleArn(v string) *UpdateBudgetActionInput

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*UpdateBudgetActionInput) SetNotificationType added in v1.35.8 

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

SetNotificationType sets the NotificationType field's value.

func (*UpdateBudgetActionInput) SetSubscribers added in v1.35.8 

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

SetSubscribers sets the Subscribers field's value.

func (UpdateBudgetActionInput) String added in v1.35.8 

func (s UpdateBudgetActionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateBudgetActionInput) Validate added in v1.35.8 

func (s *UpdateBudgetActionInput) Validate() error

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

type UpdateBudgetActionOutput added in v1.35.8 

type UpdateBudgetActionOutput struct {

	// The account ID of the user. It's a 12-digit number.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// A string that represents the budget name. The ":" and "\" characters, and
	// the "/action/" substring, aren't allowed.
	//
	// BudgetName is a required field
	BudgetName *string `min:"1" type:"string" required:"true"`

	// The updated action resource information.
	//
	// NewAction is a required field
	NewAction *Action `type:"structure" required:"true"`

	// The previous action resource information.
	//
	// OldAction is a required field
	OldAction *Action `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateBudgetActionOutput) GoString added in v1.35.8 

func (s UpdateBudgetActionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateBudgetActionOutput) SetAccountId added in v1.35.8 

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

SetAccountId sets the AccountId field's value.

func (*UpdateBudgetActionOutput) SetBudgetName added in v1.35.8 

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

SetBudgetName sets the BudgetName field's value.

func (*UpdateBudgetActionOutput) SetNewAction added in v1.35.8 

func (s *UpdateBudgetActionOutput) SetNewAction(v *Action) *UpdateBudgetActionOutput

SetNewAction sets the NewAction field's value.

func (*UpdateBudgetActionOutput) SetOldAction added in v1.35.8 

func (s *UpdateBudgetActionOutput) SetOldAction(v *Action) *UpdateBudgetActionOutput

SetOldAction sets the OldAction field's value.

func (UpdateBudgetActionOutput) String added in v1.35.8 

func (s UpdateBudgetActionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateBudgetInput 

type UpdateBudgetInput struct {

	// The accountId that is associated with the budget that you want to update.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// The budget that you want to update your budget to.
	//
	// NewBudget is a required field
	NewBudget *Budget `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Request of UpdateBudget

func (UpdateBudgetInput) GoString 

func (s UpdateBudgetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateBudgetInput) SetAccountId added in v1.5.0 

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

SetAccountId sets the AccountId field's value.

func (*UpdateBudgetInput) SetNewBudget added in v1.5.0 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateBudgetInput) Validate 

func (s *UpdateBudgetInput) Validate() error

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

type UpdateBudgetOutput 

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

Response of UpdateBudget

func (UpdateBudgetOutput) GoString 

func (s UpdateBudgetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateBudgetOutput) String 

func (s UpdateBudgetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateNotificationInput 

type UpdateNotificationInput struct {

	// The accountId that is associated with the budget whose notification you want
	// to update.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// The name of the budget whose notification you want to update.
	//
	// BudgetName is a required field
	BudgetName *string `min:"1" type:"string" required:"true"`

	// The updated notification to be associated with a budget.
	//
	// NewNotification is a required field
	NewNotification *Notification `type:"structure" required:"true"`

	// The previous notification that is associated with a budget.
	//
	// OldNotification is a required field
	OldNotification *Notification `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Request of UpdateNotification

func (UpdateNotificationInput) GoString 

func (s UpdateNotificationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateNotificationInput) SetAccountId added in v1.5.0 

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

SetAccountId sets the AccountId field's value.

func (*UpdateNotificationInput) SetBudgetName added in v1.5.0 

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

SetBudgetName sets the BudgetName field's value.

func (*UpdateNotificationInput) SetNewNotification added in v1.5.0 

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

SetNewNotification sets the NewNotification field's value.

func (*UpdateNotificationInput) SetOldNotification added in v1.5.0 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateNotificationInput) Validate 

func (s *UpdateNotificationInput) Validate() error

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

type UpdateNotificationOutput 

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

Response of UpdateNotification

func (UpdateNotificationOutput) GoString 

func (s UpdateNotificationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateNotificationOutput) String 

func (s UpdateNotificationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateSubscriberInput 

type UpdateSubscriberInput struct {

	// The accountId that is associated with the budget whose subscriber you want
	// to update.
	//
	// AccountId is a required field
	AccountId *string `min:"12" type:"string" required:"true"`

	// The name of the budget whose subscriber you want to update.
	//
	// BudgetName is a required field
	BudgetName *string `min:"1" type:"string" required:"true"`

	// The updated subscriber that is associated with a budget notification.
	//
	// NewSubscriber is a required field
	NewSubscriber *Subscriber `type:"structure" required:"true"`

	// The notification whose subscriber you want to update.
	//
	// Notification is a required field
	Notification *Notification `type:"structure" required:"true"`

	// The previous subscriber that is associated with a budget notification.
	//
	// OldSubscriber is a required field
	OldSubscriber *Subscriber `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Request of UpdateSubscriber

func (UpdateSubscriberInput) GoString 

func (s UpdateSubscriberInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSubscriberInput) SetAccountId added in v1.5.0 

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

SetAccountId sets the AccountId field's value.

func (*UpdateSubscriberInput) SetBudgetName added in v1.5.0 

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

SetBudgetName sets the BudgetName field's value.

func (*UpdateSubscriberInput) SetNewSubscriber added in v1.5.0 

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

SetNewSubscriber sets the NewSubscriber field's value.

func (*UpdateSubscriberInput) SetNotification added in v1.5.0 

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

SetNotification sets the Notification field's value.

func (*UpdateSubscriberInput) SetOldSubscriber added in v1.5.0 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSubscriberInput) Validate 

func (s *UpdateSubscriberInput) Validate() error

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

type UpdateSubscriberOutput 

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

Response of UpdateSubscriber

func (UpdateSubscriberOutput) GoString 

func (s UpdateSubscriberOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateSubscriberOutput) String 

func (s UpdateSubscriberOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

Directories

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

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.