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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405
|
// 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, 2022-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.
// - boot-mode - The boot mode that was specified by the AMI ( legacy-bios | uefi
// | uefi-preferred ).
// - capacity-reservation-id - The ID of the Capacity Reservation into which the
// instance was launched.
// - capacity-reservation-specification.capacity-reservation-preference - The
// instance's Capacity Reservation preference ( open | none ).
// -
// capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id
// - The ID of the targeted Capacity Reservation.
// -
// capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn
// - The ARN of the targeted Capacity Reservation group.
// - client-token - The idempotency token you provided when you launched the
// instance.
// - current-instance-boot-mode - The boot mode that is used to launch the
// instance at launch or start ( legacy-bios | uefi ).
// - dns-name - The public DNS name of the instance.
// - ebs-optimized - A Boolean that indicates whether the instance is optimized
// for Amazon EBS I/O.
// - ena-support - A Boolean that indicates whether the instance is enabled for
// enhanced networking with ENA.
// - enclave-options.enabled - A Boolean that indicates whether the instance is
// enabled for Amazon Web Services Nitro Enclaves.
// - 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.
// - iam-instance-profile.id - The instance profile associated with the instance.
// Specified as an ID.
// - iam-instance-profile.name - The instance profile associated with the
// instance. Specified as an name.
// - 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, a Scheduled
// Instance, or a Capacity Block ( spot | scheduled | capacity-block ).
// - 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.
// - ipv6-address - The IPv6 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.
// - maintenance-options.auto-recovery - The current automatic recovery behavior
// of the instance ( disabled | default ).
// - metadata-options.http-endpoint - The status of access to the HTTP metadata
// endpoint on your instance ( enabled | disabled )
// - metadata-options.http-protocol-ipv4 - Indicates whether the IPv4 endpoint is
// enabled ( disabled | enabled ).
// - metadata-options.http-protocol-ipv6 - Indicates whether the IPv6 endpoint is
// enabled ( disabled | enabled ).
// - metadata-options.http-put-response-hop-limit - The HTTP metadata request put
// response hop limit (integer, possible values 1 to 64 )
// - metadata-options.http-tokens - The metadata request authorization state (
// optional | required )
// - metadata-options.instance-metadata-tags - The status of access to instance
// tags from the instance metadata ( enabled | disabled )
// - metadata-options.state - The state of the metadata option changes ( pending
// | applied ).
// - monitoring-state - Indicates whether detailed monitoring is enabled (
// disabled | enabled ).
// - network-interface.addresses.association.allocation-id - The allocation ID.
// - network-interface.addresses.association.association-id - The association ID.
// - network-interface.addresses.association.carrier-ip - The carrier IP address.
// - network-interface.addresses.association.customer-owned-ip - The
// customer-owned IP address.
// - network-interface.addresses.association.ip-owner-id - The owner ID of the
// private IPv4 address associated with the network interface.
// - network-interface.addresses.association.public-dns-name - The public DNS
// name.
// - network-interface.addresses.association.public-ip - The ID of the
// association of an Elastic IP address (IPv4) with a network interface.
// - network-interface.addresses.primary - Specifies whether the IPv4 address of
// the network interface is the primary private IPv4 address.
// - network-interface.addresses.private-dns-name - The private DNS name.
// - network-interface.addresses.private-ip-address - The private IPv4 address
// 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.association.carrier-ip - The customer-owned IP address.
// - network-interface.association.customer-owned-ip - The customer-owned IP
// address.
// - network-interface.association.ip-owner-id - The owner of the Elastic IP
// address (IPv4) associated with the network interface.
// - network-interface.association.public-dns-name - The public DNS name.
// - network-interface.association.public-ip - The address of the Elastic IP
// address (IPv4) bound to the network interface.
// - network-interface.attachment.attach-time - The time that the network
// interface was attached to an instance.
// - network-interface.attachment.attachment-id - The ID of the interface
// attachment.
// - network-interface.attachment.delete-on-termination - Specifies whether the
// attachment is deleted when an instance is terminated.
// - network-interface.attachment.device-index - The device index to which the
// network interface is attached.
// - 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.network-card-index - The index of the network
// card.
// - network-interface.attachment.status - The status of the attachment (
// attaching | attached | detaching | detached ).
// - network-interface.availability-zone - The Availability Zone for the network
// interface.
// - network-interface.deny-all-igw-traffic - A Boolean that indicates whether a
// network interface with an IPv6 address is unreachable from the public internet.
// - 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.ipv4-prefixes.ipv4-prefix - The IPv4 prefixes that are
// assigned to the network interface.
// - network-interface.ipv6-address - The IPv6 address associated with the
// network interface.
// - network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated
// with the network interface.
// - network-interface.ipv6-addresses.is-primary-ipv6 - A Boolean that indicates
// whether this is the primary IPv6 address.
// - network-interface.ipv6-native - A Boolean that indicates whether this is an
// IPv6 only network interface.
// - network-interface.ipv6-prefixes.ipv6-prefix - The IPv6 prefix assigned to
// 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.outpost-arn - The ARN of the Outpost.
// - 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.private-ip-address - The private IPv4 address.
// - network-interface.public-dns-name - The public DNS name.
// - 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.tag-key - The key of a tag assigned to the network
// interface.
// - network-interface.tag-value - The value of a tag assigned to 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 .
// - platform-details - The platform ( Linux/UNIX | Red Hat BYOL Linux | Red Hat
// Enterprise Linux | Red Hat Enterprise Linux with HA | Red Hat Enterprise
// Linux with SQL Server Standard and HA | Red Hat Enterprise Linux with SQL
// Server Enterprise and HA | Red Hat Enterprise Linux with SQL Server Standard |
// Red Hat Enterprise Linux with SQL Server Web | Red Hat Enterprise Linux with
// SQL Server Enterprise | SQL Server Enterprise | SQL Server Standard | SQL
// Server Web | SUSE Linux | Ubuntu Pro | Windows | Windows BYOL | Windows with
// SQL Server Enterprise | Windows with SQL Server Standard | Windows with SQL
// Server Web ).
// - private-dns-name - The private IPv4 DNS name of the instance.
// - private-dns-name-options.enable-resource-name-dns-a-record - A Boolean that
// indicates whether to respond to DNS queries for instance hostnames with DNS A
// records.
// - private-dns-name-options.enable-resource-name-dns-aaaa-record - A Boolean
// that indicates whether to respond to DNS queries for instance hostnames with DNS
// AAAA records.
// - private-dns-name-options.hostname-type - The type of hostname ( ip-name |
// resource-name ).
// - 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 ).
// - tpm-support - Indicates if the instance is configured for NitroTPM support (
// v2.0 ).
// - usage-operation - The usage operation value for the instance ( RunInstances
// | RunInstances:00g0 | RunInstances:0010 | RunInstances:1010 |
// RunInstances:1014 | RunInstances:1110 | RunInstances:0014 | RunInstances:0210
// | RunInstances:0110 | RunInstances:0100 | RunInstances:0004 |
// RunInstances:0200 | RunInstances:000g | RunInstances:0g00 | RunInstances:0002
// | RunInstances:0800 | RunInstances:0102 | RunInstances:0006 |
// RunInstances:0202 ).
// - usage-operation-update-time - The time that the usage operation was last
// updated, for example, 2022-09-15T17:15:20.000Z .
// - 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 items to return for this request. To get the next page of
// items, make another request with the token returned in the output. For more
// information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination)
// . You cannot specify this parameter and the instance IDs parameter in the same
// request.
MaxResults *int32
// The token returned from a previous paginated request. Pagination continues from
// the end of the items returned by the previous request.
NextToken *string
noSmithyDocumentSerde
}
type DescribeInstancesOutput struct {
// The token to include in another request to get the next page of items. This
// value is null when there are no more items 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) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
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 := addProtocolFinalizerMiddlewares(stack, options, "DescribeInstances"); 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_opDescribeInstances(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
}
// 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 items to return for this request. To get the next page of
// items, make another request with the token returned in the output. For more
// information, see Pagination (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination)
// . You cannot specify this parameter and the instance IDs parameter in the same
// request.
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,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *DescribeInstancesPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// 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
// 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)
}
// InstanceStoppedWaiter defines the waiters for InstanceStopped
type InstanceStoppedWaiter struct {
client DescribeInstancesAPIClient
options InstanceStoppedWaiterOptions
}
// NewInstanceStoppedWaiter constructs a InstanceStoppedWaiter.
func NewInstanceStoppedWaiter(client DescribeInstancesAPIClient, optFns ...func(*InstanceStoppedWaiterOptions)) *InstanceStoppedWaiter {
options := InstanceStoppedWaiterOptions{}
options.MinDelay = 15 * time.Second
options.MaxDelay = 120 * time.Second
options.Retryable = instanceStoppedStateRetryable
for _, fn := range optFns {
fn(&options)
}
return &InstanceStoppedWaiter{
client: client,
options: options,
}
}
// Wait calls the waiter function for InstanceStopped waiter. The maxWaitDur is
// the maximum wait duration the waiter will wait. The maxWaitDur is required and
// must be greater than zero.
func (w *InstanceStoppedWaiter) Wait(ctx context.Context, params *DescribeInstancesInput, maxWaitDur time.Duration, optFns ...func(*InstanceStoppedWaiterOptions)) error {
_, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...)
return err
}
// WaitForOutput calls the waiter function for InstanceStopped 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 *InstanceStoppedWaiter) WaitForOutput(ctx context.Context, params *DescribeInstancesInput, maxWaitDur time.Duration, optFns ...func(*InstanceStoppedWaiterOptions)) (*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 InstanceStopped waiter")
}
func instanceStoppedStateRetryable(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 := "stopped"
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 := "pending"
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")
}
}
}
return true, nil
}
// InstanceTerminatedWaiterOptions are waiter options for InstanceTerminatedWaiter
type InstanceTerminatedWaiterOptions 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,
// InstanceTerminatedWaiter 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, InstanceTerminatedWaiter 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)
}
// InstanceTerminatedWaiter defines the waiters for InstanceTerminated
type InstanceTerminatedWaiter struct {
client DescribeInstancesAPIClient
options InstanceTerminatedWaiterOptions
}
// NewInstanceTerminatedWaiter constructs a InstanceTerminatedWaiter.
func NewInstanceTerminatedWaiter(client DescribeInstancesAPIClient, optFns ...func(*InstanceTerminatedWaiterOptions)) *InstanceTerminatedWaiter {
options := InstanceTerminatedWaiterOptions{}
options.MinDelay = 15 * time.Second
options.MaxDelay = 120 * time.Second
options.Retryable = instanceTerminatedStateRetryable
for _, fn := range optFns {
fn(&options)
}
return &InstanceTerminatedWaiter{
client: client,
options: options,
}
}
// Wait calls the waiter function for InstanceTerminated waiter. The maxWaitDur is
// the maximum wait duration the waiter will wait. The maxWaitDur is required and
// must be greater than zero.
func (w *InstanceTerminatedWaiter) Wait(ctx context.Context, params *DescribeInstancesInput, maxWaitDur time.Duration, optFns ...func(*InstanceTerminatedWaiterOptions)) error {
_, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...)
return err
}
// WaitForOutput calls the waiter function for InstanceTerminated 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 *InstanceTerminatedWaiter) WaitForOutput(ctx context.Context, params *DescribeInstancesInput, maxWaitDur time.Duration, optFns ...func(*InstanceTerminatedWaiterOptions)) (*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 InstanceTerminated waiter")
}
func instanceTerminatedStateRetryable(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 := "terminated"
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 := "pending"
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")
}
}
}
return true, nil
}
func newServiceMetadataMiddleware_opDescribeInstances(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "DescribeInstances",
}
}
|