api_op_DetachInstancesFromLoadBalancer.go raw
1 // Code generated by smithy-go-codegen DO NOT EDIT.
2
3 package lightsail
4
5 import (
6 "context"
7 "fmt"
8 awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
9 "github.com/aws/aws-sdk-go-v2/service/lightsail/types"
10 "github.com/aws/smithy-go/middleware"
11 smithyhttp "github.com/aws/smithy-go/transport/http"
12 )
13
14 // Detaches the specified instances from a Lightsail load balancer.
15 //
16 // This operation waits until the instances are no longer needed before they are
17 // detached from the load balancer.
18 //
19 // The detach instances from load balancer operation supports tag-based access
20 // control via resource tags applied to the resource identified by load balancer
21 // name . For more information, see the [Amazon Lightsail Developer Guide].
22 //
23 // [Amazon Lightsail Developer Guide]: https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags
24 func (c *Client) DetachInstancesFromLoadBalancer(ctx context.Context, params *DetachInstancesFromLoadBalancerInput, optFns ...func(*Options)) (*DetachInstancesFromLoadBalancerOutput, error) {
25 if params == nil {
26 params = &DetachInstancesFromLoadBalancerInput{}
27 }
28
29 result, metadata, err := c.invokeOperation(ctx, "DetachInstancesFromLoadBalancer", params, optFns, c.addOperationDetachInstancesFromLoadBalancerMiddlewares)
30 if err != nil {
31 return nil, err
32 }
33
34 out := result.(*DetachInstancesFromLoadBalancerOutput)
35 out.ResultMetadata = metadata
36 return out, nil
37 }
38
39 type DetachInstancesFromLoadBalancerInput struct {
40
41 // An array of strings containing the names of the instances you want to detach
42 // from the load balancer.
43 //
44 // This member is required.
45 InstanceNames []string
46
47 // The name of the Lightsail load balancer.
48 //
49 // This member is required.
50 LoadBalancerName *string
51
52 noSmithyDocumentSerde
53 }
54
55 type DetachInstancesFromLoadBalancerOutput struct {
56
57 // An array of objects that describe the result of the action, such as the status
58 // of the request, the timestamp of the request, and the resources affected by the
59 // request.
60 Operations []types.Operation
61
62 // Metadata pertaining to the operation's result.
63 ResultMetadata middleware.Metadata
64
65 noSmithyDocumentSerde
66 }
67
68 func (c *Client) addOperationDetachInstancesFromLoadBalancerMiddlewares(stack *middleware.Stack, options Options) (err error) {
69 if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
70 return err
71 }
72 err = stack.Serialize.Add(&awsAwsjson11_serializeOpDetachInstancesFromLoadBalancer{}, middleware.After)
73 if err != nil {
74 return err
75 }
76 err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDetachInstancesFromLoadBalancer{}, middleware.After)
77 if err != nil {
78 return err
79 }
80 if err := addProtocolFinalizerMiddlewares(stack, options, "DetachInstancesFromLoadBalancer"); err != nil {
81 return fmt.Errorf("add protocol finalizers: %v", err)
82 }
83
84 if err = addlegacyEndpointContextSetter(stack, options); err != nil {
85 return err
86 }
87 if err = addSetLoggerMiddleware(stack, options); err != nil {
88 return err
89 }
90 if err = addClientRequestID(stack); err != nil {
91 return err
92 }
93 if err = addComputeContentLength(stack); err != nil {
94 return err
95 }
96 if err = addResolveEndpointMiddleware(stack, options); err != nil {
97 return err
98 }
99 if err = addComputePayloadSHA256(stack); err != nil {
100 return err
101 }
102 if err = addRetry(stack, options); err != nil {
103 return err
104 }
105 if err = addRawResponseToMetadata(stack); err != nil {
106 return err
107 }
108 if err = addRecordResponseTiming(stack); err != nil {
109 return err
110 }
111 if err = addSpanRetryLoop(stack, options); err != nil {
112 return err
113 }
114 if err = addClientUserAgent(stack, options); err != nil {
115 return err
116 }
117 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
118 return err
119 }
120 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
121 return err
122 }
123 if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
124 return err
125 }
126 if err = addTimeOffsetBuild(stack, c); err != nil {
127 return err
128 }
129 if err = addUserAgentRetryMode(stack, options); err != nil {
130 return err
131 }
132 if err = addCredentialSource(stack, options); err != nil {
133 return err
134 }
135 if err = addOpDetachInstancesFromLoadBalancerValidationMiddleware(stack); err != nil {
136 return err
137 }
138 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDetachInstancesFromLoadBalancer(options.Region), middleware.Before); err != nil {
139 return err
140 }
141 if err = addRecursionDetection(stack); err != nil {
142 return err
143 }
144 if err = addRequestIDRetrieverMiddleware(stack); err != nil {
145 return err
146 }
147 if err = addResponseErrorMiddleware(stack); err != nil {
148 return err
149 }
150 if err = addRequestResponseLogging(stack, options); err != nil {
151 return err
152 }
153 if err = addDisableHTTPSMiddleware(stack, options); err != nil {
154 return err
155 }
156 if err = addInterceptBeforeRetryLoop(stack, options); err != nil {
157 return err
158 }
159 if err = addInterceptAttempt(stack, options); err != nil {
160 return err
161 }
162 if err = addInterceptors(stack, options); err != nil {
163 return err
164 }
165 return nil
166 }
167
168 func newServiceMetadataMiddleware_opDetachInstancesFromLoadBalancer(region string) *awsmiddleware.RegisterServiceMetadata {
169 return &awsmiddleware.RegisterServiceMetadata{
170 Region: region,
171 ServiceID: ServiceID,
172 OperationName: "DetachInstancesFromLoadBalancer",
173 }
174 }
175