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

#include <GetReservationCoverageRequest.h>

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

Public Member Functions

 GetReservationCoverageRequest ()
 
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)
 
GetReservationCoverageRequestWithTimePeriod (const DateInterval &value)
 
GetReservationCoverageRequestWithTimePeriod (DateInterval &&value)
 
const Aws::Vector< GroupDefinition > & GetGroupBy () const
 
bool GroupByHasBeenSet () const
 
void SetGroupBy (const Aws::Vector< GroupDefinition > &value)
 
void SetGroupBy (Aws::Vector< GroupDefinition > &&value)
 
GetReservationCoverageRequestWithGroupBy (const Aws::Vector< GroupDefinition > &value)
 
GetReservationCoverageRequestWithGroupBy (Aws::Vector< GroupDefinition > &&value)
 
GetReservationCoverageRequestAddGroupBy (const GroupDefinition &value)
 
GetReservationCoverageRequestAddGroupBy (GroupDefinition &&value)
 
const GranularityGetGranularity () const
 
bool GranularityHasBeenSet () const
 
void SetGranularity (const Granularity &value)
 
void SetGranularity (Granularity &&value)
 
GetReservationCoverageRequestWithGranularity (const Granularity &value)
 
GetReservationCoverageRequestWithGranularity (Granularity &&value)
 
const ExpressionGetFilter () const
 
bool FilterHasBeenSet () const
 
void SetFilter (const Expression &value)
 
void SetFilter (Expression &&value)
 
GetReservationCoverageRequestWithFilter (const Expression &value)
 
GetReservationCoverageRequestWithFilter (Expression &&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)
 
GetReservationCoverageRequestWithMetrics (const Aws::Vector< Aws::String > &value)
 
GetReservationCoverageRequestWithMetrics (Aws::Vector< Aws::String > &&value)
 
GetReservationCoverageRequestAddMetrics (const Aws::String &value)
 
GetReservationCoverageRequestAddMetrics (Aws::String &&value)
 
GetReservationCoverageRequestAddMetrics (const char *value)
 
const Aws::StringGetNextPageToken () const
 
bool NextPageTokenHasBeenSet () const
 
void SetNextPageToken (const Aws::String &value)
 
void SetNextPageToken (Aws::String &&value)
 
void SetNextPageToken (const char *value)
 
GetReservationCoverageRequestWithNextPageToken (const Aws::String &value)
 
GetReservationCoverageRequestWithNextPageToken (Aws::String &&value)
 
GetReservationCoverageRequestWithNextPageToken (const char *value)
 
const SortDefinitionGetSortBy () const
 
bool SortByHasBeenSet () const
 
void SetSortBy (const SortDefinition &value)
 
void SetSortBy (SortDefinition &&value)
 
GetReservationCoverageRequestWithSortBy (const SortDefinition &value)
 
