AWS SDK for C++  1.9.16
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::CloudWatch::Model::GetMetricStatisticsRequest Class Reference

#include <GetMetricStatisticsRequest.h>

+ Inheritance diagram for Aws::CloudWatch::Model::GetMetricStatisticsRequest:

Public Member Functions

 GetMetricStatisticsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetNamespace () const
 
bool NamespaceHasBeenSet () const
 
void SetNamespace (const Aws::String &value)
 
void SetNamespace (Aws::String &&value)
 
void SetNamespace (const char *value)
 
GetMetricStatisticsRequestWithNamespace (const Aws::String &value)
 
GetMetricStatisticsRequestWithNamespace (Aws::String &&value)
 
GetMetricStatisticsRequestWithNamespace (const char *value)
 
const Aws::StringGetMetricName () const
 
bool MetricNameHasBeenSet () const
 
void SetMetricName (const Aws::String &value)
 
void SetMetricName (Aws::String &&value)
 
void SetMetricName (const char *value)
 
GetMetricStatisticsRequestWithMetricName (const Aws::String &value)
 
GetMetricStatisticsRequestWithMetricName (Aws::String &&value)
 
GetMetricStatisticsRequestWithMetricName (const char *value)
 
const Aws::Vector< Dimension > & GetDimensions () const
 
bool DimensionsHasBeenSet () const
 
void SetDimensions (const Aws::Vector< Dimension > &value)
 
void SetDimensions (Aws::Vector< Dimension > &&value)
 
GetMetricStatisticsRequestWithDimensions (const Aws::Vector< Dimension > &value)
 
GetMetricStatisticsRequestWithDimensions (Aws::Vector< Dimension > &&value)
 
GetMetricStatisticsRequestAddDimensions (const Dimension &value)
 
GetMetricStatisticsRequestAddDimensions (Dimension &&value)
 
const Aws::Utils::DateTimeGetStartTime () const
 
bool StartTimeHasBeenSet () const
 
void SetStartTime (const Aws::Utils::DateTime &value)
 
void SetStartTime (Aws::Utils::DateTime &&value)
 
GetMetricStatisticsRequestWithStartTime (const Aws::Utils::DateTime &value)
 
GetMetricStatisticsRequestWithStartTime (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)
 
GetMetricStatisticsRequestWithEndTime (const Aws::Utils::DateTime &value)
 
GetMetricStatisticsRequestWithEndTime (Aws::Utils::DateTime &&value)
 
int GetPeriod () const
 
bool PeriodHasBeenSet () const
 
void SetPeriod (int value)
 
GetMetricStatisticsRequestWithPeriod (int value)
 
const Aws::Vector< Statistic > & GetStatistics () const
 
bool StatisticsHasBeenSet () const
 
void SetStatistics (const Aws::Vector< Statistic > &value)
 
void SetStatistics (Aws::Vector< Statistic > &&value)
 
GetMetricStatisticsRequestWithStatistics (const Aws::Vector< Statistic > &value)
 
GetMetricStatisticsRequestWithStatistics (Aws::Vector< Statistic > &&value)
 
GetMetricStatisticsRequestAddStatistics (const Statistic &value)
 
GetMetricStatisticsRequestAddStatistics (Statistic &&value)
 
const Aws::Vector< Aws::String > & GetExtendedStatistics () const
 
bool ExtendedStatisticsHasBeenSet () const
 
void SetExtendedStatistics (const Aws::Vector< Aws::String > &value)
 
void SetExtendedStatistics (Aws::Vector< Aws::String > &&value)
 
GetMetricStatisticsRequestWithExtendedStatistics (const Aws::Vector< Aws::String > &value)
 
GetMetricStatisticsRequestWithExtendedStatistics (Aws::Vector< Aws::String > &&value)
 
GetMetricStatisticsRequestAddExtendedStatistics (const Aws::String &value)
 
GetMetricStatisticsRequestAddExtendedStatistics (Aws::String &&value)
 
GetMetricStatisticsRequestAddExtendedStatistics (const char *value)
 
const StandardUnitGetUnit () const
 
bool UnitHasBeenSet () const
 
void SetUnit (const StandardUnit &value)
 
void SetUnit (StandardUnit &&value)
 
GetMetricStatisticsRequestWithUnit (const StandardUnit &value)
 
GetMetricStatisticsRequestWithUnit (StandardUnit &&value)
 
