AWS SDK for C++  1.8.100
AWS SDK for C++
Public Member Functions | List of all members
Aws::Lightsail::Model::GetInstanceMetricDataRequest Class Reference

#include <GetInstanceMetricDataRequest.h>

+ Inheritance diagram for Aws::Lightsail::Model::GetInstanceMetricDataRequest:

Public Member Functions

 GetInstanceMetricDataRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetInstanceName () const
 
bool InstanceNameHasBeenSet () const
 
void SetInstanceName (const Aws::String &value)
 
void SetInstanceName (Aws::String &&value)
 
void SetInstanceName (const char *value)
 
GetInstanceMetricDataRequestWithInstanceName (const Aws::String &value)
 
GetInstanceMetricDataRequestWithInstanceName (Aws::String &&value)
 
GetInstanceMetricDataRequestWithInstanceName (const char *value)
 
const InstanceMetricNameGetMetricName () const
 
bool MetricNameHasBeenSet () const
 
void SetMetricName (const InstanceMetricName &value)
 
void SetMetricName (InstanceMetricName &&value)
 
GetInstanceMetricDataRequestWithMetricName (const InstanceMetricName &value)
 
GetInstanceMetricDataRequestWithMetricName (InstanceMetricName &&value)
 
int GetPeriod () const
 
bool PeriodHasBeenSet () const
 
void SetPeriod (int value)
 
GetInstanceMetricDataRequestWithPeriod (int value)
 
const Aws::Utils::DateTimeGetStartTime () const
 
bool StartTimeHasBeenSet () const
 
void SetStartTime (const Aws::Utils::DateTime &value)
 
void SetStartTime (Aws::Utils::DateTime &&value)
 
GetInstanceMetricDataRequestWithStartTime (const Aws::Utils::DateTime &value)
 
GetInstanceMetricDataRequestWithStartTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetEndTime () const
 
bool EndTimeHasBeenSet () const
 
void SetEndTime (const Aws::Utils::DateTime &value)
 
void SetEndTime (Aws::Utils::DateTime &&value)
 
GetInstanceMetricDataRequestWithEndTime (const Aws::Utils::DateTime &value)
 
GetInstanceMetricDataRequestWithEndTime (Aws::Utils::DateTime &&value)
 
const MetricUnitGetUnit () const
 
bool UnitHasBeenSet () const
 
void SetUnit (const MetricUnit &value)
 
void SetUnit (MetricUnit &&value)
 
GetInstanceMetricDataRequestWithUnit (const MetricUnit &value)
 
GetInstanceMetricDataRequestWithUnit (MetricUnit &&value)
 
const Aws::Vector< MetricStatistic > & GetStatistics () const
 
bool StatisticsHasBeenSet () const
 
void SetStatistics (const Aws::Vector< MetricStatistic > &value)
 
void SetStatistics (Aws::Vector< MetricStatistic > &&value)
 
GetInstanceMetricDataRequestWithStatistics (const Aws::Vector< MetricStatistic > &value)
 
GetInstanceMetricDataRequestWithStatistics (Aws::Vector< MetricStatistic > &&value)
 
GetInstanceMetricDataRequestAddStatistics (const MetricStatistic &value)
 
GetInstanceMetricDataRequestAddStatistics (MetricStatistic &&value)
 
- Public Member Functions inherited from Aws::Lightsail::LightsailRequest
virtual ~LightsailRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 26 of file GetInstanceMetricDataRequest.h.

Constructor & Destructor Documentation

◆ GetInstanceMetricDataRequest()

Aws::Lightsail::Model::GetInstanceMetricDataRequest::GetInstanceMetricDataRequest ( )

Member Function Documentation

◆ AddStatistics() [1/2]

GetInstanceMetricDataRequest& Aws::Lightsail::Model::GetInstanceMetricDataRequest::AddStatistics ( const MetricStatistic value)
inline

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.

Definition at line 777 of file GetInstanceMetricDataRequest.h.

◆ AddStatistics() [2/2]

