-
Notifications
You must be signed in to change notification settings - Fork 597
/
api_op_GetInsightRuleReport.go
245 lines (219 loc) · 8.18 KB
/
api_op_GetInsightRuleReport.go
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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
// Code generated by smithy-go-codegen DO NOT EDIT.
package cloudwatch
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/cloudwatch/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// This operation returns the time series data collected by a Contributor Insights
// rule. The data includes the identity and number of contributors to the log
// group.
//
// You can also optionally return one or more statistics about each data point in
// the time series. These statistics can include the following:
//
// - UniqueContributors -- the number of unique contributors for each data point.
//
// - MaxContributorValue -- the value of the top contributor for each data point.
// The identity of the contributor might change for each data point in the graph.
//
// If this rule aggregates by COUNT, the top contributor for each data point is
//
// the contributor with the most occurrences in that period. If the rule aggregates
// by SUM, the top contributor is the contributor with the highest sum in the log
// field specified by the rule's Value , during that period.
//
// - SampleCount -- the number of data points matched by the rule.
//
// - Sum -- the sum of the values from all contributors during the time period
// represented by that data point.
//
// - Minimum -- the minimum value from a single observation during the time
// period represented by that data point.
//
// - Maximum -- the maximum value from a single observation during the time
// period represented by that data point.
//
// - Average -- the average value from all contributors during the time period
// represented by that data point.
func (c *Client) GetInsightRuleReport(ctx context.Context, params *GetInsightRuleReportInput, optFns ...func(*Options)) (*GetInsightRuleReportOutput, error) {
if params == nil {
params = &GetInsightRuleReportInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetInsightRuleReport", params, optFns, c.addOperationGetInsightRuleReportMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetInsightRuleReportOutput)
out.ResultMetadata = metadata
return out, nil
}
type GetInsightRuleReportInput struct {
// The end time of the data to use in the report. When used in a raw HTTP Query
// API, it is formatted as yyyy-MM-dd'T'HH:mm:ss . For example, 2019-07-01T23:59:59
// .
//
// This member is required.
EndTime *time.Time
// The period, in seconds, to use for the statistics in the
// InsightRuleMetricDatapoint results.
//
// This member is required.
Period *int32
// The name of the rule that you want to see data from.
//
// This member is required.
RuleName *string
// The start time of the data to use in the report. When used in a raw HTTP Query
// API, it is formatted as yyyy-MM-dd'T'HH:mm:ss . For example, 2019-07-01T23:59:59
// .
//
// This member is required.
StartTime *time.Time
// The maximum number of contributors to include in the report. The range is 1 to
// 100. If you omit this, the default of 10 is used.
MaxContributorCount *int32
// Specifies which metrics to use for aggregation of contributor values for the
// report. You can specify one or more of the following metrics:
//
// - UniqueContributors -- the number of unique contributors for each data point.
//
// - MaxContributorValue -- the value of the top contributor for each data point.
// The identity of the contributor might change for each data point in the graph.
//
// If this rule aggregates by COUNT, the top contributor for each data point is
// the contributor with the most occurrences in that period. If the rule aggregates
// by SUM, the top contributor is the contributor with the highest sum in the log
// field specified by the rule's Value , during that period.
//
// - SampleCount -- the number of data points matched by the rule.
//
// - Sum -- the sum of the values from all contributors during the time period
// represented by that data point.
//
// - Minimum -- the minimum value from a single observation during the time
// period represented by that data point.
//
// - Maximum -- the maximum value from a single observation during the time
// period represented by that data point.
//
// - Average -- the average value from all contributors during the time period
// represented by that data point.
Metrics []string
// Determines what statistic to use to rank the contributors. Valid values are Sum
// and Maximum .
OrderBy *string
noSmithyDocumentSerde
}
type GetInsightRuleReportOutput struct {
// The sum of the values from all individual contributors that match the rule.
AggregateValue *float64
// Specifies whether this rule aggregates contributor data by COUNT or SUM.
AggregationStatistic *string
// An approximate count of the unique contributors found by this rule in this time
// period.
ApproximateUniqueCount *int64
// An array of the unique contributors found by this rule in this time period. If
// the rule contains multiple keys, each combination of values for the keys counts
// as a unique contributor.
Contributors []types.InsightRuleContributor
// An array of the strings used as the keys for this rule. The keys are the
// dimensions used to classify contributors. If the rule contains more than one
// key, then each unique combination of values for the keys is counted as a unique
// contributor.
KeyLabels []string
// A time series of metric data points that matches the time period in the rule
// request.
MetricDatapoints []types.InsightRuleMetricDatapoint
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationGetInsightRuleReportMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsquery_serializeOpGetInsightRuleReport{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsquery_deserializeOpGetInsightRuleReport{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "GetInsightRuleReport"); 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 = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = 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 = addOpGetInsightRuleReportValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetInsightRuleReport(options.Region), middleware.Before); err != nil {
return err
}
if err = 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_opGetInsightRuleReport(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "GetInsightRuleReport",
}
}