- Public Member Functions inherited from Aws::CloudWatch::CloudWatchRequest
virtual ~CloudWatchRequest ()
 
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
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::CloudWatch::CloudWatchRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Definition at line 26 of file GetMetricStatisticsRequest.h.

Constructor & Destructor Documentation

◆ GetMetricStatisticsRequest()

Aws::CloudWatch::Model::GetMetricStatisticsRequest::GetMetricStatisticsRequest ( )

Member Function Documentation

◆ AddDimensions() [1/2]

GetMetricStatisticsRequest& Aws::CloudWatch::Model::GetMetricStatisticsRequest::AddDimensions ( const Dimension value)
inline

The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. If a specific combination of dimensions was not published, you can't retrieve statistics for it. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

Definition at line 222 of file GetMetricStatisticsRequest.h.

◆ AddDimensions() [2/2]

GetMetricStatisticsRequest& Aws::CloudWatch::Model::GetMetricStatisticsRequest::AddDimensions ( Dimension &&  value)
inline

The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. If a specific combination of dimensions was not published, you can't retrieve statistics for it. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

Definition at line 236 of file GetMetricStatisticsRequest.h.

◆ AddExtendedStatistics() [1/3]

GetMetricStatisticsRequest& Aws::CloudWatch::Model::GetMetricStatisticsRequest::AddExtendedStatistics ( Aws::String &&  value)
inline

The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both. Percentile statistics are not available for metrics when any of the metric values are negative numbers.

Definition at line 631 of file GetMetricStatisticsRequest.h.

◆ AddExtendedStatistics() [2/3]

GetMetricStatisticsRequest& Aws::CloudWatch::Model::GetMetricStatisticsRequest::AddExtendedStatistics ( const Aws::String value)
inline

The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both. Percentile statistics are not available for metrics when any of the metric values are negative numbers.

Definition at line 622 of file GetMetricStatisticsRequest.h.

◆ AddExtendedStatistics() [3/3]

GetMetricStatisticsRequest& Aws::CloudWatch::Model::GetMetricStatisticsRequest::AddExtendedStatistics ( const char *  value)
inline

The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both. Percentile statistics are not available for metrics when any of the metric values are negative numbers.

Definition at line 640 of file GetMetricStatisticsRequest.h.

◆ AddStatistics() [1/2]

GetMetricStatisticsRequest& Aws::CloudWatch::Model::GetMetricStatisticsRequest::AddStatistics ( const Statistic value)
inline

The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both.

Definition at line 550 of file GetMetricStatisticsRequest.h.

◆ AddStatistics() [2/2]

GetMetricStatisticsRequest& Aws::CloudWatch::Model::GetMetricStatisticsRequest::AddStatistics ( Statistic &&  value)
inline

The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both.

Definition at line 558 of file GetMetricStatisticsRequest.h.

◆ DimensionsHasBeenSet()

bool Aws::CloudWatch::Model::GetMetricStatisticsRequest::DimensionsHasBeenSet ( ) const
inline

The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. If a specific combination of dimensions was not published, you can't retrieve statistics for it. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

Definition at line 152 of file GetMetricStatisticsRequest.h.

◆ DumpBodyToUrl()

void Aws::CloudWatch::Model::GetMetricStatisticsRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ EndTimeHasBeenSet()

bool Aws::CloudWatch::Model::GetMetricStatisticsRequest::EndTimeHasBeenSet ( ) const
inline

The time stamp that determines the last data point to return.

The value specified is exclusive; results include data points up to the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).

Definition at line 392 of file GetMetricStatisticsRequest.h.

◆ ExtendedStatisticsHasBeenSet()

bool Aws::CloudWatch::Model::GetMetricStatisticsRequest::ExtendedStatisticsHasBeenSet ( ) const
inline

The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both. Percentile statistics are not available for metrics when any of the metric values are negative numbers.

Definition at line 577 of file GetMetricStatisticsRequest.h.

◆ GetDimensions()

const Aws::Vector<Dimension>& Aws::CloudWatch::Model::GetMetricStatisticsRequest::GetDimensions ( ) const
inline

The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. If a specific combination of dimensions was not published, you can't retrieve statistics for it. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

Definition at line 138 of file GetMetricStatisticsRequest.h.

◆ GetEndTime()

const Aws::Utils::DateTime& Aws::CloudWatch::Model::GetMetricStatisticsRequest::GetEndTime ( ) const
inline