GetInstanceMetricDataRequest& Aws::Lightsail::Model::GetInstanceMetricDataRequest::AddStatistics ( MetricStatistic &&  value)
inline

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.

Definition at line 796 of file GetInstanceMetricDataRequest.h.

◆ EndTimeHasBeenSet()

bool Aws::Lightsail::Model::GetInstanceMetricDataRequest::EndTimeHasBeenSet ( ) const
inline

The end time of the time period.

Definition at line 580 of file GetInstanceMetricDataRequest.h.

◆ GetEndTime()

const Aws::Utils::DateTime& Aws::Lightsail::Model::GetInstanceMetricDataRequest::GetEndTime ( ) const
inline

The end time of the time period.

Definition at line 575 of file GetInstanceMetricDataRequest.h.

◆ GetInstanceName()

const Aws::String& Aws::Lightsail::Model::GetInstanceMetricDataRequest::GetInstanceName ( ) const
inline

The name of the instance for which you want to get metrics data.

Definition at line 45 of file GetInstanceMetricDataRequest.h.

◆ GetMetricName()

const InstanceMetricName& Aws::Lightsail::Model::GetInstanceMetricDataRequest::GetMetricName ( ) const
inline

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 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 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.

Definition at line 151 of file GetInstanceMetricDataRequest.h.

◆ GetPeriod()

int Aws::Lightsail::Model::GetInstanceMetricDataRequest::GetPeriod ( ) const
inline

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.

Definition at line 511 of file GetInstanceMetricDataRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Lightsail::Model::GetInstanceMetricDataRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::Lightsail::LightsailRequest.

◆ GetServiceRequestName()

virtual const char* Aws::Lightsail::Model::GetInstanceMetricDataRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file GetInstanceMetricDataRequest.h.

◆ GetStartTime()

const Aws::Utils::DateTime& Aws::Lightsail::Model::GetInstanceMetricDataRequest::GetStartTime ( ) const
inline

The start time of the time period.

Definition at line 544 of file GetInstanceMetricDataRequest.h.

◆ GetStatistics()

const Aws::Vector<MetricStatistic>& Aws::Lightsail::Model::GetInstanceMetricDataRequest::GetStatistics ( ) const
inline

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.

Definition at line 663 of file GetInstanceMetricDataRequest.h.

◆ GetUnit()

const MetricUnit& Aws::Lightsail::Model::GetInstanceMetricDataRequest::GetUnit ( ) const
inline

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.

Definition at line 608 of file GetInstanceMetricDataRequest.h.

◆ InstanceNameHasBeenSet()

bool Aws::Lightsail::Model::GetInstanceMetricDataRequest::InstanceNameHasBeenSet ( ) const
inline

The name of the instance for which you want to get metrics data.

Definition at line 50 of file GetInstanceMetricDataRequest.h.

◆ MetricNameHasBeenSet()

bool Aws::Lightsail::Model::GetInstanceMetricDataRequest::MetricNameHasBeenSet ( ) const
inline

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 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 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.

Definition at line 221 of file GetInstanceMetricDataRequest.h.

◆ PeriodHasBeenSet()

bool Aws::Lightsail::Model::GetInstanceMetricDataRequest::PeriodHasBeenSet ( ) const
inline

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.

Definition at line 520 of file GetInstanceMetricDataRequest.h.

◆ SerializePayload()

Aws::String Aws::Lightsail::Model::GetInstanceMetricDataRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetEndTime() [1/2]

void Aws::Lightsail::Model::GetInstanceMetricDataRequest::SetEndTime ( const Aws::Utils::DateTime value)
inline

The end time of the time period.

Definition at line 585 of file GetInstanceMetricDataRequest.h.

◆ SetEndTime() [2/2]

void Aws::Lightsail::Model::GetInstanceMetricDataRequest::SetEndTime ( Aws::Utils::DateTime &&  value)
inline

The end time of the time period.

Definition at line 590 of file GetInstanceMetricDataRequest.h.

◆ SetInstanceName() [1/3]

void Aws::Lightsail::Model::GetInstanceMetricDataRequest::SetInstanceName ( const Aws::String value)
inline

