Aws::CostExplorer::Model::GetReservationUtilizationRequest Class Reference

#include <GetReservationUtilizationRequest.h>

Inheritance diagram for Aws::CostExplorer::Model::GetReservationUtilizationRequest:

Public Member Functions
	GetReservationUtilizationRequest ()
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)
GetReservationUtilizationRequest &	WithTimePeriod (const DateInterval &value)
GetReservationUtilizationRequest &	WithTimePeriod (DateInterval &&value)
const Aws::Vector< GroupDefinition > &	GetGroupBy () const
bool	GroupByHasBeenSet () const
void	SetGroupBy (const Aws::Vector< GroupDefinition > &value)
void	SetGroupBy (Aws::Vector< GroupDefinition > &&value)
GetReservationUtilizationRequest &	WithGroupBy (const Aws::Vector< GroupDefinition > &value)
GetReservationUtilizationRequest &	WithGroupBy (Aws::Vector< GroupDefinition > &&value)
GetReservationUtilizationRequest &	AddGroupBy (const GroupDefinition &value)
GetReservationUtilizationRequest &	AddGroupBy (GroupDefinition &&value)
const Granularity &	GetGranularity () const
bool	GranularityHasBeenSet () const
void	SetGranularity (const Granularity &value)
void	SetGranularity (Granularity &&value)
GetReservationUtilizationRequest &	WithGranularity (const Granularity &value)
GetReservationUtilizationRequest &	WithGranularity (Granularity &&value)
const Expression &	GetFilter () const
bool	FilterHasBeenSet () const
void	SetFilter (const Expression &value)
void	SetFilter (Expression &&value)
GetReservationUtilizationRequest &	WithFilter (const Expression &value)
GetReservationUtilizationRequest &	WithFilter (Expression &&value)
const Aws::String &	GetNextPageToken () const
bool	NextPageTokenHasBeenSet () const
void	SetNextPageToken (const Aws::String &value)
void	SetNextPageToken (Aws::String &&value)
void	SetNextPageToken (const char *value)
GetReservationUtilizationRequest &	WithNextPageToken (const Aws::String &value)
GetReservationUtilizationRequest &	WithNextPageToken (Aws::String &&value)
GetReservationUtilizationRequest &	WithNextPageToken (const char *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 26 of file GetReservationUtilizationRequest.h.

Constructor & Destructor Documentation

GetReservationUtilizationRequest()

Aws::CostExplorer::Model::GetReservationUtilizationRequest::GetReservationUtilizationRequest

(

)

Member Function Documentation

AddGroupBy() [1/2]

GetReservationUtilizationRequest& Aws::CostExplorer::Model::GetReservationUtilizationRequest::AddGroupBy ( const GroupDefinition &  value )

inline

Groups only by SUBSCRIPTION_ID. Metadata is included.

Definition at line 136 of file GetReservationUtilizationRequest.h.

AddGroupBy() [2/2]

GetReservationUtilizationRequest& Aws::CostExplorer::Model::GetReservationUtilizationRequest::AddGroupBy ( GroupDefinition &&  value )

inline

Groups only by SUBSCRIPTION_ID. Metadata is included.

Definition at line 141 of file GetReservationUtilizationRequest.h.

FilterHasBeenSet()

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

inline

Filters utilization data by dimensions. You can filter by the following dimensions:

• AZ

• CACHE_ENGINE

• DEPLOYMENT_OPTION

• INSTANCE_TYPE

• LINKED_ACCOUNT

• OPERATING_SYSTEM

• PLATFORM

• REGION

• SERVICE

• SCOPE

• TENANCY

GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.

Definition at line 239 of file GetReservationUtilizationRequest.h.

GetFilter()

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

inline

Filters utilization data by dimensions. You can filter by the following dimensions:

• AZ

• CACHE_ENGINE

• DEPLOYMENT_OPTION

• INSTANCE_TYPE

• LINKED_ACCOUNT

• OPERATING_SYSTEM

• PLATFORM

• REGION

• SERVICE

• SCOPE

• TENANCY

GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.

Definition at line 224 of file GetReservationUtilizationRequest.h.

GetGranularity()

const Granularity& Aws::CostExplorer::Model::GetReservationUtilizationRequest::GetGranularity ( ) const

inline

If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY.

The GetReservationUtilization operation supports only DAILY and MONTHLY granularities.

Definition at line 153 of file GetReservationUtilizationRequest.h.

GetGroupBy()

const Aws::Vector<GroupDefinition>& Aws::CostExplorer::Model::GetReservationUtilizationRequest::GetGroupBy ( ) const

inline

Groups only by SUBSCRIPTION_ID. Metadata is included.

Definition at line 106 of file GetReservationUtilizationRequest.h.

GetNextPageToken()

const Aws::String& Aws::CostExplorer::Model::GetReservationUtilizationRequest::GetNextPageToken ( ) const

inline

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

Definition at line 307 of file GetReservationUtilizationRequest.h.

GetRequestSpecificHeaders()

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

overridevirtual

Reimplemented from Aws::CostExplorer::CostExplorerRequest.

GetServiceRequestName()

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

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file GetReservationUtilizationRequest.h.

GetTimePeriod()

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

inline

Sets the start and end dates for retrieving RI utilization. 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.

Definition at line 50 of file GetReservationUtilizationRequest.h.

GranularityHasBeenSet()

bool Aws::CostExplorer::Model::GetReservationUtilizationRequest::GranularityHasBeenSet ( ) const

inline

If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY.

The GetReservationUtilization operation supports only DAILY and MONTHLY granularities.

Definition at line 164 of file GetReservationUtilizationRequest.h.

GroupByHasBeenSet()

bool Aws::CostExplorer::Model::GetReservationUtilizationRequest::GroupByHasBeenSet ( ) const

inline

Groups only by SUBSCRIPTION_ID. Metadata is included.

Definition at line 111 of file GetReservationUtilizationRequest.h.

NextPageTokenHasBeenSet()

bool Aws::CostExplorer::Model::GetReservationUtilizationRequest::NextPageTokenHasBeenSet ( ) const

inline

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

Definition at line 314 of file GetReservationUtilizationRequest.h.

SerializePayload()

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

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetFilter() [1/2]

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

inline

Filters utilization data by dimensions. You can filter by the following dimensions:

• AZ

• CACHE_ENGINE

• DEPLOYMENT_OPTION

• INSTANCE_TYPE

• LINKED_ACCOUNT

• OPERATING_SYSTEM

• PLATFORM

• REGION

• SERVICE

• SCOPE

• TENANCY

GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.

Definition at line 254 of file GetReservationUtilizationRequest.h.

SetFilter() [2/2]

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

inline

Filters utilization data by dimensions. You can filter by the following dimensions:

• AZ

• CACHE_ENGINE

• DEPLOYMENT_OPTION

• INSTANCE_TYPE

• LINKED_ACCOUNT

• OPERATING_SYSTEM

• PLATFORM

• REGION

• SERVICE

• SCOPE

• TENANCY

GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.

Definition at line 269 of file GetReservationUtilizationRequest.h.

SetGranularity() [1/2]

void Aws::CostExplorer::Model::GetReservationUtilizationRequest::SetGranularity ( const Granularity &  value )

inline

If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY.

The GetReservationUtilization operation supports only DAILY and MONTHLY granularities.

Definition at line 175 of file GetReservationUtilizationRequest.h.

SetGranularity() [2/2]

void Aws::CostExplorer::Model::GetReservationUtilizationRequest::SetGranularity ( Granularity &&  value )

inline

If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY.

The GetReservationUtilization operation supports only DAILY and MONTHLY granularities.

Definition at line 186 of file GetReservationUtilizationRequest.h.

SetGroupBy() [1/2]

void Aws::CostExplorer::Model::GetReservationUtilizationRequest::SetGroupBy ( const Aws::Vector< GroupDefinition > &  value )

inline

Groups only by SUBSCRIPTION_ID. Metadata is included.

Definition at line 116 of file GetReservationUtilizationRequest.h.

SetGroupBy() [2/2]

void Aws::CostExplorer::Model::GetReservationUtilizationRequest::SetGroupBy ( Aws::Vector< GroupDefinition > &&  value )

inline

Groups only by SUBSCRIPTION_ID. Metadata is included.

Definition at line 121 of file GetReservationUtilizationRequest.h.

SetNextPageToken() [1/3]

void Aws::CostExplorer::Model::GetReservationUtilizationRequest::SetNextPageToken ( const Aws::String &  value )

inline

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

Definition at line 321 of file GetReservationUtilizationRequest.h.

SetNextPageToken() [2/3]

void Aws::CostExplorer::Model::GetReservationUtilizationRequest::SetNextPageToken ( Aws::String &&  value )

inline

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

Definition at line 328 of file GetReservationUtilizationRequest.h.

SetNextPageToken() [3/3]

void Aws::CostExplorer::Model::GetReservationUtilizationRequest::SetNextPageToken ( const char *  value )

inline

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

Definition at line 335 of file GetReservationUtilizationRequest.h.

SetTimePeriod() [1/2]

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

inline

Sets the start and end dates for retrieving RI utilization. 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.

Definition at line 70 of file GetReservationUtilizationRequest.h.

SetTimePeriod() [2/2]

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

inline

Sets the start and end dates for retrieving RI utilization. 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.

Definition at line 80 of file GetReservationUtilizationRequest.h.

TimePeriodHasBeenSet()

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

inline

Sets the start and end dates for retrieving RI utilization. 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.

Definition at line 60 of file GetReservationUtilizationRequest.h.

WithFilter() [1/2]

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

inline

Filters utilization data by dimensions. You can filter by the following dimensions:

• AZ

• CACHE_ENGINE

• DEPLOYMENT_OPTION

• INSTANCE_TYPE

• LINKED_ACCOUNT

• OPERATING_SYSTEM

• PLATFORM

• REGION

• SERVICE

• SCOPE

• TENANCY

GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.

Definition at line 284 of file GetReservationUtilizationRequest.h.

WithFilter() [2/2]

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

inline

Filters utilization data by dimensions. You can filter by the following dimensions:

• AZ

• CACHE_ENGINE

• DEPLOYMENT_OPTION

• INSTANCE_TYPE

• LINKED_ACCOUNT

• OPERATING_SYSTEM

• PLATFORM

• REGION

• SERVICE

• SCOPE

• TENANCY

GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.

Definition at line 299 of file GetReservationUtilizationRequest.h.

WithGranularity() [1/2]

GetReservationUtilizationRequest& Aws::CostExplorer::Model::GetReservationUtilizationRequest::WithGranularity ( const Granularity &  value )

inline

If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY.

The GetReservationUtilization operation supports only DAILY and MONTHLY granularities.

Definition at line 197 of file GetReservationUtilizationRequest.h.

WithGranularity() [2/2]

GetReservationUtilizationRequest& Aws::CostExplorer::Model::GetReservationUtilizationRequest::WithGranularity ( Granularity &&  value )

inline

If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY.

The GetReservationUtilization operation supports only DAILY and MONTHLY granularities.

Definition at line 208 of file GetReservationUtilizationRequest.h.

WithGroupBy() [1/2]

GetReservationUtilizationRequest& Aws::CostExplorer::Model::GetReservationUtilizationRequest::WithGroupBy ( const Aws::Vector< GroupDefinition > &  value )

inline

Groups only by SUBSCRIPTION_ID. Metadata is included.

Definition at line 126 of file GetReservationUtilizationRequest.h.

WithGroupBy() [2/2]

GetReservationUtilizationRequest& Aws::CostExplorer::Model::GetReservationUtilizationRequest::WithGroupBy ( Aws::Vector< GroupDefinition > &&  value )

inline

Groups only by SUBSCRIPTION_ID. Metadata is included.

Definition at line 131 of file GetReservationUtilizationRequest.h.

WithNextPageToken() [1/3]

GetReservationUtilizationRequest& Aws::CostExplorer::Model::GetReservationUtilizationRequest::WithNextPageToken ( const Aws::String &  value )

inline

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

Definition at line 342 of file GetReservationUtilizationRequest.h.

WithNextPageToken() [2/3]

GetReservationUtilizationRequest& Aws::CostExplorer::Model::GetReservationUtilizationRequest::WithNextPageToken ( Aws::String &&  value )

inline

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

Definition at line 349 of file GetReservationUtilizationRequest.h.

WithNextPageToken() [3/3]

GetReservationUtilizationRequest& Aws::CostExplorer::Model::GetReservationUtilizationRequest::WithNextPageToken ( const char *  value )

inline

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

Definition at line 356 of file GetReservationUtilizationRequest.h.

WithTimePeriod() [1/2]

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

inline

Sets the start and end dates for retrieving RI utilization. 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.

Definition at line 90 of file GetReservationUtilizationRequest.h.

WithTimePeriod() [2/2]

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

inline

Sets the start and end dates for retrieving RI utilization. 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.

Definition at line 100 of file GetReservationUtilizationRequest.h.

---

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

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