The time stamp that determines the last data point to return.

The value specified is exclusive; results include data points up to the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).

Definition at line 384 of file GetMetricStatisticsRequest.h.

◆ GetExtendedStatistics()

const Aws::Vector<Aws::String>& Aws::CloudWatch::Model::GetMetricStatisticsRequest::GetExtendedStatistics ( ) const
inline

The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both. Percentile statistics are not available for metrics when any of the metric values are negative numbers.

Definition at line 568 of file GetMetricStatisticsRequest.h.

◆ GetMetricName()

const Aws::String& Aws::CloudWatch::Model::GetMetricStatisticsRequest::GetMetricName ( ) const
inline

The name of the metric, with or without spaces.

Definition at line 88 of file GetMetricStatisticsRequest.h.

◆ GetNamespace()

const Aws::String& Aws::CloudWatch::Model::GetMetricStatisticsRequest::GetNamespace ( ) const
inline

The namespace of the metric, with or without spaces.

Definition at line 47 of file GetMetricStatisticsRequest.h.

◆ GetPeriod()

int Aws::CloudWatch::Model::GetMetricStatisticsRequest::GetPeriod ( ) const
inline

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of

  1. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

  • Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

  • Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

  • Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

Definition at line 442 of file GetMetricStatisticsRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::CloudWatch::Model::GetMetricStatisticsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file GetMetricStatisticsRequest.h.

◆ GetStartTime()

const Aws::Utils::DateTime& Aws::CloudWatch::Model::GetMetricStatisticsRequest::GetStartTime ( ) const
inline

The time stamp that determines the first data point to return. Start times are evaluated relative to the time that CloudWatch receives the request.

The value specified is inclusive; results include data points with the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).

CloudWatch rounds the specified time stamp as follows:

  • Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.

  • Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.

  • Start time greater than 63 days ago

    • Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.

If you set Period to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.

Definition at line 260 of file GetMetricStatisticsRequest.h.

◆ GetStatistics()

const Aws::Vector<Statistic>& Aws::CloudWatch::Model::GetMetricStatisticsRequest::GetStatistics ( ) const
inline

The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both.

Definition at line 502 of file GetMetricStatisticsRequest.h.

◆ GetUnit()

const StandardUnit& Aws::CloudWatch::Model::GetMetricStatisticsRequest::GetUnit ( ) const
inline

The unit for a given metric. If you omit Unit, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

Definition at line 651 of file GetMetricStatisticsRequest.h.

◆ MetricNameHasBeenSet()

bool Aws::CloudWatch::Model::GetMetricStatisticsRequest::MetricNameHasBeenSet ( ) const
inline

The name of the metric, with or without spaces.

Definition at line 93 of file GetMetricStatisticsRequest.h.

◆ NamespaceHasBeenSet()

bool Aws::CloudWatch::Model::GetMetricStatisticsRequest::NamespaceHasBeenSet ( ) const
inline

The namespace of the metric, with or without spaces.

Definition at line 52 of file GetMetricStatisticsRequest.h.

◆ PeriodHasBeenSet()

bool Aws::CloudWatch::Model::GetMetricStatisticsRequest::PeriodHasBeenSet ( ) const
inline

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of

  1. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

  • Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

  • Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

  • Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

Definition at line 459 of file GetMetricStatisticsRequest.h.

◆ SerializePayload()

Aws::String Aws::CloudWatch::Model::GetMetricStatisticsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDimensions() [1/2]

void Aws::CloudWatch::Model::GetMetricStatisticsRequest::SetDimensions ( Aws::Vector< Dimension > &&  value)
inline

The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. If a specific combination of dimensions was not published, you can't retrieve statistics for it. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

Definition at line 180 of file GetMetricStatisticsRequest.h.

◆ SetDimensions() [2/2]

void Aws::CloudWatch::Model::GetMetricStatisticsRequest::SetDimensions ( const Aws::Vector< Dimension > &  value)
inline

The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. If a specific combination of dimensions was not published, you can't retrieve statistics for it. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

Definition at line 166 of file GetMetricStatisticsRequest.h.

◆ SetEndTime() [1/2]

void Aws::CloudWatch::Model::GetMetricStatisticsRequest::SetEndTime ( Aws::Utils::DateTime &&  value)
inline

The time stamp that determines the last data point to return.

The value specified is exclusive; results include data points up to the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).