The name of the instance for which you want to get metrics data.

Definition at line 55 of file GetInstanceMetricDataRequest.h.

◆ SetInstanceName() [2/3]

void Aws::Lightsail::Model::GetInstanceMetricDataRequest::SetInstanceName ( Aws::String &&  value)
inline

The name of the instance for which you want to get metrics data.

Definition at line 60 of file GetInstanceMetricDataRequest.h.

◆ SetInstanceName() [3/3]

void Aws::Lightsail::Model::GetInstanceMetricDataRequest::SetInstanceName ( const char *  value)
inline

The name of the instance for which you want to get metrics data.

Definition at line 65 of file GetInstanceMetricDataRequest.h.

◆ SetMetricName() [1/2]

void Aws::Lightsail::Model::GetInstanceMetricDataRequest::SetMetricName ( const InstanceMetricName value)
inline

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 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 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.

Definition at line 291 of file GetInstanceMetricDataRequest.h.

◆ SetMetricName() [2/2]

void Aws::Lightsail::Model::GetInstanceMetricDataRequest::SetMetricName ( InstanceMetricName &&  value)
inline

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 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 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.

Definition at line 361 of file GetInstanceMetricDataRequest.h.

◆ SetPeriod()

void Aws::Lightsail::Model::GetInstanceMetricDataRequest::SetPeriod ( int  value)
inline

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.

Definition at line 529 of file GetInstanceMetricDataRequest.h.

◆ SetStartTime() [1/2]

void Aws::Lightsail::Model::GetInstanceMetricDataRequest::SetStartTime ( const Aws::Utils::DateTime value)
inline

The start time of the time period.

Definition at line 554 of file GetInstanceMetricDataRequest.h.

◆ SetStartTime() [2/2]

void Aws::Lightsail::Model::GetInstanceMetricDataRequest::SetStartTime ( Aws::Utils::DateTime &&  value)
inline

The start time of the time period.

Definition at line 559 of file GetInstanceMetricDataRequest.h.

◆ SetStatistics() [1/2]

void Aws::Lightsail::Model::GetInstanceMetricDataRequest::SetStatistics ( const Aws::Vector< MetricStatistic > &  value)
inline

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.

Definition at line 701 of file GetInstanceMetricDataRequest.h.

◆ SetStatistics() [2/2]

void Aws::Lightsail::Model::GetInstanceMetricDataRequest::SetStatistics ( Aws::Vector< MetricStatistic > &&  value)
inline

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.

Definition at line 720 of file GetInstanceMetricDataRequest.h.

◆ SetUnit() [1/2]

void Aws::Lightsail::Model::GetInstanceMetricDataRequest::SetUnit ( const MetricUnit value)
inline

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.

Definition at line 622 of file GetInstanceMetricDataRequest.h.

◆ SetUnit() [2/2]

void Aws::Lightsail::Model::GetInstanceMetricDataRequest::SetUnit ( MetricUnit &&  value)
inline

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.

Definition at line 629 of file GetInstanceMetricDataRequest.h.

◆ StartTimeHasBeenSet()

bool Aws::Lightsail::Model::GetInstanceMetricDataRequest::StartTimeHasBeenSet ( ) const
inline

The start time of the time period.

Definition at line 549 of file GetInstanceMetricDataRequest.h.

◆ StatisticsHasBeenSet()

bool Aws::Lightsail::Model::GetInstanceMetricDataRequest::StatisticsHasBeenSet ( ) const
inline

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.

Definition at line 682 of file GetInstanceMetricDataRequest.h.

◆ UnitHasBeenSet()

bool Aws::Lightsail::Model::GetInstanceMetricDataRequest::UnitHasBeenSet ( ) const
inline

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.

Definition at line 615 of file GetInstanceMetricDataRequest.h.

◆ WithEndTime() [1/2]

GetInstanceMetricDataRequest& Aws::Lightsail::Model::GetInstanceMetricDataRequest::WithEndTime ( const Aws::Utils::DateTime value)
inline

The end time of the time period.

