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 246 247 248 249 250 251 252 253 254 255 256 257 258
|
// 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 for the specified Amazon Lightsail instance metric,
// given an instance name. 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) GetInstanceMetricData(ctx context.Context, params *GetInstanceMetricDataInput, optFns ...func(*Options)) (*GetInstanceMetricDataOutput, error) {
if params == nil {
params = &GetInstanceMetricDataInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetInstanceMetricData", params, optFns, c.addOperationGetInstanceMetricDataMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetInstanceMetricDataOutput)
out.ResultMetadata = metadata
return out, nil
}
type GetInstanceMetricDataInput struct {
// The end time of the time period.
//
// This member is required.
EndTime *time.Time
// The name of the instance for which you want to get metrics data.
//
// This member is required.
InstanceName *string
// The metric for which you want to return information. Valid instance metric names
// are listed below, along with the most useful statistics to include in your
// request, and the published unit value.
//
// * BurstCapacityPercentage - The
// percentage of CPU performance available for your instance to burst above its
// baseline. Your instance continuously accrues and consumes burst capacity. Burst
// capacity stops accruing when your instance's BurstCapacityPercentage reaches
// 100%. For more information, see Viewing instance burst capacity in Amazon
// Lightsail
// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-viewing-instance-burst-capacity).
// Statistics: The most useful statistics are Maximum and Average. Unit: The
// published unit is Percent.
//
// * BurstCapacityTime - The available amount of time
// for your instance to burst at 100% CPU utilization. Your instance continuously
// accrues and consumes burst capacity. Burst capacity time stops accruing when
// your instance's BurstCapacityPercentage metric reaches 100%. Burst capacity time
// is consumed at the full rate only when your instance operates at 100% CPU
// utilization. For example, if your instance operates at 50% CPU utilization in
// the burstable zone for a 5-minute period, then it consumes CPU burst capacity
// minutes at a 50% rate in that period. Your instance consumed 2 minutes and 30
// seconds of CPU burst capacity minutes in the 5-minute period. For more
// information, see Viewing instance burst capacity in Amazon Lightsail
// (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-viewing-instance-burst-capacity).
// Statistics: The most useful statistics are Maximum and Average. Unit: The
// published unit is Seconds.
//
// * CPUUtilization - The percentage of allocated
// compute units that are currently in use on the instance. This metric identifies
// the processing power to run the applications on the instance. Tools in your
// operating system can show a lower percentage than Lightsail when the instance is
// not allocated a full processor core. Statistics: The most useful statistics are
// Maximum and Average. Unit: The published unit is Percent.
//
// * NetworkIn - The
// number of bytes received on all network interfaces by the instance. This metric
// identifies the volume of incoming network traffic to the instance. The number
// reported is the number of bytes received during the period. Because this metric
// is reported in 5-minute intervals, divide the reported number by 300 to find
// Bytes/second. Statistics: The most useful statistic is Sum. Unit: The published
// unit is Bytes.
//
// * NetworkOut - The number of bytes sent out on all network
// interfaces by the instance. This metric identifies the volume of outgoing
// network traffic from the instance. The number reported is the number of bytes
// sent during the period. Because this metric is reported in 5-minute intervals,
// divide the reported number by 300 to find Bytes/second. Statistics: The most
// useful statistic is Sum. Unit: The published unit is Bytes.
//
// * StatusCheckFailed
// - Reports whether the instance passed or failed both the instance status check
// and the system status check. This metric can be either 0 (passed) or 1 (failed).
// This metric data is available in 1-minute (60 seconds) granularity. Statistics:
// The most useful statistic is Sum. Unit: The published unit is Count.
//
// *
// StatusCheckFailed_Instance - Reports whether the instance passed or failed the
// instance status check. This metric can be either 0 (passed) or 1 (failed). This
// metric data is available in 1-minute (60 seconds) granularity. Statistics: The
// most useful statistic is Sum. Unit: The published unit is Count.
//
// *
// StatusCheckFailed_System - Reports whether the instance passed or failed the
// system status check. This metric can be either 0 (passed) or 1 (failed). This
// metric data is available in 1-minute (60 seconds) granularity. Statistics: The
// most useful statistic is Sum. Unit: The published unit is Count.
//
// *
// MetadataNoToken - Reports the number of times that the instance metadata service
// was successfully accessed without a token. This metric determines if there are
// any processes accessing instance metadata by using Instance Metadata Service
// Version 1, which doesn't use a token. If all requests use token-backed sessions,
// such as Instance Metadata Service Version 2, then the value is 0. Statistics:
// The most useful statistic is Sum. Unit: The published unit is Count.
//
// This member is required.
MetricName types.InstanceMetricName
// The granularity, in seconds, of the returned data points. The StatusCheckFailed,
// StatusCheckFailed_Instance, and StatusCheckFailed_System instance metric data is
// available in 1-minute (60 seconds) granularity. All other instance metric data
// is available in 5-minute (300 seconds) granularity.
//
// This member is required.
Period int32
// The start time of the time period.
//
// 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 to specify with each available metric, see
// the metricName parameter.
//
// This member is required.
Unit types.MetricUnit
noSmithyDocumentSerde
}
type GetInstanceMetricDataOutput struct {
// An array of objects that describe the metric data returned.
MetricData []types.MetricDatapoint
// The name of the metric returned.
MetricName types.InstanceMetricName
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationGetInstanceMetricDataMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsjson11_serializeOpGetInstanceMetricData{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpGetInstanceMetricData{}, 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 = addOpGetInstanceMetricDataValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetInstanceMetricData(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_opGetInstanceMetricData(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "lightsail",
OperationName: "GetInstanceMetricData",
}
}
|