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

#include <GetUsageForecastRequest.h>

+ Inheritance diagram for Aws::CostExplorer::Model::GetUsageForecastRequest:

Public Member Functions

 GetUsageForecastRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const DateIntervalGetTimePeriod () const
 
bool TimePeriodHasBeenSet () const
 
void SetTimePeriod (const DateInterval &value)
 
void SetTimePeriod (DateInterval &&value)
 
GetUsageForecastRequestWithTimePeriod (const DateInterval &value)
 
GetUsageForecastRequestWithTimePeriod (DateInterval &&value)
 
const MetricGetMetric () const
 
bool MetricHasBeenSet () const
 
void SetMetric (const Metric &value)
 
void SetMetric (Metric &&value)
 
GetUsageForecastRequestWithMetric (const Metric &value)
 
GetUsageForecastRequestWithMetric (Metric &&value)
 
const GranularityGetGranularity () const
 
bool GranularityHasBeenSet () const
 
void SetGranularity (const Granularity &value)
 
void SetGranularity (Granularity &&value)
 
GetUsageForecastRequestWithGranularity (const Granularity &value)
 
GetUsageForecastRequestWithGranularity (Granularity &&value)
 
const ExpressionGetFilter () const
 
bool FilterHasBeenSet () const
 
void SetFilter (const Expression &value)
 
void SetFilter (Expression &&value)
 
GetUsageForecastRequestWithFilter (const Expression &value)
 
GetUsageForecastRequestWithFilter (Expression &&value)
 
int GetPredictionIntervalLevel () const
 
bool PredictionIntervalLevelHasBeenSet () const
 
void SetPredictionIntervalLevel (int value)
 
GetUsageForecastRequestWithPredictionIntervalLevel (int value)
 
- Public Member Functions inherited from Aws::CostExplorer::CostExplorerRequest
virtual ~CostExplorerRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

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

Detailed Description

Definition at line 24 of file GetUsageForecastRequest.h.

Constructor & Destructor Documentation

◆ GetUsageForecastRequest()

Aws::CostExplorer::Model::GetUsageForecastRequest::GetUsageForecastRequest ( )

Member Function Documentation

◆ FilterHasBeenSet()

bool Aws::CostExplorer::Model::GetUsageForecastRequest::FilterHasBeenSet ( ) const
inline

The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters.

Definition at line 209 of file GetUsageForecastRequest.h.

◆ GetFilter()

const Expression& Aws::CostExplorer::Model::GetUsageForecastRequest::GetFilter ( ) const
inline

The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters.

Definition at line 203 of file GetUsageForecastRequest.h.

◆ GetGranularity()

const Granularity& Aws::CostExplorer::Model::GetUsageForecastRequest::GetGranularity ( ) const
inline

How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.

The GetUsageForecast operation supports only DAILY and MONTHLY granularities.

Definition at line 156 of file GetUsageForecastRequest.h.

◆ GetMetric()

const Metric& Aws::CostExplorer::Model::GetUsageForecastRequest::GetMetric ( ) const
inline

Which metric Cost Explorer uses to create your forecast.

Valid values for a GetUsageForecast call are the following:

  • USAGE_QUANTITY

  • NORMALIZED_USAGE_AMOUNT

Definition at line 112 of file GetUsageForecastRequest.h.

◆ GetPredictionIntervalLevel()

int Aws::CostExplorer::Model::GetUsageForecastRequest::GetPredictionIntervalLevel ( ) const
inline

Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.

Definition at line 243 of file GetUsageForecastRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::CostExplorer::Model::GetUsageForecastRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::CostExplorer::Model::GetUsageForecastRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file GetUsageForecastRequest.h.

◆ GetTimePeriod()

const DateInterval& Aws::CostExplorer::Model::GetUsageForecastRequest::GetTimePeriod ( ) const
inline

The start and end dates of the period that you want to retrieve usage forecast for. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. The start date must be equal to or later than the current date to avoid a validation error.

Definition at line 49 of file GetUsageForecastRequest.h.

◆ GranularityHasBeenSet()

bool Aws::CostExplorer::Model::GetUsageForecastRequest::GranularityHasBeenSet ( ) const
inline

How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.

The GetUsageForecast operation supports only DAILY and MONTHLY granularities.

Definition at line 164 of file GetUsageForecastRequest.h.

◆ MetricHasBeenSet()

bool Aws::CostExplorer::Model::GetUsageForecastRequest::MetricHasBeenSet ( ) const
inline

Which metric Cost Explorer uses to create your forecast.

Valid values for a GetUsageForecast call are the following:

  • USAGE_QUANTITY

  • NORMALIZED_USAGE_AMOUNT

Definition at line 119 of file GetUsageForecastRequest.h.

◆ PredictionIntervalLevelHasBeenSet()

bool Aws::CostExplorer::Model::GetUsageForecastRequest::PredictionIntervalLevelHasBeenSet ( ) const
inline

Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.

Definition at line 252 of file GetUsageForecastRequest.h.

◆ SerializePayload()

Aws::String Aws::CostExplorer::Model::GetUsageForecastRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetFilter() [1/2]

void Aws::CostExplorer::Model::GetUsageForecastRequest::SetFilter ( const Expression value)
inline

The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters.

Definition at line 215 of file GetUsageForecastRequest.h.

◆ SetFilter() [2/2]

void Aws::CostExplorer::Model::GetUsageForecastRequest::SetFilter ( Expression &&  value)
inline

The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters.

Definition at line 221 of file GetUsageForecastRequest.h.

◆ SetGranularity() [1/2]

void Aws::CostExplorer::Model::GetUsageForecastRequest::SetGranularity ( const Granularity value)
inline

