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

#include <GetCostAndUsageRequest.h>

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

Public Member Functions

 GetCostAndUsageRequest ()
 
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)
 
GetCostAndUsageRequestWithTimePeriod (const DateInterval &value)
 
GetCostAndUsageRequestWithTimePeriod (DateInterval &&value)
 
const GranularityGetGranularity () const
 
bool GranularityHasBeenSet () const
 
void SetGranularity (const Granularity &value)
 
void SetGranularity (Granularity &&value)
 
GetCostAndUsageRequestWithGranularity (const Granularity &value)
 
GetCostAndUsageRequestWithGranularity (Granularity &&value)
 
const ExpressionGetFilter () const
 
bool FilterHasBeenSet () const
 
void SetFilter (const Expression &value)
 
void SetFilter (Expression &&value)
 
GetCostAndUsageRequestWithFilter (const Expression &value)
 
GetCostAndUsageRequestWithFilter (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)
 
GetCostAndUsageRequestWithMetrics (const Aws::Vector< Aws::String > &value)
 
GetCostAndUsageRequestWithMetrics (Aws::Vector< Aws::String > &&value)
 
GetCostAndUsageRequestAddMetrics (const Aws::String &value)
 
GetCostAndUsageRequestAddMetrics (Aws::String &&value)
 
GetCostAndUsageRequestAddMetrics (const char *value)
 
const Aws::Vector< GroupDefinition > & GetGroupBy () const
 
bool GroupByHasBeenSet () const
 
void SetGroupBy (const Aws::Vector< GroupDefinition > &value)
 
void SetGroupBy (Aws::Vector< GroupDefinition > &&value)
 
GetCostAndUsageRequestWithGroupBy (const Aws::Vector< GroupDefinition > &value)
 
GetCostAndUsageRequestWithGroupBy (Aws::Vector< GroupDefinition > &&value)
 
GetCostAndUsageRequestAddGroupBy (const GroupDefinition &value)
 
GetCostAndUsageRequestAddGroupBy (GroupDefinition &&value)
 
const Aws::StringGetNextPageToken () const
 
bool NextPageTokenHasBeenSet () const
 
void SetNextPageToken (const Aws::String &value)
 
void SetNextPageToken (Aws::String &&value)
 
void SetNextPageToken (const char *value)
 
GetCostAndUsageRequestWithNextPageToken (const Aws::String &value)
 
GetCostAndUsageRequestWithNextPageToken (Aws::String &&value)
 
