1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package lightsail
4
5import (
6	"context"
7	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
8	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
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// Returns information about the configured alarms. Specify an alarm name in your
15// request to return information about a specific alarm, or specify a monitored
16// resource name to return information about all alarms for a specific resource. An
17// alarm is used to monitor a single metric for one of your resources. When a
18// metric condition is met, the alarm can notify you by email, SMS text message,
19// and a banner displayed on the Amazon Lightsail console. For more information,
20// see Alarms in Amazon Lightsail
21// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms).
22func (c *Client) GetAlarms(ctx context.Context, params *GetAlarmsInput, optFns ...func(*Options)) (*GetAlarmsOutput, error) {
23	if params == nil {
24		params = &GetAlarmsInput{}
25	}
26
27	result, metadata, err := c.invokeOperation(ctx, "GetAlarms", params, optFns, addOperationGetAlarmsMiddlewares)
28	if err != nil {
29		return nil, err
30	}
31
32	out := result.(*GetAlarmsOutput)
33	out.ResultMetadata = metadata
34	return out, nil
35}
36
37type GetAlarmsInput struct {
38
39	// The name of the alarm. Specify an alarm name to return information about a
40	// specific alarm.
41	AlarmName *string
42
43	// The name of the Lightsail resource being monitored by the alarm. Specify a
44	// monitored resource name to return information about all alarms for a specific
45	// resource.
46	MonitoredResourceName *string
47
48	// The token to advance to the next page of results from your request. To get a
49	// page token, perform an initial GetAlarms request. If your results are paginated,
50	// the response will return a next page token that you can specify as the page
51	// token in a subsequent request.
52	PageToken *string
53}
54
55type GetAlarmsOutput struct {
56
57	// An array of objects that describe the alarms.
58	Alarms []types.Alarm
59
60	// The token to advance to the next page of results from your request. A next page
61	// token is not returned if there are no more results to display. To get the next
62	// page of results, perform another GetAlarms request and specify the next page
63	// token using the pageToken parameter.
64	NextPageToken *string
65
66	// Metadata pertaining to the operation's result.
67	ResultMetadata middleware.Metadata
68}
69
70func addOperationGetAlarmsMiddlewares(stack *middleware.Stack, options Options) (err error) {
71	err = stack.Serialize.Add(&awsAwsjson11_serializeOpGetAlarms{}, middleware.After)
72	if err != nil {
73		return err
74	}
75	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpGetAlarms{}, middleware.After)
76	if err != nil {
77		return err
78	}
79	if err = addSetLoggerMiddleware(stack, options); err != nil {
80		return err
81	}
82	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
83		return err
84	}
85	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
86		return err
87	}
88	if err = addResolveEndpointMiddleware(stack, options); err != nil {
89		return err
90	}
91	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
92		return err
93	}
94	if err = addRetryMiddlewares(stack, options); err != nil {
95		return err
96	}
97	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
98		return err
99	}
100	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
101		return err
102	}
103	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
104		return err
105	}
106	if err = addClientUserAgent(stack); 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 = stack.Initialize.Add(newServiceMetadataMiddleware_opGetAlarms(options.Region), middleware.Before); err != nil {
116		return err
117	}
118	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
119		return err
120	}
121	if err = addResponseErrorMiddleware(stack); err != nil {
122		return err
123	}
124	if err = addRequestResponseLogging(stack, options); err != nil {
125		return err
126	}
127	return nil
128}
129
130func newServiceMetadataMiddleware_opGetAlarms(region string) *awsmiddleware.RegisterServiceMetadata {
131	return &awsmiddleware.RegisterServiceMetadata{
132		Region:        region,
133		ServiceID:     ServiceID,
134		SigningName:   "lightsail",
135		OperationName: "GetAlarms",
136	}
137}
138