api_op_DeleteAlarm.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 // Deletes an alarm.
15 //
16 // An alarm is used to monitor a single metric for one of your resources. When a
17 // metric condition is met, the alarm can notify you by email, SMS text message,
18 // and a banner displayed on the Amazon Lightsail console. For more information,
19 // see [Alarms in Amazon Lightsail].
20 //
21 // [Alarms in Amazon Lightsail]: https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-alarms
22 func (c *Client) DeleteAlarm(ctx context.Context, params *DeleteAlarmInput, optFns ...func(*Options)) (*DeleteAlarmOutput, error) {
23 if params == nil {
24 params = &DeleteAlarmInput{}
25 }
26
27 result, metadata, err := c.invokeOperation(ctx, "DeleteAlarm", params, optFns, c.addOperationDeleteAlarmMiddlewares)
28 if err != nil {
29 return nil, err
30 }
31
32 out := result.(*DeleteAlarmOutput)
33 out.ResultMetadata = metadata
34 return out, nil
35 }
36
37 type DeleteAlarmInput struct {
38
39 // The name of the alarm to delete.
40 //
41 // This member is required.
42 AlarmName *string
43
44 noSmithyDocumentSerde
45 }
46
47 type DeleteAlarmOutput struct {
48
49 // An array of objects that describe the result of the action, such as the status
50 // of the request, the timestamp of the request, and the resources affected by the
51 // request.
52 Operations []types.Operation
53
54 // Metadata pertaining to the operation's result.
55 ResultMetadata middleware.Metadata
56
57 noSmithyDocumentSerde
58 }
59
60 func (c *Client) addOperationDeleteAlarmMiddlewares(stack *middleware.Stack, options Options) (err error) {
61 if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
62 return err
63 }
64 err = stack.Serialize.Add(&awsAwsjson11_serializeOpDeleteAlarm{}, middleware.After)
65 if err != nil {
66 return err
67 }
68 err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDeleteAlarm{}, middleware.After)
69 if err != nil {
70 return err
71 }
72 if err := addProtocolFinalizerMiddlewares(stack, options, "DeleteAlarm"); err != nil {
73 return fmt.Errorf("add protocol finalizers: %v", err)
74 }
75
76 if err = addlegacyEndpointContextSetter(stack, options); err != nil {
77 return err
78 }
79 if err = addSetLoggerMiddleware(stack, options); err != nil {
80 return err
81 }
82 if err = addClientRequestID(stack); err != nil {
83 return err
84 }
85 if err = addComputeContentLength(stack); err != nil {
86 return err
87 }
88 if err = addResolveEndpointMiddleware(stack, options); err != nil {
89 return err
90 }
91 if err = addComputePayloadSHA256(stack); err != nil {
92 return err
93 }
94 if err = addRetry(stack, options); err != nil {
95 return err
96 }
97 if err = addRawResponseToMetadata(stack); err != nil {
98 return err
99 }
100 if err = addRecordResponseTiming(stack); err != nil {
101 return err
102 }
103 if err = addSpanRetryLoop(stack, options); err != nil {
104 return err
105 }
106 if err = addClientUserAgent(stack, options); err != nil {
107 return err
108 }
109 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
110 return err
111 }
112 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
113 return err
114 }
115 if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
116 return err
117 }
118 if err = addTimeOffsetBuild(stack, c); err != nil {
119 return err
120 }
121 if err = addUserAgentRetryMode(stack, options); err != nil {
122 return err
123 }
124 if err = addCredentialSource(stack, options); err != nil {
125 return err
126 }
127 if err = addOpDeleteAlarmValidationMiddleware(stack); err != nil {
128 return err
129 }
130 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDeleteAlarm(options.Region), middleware.Before); err != nil {
131 return err
132 }
133 if err = addRecursionDetection(stack); err != nil {
134 return err
135 }
136 if err = addRequestIDRetrieverMiddleware(stack); err != nil {
137 return err
138 }
139 if err = addResponseErrorMiddleware(stack); err != nil {
140 return err
141 }
142 if err = addRequestResponseLogging(stack, options); err != nil {
143 return err
144 }
145 if err = addDisableHTTPSMiddleware(stack, options); err != nil {
146 return err
147 }
148 if err = addInterceptBeforeRetryLoop(stack, options); err != nil {
149 return err
150 }
151 if err = addInterceptAttempt(stack, options); err != nil {
152 return err
153 }
154 if err = addInterceptors(stack, options); err != nil {
155 return err
156 }
157 return nil
158 }
159
160 func newServiceMetadataMiddleware_opDeleteAlarm(region string) *awsmiddleware.RegisterServiceMetadata {
161 return &awsmiddleware.RegisterServiceMetadata{
162 Region: region,
163 ServiceID: ServiceID,
164 OperationName: "DeleteAlarm",
165 }
166 }
167