-
Notifications
You must be signed in to change notification settings - Fork 597
/
api_op_DescribeCapacityReservations.go
305 lines (268 loc) · 11.3 KB
/
api_op_DescribeCapacityReservations.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
// Code generated by smithy-go-codegen DO NOT EDIT.
package ec2
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/ec2/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Describes one or more of your Capacity Reservations. The results describe only
// the Capacity Reservations in the Amazon Web Services Region that you're
// currently using.
func (c *Client) DescribeCapacityReservations(ctx context.Context, params *DescribeCapacityReservationsInput, optFns ...func(*Options)) (*DescribeCapacityReservationsOutput, error) {
if params == nil {
params = &DescribeCapacityReservationsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribeCapacityReservations", params, optFns, c.addOperationDescribeCapacityReservationsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribeCapacityReservationsOutput)
out.ResultMetadata = metadata
return out, nil
}
type DescribeCapacityReservationsInput struct {
// The ID of the Capacity Reservation.
CapacityReservationIds []string
// Checks whether you have the required permissions for the action, without
// actually making the request, and provides an error response. If you have the
// required permissions, the error response is DryRunOperation . Otherwise, it is
// UnauthorizedOperation .
DryRun *bool
// One or more filters.
// - instance-type - The type of instance for which the Capacity Reservation
// reserves capacity.
// - owner-id - The ID of the Amazon Web Services account that owns the Capacity
// Reservation.
// - instance-platform - The type of operating system for which the Capacity
// Reservation reserves capacity.
// - availability-zone - The Availability Zone of the Capacity Reservation.
// - tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity
// Reservation can have one of the following tenancy settings:
// - default - The Capacity Reservation is created on hardware that is shared
// with other Amazon Web Services accounts.
// - dedicated - The Capacity Reservation is created on single-tenant hardware
// that is dedicated to a single Amazon Web Services account.
// - outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the
// Capacity Reservation was created.
// - state - The current state of the Capacity Reservation. A Capacity
// Reservation can be in one of the following states:
// - active - The Capacity Reservation is active and the capacity is available
// for your use.
// - expired - The Capacity Reservation expired automatically at the date and
// time specified in your request. The reserved capacity is no longer available for
// your use.
// - cancelled - The Capacity Reservation was cancelled. The reserved capacity is
// no longer available for your use.
// - pending - The Capacity Reservation request was successful but the capacity
// provisioning is still pending.
// - failed - The Capacity Reservation request has failed. A request might fail
// due to invalid request parameters, capacity constraints, or instance limit
// constraints. Failed requests are retained for 60 minutes.
// - start-date - The date and time at which the Capacity Reservation was
// started.
// - end-date - The date and time at which the Capacity Reservation expires. When
// a Capacity Reservation expires, the reserved capacity is released and you can no
// longer launch instances into it. The Capacity Reservation's state changes to
// expired when it reaches its end date and time.
// - end-date-type - Indicates the way in which the Capacity Reservation ends. A
// Capacity Reservation can have one of the following end types:
// - unlimited - The Capacity Reservation remains active until you explicitly
// cancel it.
// - limited - The Capacity Reservation expires automatically at a specified date
// and time.
// - instance-match-criteria - Indicates the type of instance launches that the
// Capacity Reservation accepts. The options include:
// - open - The Capacity Reservation accepts all instances that have matching
// attributes (instance type, platform, and Availability Zone). Instances that have
// matching attributes launch into the Capacity Reservation automatically without
// specifying any additional parameters.
// - targeted - The Capacity Reservation only accepts instances that have
// matching attributes (instance type, platform, and Availability Zone), and
// explicitly target the Capacity Reservation. This ensures that only permitted
// instances can use the reserved capacity.
// - placement-group-arn - The ARN of the cluster placement group in which the
// Capacity Reservation was created.
Filters []types.Filter
// The maximum number of results to return for the request in a single page. The
// remaining results can be seen by sending another request with the returned
// nextToken value. This value can be between 5 and 500. If maxResults is given a
// larger value than 500, you receive an error.
MaxResults *int32
// The token to use to retrieve the next page of results.
NextToken *string
noSmithyDocumentSerde
}
type DescribeCapacityReservationsOutput struct {
// Information about the Capacity Reservations.
CapacityReservations []types.CapacityReservation
// The token to use to retrieve the next page of results. This value is null when
// there are no more results to return.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDescribeCapacityReservationsMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsEc2query_serializeOpDescribeCapacityReservations{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsEc2query_deserializeOpDescribeCapacityReservations{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "DescribeCapacityReservations"); 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 = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeCapacityReservations(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
}
// DescribeCapacityReservationsAPIClient is a client that implements the
// DescribeCapacityReservations operation.
type DescribeCapacityReservationsAPIClient interface {
DescribeCapacityReservations(context.Context, *DescribeCapacityReservationsInput, ...func(*Options)) (*DescribeCapacityReservationsOutput, error)
}
var _ DescribeCapacityReservationsAPIClient = (*Client)(nil)
// DescribeCapacityReservationsPaginatorOptions is the paginator options for
// DescribeCapacityReservations
type DescribeCapacityReservationsPaginatorOptions struct {
// The maximum number of results to return for the request in a single page. The
// remaining results can be seen by sending another request with the returned
// nextToken value. This value can be between 5 and 500. If maxResults is given a
// larger value than 500, you receive an error.
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
}
// DescribeCapacityReservationsPaginator is a paginator for
// DescribeCapacityReservations
type DescribeCapacityReservationsPaginator struct {
options DescribeCapacityReservationsPaginatorOptions
client DescribeCapacityReservationsAPIClient
params *DescribeCapacityReservationsInput
nextToken *string
firstPage bool
}
// NewDescribeCapacityReservationsPaginator returns a new
// DescribeCapacityReservationsPaginator
func NewDescribeCapacityReservationsPaginator(client DescribeCapacityReservationsAPIClient, params *DescribeCapacityReservationsInput, optFns ...func(*DescribeCapacityReservationsPaginatorOptions)) *DescribeCapacityReservationsPaginator {
if params == nil {
params = &DescribeCapacityReservationsInput{}
}
options := DescribeCapacityReservationsPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &DescribeCapacityReservationsPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *DescribeCapacityReservationsPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next DescribeCapacityReservations page.
func (p *DescribeCapacityReservationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeCapacityReservationsOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.DescribeCapacityReservations(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opDescribeCapacityReservations(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "DescribeCapacityReservations",
}
}