/
api_op_DescribeDBEngineVersions.go
370 lines (328 loc) · 10.7 KB
/
api_op_DescribeDBEngineVersions.go
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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
// Code generated by smithy-go-codegen DO NOT EDIT.
package rds
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/rds/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Describes the properties of specific versions of DB engines.
func (c *Client) DescribeDBEngineVersions(ctx context.Context, params *DescribeDBEngineVersionsInput, optFns ...func(*Options)) (*DescribeDBEngineVersionsOutput, error) {
if params == nil {
params = &DescribeDBEngineVersionsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribeDBEngineVersions", params, optFns, c.addOperationDescribeDBEngineVersionsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribeDBEngineVersionsOutput)
out.ResultMetadata = metadata
return out, nil
}
type DescribeDBEngineVersionsInput struct {
// The name of a specific DB parameter group family to return details for.
//
// Constraints:
//
// - If supplied, must match an existing DB parameter group family.
DBParameterGroupFamily *string
// Specifies whether to return only the default version of the specified engine or
// the engine and major version combination.
DefaultOnly *bool
// The database engine to return version details for.
//
// Valid Values:
//
// - aurora-mysql
//
// - aurora-postgresql
//
// - custom-oracle-ee
//
// - custom-oracle-ee-cdb
//
// - custom-oracle-se2
//
// - custom-oracle-se2-cdb
//
// - db2-ae
//
// - db2-se
//
// - mariadb
//
// - mysql
//
// - oracle-ee
//
// - oracle-ee-cdb
//
// - oracle-se2
//
// - oracle-se2-cdb
//
// - postgres
//
// - sqlserver-ee
//
// - sqlserver-se
//
// - sqlserver-ex
//
// - sqlserver-web
Engine *string
// A specific database engine version to return details for.
//
// Example: 5.1.49
EngineVersion *string
// A filter that specifies one or more DB engine versions to describe.
//
// Supported filters:
//
// - db-parameter-group-family - Accepts parameter groups family names. The
// results list only includes information about the DB engine versions for these
// parameter group families.
//
// - engine - Accepts engine names. The results list only includes information
// about the DB engine versions for these engines.
//
// - engine-mode - Accepts DB engine modes. The results list only includes
// information about the DB engine versions for these engine modes. Valid DB engine
// modes are the following:
//
// - global
//
// - multimaster
//
// - parallelquery
//
// - provisioned
//
// - serverless
//
// - engine-version - Accepts engine versions. The results list only includes
// information about the DB engine versions for these engine versions.
//
// - status - Accepts engine version statuses. The results list only includes
// information about the DB engine versions for these statuses. Valid statuses are
// the following:
//
// - available
//
// - deprecated
Filters []types.Filter
// Specifies whether to also list the engine versions that aren't available. The
// default is to list only available engine versions.
IncludeAll *bool
// Specifies whether to list the supported character sets for each engine version.
//
// If this parameter is enabled and the requested engine supports the
// CharacterSetName parameter for CreateDBInstance , the response includes a list
// of supported character sets for each engine version.
//
// For RDS Custom, the default is not to list supported character sets. If you
// enable this parameter, RDS Custom returns no results.
ListSupportedCharacterSets *bool
// Specifies whether to list the supported time zones for each engine version.
//
// If this parameter is enabled and the requested engine supports the TimeZone
// parameter for CreateDBInstance , the response includes a list of supported time
// zones for each engine version.
//
// For RDS Custom, the default is not to list supported time zones. If you enable
// this parameter, RDS Custom returns no results.
ListSupportedTimezones *bool
// An optional pagination token provided by a previous request. If this parameter
// is specified, the response includes only records beyond the marker, up to the
// value specified by MaxRecords .
Marker *string
// The maximum number of records to include in the response. If more than the
// MaxRecords value is available, a pagination token called a marker is included in
// the response so you can retrieve the remaining results.
//
// Default: 100
//
// Constraints: Minimum 20, maximum 100.
MaxRecords *int32
noSmithyDocumentSerde
}
// Contains the result of a successful invocation of the DescribeDBEngineVersions
// action.
type DescribeDBEngineVersionsOutput struct {
// A list of DBEngineVersion elements.
DBEngineVersions []types.DBEngineVersion
// An optional pagination token provided by a previous request. If this parameter
// is specified, the response includes only records beyond the marker, up to the
// value specified by MaxRecords .
Marker *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDescribeDBEngineVersionsMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsquery_serializeOpDescribeDBEngineVersions{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsquery_deserializeOpDescribeDBEngineVersions{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "DescribeDBEngineVersions"); 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 = addOpDescribeDBEngineVersionsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeDBEngineVersions(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
}
// DescribeDBEngineVersionsAPIClient is a client that implements the
// DescribeDBEngineVersions operation.
type DescribeDBEngineVersionsAPIClient interface {
DescribeDBEngineVersions(context.Context, *DescribeDBEngineVersionsInput, ...func(*Options)) (*DescribeDBEngineVersionsOutput, error)
}
var _ DescribeDBEngineVersionsAPIClient = (*Client)(nil)
// DescribeDBEngineVersionsPaginatorOptions is the paginator options for
// DescribeDBEngineVersions
type DescribeDBEngineVersionsPaginatorOptions struct {
// The maximum number of records to include in the response. If more than the
// MaxRecords value is available, a pagination token called a marker is included in
// the response so you can retrieve the remaining results.
//
// Default: 100
//
// Constraints: Minimum 20, maximum 100.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// DescribeDBEngineVersionsPaginator is a paginator for DescribeDBEngineVersions
type DescribeDBEngineVersionsPaginator struct {
options DescribeDBEngineVersionsPaginatorOptions
client DescribeDBEngineVersionsAPIClient
params *DescribeDBEngineVersionsInput
nextToken *string
firstPage bool
}
// NewDescribeDBEngineVersionsPaginator returns a new
// DescribeDBEngineVersionsPaginator
func NewDescribeDBEngineVersionsPaginator(client DescribeDBEngineVersionsAPIClient, params *DescribeDBEngineVersionsInput, optFns ...func(*DescribeDBEngineVersionsPaginatorOptions)) *DescribeDBEngineVersionsPaginator {
if params == nil {
params = &DescribeDBEngineVersionsInput{}
}
options := DescribeDBEngineVersionsPaginatorOptions{}
if params.MaxRecords != nil {
options.Limit = *params.MaxRecords
}
for _, fn := range optFns {
fn(&options)
}
return &DescribeDBEngineVersionsPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.Marker,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *DescribeDBEngineVersionsPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next DescribeDBEngineVersions page.
func (p *DescribeDBEngineVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDBEngineVersionsOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.Marker = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxRecords = limit
result, err := p.client.DescribeDBEngineVersions(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.Marker
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opDescribeDBEngineVersions(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "DescribeDBEngineVersions",
}
}