Definition at line 408 of file GetMetricStatisticsRequest.h.

◆ SetEndTime() [2/2]

void Aws::CloudWatch::Model::GetMetricStatisticsRequest::SetEndTime ( const Aws::Utils::DateTime value)
inline

The time stamp that determines the last data point to return.

The value specified is exclusive; results include data points up to the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).

Definition at line 400 of file GetMetricStatisticsRequest.h.

◆ SetExtendedStatistics() [1/2]

void Aws::CloudWatch::Model::GetMetricStatisticsRequest::SetExtendedStatistics ( Aws::Vector< Aws::String > &&  value)
inline

The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both. Percentile statistics are not available for metrics when any of the metric values are negative numbers.

Definition at line 595 of file GetMetricStatisticsRequest.h.

◆ SetExtendedStatistics() [2/2]

void Aws::CloudWatch::Model::GetMetricStatisticsRequest::SetExtendedStatistics ( const Aws::Vector< Aws::String > &  value)
inline

The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both. Percentile statistics are not available for metrics when any of the metric values are negative numbers.

Definition at line 586 of file GetMetricStatisticsRequest.h.

◆ SetMetricName() [1/3]

void Aws::CloudWatch::Model::GetMetricStatisticsRequest::SetMetricName ( Aws::String &&  value)
inline

The name of the metric, with or without spaces.

Definition at line 103 of file GetMetricStatisticsRequest.h.

◆ SetMetricName() [2/3]

void Aws::CloudWatch::Model::GetMetricStatisticsRequest::SetMetricName ( const Aws::String value)
inline

The name of the metric, with or without spaces.

Definition at line 98 of file GetMetricStatisticsRequest.h.

◆ SetMetricName() [3/3]

void Aws::CloudWatch::Model::GetMetricStatisticsRequest::SetMetricName ( const char *  value)
inline

The name of the metric, with or without spaces.

Definition at line 108 of file GetMetricStatisticsRequest.h.

◆ SetNamespace() [1/3]

void Aws::CloudWatch::Model::GetMetricStatisticsRequest::SetNamespace ( Aws::String &&  value)
inline

The namespace of the metric, with or without spaces.

Definition at line 62 of file GetMetricStatisticsRequest.h.

◆ SetNamespace() [2/3]

void Aws::CloudWatch::Model::GetMetricStatisticsRequest::SetNamespace ( const Aws::String value)
inline

The namespace of the metric, with or without spaces.

Definition at line 57 of file GetMetricStatisticsRequest.h.

◆ SetNamespace() [3/3]

void Aws::CloudWatch::Model::GetMetricStatisticsRequest::SetNamespace ( const char *  value)
inline

The namespace of the metric, with or without spaces.

Definition at line 67 of file GetMetricStatisticsRequest.h.

◆ SetPeriod()

void Aws::CloudWatch::Model::GetMetricStatisticsRequest::SetPeriod ( int  value)
inline

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of

  1. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

  • Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

  • Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

  • Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

Definition at line 476 of file GetMetricStatisticsRequest.h.

◆ SetStartTime() [1/2]

void Aws::CloudWatch::Model::GetMetricStatisticsRequest::SetStartTime ( Aws::Utils::DateTime &&  value)
inline

The time stamp that determines the first data point to return. Start times are evaluated relative to the time that CloudWatch receives the request.

The value specified is inclusive; results include data points with the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).

CloudWatch rounds the specified time stamp as follows:

  • Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.

  • Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.

  • Start time greater than 63 days ago

    • Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.

If you set Period to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.

Definition at line 329 of file GetMetricStatisticsRequest.h.

◆ SetStartTime() [2/2]

void Aws::CloudWatch::Model::GetMetricStatisticsRequest::SetStartTime ( const Aws::Utils::DateTime value)
inline

The time stamp that determines the first data point to return. Start times are evaluated relative to the time that CloudWatch receives the request.

The value specified is inclusive; results include data points with the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).

CloudWatch rounds the specified time stamp as follows:

  • Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.

  • Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.

  • Start time greater than 63 days ago

    • Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.

If you set Period to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.

Definition at line 306 of file GetMetricStatisticsRequest.h.

◆ SetStatistics() [1/2]

void Aws::CloudWatch::Model::GetMetricStatisticsRequest::SetStatistics ( Aws::Vector< Statistic > &&  value)
inline

The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both.

Definition at line 526 of file GetMetricStatisticsRequest.h.