GetCostAndUsageRequestWithNextPageToken (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::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 26 of file GetCostAndUsageRequest.h.

Constructor & Destructor Documentation

◆ GetCostAndUsageRequest()

Aws::CostExplorer::Model::GetCostAndUsageRequest::GetCostAndUsageRequest ( )

Member Function Documentation

◆ AddGroupBy() [1/2]

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

You can group AWS costs using up to two different groups, either dimensions, tag keys, cost categories, or any two group by types.

When you group by tag key, you get all tag values, including empty strings.

Valid values are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TAGS, TENANCY, RECORD_TYPE, and USAGE_TYPE.

Definition at line 469 of file GetCostAndUsageRequest.h.

◆ AddGroupBy() [2/2]

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

You can group AWS costs using up to two different groups, either dimensions, tag keys, cost categories, or any two group by types.

When you group by tag key, you get all tag values, including empty strings.

Valid values are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TAGS, TENANCY, RECORD_TYPE, and USAGE_TYPE.

Definition at line 480 of file GetCostAndUsageRequest.h.

◆ AddMetrics() [1/3]

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

Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.

Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

If you return the UsageQuantity metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.

Metrics is required for GetCostAndUsage requests.

Definition at line 351 of file GetCostAndUsageRequest.h.

◆ AddMetrics() [2/3]

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

Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.

Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

If you return the UsageQuantity metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.

Metrics is required for GetCostAndUsage requests.

Definition at line 371 of file GetCostAndUsageRequest.h.

◆ AddMetrics() [3/3]

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

Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.

Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

If you return the UsageQuantity metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.

Metrics is required for GetCostAndUsage requests.

Definition at line 391 of file GetCostAndUsageRequest.h.

◆ FilterHasBeenSet()

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

Filters AWS costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression.

Definition at line 166 of file GetCostAndUsageRequest.h.

◆ GetFilter()

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

Filters AWS costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression.

Definition at line 155 of file GetCostAndUsageRequest.h.

◆ GetGranularity()

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

Sets the AWS cost granularity to MONTHLY or DAILY, or HOURLY. If Granularity isn't set, the response object doesn't include the Granularity, either MONTHLY or DAILY, or HOURLY.

Definition at line 103 of file GetCostAndUsageRequest.h.

◆ GetGroupBy()

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

You can group AWS costs using up to two different groups, either dimensions, tag keys, cost categories, or any two group by types.

When you group by tag key, you get all tag values, including empty strings.

Valid values are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TAGS, TENANCY, RECORD_TYPE, and USAGE_TYPE.

Definition at line 403 of file GetCostAndUsageRequest.h.

◆ GetMetrics()

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

Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.

Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

If you return the UsageQuantity metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.

Metrics is required for GetCostAndUsage requests.

Definition at line 231 of file GetCostAndUsageRequest.h.

◆ GetNextPageToken()

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

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file GetCostAndUsageRequest.h.

◆ GetTimePeriod()

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

Sets the start and end dates for retrieving AWS costs. 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 49 of file GetCostAndUsageRequest.h.

◆ GranularityHasBeenSet()

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

Sets the AWS cost granularity to MONTHLY or DAILY, or HOURLY. If Granularity isn't set, the response object doesn't include the Granularity, either MONTHLY or DAILY, or HOURLY.

Definition at line 111 of file GetCostAndUsageRequest.h.

◆ GroupByHasBeenSet()

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

You can group AWS costs using up to two different groups, either dimensions, tag keys, cost categories, or any two group by types.

When you group by tag key, you get all tag values, including empty strings.

Valid values are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TAGS, TENANCY, RECORD_TYPE, and USAGE_TYPE.

Definition at line 414 of file GetCostAndUsageRequest.h.

◆ MetricsHasBeenSet()

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

Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.

Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

If you return the UsageQuantity metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.

Metrics is required for GetCostAndUsage requests.

Definition at line 251 of file GetCostAndUsageRequest.h.

◆ NextPageTokenHasBeenSet()

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

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetFilter() [1/2]

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

Filters AWS costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression.

Definition at line 177 of file GetCostAndUsageRequest.h.

◆ SetFilter() [2/2]

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

Filters AWS costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression.

Definition at line 188 of file GetCostAndUsageRequest.h.

◆ SetGranularity() [1/2]

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

Sets the AWS cost granularity to MONTHLY or DAILY, or HOURLY. If Granularity isn't set, the response object doesn't include the Granularity, either MONTHLY or DAILY, or HOURLY.

Definition at line 119 of file GetCostAndUsageRequest.h.

◆ SetGranularity() [2/2]

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

Sets the AWS cost granularity to MONTHLY or DAILY, or HOURLY. If Granularity isn't set, the response object doesn't include the Granularity, either MONTHLY or DAILY, or HOURLY.

Definition at line 127 of file GetCostAndUsageRequest.h.

◆ SetGroupBy() [1/2]

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

You can group AWS costs using up to two different groups, either dimensions, tag keys, cost categories, or any two group by types.

When you group by tag key, you get all tag values, including empty strings.

Valid values are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TAGS, TENANCY, RECORD_TYPE, and USAGE_TYPE.

Definition at line 425 of file GetCostAndUsageRequest.h.

◆ SetGroupBy() [2/2]

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

You can group AWS costs using up to two different groups, either dimensions, tag keys, cost categories, or any two group by types.

When you group by tag key, you get all tag values, including empty strings.

Valid values are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TAGS, TENANCY, RECORD_TYPE, and USAGE_TYPE.

Definition at line 436 of file GetCostAndUsageRequest.h.

◆ SetMetrics() [1/2]

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

Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.

Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

If you return the UsageQuantity metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.

Metrics is required for GetCostAndUsage requests.

Definition at line 271 of file GetCostAndUsageRequest.h.

◆ SetMetrics() [2/2]

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

Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.

Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

If you return the UsageQuantity metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.

Metrics is required for GetCostAndUsage requests.

Definition at line 291 of file GetCostAndUsageRequest.h.

◆ SetNextPageToken() [1/3]

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

◆ SetNextPageToken() [2/3]

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

◆ SetNextPageToken() [3/3]

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

◆ SetTimePeriod() [1/2]

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

Sets the start and end dates for retrieving AWS costs. 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 GetCostAndUsageRequest.h.

◆ SetTimePeriod() [2/2]

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

Sets the start and end dates for retrieving AWS costs. 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 76 of file GetCostAndUsageRequest.h.

◆ TimePeriodHasBeenSet()

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

Sets the start and end dates for retrieving AWS costs. 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 58 of file GetCostAndUsageRequest.h.

◆ WithFilter() [1/2]

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

Filters AWS costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression.

Definition at line 199 of file GetCostAndUsageRequest.h.

◆ WithFilter() [2/2]

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

Filters AWS costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression.

Definition at line 210 of file GetCostAndUsageRequest.h.

◆ WithGranularity() [1/2]

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

Sets the AWS cost granularity to MONTHLY or DAILY, or HOURLY. If Granularity isn't set, the response object doesn't include the Granularity, either MONTHLY or DAILY, or HOURLY.

Definition at line 135 of file GetCostAndUsageRequest.h.

◆ WithGranularity() [2/2]

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

Sets the AWS cost granularity to MONTHLY or DAILY, or HOURLY. If Granularity isn't set, the response object doesn't include the Granularity, either MONTHLY or DAILY, or HOURLY.

Definition at line 143 of file GetCostAndUsageRequest.h.

◆ WithGroupBy() [1/2]

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

You can group AWS costs using up to two different groups, either dimensions, tag keys, cost categories, or any two group by types.

When you group by tag key, you get all tag values, including empty strings.

Valid values are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TAGS, TENANCY, RECORD_TYPE, and USAGE_TYPE.

Definition at line 447 of file GetCostAndUsageRequest.h.

◆ WithGroupBy() [2/2]

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

You can group AWS costs using up to two different groups, either dimensions, tag keys, cost categories, or any two group by types.

When you group by tag key, you get all tag values, including empty strings.

Valid values are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TAGS, TENANCY, RECORD_TYPE, and USAGE_TYPE.

Definition at line 458 of file GetCostAndUsageRequest.h.

◆ WithMetrics() [1/2]

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

Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.

Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

If you return the UsageQuantity metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.

Metrics is required for GetCostAndUsage requests.

Definition at line 311 of file GetCostAndUsageRequest.h.

◆ WithMetrics() [2/2]

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

Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.

Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

If you return the UsageQuantity metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.

Metrics is required for GetCostAndUsage requests.

Definition at line 331 of file GetCostAndUsageRequest.h.

◆ WithNextPageToken() [1/3]

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

◆ WithNextPageToken() [2/3]

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

◆ WithNextPageToken() [3/3]

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

◆ WithTimePeriod() [1/2]

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

Sets the start and end dates for retrieving AWS costs. 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 85 of file GetCostAndUsageRequest.h.

◆ WithTimePeriod() [2/2]

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

Sets the start and end dates for retrieving AWS costs. 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 94 of file GetCostAndUsageRequest.h.


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