How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.

The GetUsageForecast operation supports only DAILY and MONTHLY granularities.

Definition at line 172 of file GetUsageForecastRequest.h.

◆ SetGranularity() [2/2]

void Aws::CostExplorer::Model::GetUsageForecastRequest::SetGranularity ( Granularity &&  value)
inline

How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.

The GetUsageForecast operation supports only DAILY and MONTHLY granularities.

Definition at line 180 of file GetUsageForecastRequest.h.

◆ SetMetric() [1/2]

void Aws::CostExplorer::Model::GetUsageForecastRequest::SetMetric ( const Metric value)
inline

Which metric Cost Explorer uses to create your forecast.

Valid values for a GetUsageForecast call are the following:

  • USAGE_QUANTITY

  • NORMALIZED_USAGE_AMOUNT

Definition at line 126 of file GetUsageForecastRequest.h.

◆ SetMetric() [2/2]

void Aws::CostExplorer::Model::GetUsageForecastRequest::SetMetric ( Metric &&  value)
inline

Which metric Cost Explorer uses to create your forecast.

Valid values for a GetUsageForecast call are the following:

  • USAGE_QUANTITY

  • NORMALIZED_USAGE_AMOUNT

Definition at line 133 of file GetUsageForecastRequest.h.

◆ SetPredictionIntervalLevel()

void Aws::CostExplorer::Model::GetUsageForecastRequest::SetPredictionIntervalLevel ( int  value)
inline

Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.

Definition at line 261 of file GetUsageForecastRequest.h.

◆ SetTimePeriod() [1/2]

void Aws::CostExplorer::Model::GetUsageForecastRequest::SetTimePeriod ( const DateInterval value)
inline

The start and end dates of the period that you want to retrieve usage forecast for. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. The start date must be equal to or later than the current date to avoid a validation error.

Definition at line 71 of file GetUsageForecastRequest.h.

◆ SetTimePeriod() [2/2]

void Aws::CostExplorer::Model::GetUsageForecastRequest::SetTimePeriod ( DateInterval &&  value)
inline

The start and end dates of the period that you want to retrieve usage forecast for. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. The start date must be equal to or later than the current date to avoid a validation error.

Definition at line 82 of file GetUsageForecastRequest.h.

◆ TimePeriodHasBeenSet()

bool Aws::CostExplorer::Model::GetUsageForecastRequest::TimePeriodHasBeenSet ( ) const
inline

The start and end dates of the period that you want to retrieve usage forecast for. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. The start date must be equal to or later than the current date to avoid a validation error.

Definition at line 60 of file GetUsageForecastRequest.h.

◆ WithFilter() [1/2]

GetUsageForecastRequest& Aws::CostExplorer::Model::GetUsageForecastRequest::WithFilter ( const Expression value)
inline

The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters.

Definition at line 227 of file GetUsageForecastRequest.h.

◆ WithFilter() [2/2]

GetUsageForecastRequest& Aws::CostExplorer::Model::GetUsageForecastRequest::WithFilter ( Expression &&  value)
inline

The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters.

Definition at line 233 of file GetUsageForecastRequest.h.

◆ WithGranularity() [1/2]

GetUsageForecastRequest& Aws::CostExplorer::Model::GetUsageForecastRequest::WithGranularity ( const Granularity value)
inline

How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.

The GetUsageForecast operation supports only DAILY and MONTHLY granularities.

Definition at line 188 of file GetUsageForecastRequest.h.

◆ WithGranularity() [2/2]

GetUsageForecastRequest& Aws::CostExplorer::Model::GetUsageForecastRequest::WithGranularity ( Granularity &&  value)
inline

How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.

The GetUsageForecast operation supports only DAILY and MONTHLY granularities.

Definition at line 196 of file GetUsageForecastRequest.h.

◆ WithMetric() [1/2]

GetUsageForecastRequest& Aws::CostExplorer::Model::GetUsageForecastRequest::WithMetric ( const Metric value)
inline

Which metric Cost Explorer uses to create your forecast.

Valid values for a GetUsageForecast call are the following:

  • USAGE_QUANTITY

  • NORMALIZED_USAGE_AMOUNT

Definition at line 140 of file GetUsageForecastRequest.h.

◆ WithMetric() [2/2]

GetUsageForecastRequest& Aws::CostExplorer::Model::GetUsageForecastRequest::WithMetric ( Metric &&  value)
inline

Which metric Cost Explorer uses to create your forecast.

Valid values for a GetUsageForecast call are the following:

  • USAGE_QUANTITY

  • NORMALIZED_USAGE_AMOUNT

Definition at line 147 of file GetUsageForecastRequest.h.

◆ WithPredictionIntervalLevel()

GetUsageForecastRequest& Aws::CostExplorer::Model::GetUsageForecastRequest::WithPredictionIntervalLevel ( int  value)
inline

Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.

Definition at line 270 of file GetUsageForecastRequest.h.

◆ WithTimePeriod() [1/2]

GetUsageForecastRequest& Aws::CostExplorer::Model::GetUsageForecastRequest::WithTimePeriod ( const DateInterval value)
inline

The start and end dates of the period that you want to retrieve usage forecast for. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. The start date must be equal to or later than the current date to avoid a validation error.

Definition at line 93 of file GetUsageForecastRequest.h.

◆ WithTimePeriod() [2/2]

GetUsageForecastRequest& Aws::CostExplorer::Model::GetUsageForecastRequest::WithTimePeriod ( DateInterval &&  value)
inline

The start and end dates of the period that you want to retrieve usage forecast for. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. The start date must be equal to or later than the current date to avoid a validation error.

Definition at line 104 of file GetUsageForecastRequest.h.


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