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. AWS 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 AWS 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, 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 AWS account for which to return instance recommendations. If your
38	// account is the management account of an organization, use this parameter to
39	// specify the member account for which you want to return instance
40	// recommendations. Only one account ID can be specified per request.
41	AccountIds []string
42
43	// An array of objects that describe 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
60type GetEC2InstanceRecommendationsOutput struct {
61
62	// An array of objects that describe errors of the request. For example, an error
63	// is returned if you request recommendations for an instance of an unsupported
64	// instance family.
65	Errors []types.GetRecommendationError
66
67	// An array of objects that describe instance recommendations.
68	InstanceRecommendations []types.InstanceRecommendation
69
70	// The token to use to advance to the next page of instance recommendations. This
71	// value is null when there are no more pages of instance recommendations to
72	// return.
73	NextToken *string
74
75	// Metadata pertaining to the operation's result.
76	ResultMetadata middleware.Metadata
77}
78
79func addOperationGetEC2InstanceRecommendationsMiddlewares(stack *middleware.Stack, options Options) (err error) {
80	err = stack.Serialize.Add(&awsAwsjson10_serializeOpGetEC2InstanceRecommendations{}, middleware.After)
81	if err != nil {
82		return err
83	}
84	err = stack.Deserialize.Add(&awsAwsjson10_deserializeOpGetEC2InstanceRecommendations{}, middleware.After)
85	if err != nil {
86		return err
87	}
88	if err = addSetLoggerMiddleware(stack, options); err != nil {
89		return err
90	}
91	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
92		return err
93	}
94	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
95		return err
96	}
97	if err = addResolveEndpointMiddleware(stack, options); err != nil {
98		return err
99	}
100	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
101		return err
102	}
103	if err = addRetryMiddlewares(stack, options); err != nil {
104		return err
105	}
106	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
107		return err
108	}
109	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
110		return err
111	}
112	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
113		return err
114	}
115	if err = addClientUserAgent(stack); err != nil {
116		return err
117	}
118	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
119		return err
120	}
121	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
122		return err
123	}
124	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetEC2InstanceRecommendations(options.Region), middleware.Before); err != nil {
125		return err
126	}
127	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
128		return err
129	}
130	if err = addResponseErrorMiddleware(stack); err != nil {
131		return err
132	}
133	if err = addRequestResponseLogging(stack, options); err != nil {
134		return err
135	}
136	return nil
137}
138
139func newServiceMetadataMiddleware_opGetEC2InstanceRecommendations(region string) *awsmiddleware.RegisterServiceMetadata {
140	return &awsmiddleware.RegisterServiceMetadata{
141		Region:        region,
142		ServiceID:     ServiceID,
143		SigningName:   "compute-optimizer",
144		OperationName: "GetEC2InstanceRecommendations",
145	}
146}
147