Definition at line 595 of file GetInstanceMetricDataRequest.h.

◆ WithEndTime() [2/2]

GetInstanceMetricDataRequest& Aws::Lightsail::Model::GetInstanceMetricDataRequest::WithEndTime ( Aws::Utils::DateTime &&  value)
inline

The end time of the time period.

Definition at line 600 of file GetInstanceMetricDataRequest.h.

◆ WithInstanceName() [1/3]

GetInstanceMetricDataRequest& Aws::Lightsail::Model::GetInstanceMetricDataRequest::WithInstanceName ( const Aws::String value)
inline

The name of the instance for which you want to get metrics data.

Definition at line 70 of file GetInstanceMetricDataRequest.h.

◆ WithInstanceName() [2/3]

GetInstanceMetricDataRequest& Aws::Lightsail::Model::GetInstanceMetricDataRequest::WithInstanceName ( Aws::String &&  value)
inline

The name of the instance for which you want to get metrics data.

Definition at line 75 of file GetInstanceMetricDataRequest.h.

◆ WithInstanceName() [3/3]

GetInstanceMetricDataRequest& Aws::Lightsail::Model::GetInstanceMetricDataRequest::WithInstanceName ( const char *  value)
inline

The name of the instance for which you want to get metrics data.

Definition at line 80 of file GetInstanceMetricDataRequest.h.

◆ WithMetricName() [1/2]

GetInstanceMetricDataRequest& Aws::Lightsail::Model::GetInstanceMetricDataRequest::WithMetricName ( const InstanceMetricName value)
inline

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 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 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.

Definition at line 431 of file GetInstanceMetricDataRequest.h.

◆ WithMetricName() [2/2]

GetInstanceMetricDataRequest& Aws::Lightsail::Model::GetInstanceMetricDataRequest::WithMetricName ( InstanceMetricName &&  value)
inline

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 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 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.

Definition at line 501 of file GetInstanceMetricDataRequest.h.

◆ WithPeriod()

GetInstanceMetricDataRequest& Aws::Lightsail::Model::GetInstanceMetricDataRequest::WithPeriod ( int  value)
inline

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.

Definition at line 538 of file GetInstanceMetricDataRequest.h.

◆ WithStartTime() [1/2]

GetInstanceMetricDataRequest& Aws::Lightsail::Model::GetInstanceMetricDataRequest::WithStartTime ( const Aws::Utils::DateTime value)
inline

The start time of the time period.

Definition at line 564 of file GetInstanceMetricDataRequest.h.

◆ WithStartTime() [2/2]

GetInstanceMetricDataRequest& Aws::Lightsail::Model::GetInstanceMetricDataRequest::WithStartTime ( Aws::Utils::DateTime &&  value)
inline

The start time of the time period.

Definition at line 569 of file GetInstanceMetricDataRequest.h.

◆ WithStatistics() [1/2]

GetInstanceMetricDataRequest& Aws::Lightsail::Model::GetInstanceMetricDataRequest::WithStatistics ( const Aws::Vector< MetricStatistic > &  value)
inline

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.

Definition at line 739 of file GetInstanceMetricDataRequest.h.

◆ WithStatistics() [2/2]

GetInstanceMetricDataRequest& Aws::Lightsail::Model::GetInstanceMetricDataRequest::WithStatistics ( Aws::Vector< MetricStatistic > &&  value)
inline

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.

Definition at line 758 of file GetInstanceMetricDataRequest.h.

◆ WithUnit() [1/2]

GetInstanceMetricDataRequest& Aws::Lightsail::Model::GetInstanceMetricDataRequest::WithUnit ( const MetricUnit value)
inline

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.

Definition at line 636 of file GetInstanceMetricDataRequest.h.

◆ WithUnit() [2/2]

GetInstanceMetricDataRequest& Aws::Lightsail::Model::GetInstanceMetricDataRequest::WithUnit ( MetricUnit &&  value)
inline

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.

Definition at line 643 of file GetInstanceMetricDataRequest.h.


The documentation for this class was generated from the following file: