1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package costoptimizationhub
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/costoptimizationhub/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Returns a concise representation of savings estimates for resources. Also
// returns de-duped savings across different types of recommendations. The
// following filters are not supported for this API: recommendationIds ,
// resourceArns , and resourceIds .
func (c *Client) ListRecommendationSummaries(ctx context.Context, params *ListRecommendationSummariesInput, optFns ...func(*Options)) (*ListRecommendationSummariesOutput, error) {
if params == nil {
params = &ListRecommendationSummariesInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListRecommendationSummaries", params, optFns, c.addOperationListRecommendationSummariesMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListRecommendationSummariesOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListRecommendationSummariesInput struct {
// The grouping of recommendations by a dimension.
//
// This member is required.
GroupBy *string
// Describes a filter that returns a more specific list of recommendations.
// Filters recommendations by different dimensions.
Filter *types.Filter
// The maximum number of recommendations that are returned for the request.
MaxResults *int32
// The token to retrieve the next set of results.
NextToken *string
noSmithyDocumentSerde
}
type ListRecommendationSummariesOutput struct {
// The currency code used for the recommendation.
CurrencyCode *string
// The total overall savings for the aggregated view.
EstimatedTotalDedupedSavings *float64
// The dimension used to group the recommendations by.
GroupBy *string
// List of all savings recommendations.
Items []types.RecommendationSummary
// The token to retrieve the next set of results.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListRecommendationSummariesMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson10_serializeOpListRecommendationSummaries{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson10_deserializeOpListRecommendationSummaries{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "ListRecommendationSummaries"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpListRecommendationSummariesValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListRecommendationSummaries(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
// ListRecommendationSummariesAPIClient is a client that implements the
// ListRecommendationSummaries operation.
type ListRecommendationSummariesAPIClient interface {
ListRecommendationSummaries(context.Context, *ListRecommendationSummariesInput, ...func(*Options)) (*ListRecommendationSummariesOutput, error)
}
var _ ListRecommendationSummariesAPIClient = (*Client)(nil)
// ListRecommendationSummariesPaginatorOptions is the paginator options for
// ListRecommendationSummaries
type ListRecommendationSummariesPaginatorOptions struct {
// The maximum number of recommendations that are returned for the request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// ListRecommendationSummariesPaginator is a paginator for
// ListRecommendationSummaries
type ListRecommendationSummariesPaginator struct {
options ListRecommendationSummariesPaginatorOptions
client ListRecommendationSummariesAPIClient
params *ListRecommendationSummariesInput
nextToken *string
firstPage bool
}
// NewListRecommendationSummariesPaginator returns a new
// ListRecommendationSummariesPaginator
func NewListRecommendationSummariesPaginator(client ListRecommendationSummariesAPIClient, params *ListRecommendationSummariesInput, optFns ...func(*ListRecommendationSummariesPaginatorOptions)) *ListRecommendationSummariesPaginator {
if params == nil {
params = &ListRecommendationSummariesInput{}
}
options := ListRecommendationSummariesPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &ListRecommendationSummariesPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *ListRecommendationSummariesPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next ListRecommendationSummaries page.
func (p *ListRecommendationSummariesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRecommendationSummariesOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.ListRecommendationSummaries(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opListRecommendationSummaries(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "ListRecommendationSummaries",
}
}
|