/
api_op_GetRelationalDatabaseMetricData.go
219 lines (197 loc) · 8.2 KB
/
api_op_GetRelationalDatabaseMetricData.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
// Code generated by smithy-go-codegen DO NOT EDIT.
package lightsail
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/lightsail/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Returns the data points of the specified metric for a database in Amazon
// Lightsail. Metrics report the utilization of your resources, and the error
// counts generated by them. Monitor and collect metric data regularly to maintain
// the reliability, availability, and performance of your resources.
func (c *Client) GetRelationalDatabaseMetricData(ctx context.Context, params *GetRelationalDatabaseMetricDataInput, optFns ...func(*Options)) (*GetRelationalDatabaseMetricDataOutput, error) {
if params == nil {
params = &GetRelationalDatabaseMetricDataInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetRelationalDatabaseMetricData", params, optFns, c.addOperationGetRelationalDatabaseMetricDataMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetRelationalDatabaseMetricDataOutput)
out.ResultMetadata = metadata
return out, nil
}
type GetRelationalDatabaseMetricDataInput struct {
// The end of the time interval from which to get metric data. Constraints:
// - Specified in Coordinated Universal Time (UTC).
// - Specified in the Unix time format. For example, if you wish to use an end
// time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the end
// time.
//
// This member is required.
EndTime *time.Time
// The metric for which you want to return information. Valid relational database
// metric names are listed below, along with the most useful statistics to include
// in your request, and the published unit value. All relational database metric
// data is available in 1-minute (60 seconds) granularity.
// - CPUUtilization - The percentage of CPU utilization currently in use on the
// database. Statistics : The most useful statistics are Maximum and Average .
// Unit : The published unit is Percent .
// - DatabaseConnections - The number of database connections in use. Statistics
// : The most useful statistics are Maximum and Sum . Unit : The published unit
// is Count .
// - DiskQueueDepth - The number of outstanding IOs (read/write requests) that
// are waiting to access the disk. Statistics : The most useful statistic is Sum
// . Unit : The published unit is Count .
// - FreeStorageSpace - The amount of available storage space. Statistics : The
// most useful statistic is Sum . Unit : The published unit is Bytes .
// - NetworkReceiveThroughput - The incoming (Receive) network traffic on the
// database, including both customer database traffic and AWS traffic used for
// monitoring and replication. Statistics : The most useful statistic is Average
// . Unit : The published unit is Bytes/Second .
// - NetworkTransmitThroughput - The outgoing (Transmit) network traffic on the
// database, including both customer database traffic and AWS traffic used for
// monitoring and replication. Statistics : The most useful statistic is Average
// . Unit : The published unit is Bytes/Second .
//
// This member is required.
MetricName types.RelationalDatabaseMetricName
// The granularity, in seconds, of the returned data points. All relational
// database metric data is available in 1-minute (60 seconds) granularity.
//
// This member is required.
Period *int32
// The name of your database from which to get metric data.
//
// This member is required.
RelationalDatabaseName *string
// The start of the time interval from which to get metric data. Constraints:
// - Specified in Coordinated Universal Time (UTC).
// - Specified in the Unix time format. For example, if you wish to use a start
// time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the start
// time.
//
// This member is required.
StartTime *time.Time
// The statistic for the metric. The following statistics are available:
// - Minimum - The lowest value observed during the specified period. Use this
// value to determine low volumes of activity for your application.
// - Maximum - The highest value observed during the specified period. Use this
// value to determine high volumes of activity for your application.
// - Sum - All values submitted for the matching metric added together. You can
// use this statistic to determine the total volume of a metric.
// - Average - The value of Sum / SampleCount during the specified period. By
// comparing this statistic with the Minimum and Maximum values, you can determine
// the full scope of a metric and how close the average use is to the Minimum and
// Maximum values. This comparison helps you to know when to increase or decrease
// your resources.
// - SampleCount - The count, or number, of data points used for the statistical
// calculation.
//
// This member is required.
Statistics []types.MetricStatistic
// The unit for the metric data request. Valid units depend on the metric data
// being requested. For the valid units with each available metric, see the
// metricName parameter.
//
// This member is required.
Unit types.MetricUnit
noSmithyDocumentSerde
}
type GetRelationalDatabaseMetricDataOutput struct {
// An array of objects that describe the metric data returned.
MetricData []types.MetricDatapoint
// The name of the metric returned.
MetricName types.RelationalDatabaseMetricName
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationGetRelationalDatabaseMetricDataMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpGetRelationalDatabaseMetricData{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpGetRelationalDatabaseMetricData{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "GetRelationalDatabaseMetricData"); 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 = addOpGetRelationalDatabaseMetricDataValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetRelationalDatabaseMetricData(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_opGetRelationalDatabaseMetricData(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "GetRelationalDatabaseMetricData",
}
}