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 Elastic Block Store (Amazon EBS) volume recommendations. AWS
15// Compute Optimizer generates recommendations for Amazon EBS volumes that meet a
16// specific set of requirements. For more information, see the Supported resources
17// 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) GetEBSVolumeRecommendations(ctx context.Context, params *GetEBSVolumeRecommendationsInput, optFns ...func(*Options)) (*GetEBSVolumeRecommendationsOutput, error) {
21	if params == nil {
22		params = &GetEBSVolumeRecommendationsInput{}
23	}
24
25	result, metadata, err := c.invokeOperation(ctx, "GetEBSVolumeRecommendations", params, optFns, addOperationGetEBSVolumeRecommendationsMiddlewares)
26	if err != nil {
27		return nil, err
28	}
29
30	out := result.(*GetEBSVolumeRecommendationsOutput)
31	out.ResultMetadata = metadata
32	return out, nil
33}
34
35type GetEBSVolumeRecommendationsInput struct {
36
37	// The IDs of the AWS accounts for which to return volume recommendations. If your
38	// account is the management account of an organization, use this parameter to
39	// specify the member accounts for which you want to return volume recommendations.
40	// 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	// volume recommendations.
45	Filters []types.EBSFilter
46
47	// The maximum number of volume recommendations to return with a single request. To
48	// retrieve the remaining results, make another request with the returned NextToken
49	// value.
50	MaxResults *int32
51
52	// The token to advance to the next page of volume recommendations.
53	NextToken *string
54
55	// The Amazon Resource Name (ARN) of the volumes for which to return
56	// recommendations.
57	VolumeArns []string
58}
59
60type GetEBSVolumeRecommendationsOutput 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 unsupported volume.
64	Errors []types.GetRecommendationError
65
66	// The token to use to advance to the next page of volume recommendations. This
67	// value is null when there are no more pages of volume recommendations to return.
68	NextToken *string
69
70	// An array of objects that describe volume recommendations.
71	VolumeRecommendations []types.VolumeRecommendation
72
73	// Metadata pertaining to the operation's result.
74	ResultMetadata middleware.Metadata
75}
76
77func addOperationGetEBSVolumeRecommendationsMiddlewares(stack *middleware.Stack, options Options) (err error) {
78	err = stack.Serialize.Add(&awsAwsjson10_serializeOpGetEBSVolumeRecommendations{}, middleware.After)
79	if err != nil {
80		return err
81	}
82	err = stack.Deserialize.Add(&awsAwsjson10_deserializeOpGetEBSVolumeRecommendations{}, middleware.After)
83	if err != nil {
84		return err
85	}
86	if err = addSetLoggerMiddleware(stack, options); err != nil {
87		return err
88	}
89	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
90		return err
91	}
92	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
93		return err
94	}
95	if err = addResolveEndpointMiddleware(stack, options); err != nil {
96		return err
97	}
98	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
99		return err
100	}
101	if err = addRetryMiddlewares(stack, options); err != nil {
102		return err
103	}
104	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
105		return err
106	}
107	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
108		return err
109	}
110	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
111		return err
112	}
113	if err = addClientUserAgent(stack); err != nil {
114		return err
115	}
116	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
117		return err
118	}
119	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
120		return err
121	}
122	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetEBSVolumeRecommendations(options.Region), middleware.Before); err != nil {
123		return err
124	}
125	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
126		return err
127	}
128	if err = addResponseErrorMiddleware(stack); err != nil {
129		return err
130	}
131	if err = addRequestResponseLogging(stack, options); err != nil {
132		return err
133	}
134	return nil
135}
136
137func newServiceMetadataMiddleware_opGetEBSVolumeRecommendations(region string) *awsmiddleware.RegisterServiceMetadata {
138	return &awsmiddleware.RegisterServiceMetadata{
139		Region:        region,
140		ServiceID:     ServiceID,
141		SigningName:   "compute-optimizer",
142		OperationName: "GetEBSVolumeRecommendations",
143	}
144}
145