-
Notifications
You must be signed in to change notification settings - Fork 623
/
api_op_DescribeOrderableDBInstanceOptions.go
219 lines (184 loc) · 7.58 KB
/
api_op_DescribeOrderableDBInstanceOptions.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
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package docdb
import (
"context"
"fmt"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/internal/awsutil"
)
// Represents the input to DescribeOrderableDBInstanceOptions.
type DescribeOrderableDBInstanceOptionsInput struct {
_ struct{} `type:"structure"`
// The DB instance class filter value. Specify this parameter to show only the
// available offerings that match the specified DB instance class.
DBInstanceClass *string `type:"string"`
// The name of the engine to retrieve DB instance options for.
//
// Engine is a required field
Engine *string `type:"string" required:"true"`
// The engine version filter value. Specify this parameter to show only the
// available offerings that match the specified engine version.
EngineVersion *string `type:"string"`
// This parameter is not currently supported.
Filters []Filter `locationNameList:"Filter" type:"list"`
// The license model filter value. Specify this parameter to show only the available
// offerings that match the specified license model.
LicenseModel *string `type:"string"`
// 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 `type:"string"`
// The maximum number of records to include in the response. If more records
// exist than the specified MaxRecords value, a pagination token (marker) is
// included in the response so that the remaining results can be retrieved.
//
// Default: 100
//
// Constraints: Minimum 20, maximum 100.
MaxRecords *int64 `type:"integer"`
// The virtual private cloud (VPC) filter value. Specify this parameter to show
// only the available VPC or non-VPC offerings.
Vpc *bool `type:"boolean"`
}
// String returns the string representation
func (s DescribeOrderableDBInstanceOptionsInput) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *DescribeOrderableDBInstanceOptionsInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "DescribeOrderableDBInstanceOptionsInput"}
if s.Engine == nil {
invalidParams.Add(aws.NewErrParamRequired("Engine"))
}
if s.Filters != nil {
for i, v := range s.Filters {
if err := v.Validate(); err != nil {
invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(aws.ErrInvalidParams))
}
}
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// Represents the output of DescribeOrderableDBInstanceOptions.
type DescribeOrderableDBInstanceOptionsOutput struct {
_ struct{} `type:"structure"`
// 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 `type:"string"`
// The options that are available for a particular orderable DB instance.
OrderableDBInstanceOptions []OrderableDBInstanceOption `locationNameList:"OrderableDBInstanceOption" type:"list"`
}
// String returns the string representation
func (s DescribeOrderableDBInstanceOptionsOutput) String() string {
return awsutil.Prettify(s)
}
const opDescribeOrderableDBInstanceOptions = "DescribeOrderableDBInstanceOptions"
// DescribeOrderableDBInstanceOptionsRequest returns a request value for making API operation for
// Amazon DocumentDB with MongoDB compatibility.
//
// Returns a list of orderable DB instance options for the specified engine.
//
// // Example sending a request using DescribeOrderableDBInstanceOptionsRequest.
// req := client.DescribeOrderableDBInstanceOptionsRequest(params)
// resp, err := req.Send(context.TODO())
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeOrderableDBInstanceOptions
func (c *Client) DescribeOrderableDBInstanceOptionsRequest(input *DescribeOrderableDBInstanceOptionsInput) DescribeOrderableDBInstanceOptionsRequest {
op := &aws.Operation{
Name: opDescribeOrderableDBInstanceOptions,
HTTPMethod: "POST",
HTTPPath: "/",
Paginator: &aws.Paginator{
InputTokens: []string{"Marker"},
OutputTokens: []string{"Marker"},
LimitToken: "MaxRecords",
TruncationToken: "",
},
}
if input == nil {
input = &DescribeOrderableDBInstanceOptionsInput{}
}
req := c.newRequest(op, input, &DescribeOrderableDBInstanceOptionsOutput{})
return DescribeOrderableDBInstanceOptionsRequest{Request: req, Input: input, Copy: c.DescribeOrderableDBInstanceOptionsRequest}
}
// DescribeOrderableDBInstanceOptionsRequest is the request type for the
// DescribeOrderableDBInstanceOptions API operation.
type DescribeOrderableDBInstanceOptionsRequest struct {
*aws.Request
Input *DescribeOrderableDBInstanceOptionsInput
Copy func(*DescribeOrderableDBInstanceOptionsInput) DescribeOrderableDBInstanceOptionsRequest
}
// Send marshals and sends the DescribeOrderableDBInstanceOptions API request.
func (r DescribeOrderableDBInstanceOptionsRequest) Send(ctx context.Context) (*DescribeOrderableDBInstanceOptionsResponse, error) {
r.Request.SetContext(ctx)
err := r.Request.Send()
if err != nil {
return nil, err
}
resp := &DescribeOrderableDBInstanceOptionsResponse{
DescribeOrderableDBInstanceOptionsOutput: r.Request.Data.(*DescribeOrderableDBInstanceOptionsOutput),
response: &aws.Response{Request: r.Request},
}
return resp, nil
}
// NewDescribeOrderableDBInstanceOptionsRequestPaginator returns a paginator for DescribeOrderableDBInstanceOptions.
// Use Next method to get the next page, and CurrentPage to get the current
// response page from the paginator. Next will return false, if there are
// no more pages, or an error was encountered.
//
// Note: This operation can generate multiple requests to a service.
//
// // Example iterating over pages.
// req := client.DescribeOrderableDBInstanceOptionsRequest(input)
// p := docdb.NewDescribeOrderableDBInstanceOptionsRequestPaginator(req)
//
// for p.Next(context.TODO()) {
// page := p.CurrentPage()
// }
//
// if err := p.Err(); err != nil {
// return err
// }
//
func NewDescribeOrderableDBInstanceOptionsPaginator(req DescribeOrderableDBInstanceOptionsRequest) DescribeOrderableDBInstanceOptionsPaginator {
return DescribeOrderableDBInstanceOptionsPaginator{
Pager: aws.Pager{
NewRequest: func(ctx context.Context) (*aws.Request, error) {
var inCpy *DescribeOrderableDBInstanceOptionsInput
if req.Input != nil {
tmp := *req.Input
inCpy = &tmp
}
newReq := req.Copy(inCpy)
newReq.SetContext(ctx)
return newReq.Request, nil
},
},
}
}
// DescribeOrderableDBInstanceOptionsPaginator is used to paginate the request. This can be done by
// calling Next and CurrentPage.
type DescribeOrderableDBInstanceOptionsPaginator struct {
aws.Pager
}
func (p *DescribeOrderableDBInstanceOptionsPaginator) CurrentPage() *DescribeOrderableDBInstanceOptionsOutput {
return p.Pager.CurrentPage().(*DescribeOrderableDBInstanceOptionsOutput)
}
// DescribeOrderableDBInstanceOptionsResponse is the response type for the
// DescribeOrderableDBInstanceOptions API operation.
type DescribeOrderableDBInstanceOptionsResponse struct {
*DescribeOrderableDBInstanceOptionsOutput
response *aws.Response
}
// SDKResponseMetdata returns the response metadata for the
// DescribeOrderableDBInstanceOptions request.
func (r *DescribeOrderableDBInstanceOptionsResponse) SDKResponseMetdata() *aws.Response {
return r.response
}