1// Code generated by smithy-go-codegen DO NOT EDIT. 2 3package budgets 4 5import ( 6 "context" 7 "fmt" 8 awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware" 9 "github.com/aws/aws-sdk-go-v2/aws/signer/v4" 10 "github.com/aws/aws-sdk-go-v2/service/budgets/types" 11 "github.com/aws/smithy-go/middleware" 12 smithyhttp "github.com/aws/smithy-go/transport/http" 13) 14 15// Describes the history for DAILY, MONTHLY, and QUARTERLY budgets. Budget history 16// isn't available for ANNUAL budgets. 17func (c *Client) DescribeBudgetPerformanceHistory(ctx context.Context, params *DescribeBudgetPerformanceHistoryInput, optFns ...func(*Options)) (*DescribeBudgetPerformanceHistoryOutput, error) { 18 if params == nil { 19 params = &DescribeBudgetPerformanceHistoryInput{} 20 } 21 22 result, metadata, err := c.invokeOperation(ctx, "DescribeBudgetPerformanceHistory", params, optFns, addOperationDescribeBudgetPerformanceHistoryMiddlewares) 23 if err != nil { 24 return nil, err 25 } 26 27 out := result.(*DescribeBudgetPerformanceHistoryOutput) 28 out.ResultMetadata = metadata 29 return out, nil 30} 31 32type DescribeBudgetPerformanceHistoryInput struct { 33 34 // The account ID of the user. It should be a 12-digit number. 35 // 36 // This member is required. 37 AccountId *string 38 39 // A string that represents the budget name. The ":" and "\" characters aren't 40 // allowed. 41 // 42 // This member is required. 43 BudgetName *string 44 45 // An integer that represents how many entries a paginated response contains. The 46 // maximum is 100. 47 MaxResults *int32 48 49 // A generic string. 50 NextToken *string 51 52 // Retrieves how often the budget went into an ALARM state for the specified time 53 // period. 54 TimePeriod *types.TimePeriod 55} 56 57type DescribeBudgetPerformanceHistoryOutput struct { 58 59 // The history of how often the budget has gone into an ALARM state. For DAILY 60 // budgets, the history saves the state of the budget for the last 60 days. For 61 // MONTHLY budgets, the history saves the state of the budget for the current month 62 // plus the last 12 months. For QUARTERLY budgets, the history saves the state of 63 // the budget for the last four quarters. 64 BudgetPerformanceHistory *types.BudgetPerformanceHistory 65 66 // A generic string. 67 NextToken *string 68 69 // Metadata pertaining to the operation's result. 70 ResultMetadata middleware.Metadata 71} 72 73func addOperationDescribeBudgetPerformanceHistoryMiddlewares(stack *middleware.Stack, options Options) (err error) { 74 err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeBudgetPerformanceHistory{}, middleware.After) 75 if err != nil { 76 return err 77 } 78 err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeBudgetPerformanceHistory{}, middleware.After) 79 if err != nil { 80 return err 81 } 82 if err = addSetLoggerMiddleware(stack, options); err != nil { 83 return err 84 } 85 if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil { 86 return err 87 } 88 if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil { 89 return err 90 } 91 if err = addResolveEndpointMiddleware(stack, options); err != nil { 92 return err 93 } 94 if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil { 95 return err 96 } 97 if err = addRetryMiddlewares(stack, options); err != nil { 98 return err 99 } 100 if err = addHTTPSignerV4Middleware(stack, options); err != nil { 101 return err 102 } 103 if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil { 104 return err 105 } 106 if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil { 107 return err 108 } 109 if err = addClientUserAgent(stack); err != nil { 110 return err 111 } 112 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil { 113 return err 114 } 115 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil { 116 return err 117 } 118 if err = addOpDescribeBudgetPerformanceHistoryValidationMiddleware(stack); err != nil { 119 return err 120 } 121 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeBudgetPerformanceHistory(options.Region), middleware.Before); err != nil { 122 return err 123 } 124 if err = addRequestIDRetrieverMiddleware(stack); err != nil { 125 return err 126 } 127 if err = addResponseErrorMiddleware(stack); err != nil { 128 return err 129 } 130 if err = addRequestResponseLogging(stack, options); err != nil { 131 return err 132 } 133 return nil 134} 135 136// DescribeBudgetPerformanceHistoryAPIClient is a client that implements the 137// DescribeBudgetPerformanceHistory operation. 138type DescribeBudgetPerformanceHistoryAPIClient interface { 139 DescribeBudgetPerformanceHistory(context.Context, *DescribeBudgetPerformanceHistoryInput, ...func(*Options)) (*DescribeBudgetPerformanceHistoryOutput, error) 140} 141 142var _ DescribeBudgetPerformanceHistoryAPIClient = (*Client)(nil) 143 144// DescribeBudgetPerformanceHistoryPaginatorOptions is the paginator options for 145// DescribeBudgetPerformanceHistory 146type DescribeBudgetPerformanceHistoryPaginatorOptions struct { 147 // An integer that represents how many entries a paginated response contains. The 148 // maximum is 100. 149 Limit int32 150 151 // Set to true if pagination should stop if the service returns a pagination token 152 // that matches the most recent token provided to the service. 153 StopOnDuplicateToken bool 154} 155 156// DescribeBudgetPerformanceHistoryPaginator is a paginator for 157// DescribeBudgetPerformanceHistory 158type DescribeBudgetPerformanceHistoryPaginator struct { 159 options DescribeBudgetPerformanceHistoryPaginatorOptions 160 client DescribeBudgetPerformanceHistoryAPIClient 161 params *DescribeBudgetPerformanceHistoryInput 162 nextToken *string 163 firstPage bool 164} 165 166// NewDescribeBudgetPerformanceHistoryPaginator returns a new 167// DescribeBudgetPerformanceHistoryPaginator 168func NewDescribeBudgetPerformanceHistoryPaginator(client DescribeBudgetPerformanceHistoryAPIClient, params *DescribeBudgetPerformanceHistoryInput, optFns ...func(*DescribeBudgetPerformanceHistoryPaginatorOptions)) *DescribeBudgetPerformanceHistoryPaginator { 169 if params == nil { 170 params = &DescribeBudgetPerformanceHistoryInput{} 171 } 172 173 options := DescribeBudgetPerformanceHistoryPaginatorOptions{} 174 if params.MaxResults != nil { 175 options.Limit = *params.MaxResults 176 } 177 178 for _, fn := range optFns { 179 fn(&options) 180 } 181 182 return &DescribeBudgetPerformanceHistoryPaginator{ 183 options: options, 184 client: client, 185 params: params, 186 firstPage: true, 187 } 188} 189 190// HasMorePages returns a boolean indicating whether more pages are available 191func (p *DescribeBudgetPerformanceHistoryPaginator) HasMorePages() bool { 192 return p.firstPage || p.nextToken != nil 193} 194 195// NextPage retrieves the next DescribeBudgetPerformanceHistory page. 196func (p *DescribeBudgetPerformanceHistoryPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeBudgetPerformanceHistoryOutput, error) { 197 if !p.HasMorePages() { 198 return nil, fmt.Errorf("no more pages available") 199 } 200 201 params := *p.params 202 params.NextToken = p.nextToken 203 204 var limit *int32 205 if p.options.Limit > 0 { 206 limit = &p.options.Limit 207 } 208 params.MaxResults = limit 209 210 result, err := p.client.DescribeBudgetPerformanceHistory(ctx, ¶ms, optFns...) 211 if err != nil { 212 return nil, err 213 } 214 p.firstPage = false 215 216 prevToken := p.nextToken 217 p.nextToken = result.NextToken 218 219 if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken { 220 p.nextToken = nil 221 } 222 223 return result, nil 224} 225 226func newServiceMetadataMiddleware_opDescribeBudgetPerformanceHistory(region string) *awsmiddleware.RegisterServiceMetadata { 227 return &awsmiddleware.RegisterServiceMetadata{ 228 Region: region, 229 ServiceID: ServiceID, 230 SigningName: "budgets", 231 OperationName: "DescribeBudgetPerformanceHistory", 232 } 233} 234