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

#include <GetInsightRuleReportRequest.h>

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

Public Member Functions

 GetInsightRuleReportRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetRuleName () const
 
bool RuleNameHasBeenSet () const
 
void SetRuleName (const Aws::String &value)
 
void SetRuleName (Aws::String &&value)
 
void SetRuleName (const char *value)
 
GetInsightRuleReportRequestWithRuleName (const Aws::String &value)
 
GetInsightRuleReportRequestWithRuleName (Aws::String &&value)
 
GetInsightRuleReportRequestWithRuleName (const char *value)
 
const Aws::Utils::DateTimeGetStartTime () const
 
bool StartTimeHasBeenSet () const
 
void SetStartTime (const Aws::Utils::DateTime &value)
 
void SetStartTime (Aws::Utils::DateTime &&value)
 
GetInsightRuleReportRequestWithStartTime (const Aws::Utils::DateTime &value)
 
GetInsightRuleReportRequestWithStartTime (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)
 
GetInsightRuleReportRequestWithEndTime (const Aws::Utils::DateTime &value)
 
GetInsightRuleReportRequestWithEndTime (Aws::Utils::DateTime &&value)
 
int GetPeriod () const
 
bool PeriodHasBeenSet () const
 
void SetPeriod (int value)
 
GetInsightRuleReportRequestWithPeriod (int value)
 
int GetMaxContributorCount () const
 
bool MaxContributorCountHasBeenSet () const
 
void SetMaxContributorCount (int value)
 
GetInsightRuleReportRequestWithMaxContributorCount (int value)
 
const Aws::Vector< Aws::String > & GetMetrics () const
 
bool MetricsHasBeenSet () const
 
void SetMetrics (const Aws::Vector< Aws::String > &value)
 
void SetMetrics (Aws::Vector< Aws::String > &&value)
 
GetInsightRuleReportRequestWithMetrics (const Aws::Vector< Aws::String > &value)
 
GetInsightRuleReportRequestWithMetrics (Aws::Vector< Aws::String > &&value)
 
GetInsightRuleReportRequestAddMetrics (const Aws::String &value)
 
GetInsightRuleReportRequestAddMetrics (Aws::String &&value)
 
GetInsightRuleReportRequestAddMetrics (const char *value)
 
const Aws::StringGetOrderBy () const
 
bool OrderByHasBeenSet () const
 
void SetOrderBy (const Aws::String &value)
 
void SetOrderBy (Aws::String &&value)
 
void SetOrderBy (const char *value)
 
GetInsightRuleReportRequestWithOrderBy (const Aws::String &value)
 
GetInsightRuleReportRequestWithOrderBy (Aws::String &&value)
 
