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

#include <GetMetricDataRequest.h>

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

Public Member Functions

 GetMetricDataRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::Vector< MetricDataQuery > & GetMetricDataQueries () const
 
bool MetricDataQueriesHasBeenSet () const
 
void SetMetricDataQueries (const Aws::Vector< MetricDataQuery > &value)
 
void SetMetricDataQueries (Aws::Vector< MetricDataQuery > &&value)
 
GetMetricDataRequestWithMetricDataQueries (const Aws::Vector< MetricDataQuery > &value)
 
GetMetricDataRequestWithMetricDataQueries (Aws::Vector< MetricDataQuery > &&value)
 
GetMetricDataRequestAddMetricDataQueries (const MetricDataQuery &value)
 
GetMetricDataRequestAddMetricDataQueries (MetricDataQuery &&value)
 
const Aws::Utils::DateTimeGetStartTime () const
 
bool StartTimeHasBeenSet () const
 
void SetStartTime (const Aws::Utils::DateTime &value)
 
void SetStartTime (Aws::Utils::DateTime &&value)
 
GetMetricDataRequestWithStartTime (const Aws::Utils::DateTime &value)
 
GetMetricDataRequestWithStartTime (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)
 
GetMetricDataRequestWithEndTime (const Aws::Utils::DateTime &value)
 
