@Generated(value="com.amazonaws:awsjavasdkcodegenerator") public class GetInstanceMetricDataRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description 

GetInstanceMetricDataRequest() 
Modifier and Type  Method and Description 

GetInstanceMetricDataRequest 
clone()
Creates a shallow clone of this object for all fields except the handler context.

boolean 
equals(Object obj) 
Date 
getEndTime()
The end time of the time period.

String 
getInstanceName()
The name of the instance for which you want to get metrics data.

String 
getMetricName()
The metric for which you want to return information.

Integer 
getPeriod()
The granularity, in seconds, of the returned data points.

Date 
getStartTime()
The start time of the time period.

List<String> 
getStatistics()
The statistic for the metric.

String 
getUnit()
The unit for the metric data request.

int 
hashCode() 
void 
setEndTime(Date endTime)
The end time of the time period.

void 
setInstanceName(String instanceName)
The name of the instance for which you want to get metrics data.

void 
setMetricName(InstanceMetricName metricName)
The metric for which you want to return information.

void 
setMetricName(String metricName)
The metric for which you want to return information.

void 
setPeriod(Integer period)
The granularity, in seconds, of the returned data points.

void 
setStartTime(Date startTime)
The start time of the time period.

void 
setStatistics(Collection<String> statistics)
The statistic for the metric.

void 
setUnit(MetricUnit unit)
The unit for the metric data request.

void 
setUnit(String unit)
The unit for the metric data request.

String 
toString()
Returns a string representation of this object.

GetInstanceMetricDataRequest 
withEndTime(Date endTime)
The end time of the time period.

GetInstanceMetricDataRequest 
withInstanceName(String instanceName)
The name of the instance for which you want to get metrics data.

GetInstanceMetricDataRequest 
withMetricName(InstanceMetricName metricName)
The metric for which you want to return information.

GetInstanceMetricDataRequest 
withMetricName(String metricName)
The metric for which you want to return information.

GetInstanceMetricDataRequest 
withPeriod(Integer period)
The granularity, in seconds, of the returned data points.

GetInstanceMetricDataRequest 
withStartTime(Date startTime)
The start time of the time period.

GetInstanceMetricDataRequest 
withStatistics(Collection<String> statistics)
The statistic for the metric.

GetInstanceMetricDataRequest 
withStatistics(MetricStatistic... statistics)
The statistic for the metric.

GetInstanceMetricDataRequest 
withStatistics(String... statistics)
The statistic for the metric.

GetInstanceMetricDataRequest 
withUnit(MetricUnit unit)
The unit for the metric data request.

GetInstanceMetricDataRequest 
withUnit(String unit)
The unit for the metric data request.

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setInstanceName(String instanceName)
The name of the instance for which you want to get metrics data.
instanceName
 The name of the instance for which you want to get metrics data.public String getInstanceName()
