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

#include <GetDistributionMetricDataRequest.h>

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

Public Member Functions

 GetDistributionMetricDataRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetDistributionName () const
 
bool DistributionNameHasBeenSet () const
 
void SetDistributionName (const Aws::String &value)
 
void SetDistributionName (Aws::String &&value)
 
void SetDistributionName (const char *value)
 
GetDistributionMetricDataRequestWithDistributionName (const Aws::String &value)
 
GetDistributionMetricDataRequestWithDistributionName (Aws::String &&value)
 
GetDistributionMetricDataRequestWithDistributionName (const char *value)
 
const DistributionMetricNameGetMetricName () const
 
bool MetricNameHasBeenSet () const
 
void SetMetricName (const DistributionMetricName &value)
 
void SetMetricName (DistributionMetricName &&value)
 
GetDistributionMetricDataRequestWithMetricName (const DistributionMetricName &value)
 
GetDistributionMetricDataRequestWithMetricName (DistributionMetricName &&value)
 
const Aws::Utils::DateTimeGetStartTime () const
 
bool StartTimeHasBeenSet () const
 
void SetStartTime (const Aws::Utils::DateTime &value)
 
void SetStartTime (Aws::Utils::DateTime &&value)
 
GetDistributionMetricDataRequestWithStartTime (const Aws::Utils::DateTime &value)
 
GetDistributionMetricDataRequestWithStartTime (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)
 
GetDistributionMetricDataRequestWithEndTime (const Aws::Utils::DateTime &value)
 
GetDistributionMetricDataRequestWithEndTime (Aws::Utils::DateTime &&value)
 
int GetPeriod () const
 
bool PeriodHasBeenSet () const
 
void SetPeriod (int value)
 
GetDistributionMetricDataRequestWithPeriod (int value)
 
const MetricUnitGetUnit () const
 
bool UnitHasBeenSet () const
 
void SetUnit (const MetricUnit &value)
 
void SetUnit (MetricUnit &&value)
 
GetDistributionMetricDataRequestWithUnit (const MetricUnit &value)
 
GetDistributionMetricDataRequestWithUnit (MetricUnit &&value)
 
const Aws::Vector< MetricStatistic > & GetStatistics () const
 
bool StatisticsHasBeenSet () const
 
void SetStatistics (const Aws::Vector< MetricStatistic > &value)
 
void SetStatistics (Aws::Vector< MetricStatistic > &&value)
 
GetDistributionMetricDataRequestWithStatistics (const Aws::Vector< MetricStatistic > &value)
 
GetDistributionMetricDataRequestWithStatistics (Aws::Vector< MetricStatistic > &&value)
 
GetDistributionMetricDataRequestAddStatistics (const MetricStatistic &value)
 
