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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package computeoptimizer
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/computeoptimizer/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Exports optimization recommendations for Amazon EBS volumes. Recommendations
// are exported in a comma-separated values (.csv) file, and its metadata in a
// JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple
// Storage Service (Amazon S3) bucket that you specify. For more information, see
// Exporting Recommendations (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html)
// in the Compute Optimizer User Guide. You can have only one Amazon EBS volume
// export job in progress per Amazon Web Services Region.
func (c *Client) ExportEBSVolumeRecommendations(ctx context.Context, params *ExportEBSVolumeRecommendationsInput, optFns ...func(*Options)) (*ExportEBSVolumeRecommendationsOutput, error) {
if params == nil {
params = &ExportEBSVolumeRecommendationsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ExportEBSVolumeRecommendations", params, optFns, c.addOperationExportEBSVolumeRecommendationsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ExportEBSVolumeRecommendationsOutput)
out.ResultMetadata = metadata
return out, nil
}
type ExportEBSVolumeRecommendationsInput struct {
// Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name
// and key prefix for a recommendations export job. You must create the destination
// Amazon S3 bucket for your recommendations export before you create the export
// job. Compute Optimizer does not create the S3 bucket for you. After you create
// the S3 bucket, ensure that it has the required permission policy to allow
// Compute Optimizer to write the export file to it. If you plan to specify an
// object prefix when you create the export job, you must include the object prefix
// in the policy that you add to the S3 bucket. For more information, see Amazon
// S3 Bucket Policy for Compute Optimizer (https://docs.aws.amazon.com/compute-optimizer/latest/ug/create-s3-bucket-policy-for-compute-optimizer.html)
// in the Compute Optimizer User Guide.
//
// This member is required.
S3DestinationConfig *types.S3DestinationConfig
// The IDs of the Amazon Web Services accounts for which to export Amazon EBS
// volume recommendations. If your account is the management account of an
// organization, use this parameter to specify the member account for which you
// want to export recommendations. This parameter cannot be specified together with
// the include member accounts parameter. The parameters are mutually exclusive.
// Recommendations for member accounts are not included in the export if this
// parameter, or the include member accounts parameter, is omitted. You can specify
// multiple account IDs per request.
AccountIds []string
// The recommendations data to include in the export file. For more information
// about the fields that can be exported, see Exported files (https://docs.aws.amazon.com/compute-optimizer/latest/ug/exporting-recommendations.html#exported-files)
// in the Compute Optimizer User Guide.
FieldsToExport []types.ExportableVolumeField
// The format of the export file. The only export file format currently supported
// is Csv .
FileFormat types.FileFormat
// An array of objects to specify a filter that exports a more specific set of
// Amazon EBS volume recommendations.
Filters []types.EBSFilter
// Indicates whether to include recommendations for resources in all member
// accounts of the organization if your account is the management account of an
// organization. The member accounts must also be opted in to Compute Optimizer,
// and trusted access for Compute Optimizer must be enabled in the organization
// account. For more information, see Compute Optimizer and Amazon Web Services
// Organizations trusted access (https://docs.aws.amazon.com/compute-optimizer/latest/ug/security-iam.html#trusted-service-access)
// in the Compute Optimizer User Guide. Recommendations for member accounts of the
// organization are not included in the export file if this parameter is omitted.
// This parameter cannot be specified together with the account IDs parameter. The
// parameters are mutually exclusive. Recommendations for member accounts are not
// included in the export if this parameter, or the account IDs parameter, is
// omitted.
IncludeMemberAccounts bool
noSmithyDocumentSerde
}
type ExportEBSVolumeRecommendationsOutput struct {
// The identification number of the export job. Use the
// DescribeRecommendationExportJobs action, and specify the job ID to view the
// status of an export job.
JobId *string
// Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name
// and object keys of a recommendations export file, and its associated metadata
// file.
S3Destination *types.S3Destination
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationExportEBSVolumeRecommendationsMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson10_serializeOpExportEBSVolumeRecommendations{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson10_deserializeOpExportEBSVolumeRecommendations{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "ExportEBSVolumeRecommendations"); 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 = addOpExportEBSVolumeRecommendationsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opExportEBSVolumeRecommendations(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
}
func newServiceMetadataMiddleware_opExportEBSVolumeRecommendations(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "ExportEBSVolumeRecommendations",
}
}
|