◆ SetStatistics() [2/2]

void Aws::CloudWatch::Model::GetMetricStatisticsRequest::SetStatistics ( const Aws::Vector< Statistic > &  value)
inline

The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both.

Definition at line 518 of file GetMetricStatisticsRequest.h.

◆ SetUnit() [1/2]

void Aws::CloudWatch::Model::GetMetricStatisticsRequest::SetUnit ( const StandardUnit value)
inline

The unit for a given metric. If you omit Unit, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

Definition at line 671 of file GetMetricStatisticsRequest.h.

◆ SetUnit() [2/2]

void Aws::CloudWatch::Model::GetMetricStatisticsRequest::SetUnit ( StandardUnit &&  value)
inline

The unit for a given metric. If you omit Unit, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

Definition at line 681 of file GetMetricStatisticsRequest.h.

◆ StartTimeHasBeenSet()

bool Aws::CloudWatch::Model::GetMetricStatisticsRequest::StartTimeHasBeenSet ( ) const
inline

The time stamp that determines the first data point to return. Start times are evaluated relative to the time that CloudWatch receives the request.

The value specified is inclusive; results include data points with the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).

CloudWatch rounds the specified time stamp as follows:

  • Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.

  • Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.

  • Start time greater than 63 days ago

    • Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.

If you set Period to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.

Definition at line 283 of file GetMetricStatisticsRequest.h.

◆ StatisticsHasBeenSet()

bool Aws::CloudWatch::Model::GetMetricStatisticsRequest::StatisticsHasBeenSet ( ) const
inline

The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both.

Definition at line 510 of file GetMetricStatisticsRequest.h.

◆ UnitHasBeenSet()

bool Aws::CloudWatch::Model::GetMetricStatisticsRequest::UnitHasBeenSet ( ) const
inline

The unit for a given metric. If you omit Unit, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

Definition at line 661 of file GetMetricStatisticsRequest.h.

◆ WithDimensions() [1/2]

GetMetricStatisticsRequest& Aws::CloudWatch::Model::GetMetricStatisticsRequest::WithDimensions ( Aws::Vector< Dimension > &&  value)
inline

The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. If a specific combination of dimensions was not published, you can't retrieve statistics for it. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

Definition at line 208 of file GetMetricStatisticsRequest.h.

◆ WithDimensions() [2/2]

GetMetricStatisticsRequest& Aws::CloudWatch::Model::GetMetricStatisticsRequest::WithDimensions ( const Aws::Vector< Dimension > &  value)
inline

The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. If a specific combination of dimensions was not published, you can't retrieve statistics for it. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

Definition at line 194 of file GetMetricStatisticsRequest.h.

◆ WithEndTime() [1/2]

GetMetricStatisticsRequest& Aws::CloudWatch::Model::GetMetricStatisticsRequest::WithEndTime ( Aws::Utils::DateTime &&  value)
inline

The time stamp that determines the last data point to return.

The value specified is exclusive; results include data points up to the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).

Definition at line 424 of file GetMetricStatisticsRequest.h.

◆ WithEndTime() [2/2]

GetMetricStatisticsRequest& Aws::CloudWatch::Model::GetMetricStatisticsRequest::WithEndTime ( const Aws::Utils::DateTime value)
inline

The time stamp that determines the last data point to return.

The value specified is exclusive; results include data points up to the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).

Definition at line 416 of file GetMetricStatisticsRequest.h.

◆ WithExtendedStatistics() [1/2]

GetMetricStatisticsRequest& Aws::CloudWatch::Model::GetMetricStatisticsRequest::WithExtendedStatistics ( Aws::Vector< Aws::String > &&  value)
inline

The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both. Percentile statistics are not available for metrics when any of the metric values are negative numbers.

Definition at line 613 of file GetMetricStatisticsRequest.h.

◆ WithExtendedStatistics() [2/2]

GetMetricStatisticsRequest& Aws::CloudWatch::Model::GetMetricStatisticsRequest::WithExtendedStatistics ( const Aws::Vector< Aws::String > &  value)
inline

The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both. Percentile statistics are not available for metrics when any of the metric values are negative numbers.

Definition at line 604 of file GetMetricStatisticsRequest.h.

◆ WithMetricName() [1/3]

GetMetricStatisticsRequest& Aws::CloudWatch::Model::GetMetricStatisticsRequest::WithMetricName ( Aws::String &&  value)
inline

