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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package lightsail
import (
"context"
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/lightsail/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Returns the data points of a specific metric for an Amazon Lightsail bucket.
// Metrics report the utilization of a bucket. View and collect metric data
// regularly to monitor the number of objects stored in a bucket (including object
// versions) and the storage space used by those objects.
func (c *Client) GetBucketMetricData(ctx context.Context, params *GetBucketMetricDataInput, optFns ...func(*Options)) (*GetBucketMetricDataOutput, error) {
if params == nil {
params = &GetBucketMetricDataInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetBucketMetricData", params, optFns, c.addOperationGetBucketMetricDataMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetBucketMetricDataOutput)
out.ResultMetadata = metadata
return out, nil
}
type GetBucketMetricDataInput struct {
// The name of the bucket for which to get metric data.
//
// This member is required.
BucketName *string
// The timestamp indicating the latest data to be returned.
//
// This member is required.
EndTime *time.Time
// The metric for which you want to return information. Valid bucket metric names
// are listed below, along with the most useful statistics to include in your
// request, and the published unit value. These bucket metrics are reported once
// per day.
//
// * BucketSizeBytes - The amount of data in bytes stored in a bucket.
// This value is calculated by summing the size of all objects in the bucket
// (including object versions), including the size of all parts for all incomplete
// multipart uploads to the bucket. Statistics: The most useful statistic is
// Maximum. Unit: The published unit is Bytes.
//
// * NumberOfObjects - The total
// number of objects stored in a bucket. This value is calculated by counting all
// objects in the bucket (including object versions) and the total number of parts
// for all incomplete multipart uploads to the bucket. Statistics: The most useful
// statistic is Average. Unit: The published unit is Count.
//
// This member is required.
MetricName types.BucketMetricName
// The granularity, in seconds, of the returned data points. Bucket storage metrics
// are reported once per day. Therefore, you should specify a period of 86400
// seconds, which is the number of seconds in a day.
//
// This member is required.
Period int32
// The timestamp indicating the earliest data to be returned.
//
// 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 - The sum of all values
// submitted for the matching metric. 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 GetBucketMetricDataOutput struct {
// An array of objects that describe the metric data returned.
MetricData []types.MetricDatapoint
// The name of the metric returned.
MetricName types.BucketMetricName
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationGetBucketMetricDataMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsjson11_serializeOpGetBucketMetricData{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpGetBucketMetricData{}, middleware.After)
if 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 = addHTTPSignerV4Middleware(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); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpGetBucketMetricDataValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetBucketMetricData(options.Region), middleware.Before); 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
}
return nil
}
func newServiceMetadataMiddleware_opGetBucketMetricData(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "lightsail",
OperationName: "GetBucketMetricData",
}
}
|
