Aws::CostExplorer::Model::GetCostForecastRequest Class Reference

#include <GetCostForecastRequest.h>

Inheritance diagram for Aws::CostExplorer::Model::GetCostForecastRequest:

Public Member Functions
	GetCostForecastRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const override
const DateInterval &	GetTimePeriod () const
bool	TimePeriodHasBeenSet () const
void	SetTimePeriod (const DateInterval &value)
void	SetTimePeriod (DateInterval &&value)
GetCostForecastRequest &	WithTimePeriod (const DateInterval &value)
GetCostForecastRequest &	WithTimePeriod (DateInterval &&value)
const Metric &	GetMetric () const
bool	MetricHasBeenSet () const
void	SetMetric (const Metric &value)
void	SetMetric (Metric &&value)
GetCostForecastRequest &	WithMetric (const Metric &value)
GetCostForecastRequest &	WithMetric (Metric &&value)
const Granularity &	GetGranularity () const
bool	GranularityHasBeenSet () const
void	SetGranularity (const Granularity &value)
void	SetGranularity (Granularity &&value)
GetCostForecastRequest &	WithGranularity (const Granularity &value)
GetCostForecastRequest &	WithGranularity (Granularity &&value)
const Expression &	GetFilter () const
bool	FilterHasBeenSet () const
void	SetFilter (const Expression &value)
void	SetFilter (Expression &&value)
GetCostForecastRequest &	WithFilter (const Expression &value)
GetCostForecastRequest &	WithFilter (Expression &&value)
int	GetPredictionIntervalLevel () const
bool	PredictionIntervalLevelHasBeenSet () const
void	SetPredictionIntervalLevel (int value)
GetCostForecastRequest &	WithPredictionIntervalLevel (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::IOStream >	GetBody () 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 RequestSignedHandler &	GetRequestSignedHandler () const
const Aws::IOStreamFactory &	GetResponseStreamFactory () 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::DataReceivedEventHandler &	GetDataReceivedEventHandler () const
virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const
virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const
virtual const RequestRetryHandler &	GetRequestRetryHandler () 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 GetCostForecastRequest.h.

Constructor & Destructor Documentation

GetCostForecastRequest()

Aws::CostExplorer::Model::GetCostForecastRequest::GetCostForecastRequest

(

)

Member Function Documentation

FilterHasBeenSet()

bool Aws::CostExplorer::Model::GetCostForecastRequest::FilterHasBeenSet ( ) const

inline

The filters that you want to use to filter your forecast. The GetCostForecast API supports filtering by the following dimensions:

• AZ

• INSTANCE_TYPE

• LINKED_ACCOUNT

• LINKED_ACCOUNT_NAME

• OPERATION

• PURCHASE_TYPE

• REGION

• SERVICE

• USAGE_TYPE

• USAGE_TYPE_GROUP

• RECORD_TYPE

• OPERATING_SYSTEM

• TENANCY

• SCOPE

• PLATFORM

• SUBSCRIPTION_ID

• LEGAL_ENTITY_NAME

• DEPLOYMENT_OPTION

• DATABASE_ENGINE

• INSTANCE_TYPE_FAMILY

• BILLING_ENTITY

• RESERVATION_ID

• SAVINGS_PLAN_ARN

Definition at line 239 of file GetCostForecastRequest.h.

GetFilter()

const Expression& Aws::CostExplorer::Model::GetCostForecastRequest::GetFilter ( ) const

inline

The filters that you want to use to filter your forecast. The GetCostForecast API supports filtering by the following dimensions:

• AZ

• INSTANCE_TYPE

• LINKED_ACCOUNT

• LINKED_ACCOUNT_NAME

• OPERATION

• PURCHASE_TYPE

• REGION

• SERVICE

• USAGE_TYPE

• USAGE_TYPE_GROUP

• RECORD_TYPE

• OPERATING_SYSTEM

• TENANCY

• SCOPE

• PLATFORM

• SUBSCRIPTION_ID

• LEGAL_ENTITY_NAME

• DEPLOYMENT_OPTION

• DATABASE_ENGINE

• INSTANCE_TYPE_FAMILY

• BILLING_ENTITY

• RESERVATION_ID

• SAVINGS_PLAN_ARN

Definition at line 218 of file GetCostForecastRequest.h.

GetGranularity()

const Granularity& Aws::CostExplorer::Model::GetCostForecastRequest::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 GetCostForecast operation supports only DAILY and MONTHLY granularities.

Definition at line 156 of file GetCostForecastRequest.h.

GetMetric()

const Metric& Aws::CostExplorer::Model::GetCostForecastRequest::GetMetric ( ) const

inline

Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.

Valid values for a GetCostForecast call are the following:

• AMORTIZED_COST

• BLENDED_COST

• NET_AMORTIZED_COST

• NET_UNBLENDED_COST

• UNBLENDED_COST

Definition at line 87 of file GetCostForecastRequest.h.

GetPredictionIntervalLevel()

int Aws::CostExplorer::Model::GetCostForecastRequest::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 333 of file GetCostForecastRequest.h.

GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::CostExplorer::Model::GetCostForecastRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::CostExplorer::CostExplorerRequest.

GetServiceRequestName()

virtual const char* Aws::CostExplorer::Model::GetCostForecastRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file GetCostForecastRequest.h.

GetTimePeriod()

const DateInterval& Aws::CostExplorer::Model::GetCostForecastRequest::GetTimePeriod ( ) const

inline

The period of time that you want the forecast to cover. The start date must be equal to or no later than the current date to avoid a validation error.

Definition at line 44 of file GetCostForecastRequest.h.

GranularityHasBeenSet()

bool Aws::CostExplorer::Model::GetCostForecastRequest::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 GetCostForecast operation supports only DAILY and MONTHLY granularities.

Definition at line 164 of file GetCostForecastRequest.h.

MetricHasBeenSet()

bool Aws::CostExplorer::Model::GetCostForecastRequest::MetricHasBeenSet ( ) const

inline

Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.

Valid values for a GetCostForecast call are the following:

• AMORTIZED_COST

• BLENDED_COST

• NET_AMORTIZED_COST

• NET_UNBLENDED_COST

• UNBLENDED_COST

Definition at line 99 of file GetCostForecastRequest.h.

PredictionIntervalLevelHasBeenSet()

bool Aws::CostExplorer::Model::GetCostForecastRequest::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 342 of file GetCostForecastRequest.h.

SerializePayload()

Aws::String Aws::CostExplorer::Model::GetCostForecastRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetFilter() [1/2]

void Aws::CostExplorer::Model::GetCostForecastRequest::SetFilter ( const Expression &  value )

inline

The filters that you want to use to filter your forecast. The GetCostForecast API supports filtering by the following dimensions:

• AZ

• INSTANCE_TYPE

• LINKED_ACCOUNT

• LINKED_ACCOUNT_NAME

• OPERATION

• PURCHASE_TYPE

• REGION

• SERVICE

• USAGE_TYPE

• USAGE_TYPE_GROUP

• RECORD_TYPE

• OPERATING_SYSTEM

• TENANCY

• SCOPE

• PLATFORM

• SUBSCRIPTION_ID

• LEGAL_ENTITY_NAME

• DEPLOYMENT_OPTION

• DATABASE_ENGINE

• INSTANCE_TYPE_FAMILY

• BILLING_ENTITY

• RESERVATION_ID

• SAVINGS_PLAN_ARN

Definition at line 260 of file GetCostForecastRequest.h.

SetFilter() [2/2]

void Aws::CostExplorer::Model::GetCostForecastRequest::SetFilter ( Expression &&  value )

inline

The filters that you want to use to filter your forecast. The GetCostForecast API supports filtering by the following dimensions:

• AZ

• INSTANCE_TYPE

• LINKED_ACCOUNT

• LINKED_ACCOUNT_NAME

• OPERATION

• PURCHASE_TYPE

• REGION

• SERVICE

• USAGE_TYPE

• USAGE_TYPE_GROUP

• RECORD_TYPE

• OPERATING_SYSTEM

• TENANCY

• SCOPE

• PLATFORM

• SUBSCRIPTION_ID

• LEGAL_ENTITY_NAME

• DEPLOYMENT_OPTION

• DATABASE_ENGINE

• INSTANCE_TYPE_FAMILY

• BILLING_ENTITY

• RESERVATION_ID

• SAVINGS_PLAN_ARN

Definition at line 281 of file GetCostForecastRequest.h.

SetGranularity() [1/2]

void Aws::CostExplorer::Model::GetCostForecastRequest::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 GetCostForecast operation supports only DAILY and MONTHLY granularities.

Definition at line 172 of file GetCostForecastRequest.h.

SetGranularity() [2/2]

void Aws::CostExplorer::Model::GetCostForecastRequest::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 GetCostForecast operation supports only DAILY and MONTHLY granularities.

Definition at line 180 of file GetCostForecastRequest.h.

SetMetric() [1/2]

void Aws::CostExplorer::Model::GetCostForecastRequest::SetMetric ( const Metric &  value )

inline

Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.

Valid values for a GetCostForecast call are the following:

• AMORTIZED_COST

• BLENDED_COST

• NET_AMORTIZED_COST

• NET_UNBLENDED_COST

• UNBLENDED_COST

Definition at line 111 of file GetCostForecastRequest.h.

SetMetric() [2/2]

void Aws::CostExplorer::Model::GetCostForecastRequest::SetMetric ( Metric &&  value )

inline

Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.

Valid values for a GetCostForecast call are the following:

• AMORTIZED_COST

• BLENDED_COST

• NET_AMORTIZED_COST

• NET_UNBLENDED_COST

• UNBLENDED_COST

Definition at line 123 of file GetCostForecastRequest.h.

SetPredictionIntervalLevel()

void Aws::CostExplorer::Model::GetCostForecastRequest::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 351 of file GetCostForecastRequest.h.

SetTimePeriod() [1/2]

void Aws::CostExplorer::Model::GetCostForecastRequest::SetTimePeriod ( const DateInterval &  value )

inline

The period of time that you want the forecast to cover. The start date must be equal to or no later than the current date to avoid a validation error.

Definition at line 56 of file GetCostForecastRequest.h.

SetTimePeriod() [2/2]

void Aws::CostExplorer::Model::GetCostForecastRequest::SetTimePeriod ( DateInterval &&  value )

inline

The period of time that you want the forecast to cover. The start date must be equal to or no later than the current date to avoid a validation error.

Definition at line 62 of file GetCostForecastRequest.h.

TimePeriodHasBeenSet()

bool Aws::CostExplorer::Model::GetCostForecastRequest::TimePeriodHasBeenSet ( ) const

inline

The period of time that you want the forecast to cover. The start date must be equal to or no later than the current date to avoid a validation error.

Definition at line 50 of file GetCostForecastRequest.h.

WithFilter() [1/2]

GetCostForecastRequest& Aws::CostExplorer::Model::GetCostForecastRequest::WithFilter ( const Expression &  value )

inline

The filters that you want to use to filter your forecast. The GetCostForecast API supports filtering by the following dimensions:

• AZ

• INSTANCE_TYPE

• LINKED_ACCOUNT

• LINKED_ACCOUNT_NAME

• OPERATION

• PURCHASE_TYPE

• REGION

• SERVICE

• USAGE_TYPE

• USAGE_TYPE_GROUP

• RECORD_TYPE

• OPERATING_SYSTEM

• TENANCY

• SCOPE

• PLATFORM

• SUBSCRIPTION_ID

• LEGAL_ENTITY_NAME

• DEPLOYMENT_OPTION

• DATABASE_ENGINE

• INSTANCE_TYPE_FAMILY

• BILLING_ENTITY

• RESERVATION_ID

• SAVINGS_PLAN_ARN

Definition at line 302 of file GetCostForecastRequest.h.

WithFilter() [2/2]

GetCostForecastRequest& Aws::CostExplorer::Model::GetCostForecastRequest::WithFilter ( Expression &&  value )

inline

The filters that you want to use to filter your forecast. The GetCostForecast API supports filtering by the following dimensions:

• AZ

• INSTANCE_TYPE

• LINKED_ACCOUNT

• LINKED_ACCOUNT_NAME

• OPERATION

• PURCHASE_TYPE

• REGION

• SERVICE

• USAGE_TYPE

• USAGE_TYPE_GROUP

• RECORD_TYPE

• OPERATING_SYSTEM

• TENANCY

• SCOPE

• PLATFORM

• SUBSCRIPTION_ID

• LEGAL_ENTITY_NAME

• DEPLOYMENT_OPTION

• DATABASE_ENGINE

• INSTANCE_TYPE_FAMILY

• BILLING_ENTITY

• RESERVATION_ID

• SAVINGS_PLAN_ARN

Definition at line 323 of file GetCostForecastRequest.h.

WithGranularity() [1/2]

GetCostForecastRequest& Aws::CostExplorer::Model::GetCostForecastRequest::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 GetCostForecast operation supports only DAILY and MONTHLY granularities.

Definition at line 188 of file GetCostForecastRequest.h.

WithGranularity() [2/2]

GetCostForecastRequest& Aws::CostExplorer::Model::GetCostForecastRequest::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 GetCostForecast operation supports only DAILY and MONTHLY granularities.

Definition at line 196 of file GetCostForecastRequest.h.

WithMetric() [1/2]

GetCostForecastRequest& Aws::CostExplorer::Model::GetCostForecastRequest::WithMetric ( const Metric &  value )

inline

Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.

Valid values for a GetCostForecast call are the following:

• AMORTIZED_COST

• BLENDED_COST

• NET_AMORTIZED_COST

• NET_UNBLENDED_COST

• UNBLENDED_COST

Definition at line 135 of file GetCostForecastRequest.h.

WithMetric() [2/2]

GetCostForecastRequest& Aws::CostExplorer::Model::GetCostForecastRequest::WithMetric ( Metric &&  value )

inline

Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.

Valid values for a GetCostForecast call are the following:

• AMORTIZED_COST

• BLENDED_COST

• NET_AMORTIZED_COST

• NET_UNBLENDED_COST

• UNBLENDED_COST

Definition at line 147 of file GetCostForecastRequest.h.

WithPredictionIntervalLevel()

GetCostForecastRequest& Aws::CostExplorer::Model::GetCostForecastRequest::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 360 of file GetCostForecastRequest.h.

WithTimePeriod() [1/2]

GetCostForecastRequest& Aws::CostExplorer::Model::GetCostForecastRequest::WithTimePeriod ( const DateInterval &  value )

inline

The period of time that you want the forecast to cover. The start date must be equal to or no later than the current date to avoid a validation error.

Definition at line 68 of file GetCostForecastRequest.h.

WithTimePeriod() [2/2]

GetCostForecastRequest& Aws::CostExplorer::Model::GetCostForecastRequest::WithTimePeriod ( DateInterval &&  value )

inline

The period of time that you want the forecast to cover. The start date must be equal to or no later than the current date to avoid a validation error.

Definition at line 74 of file GetCostForecastRequest.h.

---

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

• aws-cpp-sdk-ce/include/aws/ce/model/GetCostForecastRequest.h