The name of the metric, with or without spaces.

Definition at line 118 of file GetMetricStatisticsRequest.h.

◆ WithMetricName() [2/3]

GetMetricStatisticsRequest& Aws::CloudWatch::Model::GetMetricStatisticsRequest::WithMetricName ( const Aws::String value)
inline

The name of the metric, with or without spaces.

Definition at line 113 of file GetMetricStatisticsRequest.h.

◆ WithMetricName() [3/3]

GetMetricStatisticsRequest& Aws::CloudWatch::Model::GetMetricStatisticsRequest::WithMetricName ( const char *  value)
inline

The name of the metric, with or without spaces.

Definition at line 123 of file GetMetricStatisticsRequest.h.

◆ WithNamespace() [1/3]

GetMetricStatisticsRequest& Aws::CloudWatch::Model::GetMetricStatisticsRequest::WithNamespace ( Aws::String &&  value)
inline

The namespace of the metric, with or without spaces.

Definition at line 77 of file GetMetricStatisticsRequest.h.

◆ WithNamespace() [2/3]

GetMetricStatisticsRequest& Aws::CloudWatch::Model::GetMetricStatisticsRequest::WithNamespace ( const Aws::String value)
inline

The namespace of the metric, with or without spaces.

Definition at line 72 of file GetMetricStatisticsRequest.h.

◆ WithNamespace() [3/3]

GetMetricStatisticsRequest& Aws::CloudWatch::Model::GetMetricStatisticsRequest::WithNamespace ( const char *  value)
inline

The namespace of the metric, with or without spaces.

Definition at line 82 of file GetMetricStatisticsRequest.h.

◆ WithPeriod()

GetMetricStatisticsRequest& Aws::CloudWatch::Model::GetMetricStatisticsRequest::WithPeriod ( int  value)
inline

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of

  1. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

  • Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

  • Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

  • Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

Definition at line 493 of file GetMetricStatisticsRequest.h.

◆ WithStartTime() [1/2]

GetMetricStatisticsRequest& Aws::CloudWatch::Model::GetMetricStatisticsRequest::WithStartTime ( Aws::Utils::DateTime &&  value)
inline

The time stamp that determines the first data point to return. Start times are evaluated relative to the time that CloudWatch receives the request.

The value specified is inclusive; results include data points with the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).

CloudWatch rounds the specified time stamp as follows:

  • Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.

  • Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.

  • Start time greater than 63 days ago

    • Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.

If you set Period to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.

Definition at line 375 of file GetMetricStatisticsRequest.h.

◆ WithStartTime() [2/2]

GetMetricStatisticsRequest& Aws::CloudWatch::Model::GetMetricStatisticsRequest::WithStartTime ( const Aws::Utils::DateTime value)
inline

The time stamp that determines the first data point to return. Start times are evaluated relative to the time that CloudWatch receives the request.

The value specified is inclusive; results include data points with the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).

CloudWatch rounds the specified time stamp as follows:

  • Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.

  • Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.

  • Start time greater than 63 days ago

    • Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.

If you set Period to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.

Definition at line 352 of file GetMetricStatisticsRequest.h.

◆ WithStatistics() [1/2]

GetMetricStatisticsRequest& Aws::CloudWatch::Model::GetMetricStatisticsRequest::WithStatistics ( Aws::Vector< Statistic > &&  value)
inline

The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both.

Definition at line 542 of file GetMetricStatisticsRequest.h.

◆ WithStatistics() [2/2]

GetMetricStatisticsRequest& Aws::CloudWatch::Model::GetMetricStatisticsRequest::WithStatistics ( const Aws::Vector< Statistic > &  value)
inline

The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both.

Definition at line 534 of file GetMetricStatisticsRequest.h.

◆ WithUnit() [1/2]

GetMetricStatisticsRequest& Aws::CloudWatch::Model::GetMetricStatisticsRequest::WithUnit ( const StandardUnit value)
inline

The unit for a given metric. If you omit Unit, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

Definition at line 691 of file GetMetricStatisticsRequest.h.

◆ WithUnit() [2/2]

GetMetricStatisticsRequest& Aws::CloudWatch::Model::GetMetricStatisticsRequest::WithUnit ( StandardUnit &&  value)
inline

The unit for a given metric. If you omit Unit, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

Definition at line 701 of file GetMetricStatisticsRequest.h.


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