GetDistributionMetricDataRequestAddStatistics (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 GetDistributionMetricDataRequest.h.

Constructor & Destructor Documentation

◆ GetDistributionMetricDataRequest()

Aws::Lightsail::Model::GetDistributionMetricDataRequest::GetDistributionMetricDataRequest ( )

Member Function Documentation

◆ AddStatistics() [1/2]

GetDistributionMetricDataRequest& Aws::Lightsail::Model::GetDistributionMetricDataRequest::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 655 of file GetDistributionMetricDataRequest.h.

◆ AddStatistics() [2/2]

GetDistributionMetricDataRequest& Aws::Lightsail::Model::GetDistributionMetricDataRequest::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 674 of file GetDistributionMetricDataRequest.h.

◆ DistributionNameHasBeenSet()

bool Aws::Lightsail::Model::GetDistributionMetricDataRequest::DistributionNameHasBeenSet ( ) const
inline

The name of the distribution for which to get metric data.

Use the GetDistributions action to get a list of distribution names that you can specify.

Definition at line 54 of file GetDistributionMetricDataRequest.h.

◆ EndTimeHasBeenSet()

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

The end of the time interval for which to get metric data.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

Definition at line 409 of file GetDistributionMetricDataRequest.h.

◆ GetDistributionName()

const Aws::String& Aws::Lightsail::Model::GetDistributionMetricDataRequest::GetDistributionName ( ) const
inline

The name of the distribution for which to get metric data.

Use the GetDistributions action to get a list of distribution names that you can specify.

Definition at line 47 of file GetDistributionMetricDataRequest.h.

◆ GetEndTime()

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

The end of the time interval for which to get metric data.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

Definition at line 398 of file GetDistributionMetricDataRequest.h.

◆ GetMetricName()

const DistributionMetricName& Aws::Lightsail::Model::GetDistributionMetricDataRequest::GetMetricName ( ) const
inline

The metric for which you want to return information.

Valid distribution metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

  • Requests - The total number of viewer requests received by your Lightsail distribution, for all HTTP methods, and for both HTTP and HTTPS requests.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is None.

  • BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS requests.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is None.

  • BytesUploaded - The number of bytes uploaded to your origin by your Lightsail distribution, using POST and PUT requests.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is None.

  • TotalErrorRate - The percentage of all viewer requests for which the response's HTTP status code was 4xx or 5xx.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Percent.

  • 4xxErrorRate - The percentage of all viewer requests for which the response's HTTP status cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a status code of 404 (Not Found) means that the client requested an object that could not be found.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Percent.

  • 5xxErrorRate - The percentage of all viewer requests for which the response's HTTP status code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status code of 503 (Service Unavailable) means that the origin server is currently unavailable.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Percent.

Definition at line 134 of file GetDistributionMetricDataRequest.h.

◆ GetPeriod()

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

The granularity, in seconds, for the metric data points that will be returned.

Definition at line 460 of file GetDistributionMetricDataRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::Lightsail::LightsailRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file GetDistributionMetricDataRequest.h.

◆ GetStartTime()

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

The start of the time interval for which to get metric data.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

Definition at line 331 of file GetDistributionMetricDataRequest.h.

◆ GetStatistics()

const Aws::Vector<MetricStatistic>& Aws::Lightsail::Model::GetDistributionMetricDataRequest::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 541 of file GetDistributionMetricDataRequest.h.

◆ GetUnit()

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

The unit for the metric data request.

Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

Definition at line 486 of file GetDistributionMetricDataRequest.h.

◆ MetricNameHasBeenSet()

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

The metric for which you want to return information.

Valid distribution metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

  • Requests - The total number of viewer requests received by your Lightsail distribution, for all HTTP methods, and for both HTTP and HTTPS requests.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is None.

  • BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS requests.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is None.

  • BytesUploaded - The number of bytes uploaded to your origin by your Lightsail distribution, using POST and PUT requests.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is None.

  • TotalErrorRate - The percentage of all viewer requests for which the response's HTTP status code was 4xx or 5xx.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Percent.

  • 4xxErrorRate - The percentage of all viewer requests for which the response's HTTP status cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a status code of 404 (Not Found) means that the client requested an object that could not be found.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Percent.

  • 5xxErrorRate - The percentage of all viewer requests for which the response's HTTP status code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status code of 503 (Service Unavailable) means that the origin server is currently unavailable.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Percent.

Definition at line 171 of file GetDistributionMetricDataRequest.h.

◆ PeriodHasBeenSet()

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

The granularity, in seconds, for the metric data points that will be returned.

Definition at line 466 of file GetDistributionMetricDataRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDistributionName() [1/3]

void Aws::Lightsail::Model::GetDistributionMetricDataRequest::SetDistributionName ( const Aws::String value)
inline

The name of the distribution for which to get metric data.

Use the GetDistributions action to get a list of distribution names that you can specify.

Definition at line 61 of file GetDistributionMetricDataRequest.h.

◆ SetDistributionName() [2/3]

void Aws::Lightsail::Model::GetDistributionMetricDataRequest::SetDistributionName ( Aws::String &&  value)
inline

The name of the distribution for which to get metric data.

Use the GetDistributions action to get a list of distribution names that you can specify.

Definition at line 68 of file GetDistributionMetricDataRequest.h.

◆ SetDistributionName() [3/3]

void Aws::Lightsail::Model::GetDistributionMetricDataRequest::SetDistributionName ( const char *  value)
inline

The name of the distribution for which to get metric data.

Use the GetDistributions action to get a list of distribution names that you can specify.

Definition at line 75 of file GetDistributionMetricDataRequest.h.

◆ SetEndTime() [1/2]

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

The end of the time interval for which to get metric data.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

Definition at line 420 of file GetDistributionMetricDataRequest.h.

◆ SetEndTime() [2/2]

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

The end of the time interval for which to get metric data.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

Definition at line 431 of file GetDistributionMetricDataRequest.h.

◆ SetMetricName() [1/2]

void Aws::Lightsail::Model::GetDistributionMetricDataRequest::SetMetricName ( const DistributionMetricName value)
inline

The metric for which you want to return information.

Valid distribution metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

  • Requests - The total number of viewer requests received by your Lightsail distribution, for all HTTP methods, and for both HTTP and HTTPS requests.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is None.

  • BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS requests.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is None.

  • BytesUploaded - The number of bytes uploaded to your origin by your Lightsail distribution, using POST and PUT requests.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is None.

  • TotalErrorRate - The percentage of all viewer requests for which the response's HTTP status code was 4xx or 5xx.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Percent.

  • 4xxErrorRate - The percentage of all viewer requests for which the response's HTTP status cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a status code of 404 (Not Found) means that the client requested an object that could not be found.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Percent.

  • 5xxErrorRate - The percentage of all viewer requests for which the response's HTTP status code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status code of 503 (Service Unavailable) means that the origin server is currently unavailable.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Percent.

Definition at line 208 of file GetDistributionMetricDataRequest.h.

◆ SetMetricName() [2/2]

void Aws::Lightsail::Model::GetDistributionMetricDataRequest::SetMetricName ( DistributionMetricName &&  value)
inline

The metric for which you want to return information.

Valid distribution metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

  • Requests - The total number of viewer requests received by your Lightsail distribution, for all HTTP methods, and for both HTTP and HTTPS requests.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is None.

  • BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS requests.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is None.

  • BytesUploaded - The number of bytes uploaded to your origin by your Lightsail distribution, using POST and PUT requests.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is None.

  • TotalErrorRate - The percentage of all viewer requests for which the response's HTTP status code was 4xx or 5xx.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Percent.

  • 4xxErrorRate - The percentage of all viewer requests for which the response's HTTP status cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a status code of 404 (Not Found) means that the client requested an object that could not be found.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Percent.

  • 5xxErrorRate - The percentage of all viewer requests for which the response's HTTP status code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status code of 503 (Service Unavailable) means that the origin server is currently unavailable.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Percent.

Definition at line 245 of file GetDistributionMetricDataRequest.h.

◆ SetPeriod()

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

The granularity, in seconds, for the metric data points that will be returned.

Definition at line 472 of file GetDistributionMetricDataRequest.h.

◆ SetStartTime() [1/2]

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

The start of the time interval for which to get metric data.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

Definition at line 353 of file GetDistributionMetricDataRequest.h.

◆ SetStartTime() [2/2]

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

The start of the time interval for which to get metric data.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

Definition at line 364 of file GetDistributionMetricDataRequest.h.

◆ SetStatistics() [1/2]

void Aws::Lightsail::Model::GetDistributionMetricDataRequest::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 579 of file GetDistributionMetricDataRequest.h.

◆ SetStatistics() [2/2]

void Aws::Lightsail::Model::GetDistributionMetricDataRequest::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 598 of file GetDistributionMetricDataRequest.h.

◆ SetUnit() [1/2]

void Aws::Lightsail::Model::GetDistributionMetricDataRequest::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 with each available metric, see the metricName parameter.

Definition at line 500 of file GetDistributionMetricDataRequest.h.

◆ SetUnit() [2/2]

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

The unit for the metric data request.

Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

Definition at line 507 of file GetDistributionMetricDataRequest.h.

◆ StartTimeHasBeenSet()

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

The start of the time interval for which to get metric data.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

Definition at line 342 of file GetDistributionMetricDataRequest.h.

◆ StatisticsHasBeenSet()

bool Aws::Lightsail::Model::GetDistributionMetricDataRequest::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 560 of file GetDistributionMetricDataRequest.h.

◆ UnitHasBeenSet()

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

The unit for the metric data request.

Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

Definition at line 493 of file GetDistributionMetricDataRequest.h.

◆ WithDistributionName() [1/3]

GetDistributionMetricDataRequest& Aws::Lightsail::Model::GetDistributionMetricDataRequest::WithDistributionName ( const Aws::String value)
inline

The name of the distribution for which to get metric data.

Use the GetDistributions action to get a list of distribution names that you can specify.

Definition at line 82 of file GetDistributionMetricDataRequest.h.

◆ WithDistributionName() [2/3]

GetDistributionMetricDataRequest& Aws::Lightsail::Model::GetDistributionMetricDataRequest::WithDistributionName ( Aws::String &&  value)
inline

The name of the distribution for which to get metric data.

Use the GetDistributions action to get a list of distribution names that you can specify.

Definition at line 89 of file GetDistributionMetricDataRequest.h.

◆ WithDistributionName() [3/3]

GetDistributionMetricDataRequest& Aws::Lightsail::Model::GetDistributionMetricDataRequest::WithDistributionName ( const char *  value)
inline

The name of the distribution for which to get metric data.

Use the GetDistributions action to get a list of distribution names that you can specify.

Definition at line 96 of file GetDistributionMetricDataRequest.h.

◆ WithEndTime() [1/2]

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

The end of the time interval for which to get metric data.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

Definition at line 442 of file GetDistributionMetricDataRequest.h.

◆ WithEndTime() [2/2]

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

The end of the time interval for which to get metric data.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

Definition at line 453 of file GetDistributionMetricDataRequest.h.

◆ WithMetricName() [1/2]

GetDistributionMetricDataRequest& Aws::Lightsail::Model::GetDistributionMetricDataRequest::WithMetricName ( const DistributionMetricName value)
inline

The metric for which you want to return information.

Valid distribution metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

  • Requests - The total number of viewer requests received by your Lightsail distribution, for all HTTP methods, and for both HTTP and HTTPS requests.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is None.

  • BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS requests.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is None.

  • BytesUploaded - The number of bytes uploaded to your origin by your Lightsail distribution, using POST and PUT requests.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is None.

  • TotalErrorRate - The percentage of all viewer requests for which the response's HTTP status code was 4xx or 5xx.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Percent.

  • 4xxErrorRate - The percentage of all viewer requests for which the response's HTTP status cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a status code of 404 (Not Found) means that the client requested an object that could not be found.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Percent.

  • 5xxErrorRate - The percentage of all viewer requests for which the response's HTTP status code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status code of 503 (Service Unavailable) means that the origin server is currently unavailable.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Percent.

Definition at line 282 of file GetDistributionMetricDataRequest.h.

◆ WithMetricName() [2/2]

GetDistributionMetricDataRequest& Aws::Lightsail::Model::GetDistributionMetricDataRequest::WithMetricName ( DistributionMetricName &&  value)
inline

The metric for which you want to return information.

Valid distribution metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

  • Requests - The total number of viewer requests received by your Lightsail distribution, for all HTTP methods, and for both HTTP and HTTPS requests.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is None.

  • BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS requests.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is None.

  • BytesUploaded - The number of bytes uploaded to your origin by your Lightsail distribution, using POST and PUT requests.

    Statistics: The most useful statistic is Sum.

    Unit: The published unit is None.

  • TotalErrorRate - The percentage of all viewer requests for which the response's HTTP status code was 4xx or 5xx.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Percent.

  • 4xxErrorRate - The percentage of all viewer requests for which the response's HTTP status cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a status code of 404 (Not Found) means that the client requested an object that could not be found.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Percent.

  • 5xxErrorRate - The percentage of all viewer requests for which the response's HTTP status code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status code of 503 (Service Unavailable) means that the origin server is currently unavailable.

    Statistics: The most useful statistic is Average.

    Unit: The published unit is Percent.

Definition at line 319 of file GetDistributionMetricDataRequest.h.

◆ WithPeriod()

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

The granularity, in seconds, for the metric data points that will be returned.

Definition at line 478 of file GetDistributionMetricDataRequest.h.

◆ WithStartTime() [1/2]

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

The start of the time interval for which to get metric data.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

Definition at line 375 of file GetDistributionMetricDataRequest.h.

◆ WithStartTime() [2/2]

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

The start of the time interval for which to get metric data.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.

Definition at line 386 of file GetDistributionMetricDataRequest.h.

◆ WithStatistics() [1/2]

GetDistributionMetricDataRequest& Aws::Lightsail::Model::GetDistributionMetricDataRequest::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 617 of file GetDistributionMetricDataRequest.h.

◆ WithStatistics() [2/2]

GetDistributionMetricDataRequest& Aws::Lightsail::Model::GetDistributionMetricDataRequest::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 636 of file GetDistributionMetricDataRequest.h.

◆ WithUnit() [1/2]

GetDistributionMetricDataRequest& Aws::Lightsail::Model::GetDistributionMetricDataRequest::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 with each available metric, see the metricName parameter.

Definition at line 514 of file GetDistributionMetricDataRequest.h.

◆ WithUnit() [2/2]

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

The unit for the metric data request.

Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

Definition at line 521 of file GetDistributionMetricDataRequest.h.


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