GetReservationCoverageRequestWithSortBy (SortDefinition &&value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
GetReservationCoverageRequestWithMaxResults (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

You can use the following request parameters to query for how much of your instance usage a reservation covered.

See Also:

AWS API Reference

Definition at line 31 of file GetReservationCoverageRequest.h.

Constructor & Destructor Documentation

◆ GetReservationCoverageRequest()

Aws::CostExplorer::Model::GetReservationCoverageRequest::GetReservationCoverageRequest ( )

Member Function Documentation

◆ AddGroupBy() [1/2]

GetReservationCoverageRequest& Aws::CostExplorer::Model::GetReservationCoverageRequest::AddGroupBy ( const GroupDefinition value)
inline

You can group the data by the following attributes:

  • AZ

  • CACHE_ENGINE

  • DATABASE_ENGINE

  • DEPLOYMENT_OPTION

  • INSTANCE_TYPE

  • LINKED_ACCOUNT

  • OPERATING_SYSTEM

  • PLATFORM

  • REGION

  • TENANCY

Definition at line 175 of file GetReservationCoverageRequest.h.

◆ AddGroupBy() [2/2]

GetReservationCoverageRequest& Aws::CostExplorer::Model::GetReservationCoverageRequest::AddGroupBy ( GroupDefinition &&  value)
inline

You can group the data by the following attributes:

  • AZ

  • CACHE_ENGINE

  • DATABASE_ENGINE

  • DEPLOYMENT_OPTION

  • INSTANCE_TYPE

  • LINKED_ACCOUNT

  • OPERATING_SYSTEM

  • PLATFORM

  • REGION

  • TENANCY

Definition at line 184 of file GetReservationCoverageRequest.h.

◆ AddMetrics() [1/3]

GetReservationCoverageRequest& Aws::CostExplorer::Model::GetReservationCoverageRequest::AddMetrics ( Aws::String &&  value)
inline

The measurement that you want your reservation coverage reported in.

Valid values are Hour, Unit, and Cost. You can use multiple values in a request.

Definition at line 411 of file GetReservationCoverageRequest.h.

◆ AddMetrics() [2/3]

GetReservationCoverageRequest& Aws::CostExplorer::Model::GetReservationCoverageRequest::AddMetrics ( const Aws::String value)
inline

The measurement that you want your reservation coverage reported in.

Valid values are Hour, Unit, and Cost. You can use multiple values in a request.

Definition at line 404 of file GetReservationCoverageRequest.h.

◆ AddMetrics() [3/3]

GetReservationCoverageRequest& Aws::CostExplorer::Model::GetReservationCoverageRequest::AddMetrics ( const char *  value)
inline

The measurement that you want your reservation coverage reported in.

Valid values are Hour, Unit, and Cost. You can use multiple values in a request.

Definition at line 418 of file GetReservationCoverageRequest.h.

◆ FilterHasBeenSet()

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

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

  • AZ

  • CACHE_ENGINE

  • DATABASE_ENGINE

  • DEPLOYMENT_OPTION

  • INSTANCE_TYPE

  • LINKED_ACCOUNT

  • OPERATING_SYSTEM

  • PLATFORM

  • REGION

  • SERVICE

  • TAG

  • TENANCY

GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.

If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.

Cost category is also supported.

Definition at line 286 of file GetReservationCoverageRequest.h.

◆ GetFilter()

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

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

  • AZ

  • CACHE_ENGINE

  • DATABASE_ENGINE

  • DEPLOYMENT_OPTION

  • INSTANCE_TYPE

  • LINKED_ACCOUNT

  • OPERATING_SYSTEM

  • PLATFORM

  • REGION

  • SERVICE

  • TAG

  • TENANCY

GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.

If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.

Cost category is also supported.

Definition at line 269 of file GetReservationCoverageRequest.h.

◆ GetGranularity()

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

The granularity of the AWS cost data for the reservation. Valid values are MONTHLY and DAILY.

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.

The GetReservationCoverage operation supports only DAILY and MONTHLY granularities.

Definition at line 196 of file GetReservationCoverageRequest.h.

◆ GetGroupBy()

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

You can group the data by the following attributes:

  • AZ

  • CACHE_ENGINE

  • DATABASE_ENGINE

  • DEPLOYMENT_OPTION

  • INSTANCE_TYPE

  • LINKED_ACCOUNT

  • OPERATING_SYSTEM

  • PLATFORM

  • REGION

  • TENANCY

Definition at line 121 of file GetReservationCoverageRequest.h.

◆ GetMaxResults()

int Aws::CostExplorer::Model::GetReservationCoverageRequest::GetMaxResults ( ) const
inline

The maximum number of objects that you returned for this request. If more objects are available, in the response, AWS provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.

Definition at line 574 of file GetReservationCoverageRequest.h.

◆ GetMetrics()

const Aws::Vector<Aws::String>& Aws::CostExplorer::Model::GetReservationCoverageRequest::GetMetrics ( ) const
inline

The measurement that you want your reservation coverage reported in.

Valid values are Hour, Unit, and Cost. You can use multiple values in a request.

Definition at line 362 of file GetReservationCoverageRequest.h.

◆ GetNextPageToken()

const Aws::String& Aws::CostExplorer::Model::GetReservationCoverageRequest::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 426 of file GetReservationCoverageRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 40 of file GetReservationCoverageRequest.h.

◆ GetSortBy()

const SortDefinition& Aws::CostExplorer::Model::GetReservationCoverageRequest::GetSortBy ( ) const
inline

The value by which you want to sort the data.

The following values are supported for Key:

  • OnDemandCost

  • CoverageHoursPercentage

  • OnDemandHours

  • ReservedHours

  • TotalRunningHours

  • CoverageNormalizedUnitsPercentage

  • OnDemandNormalizedUnits

  • ReservedNormalizedUnits

  • TotalRunningNormalizedUnits

  • Time

Supported values for SortOrder are ASCENDING or DESCENDING.

Definition at line 491 of file GetReservationCoverageRequest.h.

◆ GetTimePeriod()

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

The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. 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 56 of file GetReservationCoverageRequest.h.

◆ GranularityHasBeenSet()

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

The granularity of the AWS cost data for the reservation. Valid values are MONTHLY and DAILY.

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.

The GetReservationCoverage operation supports only DAILY and MONTHLY granularities.

Definition at line 207 of file GetReservationCoverageRequest.h.

◆ GroupByHasBeenSet()

bool Aws::CostExplorer::Model::GetReservationCoverageRequest::GroupByHasBeenSet ( ) const
inline

You can group the data by the following attributes:

  • AZ

  • CACHE_ENGINE

  • DATABASE_ENGINE

  • DEPLOYMENT_OPTION

  • INSTANCE_TYPE

  • LINKED_ACCOUNT

  • OPERATING_SYSTEM

  • PLATFORM

  • REGION

  • TENANCY

Definition at line 130 of file GetReservationCoverageRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::CostExplorer::Model::GetReservationCoverageRequest::MaxResultsHasBeenSet ( ) const
inline

The maximum number of objects that you returned for this request. If more objects are available, in the response, AWS provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.

Definition at line 581 of file GetReservationCoverageRequest.h.

◆ MetricsHasBeenSet()

bool Aws::CostExplorer::Model::GetReservationCoverageRequest::MetricsHasBeenSet ( ) const
inline

The measurement that you want your reservation coverage reported in.

Valid values are Hour, Unit, and Cost. You can use multiple values in a request.

Definition at line 369 of file GetReservationCoverageRequest.h.

◆ NextPageTokenHasBeenSet()

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

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetFilter() [1/2]

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

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

  • AZ

  • CACHE_ENGINE

  • DATABASE_ENGINE

  • DEPLOYMENT_OPTION

  • INSTANCE_TYPE

  • LINKED_ACCOUNT

  • OPERATING_SYSTEM

  • PLATFORM

  • REGION

  • SERVICE

  • TAG

  • TENANCY

GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.

If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.

Cost category is also supported.

Definition at line 303 of file GetReservationCoverageRequest.h.

◆ SetFilter() [2/2]

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

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

  • AZ

  • CACHE_ENGINE

  • DATABASE_ENGINE

  • DEPLOYMENT_OPTION

  • INSTANCE_TYPE

  • LINKED_ACCOUNT

  • OPERATING_SYSTEM

  • PLATFORM

  • REGION

  • SERVICE

  • TAG

  • TENANCY

GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.

If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.

Cost category is also supported.

Definition at line 320 of file GetReservationCoverageRequest.h.

◆ SetGranularity() [1/2]

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

The granularity of the AWS cost data for the reservation. Valid values are MONTHLY and DAILY.

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.

The GetReservationCoverage operation supports only DAILY and MONTHLY granularities.

Definition at line 218 of file GetReservationCoverageRequest.h.

◆ SetGranularity() [2/2]

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

The granularity of the AWS cost data for the reservation. Valid values are MONTHLY and DAILY.

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.

The GetReservationCoverage operation supports only DAILY and MONTHLY granularities.

Definition at line 229 of file GetReservationCoverageRequest.h.

◆ SetGroupBy() [1/2]

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

You can group the data by the following attributes:

  • AZ

  • CACHE_ENGINE

  • DATABASE_ENGINE

  • DEPLOYMENT_OPTION

  • INSTANCE_TYPE

  • LINKED_ACCOUNT

  • OPERATING_SYSTEM

  • PLATFORM

  • REGION

  • TENANCY

Definition at line 148 of file GetReservationCoverageRequest.h.

◆ SetGroupBy() [2/2]

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

You can group the data by the following attributes:

  • AZ

  • CACHE_ENGINE

  • DATABASE_ENGINE

  • DEPLOYMENT_OPTION

  • INSTANCE_TYPE

  • LINKED_ACCOUNT

  • OPERATING_SYSTEM

  • PLATFORM

  • REGION

  • TENANCY

Definition at line 139 of file GetReservationCoverageRequest.h.

◆ SetMaxResults()

void Aws::CostExplorer::Model::GetReservationCoverageRequest::SetMaxResults ( int  value)
inline

The maximum number of objects that you returned for this request. If more objects are available, in the response, AWS provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.

Definition at line 588 of file GetReservationCoverageRequest.h.

◆ SetMetrics() [1/2]

void Aws::CostExplorer::Model::GetReservationCoverageRequest::SetMetrics ( Aws::Vector< Aws::String > &&  value)
inline

The measurement that you want your reservation coverage reported in.

Valid values are Hour, Unit, and Cost. You can use multiple values in a request.

Definition at line 383 of file GetReservationCoverageRequest.h.

◆ SetMetrics() [2/2]

void Aws::CostExplorer::Model::GetReservationCoverageRequest::SetMetrics ( const Aws::Vector< Aws::String > &  value)
inline

The measurement that you want your reservation coverage reported in.

Valid values are Hour, Unit, and Cost. You can use multiple values in a request.

Definition at line 376 of file GetReservationCoverageRequest.h.

◆ SetNextPageToken() [1/3]

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

◆ SetNextPageToken() [2/3]

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

◆ SetNextPageToken() [3/3]

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

◆ SetSortBy() [1/2]

void Aws::CostExplorer::Model::GetReservationCoverageRequest::SetSortBy ( const SortDefinition value)
inline

The value by which you want to sort the data.

The following values are supported for Key:

  • OnDemandCost

  • CoverageHoursPercentage

  • OnDemandHours

  • ReservedHours

  • TotalRunningHours

  • CoverageNormalizedUnitsPercentage

  • OnDemandNormalizedUnits

  • ReservedNormalizedUnits

  • TotalRunningNormalizedUnits

  • Time

Supported values for SortOrder are ASCENDING or DESCENDING.

Definition at line 521 of file GetReservationCoverageRequest.h.

◆ SetSortBy() [2/2]

void Aws::CostExplorer::Model::GetReservationCoverageRequest::SetSortBy ( SortDefinition &&  value)
inline

The value by which you want to sort the data.

The following values are supported for Key:

  • OnDemandCost

  • CoverageHoursPercentage

  • OnDemandHours

  • ReservedHours

  • TotalRunningHours

  • CoverageNormalizedUnitsPercentage

  • OnDemandNormalizedUnits

  • ReservedNormalizedUnits

  • TotalRunningNormalizedUnits

  • Time

Supported values for SortOrder are ASCENDING or DESCENDING.

Definition at line 536 of file GetReservationCoverageRequest.h.

◆ SetTimePeriod() [1/2]

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

The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. 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 78 of file GetReservationCoverageRequest.h.

◆ SetTimePeriod() [2/2]

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

The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. 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 89 of file GetReservationCoverageRequest.h.

◆ SortByHasBeenSet()

bool Aws::CostExplorer::Model::GetReservationCoverageRequest::SortByHasBeenSet ( ) const
inline

The value by which you want to sort the data.

The following values are supported for Key:

  • OnDemandCost

  • CoverageHoursPercentage

  • OnDemandHours

  • ReservedHours

  • TotalRunningHours

  • CoverageNormalizedUnitsPercentage

  • OnDemandNormalizedUnits

  • ReservedNormalizedUnits

  • TotalRunningNormalizedUnits

  • Time

Supported values for SortOrder are ASCENDING or DESCENDING.

Definition at line 506 of file GetReservationCoverageRequest.h.

◆ TimePeriodHasBeenSet()

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

The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. 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 67 of file GetReservationCoverageRequest.h.

◆ WithFilter() [1/2]

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

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

  • AZ

  • CACHE_ENGINE

  • DATABASE_ENGINE

  • DEPLOYMENT_OPTION

  • INSTANCE_TYPE

  • LINKED_ACCOUNT

  • OPERATING_SYSTEM

  • PLATFORM

  • REGION

  • SERVICE

  • TAG

  • TENANCY

GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.

If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.

Cost category is also supported.

Definition at line 337 of file GetReservationCoverageRequest.h.

◆ WithFilter() [2/2]

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

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

  • AZ

  • CACHE_ENGINE

  • DATABASE_ENGINE

  • DEPLOYMENT_OPTION

  • INSTANCE_TYPE

  • LINKED_ACCOUNT

  • OPERATING_SYSTEM

  • PLATFORM

  • REGION

  • SERVICE

  • TAG

  • TENANCY

GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.

If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.

Cost category is also supported.

Definition at line 354 of file GetReservationCoverageRequest.h.

◆ WithGranularity() [1/2]

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

The granularity of the AWS cost data for the reservation. Valid values are MONTHLY and DAILY.

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.

The GetReservationCoverage operation supports only DAILY and MONTHLY granularities.

Definition at line 240 of file GetReservationCoverageRequest.h.

◆ WithGranularity() [2/2]

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

The granularity of the AWS cost data for the reservation. Valid values are MONTHLY and DAILY.

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.

The GetReservationCoverage operation supports only DAILY and MONTHLY granularities.

Definition at line 251 of file GetReservationCoverageRequest.h.

◆ WithGroupBy() [1/2]

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

You can group the data by the following attributes:

  • AZ

  • CACHE_ENGINE

  • DATABASE_ENGINE

  • DEPLOYMENT_OPTION

  • INSTANCE_TYPE

  • LINKED_ACCOUNT

  • OPERATING_SYSTEM

  • PLATFORM

  • REGION

  • TENANCY

Definition at line 166 of file GetReservationCoverageRequest.h.

◆ WithGroupBy() [2/2]

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

You can group the data by the following attributes:

  • AZ

  • CACHE_ENGINE

  • DATABASE_ENGINE

  • DEPLOYMENT_OPTION

  • INSTANCE_TYPE

  • LINKED_ACCOUNT

  • OPERATING_SYSTEM

  • PLATFORM

  • REGION

  • TENANCY

Definition at line 157 of file GetReservationCoverageRequest.h.

◆ WithMaxResults()

GetReservationCoverageRequest& Aws::CostExplorer::Model::GetReservationCoverageRequest::WithMaxResults ( int  value)
inline

The maximum number of objects that you returned for this request. If more objects are available, in the response, AWS provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.

Definition at line 595 of file GetReservationCoverageRequest.h.

◆ WithMetrics() [1/2]

GetReservationCoverageRequest& Aws::CostExplorer::Model::GetReservationCoverageRequest::WithMetrics ( Aws::Vector< Aws::String > &&  value)
inline

The measurement that you want your reservation coverage reported in.

Valid values are Hour, Unit, and Cost. You can use multiple values in a request.

Definition at line 397 of file GetReservationCoverageRequest.h.

◆ WithMetrics() [2/2]

GetReservationCoverageRequest& Aws::CostExplorer::Model::GetReservationCoverageRequest::WithMetrics ( const Aws::Vector< Aws::String > &  value)
inline

The measurement that you want your reservation coverage reported in.

Valid values are Hour, Unit, and Cost. You can use multiple values in a request.

Definition at line 390 of file GetReservationCoverageRequest.h.

◆ WithNextPageToken() [1/3]

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

◆ WithNextPageToken() [2/3]

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

◆ WithNextPageToken() [3/3]

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

◆ WithSortBy() [1/2]

GetReservationCoverageRequest& Aws::CostExplorer::Model::GetReservationCoverageRequest::WithSortBy ( const SortDefinition value)
inline

The value by which you want to sort the data.

The following values are supported for Key:

  • OnDemandCost

  • CoverageHoursPercentage

  • OnDemandHours

  • ReservedHours

  • TotalRunningHours

  • CoverageNormalizedUnitsPercentage

  • OnDemandNormalizedUnits

  • ReservedNormalizedUnits

  • TotalRunningNormalizedUnits

  • Time

Supported values for SortOrder are ASCENDING or DESCENDING.

Definition at line 551 of file GetReservationCoverageRequest.h.

◆ WithSortBy() [2/2]

GetReservationCoverageRequest& Aws::CostExplorer::Model::GetReservationCoverageRequest::WithSortBy ( SortDefinition &&  value)
inline

The value by which you want to sort the data.

The following values are supported for Key:

  • OnDemandCost

  • CoverageHoursPercentage

  • OnDemandHours

  • ReservedHours

  • TotalRunningHours

  • CoverageNormalizedUnitsPercentage

  • OnDemandNormalizedUnits

  • ReservedNormalizedUnits

  • TotalRunningNormalizedUnits

  • Time

Supported values for SortOrder are ASCENDING or DESCENDING.

Definition at line 566 of file GetReservationCoverageRequest.h.

◆ WithTimePeriod() [1/2]

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

The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. 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 GetReservationCoverageRequest.h.

◆ WithTimePeriod() [2/2]

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

The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. 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 111 of file GetReservationCoverageRequest.h.


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