// Code generated by smithy-go-codegen DO NOT EDIT. package opsworks 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/opsworks/types" "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" "time" ) // Requests a description of a set of instances. This call accepts only one // resource-identifying parameter. Required Permissions: To use this action, an IAM // user must have a Show, Deploy, or Manage permissions level for the stack, or an // attached policy that explicitly grants permissions. For more information about // user permissions, see Managing User Permissions (https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html) // . 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 { // An array of instance IDs to be described. If you use this parameter, // DescribeInstances returns a description of the specified instances. Otherwise, // it returns a description of every instance. InstanceIds []string // A layer ID. If you use this parameter, DescribeInstances returns descriptions // of the instances associated with the specified layer. LayerId *string // A stack ID. If you use this parameter, DescribeInstances returns descriptions // of the instances associated with the specified stack. StackId *string noSmithyDocumentSerde } // Contains the response to a DescribeInstances request. type DescribeInstancesOutput struct { // An array of Instance objects that describe the instances. Instances []types.Instance // 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(&awsAwsjson11_serializeOpDescribeInstances{}, middleware.After) if err != nil { return err } err = stack.Deserialize.Add(&awsAwsjson11_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, 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 = 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 } 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) // InstanceOnlineWaiterOptions are waiter options for InstanceOnlineWaiter type InstanceOnlineWaiterOptions 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, // InstanceOnlineWaiter 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, InstanceOnlineWaiter 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) } // InstanceOnlineWaiter defines the waiters for InstanceOnline type InstanceOnlineWaiter struct { client DescribeInstancesAPIClient options InstanceOnlineWaiterOptions } // NewInstanceOnlineWaiter constructs a InstanceOnlineWaiter. func NewInstanceOnlineWaiter(client DescribeInstancesAPIClient, optFns ...func(*InstanceOnlineWaiterOptions)) *InstanceOnlineWaiter { options := InstanceOnlineWaiterOptions{} options.MinDelay = 15 * time.Second options.MaxDelay = 120 * time.Second options.Retryable = instanceOnlineStateRetryable for _, fn := range optFns { fn(&options) } return &InstanceOnlineWaiter{ client: client, options: options, } } // Wait calls the waiter function for InstanceOnline waiter. The maxWaitDur is the // maximum wait duration the waiter will wait. The maxWaitDur is required and must // be greater than zero. func (w *InstanceOnlineWaiter) Wait(ctx context.Context, params *DescribeInstancesInput, maxWaitDur time.Duration, optFns ...func(*InstanceOnlineWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err } // WaitForOutput calls the waiter function for InstanceOnline 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 *InstanceOnlineWaiter) WaitForOutput(ctx context.Context, params *DescribeInstancesInput, maxWaitDur time.Duration, optFns ...func(*InstanceOnlineWaiterOptions)) (*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 InstanceOnline waiter") } func instanceOnlineStateRetryable(ctx context.Context, input *DescribeInstancesInput, output *DescribeInstancesOutput, err error) (bool, error) { if err == nil { pathValue, err := jmespath.Search("Instances[].Status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "online" 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.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) != expectedValue { match = false } } if match { return false, nil } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "setup_failed" listOfValues, ok := pathValue.([]interface{}) if !ok { return false, fmt.Errorf("waiter comparator expected list got %T", pathValue) } for _, v := range listOfValues { value, ok := v.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", 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.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "start_failed" listOfValues, ok := pathValue.([]interface{}) if !ok { return false, fmt.Errorf("waiter comparator expected list got %T", pathValue) } for _, v := range listOfValues { value, ok := v.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "stopped" listOfValues, ok := pathValue.([]interface{}) if !ok { return false, fmt.Errorf("waiter comparator expected list got %T", pathValue) } for _, v := range listOfValues { value, ok := v.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", 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.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "terminating" listOfValues, ok := pathValue.([]interface{}) if !ok { return false, fmt.Errorf("waiter comparator expected list got %T", pathValue) } for _, v := range listOfValues { value, ok := v.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", 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.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "stop_failed" listOfValues, ok := pathValue.([]interface{}) if !ok { return false, fmt.Errorf("waiter comparator expected list got %T", pathValue) } for _, v := range listOfValues { value, ok := v.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } return true, nil } // InstanceRegisteredWaiterOptions are waiter options for InstanceRegisteredWaiter type InstanceRegisteredWaiterOptions 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, // InstanceRegisteredWaiter 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, InstanceRegisteredWaiter 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) } // InstanceRegisteredWaiter defines the waiters for InstanceRegistered type InstanceRegisteredWaiter struct { client DescribeInstancesAPIClient options InstanceRegisteredWaiterOptions } // NewInstanceRegisteredWaiter constructs a InstanceRegisteredWaiter. func NewInstanceRegisteredWaiter(client DescribeInstancesAPIClient, optFns ...func(*InstanceRegisteredWaiterOptions)) *InstanceRegisteredWaiter { options := InstanceRegisteredWaiterOptions{} options.MinDelay = 15 * time.Second options.MaxDelay = 120 * time.Second options.Retryable = instanceRegisteredStateRetryable for _, fn := range optFns { fn(&options) } return &InstanceRegisteredWaiter{ client: client, options: options, } } // Wait calls the waiter function for InstanceRegistered waiter. The maxWaitDur is // the maximum wait duration the waiter will wait. The maxWaitDur is required and // must be greater than zero. func (w *InstanceRegisteredWaiter) Wait(ctx context.Context, params *DescribeInstancesInput, maxWaitDur time.Duration, optFns ...func(*InstanceRegisteredWaiterOptions)) error { _, err := w.WaitForOutput(ctx, params, maxWaitDur, optFns...) return err } // WaitForOutput calls the waiter function for InstanceRegistered 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 *InstanceRegisteredWaiter) WaitForOutput(ctx context.Context, params *DescribeInstancesInput, maxWaitDur time.Duration, optFns ...func(*InstanceRegisteredWaiterOptions)) (*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 InstanceRegistered waiter") } func instanceRegisteredStateRetryable(ctx context.Context, input *DescribeInstancesInput, output *DescribeInstancesOutput, err error) (bool, error) { if err == nil { pathValue, err := jmespath.Search("Instances[].Status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "registered" 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.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) != expectedValue { match = false } } if match { return false, nil } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "setup_failed" listOfValues, ok := pathValue.([]interface{}) if !ok { return false, fmt.Errorf("waiter comparator expected list got %T", pathValue) } for _, v := range listOfValues { value, ok := v.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", 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.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "stopped" listOfValues, ok := pathValue.([]interface{}) if !ok { return false, fmt.Errorf("waiter comparator expected list got %T", pathValue) } for _, v := range listOfValues { value, ok := v.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", 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.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "terminating" listOfValues, ok := pathValue.([]interface{}) if !ok { return false, fmt.Errorf("waiter comparator expected list got %T", pathValue) } for _, v := range listOfValues { value, ok := v.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", 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.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "stop_failed" listOfValues, ok := pathValue.([]interface{}) if !ok { return false, fmt.Errorf("waiter comparator expected list got %T", pathValue) } for _, v := range listOfValues { value, ok := v.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } 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("Instances[].Status", 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.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) != expectedValue { match = false } } if match { return false, nil } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "booting" listOfValues, ok := pathValue.([]interface{}) if !ok { return false, fmt.Errorf("waiter comparator expected list got %T", pathValue) } for _, v := range listOfValues { value, ok := v.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", 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.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "rebooting" listOfValues, ok := pathValue.([]interface{}) if !ok { return false, fmt.Errorf("waiter comparator expected list got %T", pathValue) } for _, v := range listOfValues { value, ok := v.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "requested" listOfValues, ok := pathValue.([]interface{}) if !ok { return false, fmt.Errorf("waiter comparator expected list got %T", pathValue) } for _, v := range listOfValues { value, ok := v.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "running_setup" listOfValues, ok := pathValue.([]interface{}) if !ok { return false, fmt.Errorf("waiter comparator expected list got %T", pathValue) } for _, v := range listOfValues { value, ok := v.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "setup_failed" listOfValues, ok := pathValue.([]interface{}) if !ok { return false, fmt.Errorf("waiter comparator expected list got %T", pathValue) } for _, v := range listOfValues { value, ok := v.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "start_failed" listOfValues, ok := pathValue.([]interface{}) if !ok { return false, fmt.Errorf("waiter comparator expected list got %T", pathValue) } for _, v := range listOfValues { value, ok := v.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "stop_failed" listOfValues, ok := pathValue.([]interface{}) if !ok { return false, fmt.Errorf("waiter comparator expected list got %T", pathValue) } for _, v := range listOfValues { value, ok := v.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string 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("Instances[].Status", 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.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) != expectedValue { match = false } } if match { return false, nil } } if err != nil { var errorType *types.ResourceNotFoundException if errors.As(err, &errorType) { return false, nil } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "booting" listOfValues, ok := pathValue.([]interface{}) if !ok { return false, fmt.Errorf("waiter comparator expected list got %T", pathValue) } for _, v := range listOfValues { value, ok := v.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "online" listOfValues, ok := pathValue.([]interface{}) if !ok { return false, fmt.Errorf("waiter comparator expected list got %T", pathValue) } for _, v := range listOfValues { value, ok := v.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", 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.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "rebooting" listOfValues, ok := pathValue.([]interface{}) if !ok { return false, fmt.Errorf("waiter comparator expected list got %T", pathValue) } for _, v := range listOfValues { value, ok := v.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "requested" listOfValues, ok := pathValue.([]interface{}) if !ok { return false, fmt.Errorf("waiter comparator expected list got %T", pathValue) } for _, v := range listOfValues { value, ok := v.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "running_setup" listOfValues, ok := pathValue.([]interface{}) if !ok { return false, fmt.Errorf("waiter comparator expected list got %T", pathValue) } for _, v := range listOfValues { value, ok := v.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "setup_failed" listOfValues, ok := pathValue.([]interface{}) if !ok { return false, fmt.Errorf("waiter comparator expected list got %T", pathValue) } for _, v := range listOfValues { value, ok := v.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string value, got %T", pathValue) } if string(*value) == expectedValue { return false, fmt.Errorf("waiter state transitioned to Failure") } } } if err == nil { pathValue, err := jmespath.Search("Instances[].Status", output) if err != nil { return false, fmt.Errorf("error evaluating waiter state: %w", err) } expectedValue := "start_failed" listOfValues, ok := pathValue.([]interface{}) if !ok { return false, fmt.Errorf("waiter comparator expected list got %T", pathValue) } for _, v := range listOfValues { value, ok := v.(*string) if !ok { return false, fmt.Errorf("waiter comparator expected *string 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, SigningName: "opsworks", OperationName: "DescribeInstances", } }