-
Notifications
You must be signed in to change notification settings - Fork 597
/
api_op_DescribeInstances.go
1437 lines (1243 loc) · 47.5 KB
/
api_op_DescribeInstances.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
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Code generated by smithy-go-codegen DO NOT EDIT.
package ec2
import (
"context"
"errors"
"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"
smithy "github.com/aws/smithy-go"
"github.com/aws/smithy-go/middleware"
smithytime "github.com/aws/smithy-go/time"
smithyhttp "github.com/aws/smithy-go/transport/http"
smithywaiter "github.com/aws/smithy-go/waiter"
"github.com/jmespath/go-jmespath"
"strconv"
"time"
)
// Describes the specified instances or all instances. If you specify instance IDs,
// the output includes information for only the specified instances. If you specify
// filters, the output includes information for only those instances that meet the
// filter criteria. If you do not specify instance IDs or filters, the output
// includes information for all instances, which can affect performance. We
// recommend that you use pagination to ensure that the operation returns quickly
// and successfully. If you specify an instance ID that is not valid, an error is
// returned. If you specify an instance that you do not own, it is not included in
// the output. Recently terminated instances might appear in the returned results.
// This interval is usually less than one hour. If you describe instances in the
// rare case where an Availability Zone is experiencing a service disruption and
// you specify instance IDs that are in the affected zone, or do not specify any
// instance IDs at all, the call fails. If you describe instances and specify only
// instance IDs that are in an unaffected zone, the call works normally.
func (c *Client) DescribeInstances(ctx context.Context, params *DescribeInstancesInput, optFns ...func(*Options)) (*DescribeInstancesOutput, error) {
if params == nil {
params = &DescribeInstancesInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribeInstances", params, optFns, c.addOperationDescribeInstancesMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribeInstancesOutput)
out.ResultMetadata = metadata
return out, nil
}
type DescribeInstancesInput struct {
// 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
// The filters.
//
// * affinity - The affinity setting for an instance running on a
// Dedicated Host (default | host).
//
// * architecture - The instance architecture
// (i386 | x86_64 | arm64).
//
// * availability-zone - The Availability Zone of the
// instance.
//
// * block-device-mapping.attach-time - The attach time for an EBS
// volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.
//
// *
// block-device-mapping.delete-on-termination - A Boolean that indicates whether
// the EBS volume is deleted on instance termination.
//
// *
// block-device-mapping.device-name - The device name specified in the block device
// mapping (for example, /dev/sdh or xvdh).
//
// * block-device-mapping.status - The
// status for the EBS volume (attaching | attached | detaching | detached).
//
// *
// block-device-mapping.volume-id - The volume ID of the EBS volume.
//
// *
// client-token - The idempotency token you provided when you launched the
// instance.
//
// * dns-name - The public DNS name of the instance.
//
// * group-id - The
// ID of the security group for the instance. EC2-Classic only.
//
// * group-name - The
// name of the security group for the instance. EC2-Classic only.
//
// *
// hibernation-options.configured - A Boolean that indicates whether the instance
// is enabled for hibernation. A value of true means that the instance is enabled
// for hibernation.
//
// * host-id - The ID of the Dedicated Host on which the instance
// is running, if applicable.
//
// * hypervisor - The hypervisor type of the instance
// (ovm | xen). The value xen is used for both Xen and Nitro hypervisors.
//
// *
// iam-instance-profile.arn - The instance profile associated with the instance.
// Specified as an ARN.
//
// * image-id - The ID of the image used to launch the
// instance.
//
// * instance-id - The ID of the instance.
//
// * instance-lifecycle -
// Indicates whether this is a Spot Instance or a Scheduled Instance (spot |
// scheduled).
//
// * instance-state-code - The state of the instance, as a 16-bit
// unsigned integer. The high byte is used for internal purposes and should be
// ignored. The low byte is set based on the state represented. The valid values
// are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64
// (stopping), and 80 (stopped).
//
// * instance-state-name - The state of the instance
// (pending | running | shutting-down | terminated | stopping | stopped).
//
// *
// instance-type - The type of instance (for example, t2.micro).
//
// *
// instance.group-id - The ID of the security group for the instance.
//
// *
// instance.group-name - The name of the security group for the instance.
//
// *
// ip-address - The public IPv4 address of the instance.
//
// * kernel-id - The kernel
// ID.
//
// * key-name - The name of the key pair used when the instance was
// launched.
//
// * launch-index - When launching multiple instances, this is the index
// for the instance in the launch group (for example, 0, 1, 2, and so on).
//
// *
// launch-time - The time when the instance was launched, in the ISO 8601 format in
// the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example,
// 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*,
// which matches an entire day.
//
// * metadata-options.http-tokens - The metadata
// request authorization state (optional | required)
//
// *
// metadata-options.http-put-response-hop-limit - The http metadata request put
// response hop limit (integer, possible values 1 to 64)
//
// *
// metadata-options.http-endpoint - Enable or disable metadata access on http
// endpoint (enabled | disabled)
//
// * monitoring-state - Indicates whether detailed
// monitoring is enabled (disabled | enabled).
//
// *
// network-interface.addresses.private-ip-address - The private IPv4 address
// associated with the network interface.
//
// * network-interface.addresses.primary -
// Specifies whether the IPv4 address of the network interface is the primary
// private IPv4 address.
//
// * network-interface.addresses.association.public-ip - The
// ID of the association of an Elastic IP address (IPv4) with a network
// interface.
//
// * network-interface.addresses.association.ip-owner-id - The owner ID
// of the private IPv4 address associated with the network interface.
//
// *
// network-interface.association.public-ip - The address of the Elastic IP address
// (IPv4) bound to the network interface.
//
// *
// network-interface.association.ip-owner-id - The owner of the Elastic IP address
// (IPv4) associated with the network interface.
//
// *
// network-interface.association.allocation-id - The allocation ID returned when
// you allocated the Elastic IP address (IPv4) for your network interface.
//
// *
// network-interface.association.association-id - The association ID returned when
// the network interface was associated with an IPv4 address.
//
// *
// network-interface.attachment.attachment-id - The ID of the interface
// attachment.
//
// * network-interface.attachment.instance-id - The ID of the instance
// to which the network interface is attached.
//
// *
// network-interface.attachment.instance-owner-id - The owner ID of the instance to
// which the network interface is attached.
//
// *
// network-interface.attachment.device-index - The device index to which the
// network interface is attached.
//
// * network-interface.attachment.status - The
// status of the attachment (attaching | attached | detaching | detached).
//
// *
// network-interface.attachment.attach-time - The time that the network interface
// was attached to an instance.
//
// *
// network-interface.attachment.delete-on-termination - Specifies whether the
// attachment is deleted when an instance is terminated.
//
// *
// network-interface.availability-zone - The Availability Zone for the network
// interface.
//
// * network-interface.description - The description of the network
// interface.
//
// * network-interface.group-id - The ID of a security group associated
// with the network interface.
//
// * network-interface.group-name - The name of a
// security group associated with the network interface.
//
// *
// network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with
// the network interface.
//
// * network-interface.mac-address - The MAC address of the
// network interface.
//
// * network-interface.network-interface-id - The ID of the
// network interface.
//
// * network-interface.owner-id - The ID of the owner of the
// network interface.
//
// * network-interface.private-dns-name - The private DNS name
// of the network interface.
//
// * network-interface.requester-id - The requester ID
// for the network interface.
//
// * network-interface.requester-managed - Indicates
// whether the network interface is being managed by Amazon Web Services.
//
// *
// network-interface.status - The status of the network interface (available) |
// in-use).
//
// * network-interface.source-dest-check - Whether the network interface
// performs source/destination checking. A value of true means that checking is
// enabled, and false means that checking is disabled. The value must be false for
// the network interface to perform network address translation (NAT) in your
// VPC.
//
// * network-interface.subnet-id - The ID of the subnet for the network
// interface.
//
// * network-interface.vpc-id - The ID of the VPC for the network
// interface.
//
// * outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
//
// *
// owner-id - The Amazon Web Services account ID of the instance owner.
//
// *
// placement-group-name - The name of the placement group for the instance.
//
// *
// placement-partition-number - The partition in which the instance is located.
//
// *
// platform - The platform. To list only Windows instances, use windows.
//
// *
// private-dns-name - The private IPv4 DNS name of the instance.
//
// *
// private-ip-address - The private IPv4 address of the instance.
//
// * product-code -
// The product code associated with the AMI used to launch the instance.
//
// *
// product-code.type - The type of product code (devpay | marketplace).
//
// *
// ramdisk-id - The RAM disk ID.
//
// * reason - The reason for the current state of
// the instance (for example, shows "User Initiated [date]" when you stop or
// terminate the instance). Similar to the state-reason-code filter.
//
// *
// requester-id - The ID of the entity that launched the instance on your behalf
// (for example, Amazon Web Services Management Console, Auto Scaling, and so
// on).
//
// * reservation-id - The ID of the instance's reservation. A reservation ID
// is created any time you launch an instance. A reservation ID has a one-to-one
// relationship with an instance launch request, but can be associated with more
// than one instance if you launch multiple instances using the same launch
// request. For example, if you launch one instance, you get one reservation ID. If
// you launch ten instances using the same launch request, you also get one
// reservation ID.
//
// * root-device-name - The device name of the root device volume
// (for example, /dev/sda1).
//
// * root-device-type - The type of the root device
// volume (ebs | instance-store).
//
// * source-dest-check - Indicates whether the
// instance performs source/destination checking. A value of true means that
// checking is enabled, and false means that checking is disabled. The value must
// be false for the instance to perform network address translation (NAT) in your
// VPC.
//
// * spot-instance-request-id - The ID of the Spot Instance request.
//
// *
// state-reason-code - The reason code for the state change.
//
// *
// state-reason-message - A message that describes the state change.
//
// * subnet-id -
// The ID of the subnet for the instance.
//
// * tag: - The key/value combination of a
// tag assigned to the resource. Use the tag key in the filter name and the tag
// value as the filter value. For example, to find all resources that have a tag
// with the key Owner and the value TeamA, specify tag:Owner for the filter name
// and TeamA for the filter value.
//
// * tag-key - The key of a tag assigned to the
// resource. Use this filter to find all resources that have a tag with a specific
// key, regardless of the tag value.
//
// * tenancy - The tenancy of an instance
// (dedicated | default | host).
//
// * virtualization-type - The virtualization type
// of the instance (paravirtual | hvm).
//
// * vpc-id - The ID of the VPC that the
// instance is running in.
Filters []types.Filter
// The instance IDs. Default: Describes all your instances.
InstanceIds []string
// The maximum number of results to return in a single call. To retrieve the
// remaining results, make another call with the returned NextToken value. This
// value can be between 5 and 1000. You cannot specify this parameter and the
// instance IDs parameter in the same call.
MaxResults *int32
// The token to request the next page of results.
NextToken *string
noSmithyDocumentSerde
}
type DescribeInstancesOutput struct {
// 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
// Information about the reservations.
Reservations []types.Reservation
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDescribeInstancesMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsEc2query_serializeOpDescribeInstances{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsEc2query_deserializeOpDescribeInstances{}, middleware.After)
if 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 = addHTTPSignerV4Middleware(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); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeInstances(options.Region), middleware.Before); 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
}
return nil
}
// DescribeInstancesAPIClient is a client that implements the DescribeInstances
// operation.
type DescribeInstancesAPIClient interface {
DescribeInstances(context.Context, *DescribeInstancesInput, ...func(*Options)) (*DescribeInstancesOutput, error)
}
var _ DescribeInstancesAPIClient = (*Client)(nil)
// DescribeInstancesPaginatorOptions is the paginator options for DescribeInstances
type DescribeInstancesPaginatorOptions struct {
// The maximum number of results to return in a single call. To retrieve the
// remaining results, make another call with the returned NextToken value. This
// value can be between 5 and 1000. You cannot specify this parameter and the
// instance IDs parameter in the same call.
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
}
// DescribeInstancesPaginator is a paginator for DescribeInstances
type DescribeInstancesPaginator struct {
options DescribeInstancesPaginatorOptions
client DescribeInstancesAPIClient
params *DescribeInstancesInput
nextToken *string
firstPage bool
}
// NewDescribeInstancesPaginator returns a new DescribeInstancesPaginator
func NewDescribeInstancesPaginator(client DescribeInstancesAPIClient, params *DescribeInstancesInput, optFns ...func(*DescribeInstancesPaginatorOptions)) *DescribeInstancesPaginator {
if params == nil {
params = &DescribeInstancesInput{}
}
options := DescribeInstancesPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &DescribeInstancesPaginator{
options: options,
client: client,
params: params,
firstPage: true,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *DescribeInstancesPaginator) HasMorePages() bool {
return p.firstPage || p.nextToken != nil
}
// NextPage retrieves the next DescribeInstances page.
func (p *DescribeInstancesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeInstancesOutput, 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.DescribeInstances(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
}
// InstanceExistsWaiterOptions are waiter options for InstanceExistsWaiter
type InstanceExistsWaiterOptions struct {
// Set of options to modify how an operation is invoked. These apply to all
// operations invoked for this client. Use functional options on operation call to
// modify this list for per operation behavior.
APIOptions []func(*middleware.Stack) error
// MinDelay is the minimum amount of time to delay between retries. If unset,
// InstanceExistsWaiter will use default minimum delay of 5 seconds. Note that
// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
MinDelay time.Duration
// MaxDelay is the maximum amount of time to delay between retries. If unset or set
// to zero, InstanceExistsWaiter will use default max delay of 120 seconds. Note
// that MaxDelay must resolve to value greater than or equal to the MinDelay.
MaxDelay time.Duration
// LogWaitAttempts is used to enable logging for waiter retry attempts
LogWaitAttempts bool
// Retryable is function that can be used to override the service defined
// waiter-behavior based on operation output, or returned error. This function is
// used by the waiter to decide if a state is retryable or a terminal state. By
// default service-modeled logic will populate this option. This option can thus be
// used to define a custom waiter state with fall-back to service-modeled waiter
// state mutators.The function returns an error in case of a failure state. In case
// of retry state, this function returns a bool value of true and nil error, while
// in case of success it returns a bool value of false and nil error.
Retryable func(context.Context, *DescribeInstancesInput, *DescribeInstancesOutput, error) (bool, error)
}
// InstanceExistsWaiter defines the waiters for InstanceExists
type InstanceExistsWaiter struct {
client DescribeInstancesAPIClient
options InstanceExistsWaiterOptions
}
// NewInstanceExistsWaiter constructs a InstanceExistsWaiter.
func NewInstanceExistsWaiter(client DescribeInstancesAPIClient, optFns ...func(*InstanceExistsWaiterOptions)) *InstanceExistsWaiter {
options := InstanceExistsWaiterOptions{}
options.MinDelay = 5 * time.Second
options.MaxDelay = 120 * time.Second
options.Retryable = instanceExistsStateRetryable
for _, fn := range optFns {
fn(&options)
}
return &InstanceExistsWaiter{
client: client,
options: options,
}
}
// Wait calls the waiter function for InstanceExists waiter. The maxWaitDur is the
// maximum wait duration the waiter will wait. The maxWaitDur is required and must
// be greater than zero.
func (w *InstanceExistsWaiter) Wait(ctx context.Context, params *DescribeInstancesInput, maxWaitDur time.Duration, optFns ...func(*InstanceExistsWaiterOptions)) error {
_, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...)
return err
}
// WaitForOutput calls the waiter function for InstanceExists waiter and returns
// the output of the successful operation. The maxWaitDur is the maximum wait
// duration the waiter will wait. The maxWaitDur is required and must be greater
// than zero.
func (w *InstanceExistsWaiter) WaitForOutput(ctx context.Context, params *DescribeInstancesInput, maxWaitDur time.Duration, optFns ...func(*InstanceExistsWaiterOptions)) (*DescribeInstancesOutput, error) {
if maxWaitDur <= 0 {
return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero")
}
options := w.options
for _, fn := range optFns {
fn(&options)
}
if options.MaxDelay <= 0 {
options.MaxDelay = 120 * time.Second
}
if options.MinDelay > options.MaxDelay {
return nil, fmt.Errorf("minimum waiter delay %v must be lesser than or equal to maximum waiter delay of %v.", options.MinDelay, options.MaxDelay)
}
ctx, cancelFn := context.WithTimeout(ctx, maxWaitDur)
defer cancelFn()
logger := smithywaiter.Logger{}
remainingTime := maxWaitDur
var attempt int64
for {
attempt++
apiOptions := options.APIOptions
start := time.Now()
if options.LogWaitAttempts {
logger.Attempt = attempt
apiOptions = append([]func(*middleware.Stack) error{}, options.APIOptions...)
apiOptions = append(apiOptions, logger.AddLogger)
}
out, err := w.client.DescribeInstances(ctx, params, func(o *Options) {
o.APIOptions = append(o.APIOptions, apiOptions...)
})
retryable, err := options.Retryable(ctx, params, out, err)
if err != nil {
return nil, err
}
if !retryable {
return out, nil
}
remainingTime -= time.Since(start)
if remainingTime < options.MinDelay || remainingTime <= 0 {
break
}
// compute exponential backoff between waiter retries
delay, err := smithywaiter.ComputeDelay(
attempt, options.MinDelay, options.MaxDelay, remainingTime,
)
if err != nil {
return nil, fmt.Errorf("error computing waiter delay, %w", err)
}
remainingTime -= delay
// sleep for the delay amount before invoking a request
if err := smithytime.SleepWithContext(ctx, delay); err != nil {
return nil, fmt.Errorf("request cancelled while waiting, %w", err)
}
}
return nil, fmt.Errorf("exceeded max wait time for InstanceExists waiter")
}
func instanceExistsStateRetryable(ctx context.Context, input *DescribeInstancesInput, output *DescribeInstancesOutput, err error) (bool, error) {
if err == nil {
pathValue, err := jmespath.Search("length(Reservations[]) > `0`", output)
if err != nil {
return false, fmt.Errorf("error evaluating waiter state: %w", err)
}
expectedValue := "true"
bv, err := strconv.ParseBool(expectedValue)
if err != nil {
return false, fmt.Errorf("error parsing boolean from string %w", err)
}
value, ok := pathValue.(bool)
if !ok {
return false, fmt.Errorf("waiter comparator expected bool value got %T", pathValue)
}
if value == bv {
return false, nil
}
}
if err != nil {
var apiErr smithy.APIError
ok := errors.As(err, &apiErr)
if !ok {
return false, fmt.Errorf("expected err to be of type smithy.APIError, got %w", err)
}
if "InvalidInstanceID.NotFound" == apiErr.ErrorCode() {
return true, nil
}
}
return true, nil
}
// InstanceRunningWaiterOptions are waiter options for InstanceRunningWaiter
type InstanceRunningWaiterOptions struct {
// Set of options to modify how an operation is invoked. These apply to all
// operations invoked for this client. Use functional options on operation call to
// modify this list for per operation behavior.
APIOptions []func(*middleware.Stack) error
// MinDelay is the minimum amount of time to delay between retries. If unset,
// InstanceRunningWaiter will use default minimum delay of 15 seconds. Note that
// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
MinDelay time.Duration
// MaxDelay is the maximum amount of time to delay between retries. If unset or set
// to zero, InstanceRunningWaiter will use default max delay of 120 seconds. Note
// that MaxDelay must resolve to value greater than or equal to the MinDelay.
MaxDelay time.Duration
// LogWaitAttempts is used to enable logging for waiter retry attempts
LogWaitAttempts bool
// Retryable is function that can be used to override the service defined
// waiter-behavior based on operation output, or returned error. This function is
// used by the waiter to decide if a state is retryable or a terminal state. By
// default service-modeled logic will populate this option. This option can thus be
// used to define a custom waiter state with fall-back to service-modeled waiter
// state mutators.The function returns an error in case of a failure state. In case
// of retry state, this function returns a bool value of true and nil error, while
// in case of success it returns a bool value of false and nil error.
Retryable func(context.Context, *DescribeInstancesInput, *DescribeInstancesOutput, error) (bool, error)
}
// InstanceRunningWaiter defines the waiters for InstanceRunning
type InstanceRunningWaiter struct {
client DescribeInstancesAPIClient
options InstanceRunningWaiterOptions
}
// NewInstanceRunningWaiter constructs a InstanceRunningWaiter.
func NewInstanceRunningWaiter(client DescribeInstancesAPIClient, optFns ...func(*InstanceRunningWaiterOptions)) *InstanceRunningWaiter {
options := InstanceRunningWaiterOptions{}
options.MinDelay = 15 * time.Second
options.MaxDelay = 120 * time.Second
options.Retryable = instanceRunningStateRetryable
for _, fn := range optFns {
fn(&options)
}
return &InstanceRunningWaiter{
client: client,
options: options,
}
}
// Wait calls the waiter function for InstanceRunning waiter. The maxWaitDur is the
// maximum wait duration the waiter will wait. The maxWaitDur is required and must
// be greater than zero.
func (w *InstanceRunningWaiter) Wait(ctx context.Context, params *DescribeInstancesInput, maxWaitDur time.Duration, optFns ...func(*InstanceRunningWaiterOptions)) error {
_, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...)
return err
}
// WaitForOutput calls the waiter function for InstanceRunning waiter and returns
// the output of the successful operation. The maxWaitDur is the maximum wait
// duration the waiter will wait. The maxWaitDur is required and must be greater
// than zero.
func (w *InstanceRunningWaiter) WaitForOutput(ctx context.Context, params *DescribeInstancesInput, maxWaitDur time.Duration, optFns ...func(*InstanceRunningWaiterOptions)) (*DescribeInstancesOutput, error) {
if maxWaitDur <= 0 {
return nil, fmt.Errorf("maximum wait time for waiter must be greater than zero")
}
options := w.options
for _, fn := range optFns {
fn(&options)
}
if options.MaxDelay <= 0 {
options.MaxDelay = 120 * time.Second
}
if options.MinDelay > options.MaxDelay {
return nil, fmt.Errorf("minimum waiter delay %v must be lesser than or equal to maximum waiter delay of %v.", options.MinDelay, options.MaxDelay)
}
ctx, cancelFn := context.WithTimeout(ctx, maxWaitDur)
defer cancelFn()
logger := smithywaiter.Logger{}
remainingTime := maxWaitDur
var attempt int64
for {
attempt++
apiOptions := options.APIOptions
start := time.Now()
if options.LogWaitAttempts {
logger.Attempt = attempt
apiOptions = append([]func(*middleware.Stack) error{}, options.APIOptions...)
apiOptions = append(apiOptions, logger.AddLogger)
}
out, err := w.client.DescribeInstances(ctx, params, func(o *Options) {
o.APIOptions = append(o.APIOptions, apiOptions...)
})
retryable, err := options.Retryable(ctx, params, out, err)
if err != nil {
return nil, err
}
if !retryable {
return out, nil
}
remainingTime -= time.Since(start)
if remainingTime < options.MinDelay || remainingTime <= 0 {
break
}
// compute exponential backoff between waiter retries
delay, err := smithywaiter.ComputeDelay(
attempt, options.MinDelay, options.MaxDelay, remainingTime,
)
if err != nil {
return nil, fmt.Errorf("error computing waiter delay, %w", err)
}
remainingTime -= delay
// sleep for the delay amount before invoking a request
if err := smithytime.SleepWithContext(ctx, delay); err != nil {
return nil, fmt.Errorf("request cancelled while waiting, %w", err)
}
}
return nil, fmt.Errorf("exceeded max wait time for InstanceRunning waiter")
}
func instanceRunningStateRetryable(ctx context.Context, input *DescribeInstancesInput, output *DescribeInstancesOutput, err error) (bool, error) {
if err == nil {
pathValue, err := jmespath.Search("Reservations[].Instances[].State.Name", output)
if err != nil {
return false, fmt.Errorf("error evaluating waiter state: %w", err)
}
expectedValue := "running"
var match = true
listOfValues, ok := pathValue.([]interface{})
if !ok {
return false, fmt.Errorf("waiter comparator expected list got %T", pathValue)
}
if len(listOfValues) == 0 {
match = false
}
for _, v := range listOfValues {
value, ok := v.(types.InstanceStateName)
if !ok {
return false, fmt.Errorf("waiter comparator expected types.InstanceStateName value, got %T", pathValue)
}
if string(value) != expectedValue {
match = false
}
}
if match {
return false, nil
}
}
if err == nil {
pathValue, err := jmespath.Search("Reservations[].Instances[].State.Name", output)
if err != nil {
return false, fmt.Errorf("error evaluating waiter state: %w", err)
}
expectedValue := "shutting-down"
listOfValues, ok := pathValue.([]interface{})
if !ok {
return false, fmt.Errorf("waiter comparator expected list got %T", pathValue)
}
for _, v := range listOfValues {
value, ok := v.(types.InstanceStateName)
if !ok {
return false, fmt.Errorf("waiter comparator expected types.InstanceStateName value, got %T", pathValue)
}
if string(value) == expectedValue {
return false, fmt.Errorf("waiter state transitioned to Failure")
}
}
}
if err == nil {
pathValue, err := jmespath.Search("Reservations[].Instances[].State.Name", output)
if err != nil {
return false, fmt.Errorf("error evaluating waiter state: %w", err)
}
expectedValue := "terminated"
listOfValues, ok := pathValue.([]interface{})
if !ok {
return false, fmt.Errorf("waiter comparator expected list got %T", pathValue)
}
for _, v := range listOfValues {
value, ok := v.(types.InstanceStateName)
if !ok {
return false, fmt.Errorf("waiter comparator expected types.InstanceStateName value, got %T", pathValue)
}
if string(value) == expectedValue {
return false, fmt.Errorf("waiter state transitioned to Failure")
}
}
}
if err == nil {
pathValue, err := jmespath.Search("Reservations[].Instances[].State.Name", output)
if err != nil {
return false, fmt.Errorf("error evaluating waiter state: %w", err)
}
expectedValue := "stopping"
listOfValues, ok := pathValue.([]interface{})
if !ok {
return false, fmt.Errorf("waiter comparator expected list got %T", pathValue)
}
for _, v := range listOfValues {
value, ok := v.(types.InstanceStateName)
if !ok {
return false, fmt.Errorf("waiter comparator expected types.InstanceStateName value, got %T", pathValue)
}
if string(value) == expectedValue {
return false, fmt.Errorf("waiter state transitioned to Failure")
}
}
}
if err != nil {
var apiErr smithy.APIError
ok := errors.As(err, &apiErr)
if !ok {
return false, fmt.Errorf("expected err to be of type smithy.APIError, got %w", err)
}
if "InvalidInstanceID.NotFound" == apiErr.ErrorCode() {
return true, nil
}
}
return true, nil
}
// InstanceStoppedWaiterOptions are waiter options for InstanceStoppedWaiter
type InstanceStoppedWaiterOptions struct {
// Set of options to modify how an operation is invoked. These apply to all
// operations invoked for this client. Use functional options on operation call to
// modify this list for per operation behavior.
APIOptions []func(*middleware.Stack) error
// MinDelay is the minimum amount of time to delay between retries. If unset,
// InstanceStoppedWaiter will use default minimum delay of 15 seconds. Note that
// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
MinDelay time.Duration
// MaxDelay is the maximum amount of time to delay between retries. If unset or set
// to zero, InstanceStoppedWaiter will use default max delay of 120 seconds. Note
// that MaxDelay must resolve to value greater than or equal to the MinDelay.
MaxDelay time.Duration