The name of the instance for which you want to get metrics data.
public GetInstanceMetricDataRequest withInstanceName(String instanceName)
The name of the instance for which you want to get metrics data.
instanceName
 The name of the instance for which you want to get metrics data.public void setMetricName(String 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 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.
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 5minute 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 5minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail.
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 5minute 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 5minute 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 1minute (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 1minute (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 1minute (60 seconds)
granularity.
Statistics
: The most useful statistic is Sum
.
Unit
: The published unit is Count
.
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 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.
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 5minute 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 5minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail.
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 5minute 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 5minute 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 1minute (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 1minute (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
1minute (60 seconds) granularity.
Statistics
: The most useful statistic is Sum
.
Unit
: The published unit is Count
.
InstanceMetricName
public String getMetricName()
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.
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 5minute 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 5minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail.
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 5minute 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 5minute 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 1minute (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 1minute (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 1minute (60 seconds)
granularity.
Statistics
: The most useful statistic is Sum
.
Unit
: The published unit is Count
.
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.
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 5minute 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 5minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail.
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 5minute 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 5minute
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 1minute (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 1minute (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
1minute (60 seconds) granularity.
Statistics
: The most useful statistic is Sum
.
Unit
: The published unit is Count
.
InstanceMetricName
public GetInstanceMetricDataRequest withMetricName(String 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 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.
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 5minute 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 5minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail.
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 5minute 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 5minute 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 1minute (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 1minute (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 1minute (60 seconds)
granularity.
Statistics
: The most useful statistic is Sum
.
Unit
: The published unit is Count
.
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 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.
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 5minute 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 5minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail.
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 5minute 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 5minute 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 1minute (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 1minute (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
1minute (60 seconds) granularity.
Statistics
: The most useful statistic is Sum
.
Unit
: The published unit is Count
.
InstanceMetricName
public void setMetricName(InstanceMetricName 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 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.
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 5minute 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 5minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail.
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 5minute 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 5minute 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 1minute (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 1minute (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 1minute (60 seconds)
granularity.
Statistics
: The most useful statistic is Sum
.
Unit
: The published unit is Count
.
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 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.
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 5minute 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 5minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail.
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 5minute 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 5minute 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 1minute (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 1minute (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
1minute (60 seconds) granularity.
Statistics
: The most useful statistic is Sum
.
Unit
: The published unit is Count
.
InstanceMetricName
public GetInstanceMetricDataRequest withMetricName(InstanceMetricName 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 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.
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 5minute 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 5minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail.
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 5minute 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 5minute 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 1minute (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 1minute (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 1minute (60 seconds)
granularity.
Statistics
: The most useful statistic is Sum
.
Unit
: The published unit is Count
.
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 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.
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 5minute 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 5minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail.
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 5minute 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 5minute 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 1minute (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 1minute (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
1minute (60 seconds) granularity.
Statistics
: The most useful statistic is Sum
.
Unit
: The published unit is Count
.
InstanceMetricName
public void setPeriod(Integer period)
The granularity, in seconds, of the returned data points.
The StatusCheckFailed
, StatusCheckFailed_Instance
, and
StatusCheckFailed_System
instance metric data is available in 1minute (60 seconds) granularity. All
other instance metric data is available in 5minute (300 seconds) granularity.
period
 The granularity, in seconds, of the returned data points.
The StatusCheckFailed
, StatusCheckFailed_Instance
, and
StatusCheckFailed_System
instance metric data is available in 1minute (60 seconds)
granularity. All other instance metric data is available in 5minute (300 seconds) granularity.
public Integer getPeriod()
The granularity, in seconds, of the returned data points.
The StatusCheckFailed
, StatusCheckFailed_Instance
, and
StatusCheckFailed_System
instance metric data is available in 1minute (60 seconds) granularity. All
other instance metric data is available in 5minute (300 seconds) granularity.
The StatusCheckFailed
, StatusCheckFailed_Instance
, and
StatusCheckFailed_System
instance metric data is available in 1minute (60 seconds)
granularity. All other instance metric data is available in 5minute (300 seconds) granularity.
public GetInstanceMetricDataRequest withPeriod(Integer period)
The granularity, in seconds, of the returned data points.
The StatusCheckFailed
, StatusCheckFailed_Instance
, and
StatusCheckFailed_System
instance metric data is available in 1minute (60 seconds) granularity. All
other instance metric data is available in 5minute (300 seconds) granularity.
period
 The granularity, in seconds, of the returned data points.
The StatusCheckFailed
, StatusCheckFailed_Instance
, and
StatusCheckFailed_System
instance metric data is available in 1minute (60 seconds)
granularity. All other instance metric data is available in 5minute (300 seconds) granularity.
public void setStartTime(Date startTime)
The start time of the time period.
startTime
 The start time of the time period.public Date getStartTime()
The start time of the time period.
public GetInstanceMetricDataRequest withStartTime(Date startTime)
The start time of the time period.
startTime
 The start time of the time period.public void setEndTime(Date endTime)
The end time of the time period.
endTime
 The end time of the time period.public Date getEndTime()
The end time of the time period.
public GetInstanceMetricDataRequest withEndTime(Date endTime)
The end time of the time period.
endTime
 The end time of the time period.public void setUnit(String 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.
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.MetricUnit
public String getUnit()
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.
metricName
parameter.MetricUnit
public GetInstanceMetricDataRequest withUnit(String 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.
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.MetricUnit
public void setUnit(MetricUnit 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.
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.MetricUnit
public GetInstanceMetricDataRequest withUnit(MetricUnit 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.
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.MetricUnit
public List<String> getStatistics()
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.
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.
MetricStatistic
public void setStatistics(Collection<String> 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.
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.
MetricStatistic
public GetInstanceMetricDataRequest withStatistics(String... 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.
NOTE: This method appends the values to the existing list (if any). Use
setStatistics(java.util.Collection)
or withStatistics(java.util.Collection)
if you want to
override the existing values.
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.
MetricStatistic
public GetInstanceMetricDataRequest withStatistics(Collection<String> 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.
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.
MetricStatistic
public GetInstanceMetricDataRequest withStatistics(MetricStatistic... 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.
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.
MetricStatistic
public String toString()
toString
in class Object
Object.toString()
public GetInstanceMetricDataRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()