1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package computeoptimizer
4
5import (
6	"context"
7	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
8	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
9	"github.com/aws/aws-sdk-go-v2/service/computeoptimizer/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Returns Amazon EC2 instance recommendations. Compute Optimizer generates
15// recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances that
16// meet a specific set of requirements. For more information, see the Supported
17// resources and requirements
18// (https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html) in
19// the Compute Optimizer User Guide.
20func (c *Client) GetEC2InstanceRecommendations(ctx context.Context, params *GetEC2InstanceRecommendationsInput, optFns ...func(*Options)) (*GetEC2InstanceRecommendationsOutput, error) {
21	if params == nil {
22		params = &GetEC2InstanceRecommendationsInput{}
23	}
24
25	result, metadata, err := c.invokeOperation(ctx, "GetEC2InstanceRecommendations", params, optFns, c.addOperationGetEC2InstanceRecommendationsMiddlewares)
26	if err != nil {
27		return nil, err
28	}
29
30	out := result.(*GetEC2InstanceRecommendationsOutput)
31	out.ResultMetadata = metadata
32	return out, nil
33}
34
35type GetEC2InstanceRecommendationsInput struct {
36
37	// The ID of the Amazon Web Services account for which to return instance
38	// recommendations. If your account is the management account of an organization,
39	// use this parameter to specify the member account for which you want to return
40	// instance recommendations. Only one account ID can be specified per request.
41	AccountIds []string
42
43	// An array of objects to specify a filter that returns a more specific list of
44	// instance recommendations.
45	Filters []types.Filter
46
47	// The Amazon Resource Name (ARN) of the instances for which to return
48	// recommendations.
49	InstanceArns []string
50
51	// The maximum number of instance recommendations to return with a single request.
52	// To retrieve the remaining results, make another request with the returned
53	// nextToken value.
54	MaxResults *int32
55
56	// The token to advance to the next page of instance recommendations.
57	NextToken *string
58
59	// An object to specify the preferences for the Amazon EC2 instance recommendations
60	// to return in the response.
61	RecommendationPreferences *types.RecommendationPreferences
62
63	noSmithyDocumentSerde
64}
65
66type GetEC2InstanceRecommendationsOutput struct {
67
68	// An array of objects that describe errors of the request. For example, an error
69	// is returned if you request recommendations for an instance of an unsupported
70	// instance family.
71	Errors []types.GetRecommendationError
72
73	// An array of objects that describe instance recommendations.
74	InstanceRecommendations []types.InstanceRecommendation
75
76	// The token to use to advance to the next page of instance recommendations. This
77	// value is null when there are no more pages of instance recommendations to
78	// return.
79	NextToken *string
80
81	// Metadata pertaining to the operation's result.
82	ResultMetadata middleware.Metadata
83
84	noSmithyDocumentSerde
85}
86
87func (c *Client) addOperationGetEC2InstanceRecommendationsMiddlewares(stack *middleware.Stack, options Options) (err error) {
88	err = stack.Serialize.Add(&awsAwsjson10_serializeOpGetEC2InstanceRecommendations{}, middleware.After)
89	if err != nil {
90		return err
91	}
92	err = stack.Deserialize.Add(&awsAwsjson10_deserializeOpGetEC2InstanceRecommendations{}, middleware.After)
93	if err != nil {
94		return err
95	}
96	if err = addSetLoggerMiddleware(stack, options); err != nil {
97		return err
98	}
99	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
100		return err
101	}
102	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
103		return err
104	}
105	if err = addResolveEndpointMiddleware(stack, options); err != nil {
106		return err
107	}
108	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
109		return err
110	}
111	if err = addRetryMiddlewares(stack, options); err != nil {
112		return err
113	}
114	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
115		return err
116	}
117	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
118		return err
119	}
120	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
121		return err
122	}
123	if err = addClientUserAgent(stack); err != nil {
124		return err
125	}
126	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
127		return err
128	}
129	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
130		return err
131	}
132	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetEC2InstanceRecommendations(options.Region), middleware.Before); err != nil {
133		return err
134	}
135	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
136		return err
137	}
138	if err = addResponseErrorMiddleware(stack); err != nil {
139		return err
140	}
141	if err = addRequestResponseLogging(stack, options); err != nil {
142		return err
143	}
144	return nil
145}
146
147func newServiceMetadataMiddleware_opGetEC2InstanceRecommendations(region string) *awsmiddleware.RegisterServiceMetadata {
148	return &awsmiddleware.RegisterServiceMetadata{
149		Region:        region,
150		ServiceID:     ServiceID,
151		SigningName:   "compute-optimizer",
152		OperationName: "GetEC2InstanceRecommendations",
153	}
154}
155