GetMetricDataRequestWithEndTime (Aws::Utils::DateTime &&value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
GetMetricDataRequestWithNextToken (const Aws::String &value)
 
GetMetricDataRequestWithNextToken (Aws::String &&value)
 
GetMetricDataRequestWithNextToken (const char *value)
 
const ScanByGetScanBy () const
 
bool ScanByHasBeenSet () const
 
void SetScanBy (const ScanBy &value)
 
void SetScanBy (ScanBy &&value)
 
GetMetricDataRequestWithScanBy (const ScanBy &value)
 
GetMetricDataRequestWithScanBy (ScanBy &&value)
 
int GetMaxDatapoints () const
 
bool MaxDatapointsHasBeenSet () const
 
void SetMaxDatapoints (int value)
 
GetMetricDataRequestWithMaxDatapoints (int value)
 
const LabelOptionsGetLabelOptions () const
 
bool LabelOptionsHasBeenSet () const
 
void SetLabelOptions (const LabelOptions &value)
 
void SetLabelOptions (LabelOptions &&value)
 
GetMetricDataRequestWithLabelOptions (const LabelOptions &value)
 
GetMetricDataRequestWithLabelOptions (LabelOptions &&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 GetMetricDataRequest.h.

Constructor & Destructor Documentation

◆ GetMetricDataRequest()

Aws::CloudWatch::Model::GetMetricDataRequest::GetMetricDataRequest ( )

Member Function Documentation

◆ AddMetricDataQueries() [1/2]

GetMetricDataRequest& Aws::CloudWatch::Model::GetMetricDataRequest::AddMetricDataQueries ( const MetricDataQuery value)
inline

The metric queries to be returned. A single GetMetricData call can include as many as 500 MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.

Definition at line 98 of file GetMetricDataRequest.h.

◆ AddMetricDataQueries() [2/2]

GetMetricDataRequest& Aws::CloudWatch::Model::GetMetricDataRequest::AddMetricDataQueries ( MetricDataQuery &&  value)
inline

The metric queries to be returned. A single GetMetricData call can include as many as 500 MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.

Definition at line 106 of file GetMetricDataRequest.h.

◆ DumpBodyToUrl()

void Aws::CloudWatch::Model::GetMetricDataRequest::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::GetMetricDataRequest::EndTimeHasBeenSet ( ) const
inline

The time stamp indicating the latest data to be returned.

The value specified is exclusive; results include data points up to the specified time stamp.

For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as EndTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the EndTime.

Definition at line 288 of file GetMetricDataRequest.h.

◆ GetEndTime()

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

The time stamp indicating the latest data to be returned.

The value specified is exclusive; results include data points up to the specified time stamp.

For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as EndTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the EndTime.

Definition at line 276 of file GetMetricDataRequest.h.

◆ GetLabelOptions()

const LabelOptions& Aws::CloudWatch::Model::GetMetricDataRequest::GetLabelOptions ( ) const
inline

This structure includes the Timezone parameter, which you can use to specify your time zone so that the labels of returned data display the correct time for your time zone.

Definition at line 473 of file GetMetricDataRequest.h.

◆ GetMaxDatapoints()

int Aws::CloudWatch::Model::GetMetricDataRequest::GetMaxDatapoints ( ) const
inline

The maximum number of data points the request should return before paginating. If you omit this, the default of 100,800 is used.

Definition at line 447 of file GetMetricDataRequest.h.

◆ GetMetricDataQueries()

const Aws::Vector<MetricDataQuery>& Aws::CloudWatch::Model::GetMetricDataRequest::GetMetricDataQueries ( ) const
inline

The metric queries to be returned. A single GetMetricData call can include as many as 500 MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.

Definition at line 50 of file GetMetricDataRequest.h.

◆ GetNextToken()

const Aws::String& Aws::CloudWatch::Model::GetMetricDataRequest::GetNextToken ( ) const
inline

Include this value, if it was returned by the previous GetMetricData operation, to get the next set of data points.

Definition at line 343 of file GetMetricDataRequest.h.

◆ GetScanBy()

const ScanBy& Aws::CloudWatch::Model::GetMetricDataRequest::GetScanBy ( ) const
inline

The order in which data points should be returned. TimestampDescending returns the newest data first and paginates when the MaxDatapoints limit is reached. TimestampAscending returns the oldest data first and paginates when the MaxDatapoints limit is reached.

Definition at line 395 of file GetMetricDataRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file GetMetricDataRequest.h.

◆ GetStartTime()

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

The time stamp indicating the earliest data to be returned.

The value specified is inclusive; results include data points with the specified time stamp.

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.

For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the StartTime.

Definition at line 133 of file GetMetricDataRequest.h.

◆ LabelOptionsHasBeenSet()

bool Aws::CloudWatch::Model::GetMetricDataRequest::LabelOptionsHasBeenSet ( ) const
inline

This structure includes the Timezone parameter, which you can use to specify your time zone so that the labels of returned data display the correct time for your time zone.

Definition at line 480 of file GetMetricDataRequest.h.

◆ MaxDatapointsHasBeenSet()

bool Aws::CloudWatch::Model::GetMetricDataRequest::MaxDatapointsHasBeenSet ( ) const
inline

The maximum number of data points the request should return before paginating. If you omit this, the default of 100,800 is used.

Definition at line 453 of file GetMetricDataRequest.h.

◆ MetricDataQueriesHasBeenSet()

bool Aws::CloudWatch::Model::GetMetricDataRequest::MetricDataQueriesHasBeenSet ( ) const
inline

The metric queries to be returned. A single GetMetricData call can include as many as 500 MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.

Definition at line 58 of file GetMetricDataRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::CloudWatch::Model::GetMetricDataRequest::NextTokenHasBeenSet ( ) const
inline

Include this value, if it was returned by the previous GetMetricData operation, to get the next set of data points.

Definition at line 349 of file GetMetricDataRequest.h.

◆ ScanByHasBeenSet()

bool Aws::CloudWatch::Model::GetMetricDataRequest::ScanByHasBeenSet ( ) const
inline

The order in which data points should be returned. TimestampDescending returns the newest data first and paginates when the MaxDatapoints limit is reached. TimestampAscending returns the oldest data first and paginates when the MaxDatapoints limit is reached.

Definition at line 404 of file GetMetricDataRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetEndTime() [1/2]

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

The time stamp indicating the latest data to be returned.

The value specified is exclusive; results include data points up to the specified time stamp.

For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as EndTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the EndTime.

Definition at line 312 of file GetMetricDataRequest.h.

◆ SetEndTime() [2/2]

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

The time stamp indicating the latest data to be returned.

The value specified is exclusive; results include data points up to the specified time stamp.

For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as EndTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the EndTime.

Definition at line 300 of file GetMetricDataRequest.h.

◆ SetLabelOptions() [1/2]

void Aws::CloudWatch::Model::GetMetricDataRequest::SetLabelOptions ( const LabelOptions value)
inline

This structure includes the Timezone parameter, which you can use to specify your time zone so that the labels of returned data display the correct time for your time zone.

Definition at line 487 of file GetMetricDataRequest.h.

◆ SetLabelOptions() [2/2]

void Aws::CloudWatch::Model::GetMetricDataRequest::SetLabelOptions ( LabelOptions &&  value)
inline

This structure includes the Timezone parameter, which you can use to specify your time zone so that the labels of returned data display the correct time for your time zone.

Definition at line 494 of file GetMetricDataRequest.h.

◆ SetMaxDatapoints()

void Aws::CloudWatch::Model::GetMetricDataRequest::SetMaxDatapoints ( int  value)
inline

The maximum number of data points the request should return before paginating. If you omit this, the default of 100,800 is used.

Definition at line 459 of file GetMetricDataRequest.h.

◆ SetMetricDataQueries() [1/2]

void Aws::CloudWatch::Model::GetMetricDataRequest::SetMetricDataQueries ( Aws::Vector< MetricDataQuery > &&  value)
inline

The metric queries to be returned. A single GetMetricData call can include as many as 500 MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.

Definition at line 74 of file GetMetricDataRequest.h.

◆ SetMetricDataQueries() [2/2]

void Aws::CloudWatch::Model::GetMetricDataRequest::SetMetricDataQueries ( const Aws::Vector< MetricDataQuery > &  value)
inline

The metric queries to be returned. A single GetMetricData call can include as many as 500 MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.

Definition at line 66 of file GetMetricDataRequest.h.

◆ SetNextToken() [1/3]

void Aws::CloudWatch::Model::GetMetricDataRequest::SetNextToken ( Aws::String &&  value)
inline

Include this value, if it was returned by the previous GetMetricData operation, to get the next set of data points.

Definition at line 361 of file GetMetricDataRequest.h.

◆ SetNextToken() [2/3]

void Aws::CloudWatch::Model::GetMetricDataRequest::SetNextToken ( const Aws::String value)
inline

Include this value, if it was returned by the previous GetMetricData operation, to get the next set of data points.

Definition at line 355 of file GetMetricDataRequest.h.

◆ SetNextToken() [3/3]

void Aws::CloudWatch::Model::GetMetricDataRequest::SetNextToken ( const char *  value)
inline

Include this value, if it was returned by the previous GetMetricData operation, to get the next set of data points.

Definition at line 367 of file GetMetricDataRequest.h.

◆ SetScanBy() [1/2]

void Aws::CloudWatch::Model::GetMetricDataRequest::SetScanBy ( const ScanBy value)
inline

The order in which data points should be returned. TimestampDescending returns the newest data first and paginates when the MaxDatapoints limit is reached. TimestampAscending returns the oldest data first and paginates when the MaxDatapoints limit is reached.

Definition at line 413 of file GetMetricDataRequest.h.

◆ SetScanBy() [2/2]

void Aws::CloudWatch::Model::GetMetricDataRequest::SetScanBy ( ScanBy &&  value)
inline

The order in which data points should be returned. TimestampDescending returns the newest data first and paginates when the MaxDatapoints limit is reached. TimestampAscending returns the oldest data first and paginates when the MaxDatapoints limit is reached.

Definition at line 422 of file GetMetricDataRequest.h.

◆ SetStartTime() [1/2]

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

The time stamp indicating the earliest data to be returned.

The value specified is inclusive; results include data points with the specified time stamp.

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.

For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the StartTime.

Definition at line 211 of file GetMetricDataRequest.h.

◆ SetStartTime() [2/2]

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

The time stamp indicating the earliest data to be returned.

The value specified is inclusive; results include data points with the specified time stamp.

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.

For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the StartTime.

Definition at line 185 of file GetMetricDataRequest.h.

◆ StartTimeHasBeenSet()

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

The time stamp indicating the earliest data to be returned.

The value specified is inclusive; results include data points with the specified time stamp.

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.

For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the StartTime.

Definition at line 159 of file GetMetricDataRequest.h.

◆ WithEndTime() [1/2]

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

The time stamp indicating the latest data to be returned.

The value specified is exclusive; results include data points up to the specified time stamp.

For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as EndTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the EndTime.

Definition at line 336 of file GetMetricDataRequest.h.

◆ WithEndTime() [2/2]

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

The time stamp indicating the latest data to be returned.

The value specified is exclusive; results include data points up to the specified time stamp.

For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as EndTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the EndTime.

Definition at line 324 of file GetMetricDataRequest.h.

◆ WithLabelOptions() [1/2]

GetMetricDataRequest& Aws::CloudWatch::Model::GetMetricDataRequest::WithLabelOptions ( const LabelOptions value)
inline

This structure includes the Timezone parameter, which you can use to specify your time zone so that the labels of returned data display the correct time for your time zone.

Definition at line 501 of file GetMetricDataRequest.h.

◆ WithLabelOptions() [2/2]

GetMetricDataRequest& Aws::CloudWatch::Model::GetMetricDataRequest::WithLabelOptions ( LabelOptions &&  value)
inline

This structure includes the Timezone parameter, which you can use to specify your time zone so that the labels of returned data display the correct time for your time zone.

Definition at line 508 of file GetMetricDataRequest.h.

◆ WithMaxDatapoints()

GetMetricDataRequest& Aws::CloudWatch::Model::GetMetricDataRequest::WithMaxDatapoints ( int  value)
inline

The maximum number of data points the request should return before paginating. If you omit this, the default of 100,800 is used.

Definition at line 465 of file GetMetricDataRequest.h.

◆ WithMetricDataQueries() [1/2]

GetMetricDataRequest& Aws::CloudWatch::Model::GetMetricDataRequest::WithMetricDataQueries ( Aws::Vector< MetricDataQuery > &&  value)
inline

The metric queries to be returned. A single GetMetricData call can include as many as 500 MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.

Definition at line 90 of file GetMetricDataRequest.h.

◆ WithMetricDataQueries() [2/2]

GetMetricDataRequest& Aws::CloudWatch::Model::GetMetricDataRequest::WithMetricDataQueries ( const Aws::Vector< MetricDataQuery > &  value)
inline

The metric queries to be returned. A single GetMetricData call can include as many as 500 MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.

Definition at line 82 of file GetMetricDataRequest.h.

◆ WithNextToken() [1/3]

GetMetricDataRequest& Aws::CloudWatch::Model::GetMetricDataRequest::WithNextToken ( Aws::String &&  value)
inline

Include this value, if it was returned by the previous GetMetricData operation, to get the next set of data points.

Definition at line 379 of file GetMetricDataRequest.h.

◆ WithNextToken() [2/3]

GetMetricDataRequest& Aws::CloudWatch::Model::GetMetricDataRequest::WithNextToken ( const Aws::String value)
inline

Include this value, if it was returned by the previous GetMetricData operation, to get the next set of data points.

Definition at line 373 of file GetMetricDataRequest.h.

◆ WithNextToken() [3/3]

GetMetricDataRequest& Aws::CloudWatch::Model::GetMetricDataRequest::WithNextToken ( const char *  value)
inline

Include this value, if it was returned by the previous GetMetricData operation, to get the next set of data points.

Definition at line 385 of file GetMetricDataRequest.h.

◆ WithScanBy() [1/2]

GetMetricDataRequest& Aws::CloudWatch::Model::GetMetricDataRequest::WithScanBy ( const ScanBy value)
inline

The order in which data points should be returned. TimestampDescending returns the newest data first and paginates when the MaxDatapoints limit is reached. TimestampAscending returns the oldest data first and paginates when the MaxDatapoints limit is reached.

Definition at line 431 of file GetMetricDataRequest.h.

◆ WithScanBy() [2/2]

GetMetricDataRequest& Aws::CloudWatch::Model::GetMetricDataRequest::WithScanBy ( ScanBy &&  value)
inline

The order in which data points should be returned. TimestampDescending returns the newest data first and paginates when the MaxDatapoints limit is reached. TimestampAscending returns the oldest data first and paginates when the MaxDatapoints limit is reached.

Definition at line 440 of file GetMetricDataRequest.h.

◆ WithStartTime() [1/2]

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

The time stamp indicating the earliest data to be returned.

The value specified is inclusive; results include data points with the specified time stamp.

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.

For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the StartTime.

Definition at line 263 of file GetMetricDataRequest.h.

◆ WithStartTime() [2/2]

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

The time stamp indicating the earliest data to be returned.

The value specified is inclusive; results include data points with the specified time stamp.

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.

For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the StartTime.

Definition at line 237 of file GetMetricDataRequest.h.


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