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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package costexplorer
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/costexplorer/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Retrieves the Savings Plans recommendations for your account. First use
// StartSavingsPlansPurchaseRecommendationGeneration to generate a new set of
// recommendations, and then use GetSavingsPlansPurchaseRecommendation to retrieve
// them.
func (c *Client) GetSavingsPlansPurchaseRecommendation(ctx context.Context, params *GetSavingsPlansPurchaseRecommendationInput, optFns ...func(*Options)) (*GetSavingsPlansPurchaseRecommendationOutput, error) {
if params == nil {
params = &GetSavingsPlansPurchaseRecommendationInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetSavingsPlansPurchaseRecommendation", params, optFns, c.addOperationGetSavingsPlansPurchaseRecommendationMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetSavingsPlansPurchaseRecommendationOutput)
out.ResultMetadata = metadata
return out, nil
}
type GetSavingsPlansPurchaseRecommendationInput struct {
// The lookback period that's used to generate the recommendation.
//
// This member is required.
LookbackPeriodInDays types.LookbackPeriodInDays
// The payment option that's used to generate these recommendations.
//
// This member is required.
PaymentOption types.PaymentOption
// The Savings Plans recommendation type that's requested.
//
// This member is required.
SavingsPlansType types.SupportedSavingsPlansType
// The savings plan recommendation term that's used to generate these
// recommendations.
//
// This member is required.
TermInYears types.TermInYears
// The account scope that you want your recommendations for. Amazon Web Services
// calculates recommendations including the management account and member accounts
// if the value is set to PAYER . If the value is LINKED , recommendations are
// calculated for individual member accounts only.
AccountScope types.AccountScope
// You can filter your recommendations by Account ID with the LINKED_ACCOUNT
// dimension. To filter your recommendations by Account ID, specify Key as
// LINKED_ACCOUNT and Value as the comma-separated Acount ID(s) that you want to
// see Savings Plans purchase recommendations for.
//
// For GetSavingsPlansPurchaseRecommendation, the Filter doesn't include
// CostCategories or Tags . It only includes Dimensions . With Dimensions , Key
// must be LINKED_ACCOUNT and Value can be a single Account ID or multiple
// comma-separated Account IDs that you want to see Savings Plans Purchase
// Recommendations for. AND and OR operators are not supported.
Filter *types.Expression
// The token to retrieve the next set of results. Amazon Web Services provides the
// token when the response from a previous call has more results than the maximum
// page size.
NextPageToken *string
// The number of recommendations that you want returned in a single response
// object.
PageSize int32
noSmithyDocumentSerde
}
type GetSavingsPlansPurchaseRecommendationOutput struct {
// Information that regards this specific recommendation set.
Metadata *types.SavingsPlansPurchaseRecommendationMetadata
// The token for the next set of retrievable results. Amazon Web Services provides
// the token when the response from a previous call has more results than the
// maximum page size.
NextPageToken *string
// Contains your request parameters, Savings Plan Recommendations Summary, and
// Details.
SavingsPlansPurchaseRecommendation *types.SavingsPlansPurchaseRecommendation
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationGetSavingsPlansPurchaseRecommendationMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpGetSavingsPlansPurchaseRecommendation{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpGetSavingsPlansPurchaseRecommendation{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "GetSavingsPlansPurchaseRecommendation"); 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 = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = 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 = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpGetSavingsPlansPurchaseRecommendationValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetSavingsPlansPurchaseRecommendation(options.Region), middleware.Before); err != nil {
return err
}
if err = 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
}
func newServiceMetadataMiddleware_opGetSavingsPlansPurchaseRecommendation(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "GetSavingsPlansPurchaseRecommendation",
}
}
|