GetInsightRuleReportRequestWithOrderBy (const char *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 23 of file GetInsightRuleReportRequest.h.

Constructor & Destructor Documentation

◆ GetInsightRuleReportRequest()

Aws::CloudWatch::Model::GetInsightRuleReportRequest::GetInsightRuleReportRequest ( )

Member Function Documentation

◆ AddMetrics() [1/3]

GetInsightRuleReportRequest& Aws::CloudWatch::Model::GetInsightRuleReportRequest::AddMetrics ( const Aws::String value)
inline

Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more of the following metrics:

  • UniqueContributors – the number of unique contributors for each data point.

  • MaxContributorValue – the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.

    If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's Value, during that period.

  • SampleCount – the number of data points matched by the rule.

  • Sum – the sum of the values from all contributors during the time period represented by that data point.

  • Minimum – the minimum value from a single observation during the time period represented by that data point.

  • Maximum – the maximum value from a single observation during the time period represented by that data point.

  • Average – the average value from all contributors during the time period represented by that data point.

Definition at line 377 of file GetInsightRuleReportRequest.h.

◆ AddMetrics() [2/3]

GetInsightRuleReportRequest& Aws::CloudWatch::Model::GetInsightRuleReportRequest::AddMetrics ( Aws::String &&  value)
inline

Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more of the following metrics:

  • UniqueContributors – the number of unique contributors for each data point.

  • MaxContributorValue – the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.

    If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's Value, during that period.

  • SampleCount – the number of data points matched by the rule.

  • Sum – the sum of the values from all contributors during the time period represented by that data point.

  • Minimum – the minimum value from a single observation during the time period represented by that data point.

  • Maximum – the maximum value from a single observation during the time period represented by that data point.

  • Average – the average value from all contributors during the time period represented by that data point.

Definition at line 400 of file GetInsightRuleReportRequest.h.

◆ AddMetrics() [3/3]

GetInsightRuleReportRequest& Aws::CloudWatch::Model::GetInsightRuleReportRequest::AddMetrics ( const char *  value)
inline

Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more of the following metrics:

  • UniqueContributors – the number of unique contributors for each data point.

  • MaxContributorValue – the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.

    If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's Value, during that period.

  • SampleCount – the number of data points matched by the rule.

  • Sum – the sum of the values from all contributors during the time period represented by that data point.

  • Minimum – the minimum value from a single observation during the time period represented by that data point.

  • Maximum – the maximum value from a single observation during the time period represented by that data point.

  • Average – the average value from all contributors during the time period represented by that data point.

Definition at line 423 of file GetInsightRuleReportRequest.h.

◆ DumpBodyToUrl()

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

The end time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

Definition at line 137 of file GetInsightRuleReportRequest.h.

◆ GetEndTime()

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

The end time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

Definition at line 130 of file GetInsightRuleReportRequest.h.

◆ GetMaxContributorCount()

int Aws::CloudWatch::Model::GetInsightRuleReportRequest::GetMaxContributorCount ( ) const
inline

The maximum number of contributors to include in the report. The range is 1 to 100. If you omit this, the default of 10 is used.

Definition at line 197 of file GetInsightRuleReportRequest.h.

◆ GetMetrics()

const Aws::Vector<Aws::String>& Aws::CloudWatch::Model::GetInsightRuleReportRequest::GetMetrics ( ) const
inline

Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more of the following metrics:

  • UniqueContributors – the number of unique contributors for each data point.

  • MaxContributorValue – the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.

    If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's Value, during that period.

  • SampleCount – the number of data points matched by the rule.

  • Sum – the sum of the values from all contributors during the time period represented by that data point.

  • Minimum – the minimum value from a single observation during the time period represented by that data point.

  • Maximum – the maximum value from a single observation during the time period represented by that data point.

  • Average – the average value from all contributors during the time period represented by that data point.

Definition at line 239 of file GetInsightRuleReportRequest.h.

◆ GetOrderBy()

const Aws::String& Aws::CloudWatch::Model::GetInsightRuleReportRequest::GetOrderBy ( ) const
inline

Determines what statistic to use to rank the contributors. Valid values are SUM and MAXIMUM.

Definition at line 430 of file GetInsightRuleReportRequest.h.

◆ GetPeriod()

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

The period, in seconds, to use for the statistics in the InsightRuleMetricDatapoint results.

Definition at line 172 of file GetInsightRuleReportRequest.h.

◆ GetRuleName()

const Aws::String& Aws::CloudWatch::Model::GetInsightRuleReportRequest::GetRuleName ( ) const
inline

The name of the rule that you want to see data from.

Definition at line 44 of file GetInsightRuleReportRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file GetInsightRuleReportRequest.h.

◆ GetStartTime()

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

The start time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

Definition at line 87 of file GetInsightRuleReportRequest.h.

◆ MaxContributorCountHasBeenSet()

bool Aws::CloudWatch::Model::GetInsightRuleReportRequest::MaxContributorCountHasBeenSet ( ) const
inline

The maximum number of contributors to include in the report. The range is 1 to 100. If you omit this, the default of 10 is used.

Definition at line 203 of file GetInsightRuleReportRequest.h.

◆ MetricsHasBeenSet()

bool Aws::CloudWatch::Model::GetInsightRuleReportRequest::MetricsHasBeenSet ( ) const
inline

Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more of the following metrics:

  • UniqueContributors – the number of unique contributors for each data point.

  • MaxContributorValue – the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.

    If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's Value, during that period.

  • SampleCount – the number of data points matched by the rule.

  • Sum – the sum of the values from all contributors during the time period represented by that data point.

  • Minimum – the minimum value from a single observation during the time period represented by that data point.

  • Maximum – the maximum value from a single observation during the time period represented by that data point.

  • Average – the average value from all contributors during the time period represented by that data point.

Definition at line 262 of file GetInsightRuleReportRequest.h.

◆ OrderByHasBeenSet()

bool Aws::CloudWatch::Model::GetInsightRuleReportRequest::OrderByHasBeenSet ( ) const
inline

Determines what statistic to use to rank the contributors. Valid values are SUM and MAXIMUM.

Definition at line 436 of file GetInsightRuleReportRequest.h.

◆ PeriodHasBeenSet()

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

The period, in seconds, to use for the statistics in the InsightRuleMetricDatapoint results.

Definition at line 178 of file GetInsightRuleReportRequest.h.

◆ RuleNameHasBeenSet()

bool Aws::CloudWatch::Model::GetInsightRuleReportRequest::RuleNameHasBeenSet ( ) const
inline

The name of the rule that you want to see data from.

Definition at line 49 of file GetInsightRuleReportRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetEndTime() [1/2]

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

The end time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

Definition at line 144 of file GetInsightRuleReportRequest.h.

◆ SetEndTime() [2/2]

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

The end time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

Definition at line 151 of file GetInsightRuleReportRequest.h.

◆ SetMaxContributorCount()

void Aws::CloudWatch::Model::GetInsightRuleReportRequest::SetMaxContributorCount ( int  value)
inline

The maximum number of contributors to include in the report. The range is 1 to 100. If you omit this, the default of 10 is used.

Definition at line 209 of file GetInsightRuleReportRequest.h.

◆ SetMetrics() [1/2]

void Aws::CloudWatch::Model::GetInsightRuleReportRequest::SetMetrics ( const Aws::Vector< Aws::String > &  value)
inline

Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more of the following metrics:

  • UniqueContributors – the number of unique contributors for each data point.

  • MaxContributorValue – the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.

    If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's Value, during that period.

  • SampleCount – the number of data points matched by the rule.

  • Sum – the sum of the values from all contributors during the time period represented by that data point.

  • Minimum – the minimum value from a single observation during the time period represented by that data point.

  • Maximum – the maximum value from a single observation during the time period represented by that data point.

  • Average – the average value from all contributors during the time period represented by that data point.

Definition at line 285 of file GetInsightRuleReportRequest.h.

◆ SetMetrics() [2/2]

void Aws::CloudWatch::Model::GetInsightRuleReportRequest::SetMetrics ( Aws::Vector< Aws::String > &&  value)
inline

Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more of the following metrics:

  • UniqueContributors – the number of unique contributors for each data point.

  • MaxContributorValue – the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.

    If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's Value, during that period.

  • SampleCount – the number of data points matched by the rule.

  • Sum – the sum of the values from all contributors during the time period represented by that data point.

  • Minimum – the minimum value from a single observation during the time period represented by that data point.

  • Maximum – the maximum value from a single observation during the time period represented by that data point.

  • Average – the average value from all contributors during the time period represented by that data point.

Definition at line 308 of file GetInsightRuleReportRequest.h.

◆ SetOrderBy() [1/3]

void Aws::CloudWatch::Model::GetInsightRuleReportRequest::SetOrderBy ( const Aws::String value)
inline

Determines what statistic to use to rank the contributors. Valid values are SUM and MAXIMUM.

Definition at line 442 of file GetInsightRuleReportRequest.h.

◆ SetOrderBy() [2/3]

void Aws::CloudWatch::Model::GetInsightRuleReportRequest::SetOrderBy ( Aws::String &&  value)
inline

Determines what statistic to use to rank the contributors. Valid values are SUM and MAXIMUM.

Definition at line 448 of file GetInsightRuleReportRequest.h.

◆ SetOrderBy() [3/3]

void Aws::CloudWatch::Model::GetInsightRuleReportRequest::SetOrderBy ( const char *  value)
inline

Determines what statistic to use to rank the contributors. Valid values are SUM and MAXIMUM.

Definition at line 454 of file GetInsightRuleReportRequest.h.

◆ SetPeriod()

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

The period, in seconds, to use for the statistics in the InsightRuleMetricDatapoint results.

Definition at line 184 of file GetInsightRuleReportRequest.h.

◆ SetRuleName() [1/3]

void Aws::CloudWatch::Model::GetInsightRuleReportRequest::SetRuleName ( const Aws::String value)
inline

The name of the rule that you want to see data from.

Definition at line 54 of file GetInsightRuleReportRequest.h.

◆ SetRuleName() [2/3]

void Aws::CloudWatch::Model::GetInsightRuleReportRequest::SetRuleName ( Aws::String &&  value)
inline

The name of the rule that you want to see data from.

Definition at line 59 of file GetInsightRuleReportRequest.h.

◆ SetRuleName() [3/3]

void Aws::CloudWatch::Model::GetInsightRuleReportRequest::SetRuleName ( const char *  value)
inline

The name of the rule that you want to see data from.

Definition at line 64 of file GetInsightRuleReportRequest.h.

◆ SetStartTime() [1/2]

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

The start time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

Definition at line 101 of file GetInsightRuleReportRequest.h.

◆ SetStartTime() [2/2]

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

The start time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

Definition at line 108 of file GetInsightRuleReportRequest.h.

◆ StartTimeHasBeenSet()

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

The start time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

Definition at line 94 of file GetInsightRuleReportRequest.h.

◆ WithEndTime() [1/2]

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

The end time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

Definition at line 158 of file GetInsightRuleReportRequest.h.

◆ WithEndTime() [2/2]

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

The end time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

Definition at line 165 of file GetInsightRuleReportRequest.h.

◆ WithMaxContributorCount()

GetInsightRuleReportRequest& Aws::CloudWatch::Model::GetInsightRuleReportRequest::WithMaxContributorCount ( int  value)
inline

The maximum number of contributors to include in the report. The range is 1 to 100. If you omit this, the default of 10 is used.

Definition at line 215 of file GetInsightRuleReportRequest.h.

◆ WithMetrics() [1/2]

GetInsightRuleReportRequest& Aws::CloudWatch::Model::GetInsightRuleReportRequest::WithMetrics ( const Aws::Vector< Aws::String > &  value)
inline

Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more of the following metrics:

  • UniqueContributors – the number of unique contributors for each data point.

  • MaxContributorValue – the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.

    If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's Value, during that period.

  • SampleCount – the number of data points matched by the rule.

  • Sum – the sum of the values from all contributors during the time period represented by that data point.

  • Minimum – the minimum value from a single observation during the time period represented by that data point.

  • Maximum – the maximum value from a single observation during the time period represented by that data point.

  • Average – the average value from all contributors during the time period represented by that data point.

Definition at line 331 of file GetInsightRuleReportRequest.h.

◆ WithMetrics() [2/2]

GetInsightRuleReportRequest& Aws::CloudWatch::Model::GetInsightRuleReportRequest::WithMetrics ( Aws::Vector< Aws::String > &&  value)
inline

Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more of the following metrics:

  • UniqueContributors – the number of unique contributors for each data point.

  • MaxContributorValue – the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.

    If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's Value, during that period.

  • SampleCount – the number of data points matched by the rule.

  • Sum – the sum of the values from all contributors during the time period represented by that data point.

  • Minimum – the minimum value from a single observation during the time period represented by that data point.

  • Maximum – the maximum value from a single observation during the time period represented by that data point.

  • Average – the average value from all contributors during the time period represented by that data point.

Definition at line 354 of file GetInsightRuleReportRequest.h.

◆ WithOrderBy() [1/3]

GetInsightRuleReportRequest& Aws::CloudWatch::Model::GetInsightRuleReportRequest::WithOrderBy ( const Aws::String value)
inline

Determines what statistic to use to rank the contributors. Valid values are SUM and MAXIMUM.

Definition at line 460 of file GetInsightRuleReportRequest.h.

◆ WithOrderBy() [2/3]

GetInsightRuleReportRequest& Aws::CloudWatch::Model::GetInsightRuleReportRequest::WithOrderBy ( Aws::String &&  value)
inline

Determines what statistic to use to rank the contributors. Valid values are SUM and MAXIMUM.

Definition at line 466 of file GetInsightRuleReportRequest.h.

◆ WithOrderBy() [3/3]

GetInsightRuleReportRequest& Aws::CloudWatch::Model::GetInsightRuleReportRequest::WithOrderBy ( const char *  value)
inline

Determines what statistic to use to rank the contributors. Valid values are SUM and MAXIMUM.

Definition at line 472 of file GetInsightRuleReportRequest.h.

◆ WithPeriod()

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

The period, in seconds, to use for the statistics in the InsightRuleMetricDatapoint results.

Definition at line 190 of file GetInsightRuleReportRequest.h.

◆ WithRuleName() [1/3]

GetInsightRuleReportRequest& Aws::CloudWatch::Model::GetInsightRuleReportRequest::WithRuleName ( const Aws::String value)
inline

The name of the rule that you want to see data from.

Definition at line 69 of file GetInsightRuleReportRequest.h.

◆ WithRuleName() [2/3]

GetInsightRuleReportRequest& Aws::CloudWatch::Model::GetInsightRuleReportRequest::WithRuleName ( Aws::String &&  value)
inline

The name of the rule that you want to see data from.

Definition at line 74 of file GetInsightRuleReportRequest.h.

◆ WithRuleName() [3/3]

GetInsightRuleReportRequest& Aws::CloudWatch::Model::GetInsightRuleReportRequest::WithRuleName ( const char *  value)
inline

The name of the rule that you want to see data from.

Definition at line 79 of file GetInsightRuleReportRequest.h.

◆ WithStartTime() [1/2]

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

The start time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

Definition at line 115 of file GetInsightRuleReportRequest.h.

◆ WithStartTime() [2/2]

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

The start time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

Definition at line 122 of file GetInsightRuleReportRequest.h.


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