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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package iotevents
import (
"context"
"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/iotevents/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Retrieves information about an alarm model. If you don't specify a value for
// the alarmModelVersion parameter, the latest version is returned.
func (c *Client) DescribeAlarmModel(ctx context.Context, params *DescribeAlarmModelInput, optFns ...func(*Options)) (*DescribeAlarmModelOutput, error) {
if params == nil {
params = &DescribeAlarmModelInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribeAlarmModel", params, optFns, c.addOperationDescribeAlarmModelMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribeAlarmModelOutput)
out.ResultMetadata = metadata
return out, nil
}
type DescribeAlarmModelInput struct {
// The name of the alarm model.
//
// This member is required.
AlarmModelName *string
// The version of the alarm model.
AlarmModelVersion *string
noSmithyDocumentSerde
}
type DescribeAlarmModelOutput struct {
// Contains the configuration information of alarm state changes.
AlarmCapabilities *types.AlarmCapabilities
// Contains information about one or more alarm actions.
AlarmEventActions *types.AlarmEventActions
// The ARN of the alarm model. For more information, see Amazon Resource Names
// (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// in the AWS General Reference.
AlarmModelArn *string
// The description of the alarm model.
AlarmModelDescription *string
// The name of the alarm model.
AlarmModelName *string
// The version of the alarm model.
AlarmModelVersion *string
// Contains information about one or more notification actions.
AlarmNotification *types.AlarmNotification
// Defines when your alarm is invoked.
AlarmRule *types.AlarmRule
// The time the alarm model was created, in the Unix epoch format.
CreationTime *time.Time
// An input attribute used as a key to create an alarm. AWS IoT Events routes
// inputs (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html)
// associated with this key to the alarm.
Key *string
// The time the alarm model was last updated, in the Unix epoch format.
LastUpdateTime *time.Time
// The ARN of the IAM role that allows the alarm to perform actions and access AWS
// resources. For more information, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// in the AWS General Reference.
RoleArn *string
// A non-negative integer that reflects the severity level of the alarm.
Severity *int32
// The status of the alarm model. The status can be one of the following values:
// - ACTIVE - The alarm model is active and it's ready to evaluate data.
// - ACTIVATING - AWS IoT Events is activating your alarm model. Activating an
// alarm model can take up to a few minutes.
// - INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data.
// Check your alarm model information and update the alarm model.
// - FAILED - You couldn't create or update the alarm model. Check your alarm
// model information and try again.
Status types.AlarmModelVersionStatus
// Contains information about the status of the alarm model.
StatusMessage *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDescribeAlarmModelMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpDescribeAlarmModel{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpDescribeAlarmModel{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "DescribeAlarmModel"); 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 = addOpDescribeAlarmModelValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeAlarmModel(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
}
func newServiceMetadataMiddleware_opDescribeAlarmModel(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "DescribeAlarmModel",
}
}
|
