Class GetInstanceMetricDataRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetInstanceMetricDataRequest.Builder,
GetInstanceMetricDataRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
endTime()
The end time of the time period.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Statistics property.final String
The name of the instance for which you want to get metrics data.final InstanceMetricName
The metric for which you want to return information.final String
The metric for which you want to return information.final Integer
period()
The granularity, in seconds, of the returned data points.static Class
<? extends GetInstanceMetricDataRequest.Builder> final Instant
The start time of the time period.final List
<MetricStatistic> The statistic for the metric.The statistic for the metric.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final MetricUnit
unit()
The unit for the metric data request.final String
The unit for the metric data request.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
instanceName
The name of the instance for which you want to get metrics data.
- Returns:
- The name of the instance for which you want to get metrics data.
-
metricName
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 publishedunit
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'sBurstCapacityPercentage
reaches 100%. For more information, see Viewing instance burst capacity in Amazon Lightsail.Statistics
: The most useful statistics areMaximum
andAverage
.Unit
: The published unit isPercent
. -
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'sBurstCapacityPercentage
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.
Statistics
: The most useful statistics areMaximum
andAverage
.Unit
: The published unit isSeconds
. -
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 areMaximum
andAverage
.Unit
: The published unit isPercent
. -
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 isSum
.Unit
: The published unit isBytes
. -
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 isSum
.Unit
: The published unit isBytes
. -
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 isSum
.Unit
: The published unit isCount
. -
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 isSum
.Unit
: The published unit isCount
. -
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 isSum
.Unit
: The published unit isCount
. -
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 isSum
.Unit
: The published unit isCount
.
If the service returns an enum value that is not available in the current SDK version,
metricName
will returnInstanceMetricName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommetricNameAsString()
.- Returns:
- 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 publishedunit
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'sBurstCapacityPercentage
reaches 100%. For more information, see Viewing instance burst capacity in Amazon Lightsail.Statistics
: The most useful statistics areMaximum
andAverage
.Unit
: The published unit isPercent
. -
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'sBurstCapacityPercentage
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.
Statistics
: The most useful statistics areMaximum
andAverage
.Unit
: The published unit isSeconds
. -
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 areMaximum
andAverage
.Unit
: The published unit isPercent
. -
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 isSum
.Unit
: The published unit isBytes
. -
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 isSum
.Unit
: The published unit isBytes
. -
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 isSum
.Unit
: The published unit isCount
. -
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 isSum
.Unit
: The published unit isCount
. -
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 isSum
.Unit
: The published unit isCount
. -
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 isSum
.Unit
: The published unit isCount
.
-
- See Also:
-
-
metricNameAsString
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 publishedunit
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'sBurstCapacityPercentage
reaches 100%. For more information, see Viewing instance burst capacity in Amazon Lightsail.Statistics
: The most useful statistics areMaximum
andAverage
.Unit
: The published unit isPercent
. -
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'sBurstCapacityPercentage
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.
Statistics
: The most useful statistics areMaximum
andAverage
.Unit
: The published unit isSeconds
. -
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 areMaximum
andAverage
.Unit
: The published unit isPercent
. -
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 isSum
.Unit
: The published unit isBytes
. -
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 isSum
.Unit
: The published unit isBytes
. -
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 isSum
.Unit
: The published unit isCount
. -
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 isSum
.Unit
: The published unit isCount
. -
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 isSum
.Unit
: The published unit isCount
. -
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 isSum
.Unit
: The published unit isCount
.
If the service returns an enum value that is not available in the current SDK version,
metricName
will returnInstanceMetricName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommetricNameAsString()
.- Returns:
- 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 publishedunit
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'sBurstCapacityPercentage
reaches 100%. For more information, see Viewing instance burst capacity in Amazon Lightsail.Statistics
: The most useful statistics areMaximum
andAverage
.Unit
: The published unit isPercent
. -
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'sBurstCapacityPercentage
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.
Statistics
: The most useful statistics areMaximum
andAverage
.Unit
: The published unit isSeconds
. -
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 areMaximum
andAverage
.Unit
: The published unit isPercent
. -
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 isSum
.Unit
: The published unit isBytes
. -
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 isSum
.Unit
: The published unit isBytes
. -
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 isSum
.Unit
: The published unit isCount
. -
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 isSum
.Unit
: The published unit isCount
. -
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 isSum
.Unit
: The published unit isCount
. -
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 isSum
.Unit
: The published unit isCount
.
-
- See Also:
-
-
period
The granularity, in seconds, of the returned data points.
The
StatusCheckFailed
,StatusCheckFailed_Instance
, andStatusCheckFailed_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.- Returns:
- The granularity, in seconds, of the returned data points.
The
StatusCheckFailed
,StatusCheckFailed_Instance
, andStatusCheckFailed_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.
-
startTime
The start time of the time period.
- Returns:
- The start time of the time period.
-
endTime
The end time of the time period.
- Returns:
- The end time of the time period.
-
unit
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.If the service returns an enum value that is not available in the current SDK version,
unit
will returnMetricUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromunitAsString()
.- Returns:
- 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. - See Also:
-
unitAsString
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.If the service returns an enum value that is not available in the current SDK version,
unit
will returnMetricUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromunitAsString()
.- Returns:
- 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. - See Also:
-
statistics
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasStatistics()
method.- Returns:
- 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.
-
-
-
hasStatistics
public final boolean hasStatistics()For responses, this returns true if the service returned a value for the Statistics property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
statisticsAsStrings
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasStatistics()
method.- Returns:
- 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.
-
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetInstanceMetricDataRequest.Builder,
GetInstanceMetricDataRequest> - Specified by:
toBuilder
in classLightsailRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-