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

#include <GetDimensionValuesRequest.h>

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

Public Member Functions

 GetDimensionValuesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetSearchString () const
 
bool SearchStringHasBeenSet () const
 
void SetSearchString (const Aws::String &value)
 
void SetSearchString (Aws::String &&value)
 
void SetSearchString (const char *value)
 
GetDimensionValuesRequestWithSearchString (const Aws::String &value)
 
GetDimensionValuesRequestWithSearchString (Aws::String &&value)
 
GetDimensionValuesRequestWithSearchString (const char *value)
 
const DateIntervalGetTimePeriod () const
 
bool TimePeriodHasBeenSet () const
 
void SetTimePeriod (const DateInterval &value)
 
void SetTimePeriod (DateInterval &&value)
 
GetDimensionValuesRequestWithTimePeriod (const DateInterval &value)
 
GetDimensionValuesRequestWithTimePeriod (DateInterval &&value)
 
const DimensionGetDimension () const
 
bool DimensionHasBeenSet () const
 
void SetDimension (const Dimension &value)
 
void SetDimension (Dimension &&value)
 
GetDimensionValuesRequestWithDimension (const Dimension &value)
 
GetDimensionValuesRequestWithDimension (Dimension &&value)
 
const ContextGetContext () const
 
bool ContextHasBeenSet () const
 
void SetContext (const Context &value)
 
void SetContext (Context &&value)
 
GetDimensionValuesRequestWithContext (const Context &value)
 
GetDimensionValuesRequestWithContext (Context &&value)
 
const ExpressionGetFilter () const
 
bool FilterHasBeenSet () const
 
void SetFilter (const Expression &value)
 
void SetFilter (Expression &&value)
 
GetDimensionValuesRequestWithFilter (const Expression &value)
 
GetDimensionValuesRequestWithFilter (Expression &&value)
 
const Aws::Vector< SortDefinition > & GetSortBy () const
 
bool SortByHasBeenSet () const
 
void SetSortBy (const Aws::Vector< SortDefinition > &value)
 
void SetSortBy (Aws::Vector< SortDefinition > &&value)
 
GetDimensionValuesRequestWithSortBy (const Aws::Vector< SortDefinition > &value)
 
GetDimensionValuesRequestWithSortBy (Aws::Vector< SortDefinition > &&value)
 
GetDimensionValuesRequestAddSortBy (const SortDefinition &value)
 
GetDimensionValuesRequestAddSortBy (SortDefinition &&value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
GetDimensionValuesRequestWithMaxResults (int value)
 
const Aws::StringGetNextPageToken () const
 
bool NextPageTokenHasBeenSet () const
 
void SetNextPageToken (const Aws::String &value)
 
void SetNextPageToken (Aws::String &&value)
 
void SetNextPageToken (const char *value)
 
GetDimensionValuesRequestWithNextPageToken (const Aws::String &value)
 
GetDimensionValuesRequestWithNextPageToken (Aws::String &&value)
 
GetDimensionValuesRequestWithNextPageToken (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 27 of file GetDimensionValuesRequest.h.

Constructor & Destructor Documentation

◆ GetDimensionValuesRequest()

Aws::CostExplorer::Model::GetDimensionValuesRequest::GetDimensionValuesRequest ( )

Member Function Documentation

◆ AddSortBy() [1/2]

GetDimensionValuesRequest& Aws::CostExplorer::Model::GetDimensionValuesRequest::AddSortBy ( const SortDefinition value)
inline

The value by which you want to sort the data.

The key represents cost and usage metrics. The following values are supported:

  • BlendedCost

  • UnblendedCost

  • AmortizedCost

  • NetAmortizedCost

  • NetUnblendedCost

  • UsageQuantity

  • NormalizedUsageAmount

Supported values for SortOrder are ASCENDING or DESCENDING.

When you specify a SortBy paramater, the context must be COST_AND_USAGE. Further, when using SortBy, NextPageToken and SearchString are not supported.

Definition at line 690 of file GetDimensionValuesRequest.h.

◆ AddSortBy() [2/2]

GetDimensionValuesRequest& Aws::CostExplorer::Model::GetDimensionValuesRequest::AddSortBy ( SortDefinition &&  value)
inline

The value by which you want to sort the data.

The key represents cost and usage metrics. The following values are supported:

  • BlendedCost

  • UnblendedCost

  • AmortizedCost

  • NetAmortizedCost

  • NetUnblendedCost

  • UsageQuantity

  • NormalizedUsageAmount

Supported values for SortOrder are ASCENDING or DESCENDING.

When you specify a SortBy paramater, the context must be COST_AND_USAGE. Further, when using SortBy, NextPageToken and SearchString are not supported.

Definition at line 706 of file GetDimensionValuesRequest.h.

◆ ContextHasBeenSet()

bool Aws::CostExplorer::Model::GetDimensionValuesRequest::ContextHasBeenSet ( ) const
inline

The context for the call to GetDimensionValues. This can be RESERVATIONS or COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to RESERVATIONS, the resulting dimension values can be used in the GetReservationUtilization operation. If the context is set to COST_AND_USAGE, the resulting dimension values can be used in the GetCostAndUsage operation.

If you set the context to COST_AND_USAGE, you can use the following dimensions for searching:

  • AZ - The Availability Zone. An example is us-east-1a.

  • DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.

  • INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

  • LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.

  • LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.

  • OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.

  • OPERATION - The action performed. Examples include RunInstance and CreateBucket.

  • PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

  • PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.

  • SERVICE - The AWS service such as Amazon DynamoDB.

  • USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.

  • USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.

  • REGION - The AWS Region.

  • RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.

  • RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.

If you set the context to RESERVATIONS, you can use the following dimensions for searching:

  • AZ - The Availability Zone. An example is us-east-1a.

  • CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.

  • DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.

  • INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

  • LINKED_ACCOUNT

    • The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.

  • PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

  • REGION - The AWS Region.

  • SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.

  • TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).

  • TENANCY - The tenancy of a resource. Examples are shared or dedicated.

If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:

  • SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)

  • PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)

  • REGION - The AWS Region.

  • INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)

  • LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.

  • SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan

Definition at line 306 of file GetDimensionValuesRequest.h.

◆ DimensionHasBeenSet()

bool Aws::CostExplorer::Model::GetDimensionValuesRequest::DimensionHasBeenSet ( ) const
inline

The name of the dimension. Each Dimension is available for a different Context. For more information, see Context.

Definition at line 151 of file GetDimensionValuesRequest.h.

◆ FilterHasBeenSet()

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

Definition at line 565 of file GetDimensionValuesRequest.h.

◆ GetContext()

const Context& Aws::CostExplorer::Model::GetDimensionValuesRequest::GetContext ( ) const
inline

The context for the call to GetDimensionValues. This can be RESERVATIONS or COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to RESERVATIONS, the resulting dimension values can be used in the GetReservationUtilization operation. If the context is set to COST_AND_USAGE, the resulting dimension values can be used in the GetCostAndUsage operation.

If you set the context to COST_AND_USAGE, you can use the following dimensions for searching:

  • AZ - The Availability Zone. An example is us-east-1a.

  • DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.

  • INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

  • LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.

  • LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.

  • OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.

  • OPERATION - The action performed. Examples include RunInstance and CreateBucket.

  • PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

  • PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.

  • SERVICE - The AWS service such as Amazon DynamoDB.

  • USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.

  • USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.

  • REGION - The AWS Region.

  • RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.

  • RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.

If you set the context to RESERVATIONS, you can use the following dimensions for searching:

  • AZ - The Availability Zone. An example is us-east-1a.

  • CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.

  • DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.

  • INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

  • LINKED_ACCOUNT

    • The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.

  • PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

  • REGION - The AWS Region.

  • SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.

  • TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).

  • TENANCY - The tenancy of a resource. Examples are shared or dedicated.

If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:

  • SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)

  • PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)

  • REGION - The AWS Region.

  • INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)

  • LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.

  • SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan

Definition at line 243 of file GetDimensionValuesRequest.h.

◆ GetDimension()

const Dimension& Aws::CostExplorer::Model::GetDimensionValuesRequest::GetDimension ( ) const
inline

The name of the dimension. Each Dimension is available for a different Context. For more information, see Context.

Definition at line 144 of file GetDimensionValuesRequest.h.

◆ GetFilter()

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

Definition at line 562 of file GetDimensionValuesRequest.h.

◆ GetMaxResults()

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

This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

For GetDimensionValues, MaxResults has an upper limit of 1000.

Definition at line 716 of file GetDimensionValuesRequest.h.

◆ GetNextPageToken()

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

◆ GetRequestSpecificHeaders()

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

◆ GetSearchString()

const Aws::String& Aws::CostExplorer::Model::GetDimensionValuesRequest::GetSearchString ( ) const
inline

The value that you want to search the filter values for.

Definition at line 46 of file GetDimensionValuesRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file GetDimensionValuesRequest.h.

◆ GetSortBy()

const Aws::Vector<SortDefinition>& Aws::CostExplorer::Model::GetDimensionValuesRequest::GetSortBy ( ) const
inline

The value by which you want to sort the data.

The key represents cost and usage metrics. The following values are supported:

  • BlendedCost

  • UnblendedCost

  • AmortizedCost

  • NetAmortizedCost

  • NetUnblendedCost

  • UsageQuantity

  • NormalizedUsageAmount

Supported values for SortOrder are ASCENDING or DESCENDING.

When you specify a SortBy paramater, the context must be COST_AND_USAGE. Further, when using SortBy, NextPageToken and SearchString are not supported.

Definition at line 594 of file GetDimensionValuesRequest.h.

◆ GetTimePeriod()

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

The start and end dates for retrieving the dimension values. 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 91 of file GetDimensionValuesRequest.h.

◆ MaxResultsHasBeenSet()

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

This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

For GetDimensionValues, MaxResults has an upper limit of 1000.

Definition at line 725 of file GetDimensionValuesRequest.h.

◆ NextPageTokenHasBeenSet()

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

◆ SearchStringHasBeenSet()

bool Aws::CostExplorer::Model::GetDimensionValuesRequest::SearchStringHasBeenSet ( ) const
inline

The value that you want to search the filter values for.

Definition at line 51 of file GetDimensionValuesRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetContext() [1/2]

void Aws::CostExplorer::Model::GetDimensionValuesRequest::SetContext ( const Context value)
inline

The context for the call to GetDimensionValues. This can be RESERVATIONS or COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to RESERVATIONS, the resulting dimension values can be used in the GetReservationUtilization operation. If the context is set to COST_AND_USAGE, the resulting dimension values can be used in the GetCostAndUsage operation.

If you set the context to COST_AND_USAGE, you can use the following dimensions for searching:

  • AZ - The Availability Zone. An example is us-east-1a.

  • DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.

  • INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

  • LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.

  • LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.

  • OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.

  • OPERATION - The action performed. Examples include RunInstance and CreateBucket.

  • PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

  • PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.

  • SERVICE - The AWS service such as Amazon DynamoDB.

  • USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.

  • USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.

  • REGION - The AWS Region.

  • RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.

  • RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.

If you set the context to RESERVATIONS, you can use the following dimensions for searching:

  • AZ - The Availability Zone. An example is us-east-1a.

  • CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.

  • DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.

  • INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

  • LINKED_ACCOUNT

    • The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.

  • PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

  • REGION - The AWS Region.

  • SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.

  • TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).

  • TENANCY - The tenancy of a resource. Examples are shared or dedicated.

If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:

  • SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)

  • PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)

  • REGION - The AWS Region.

  • INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)

  • LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.

  • SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan

Definition at line 369 of file GetDimensionValuesRequest.h.

◆ SetContext() [2/2]

void Aws::CostExplorer::Model::GetDimensionValuesRequest::SetContext ( Context &&  value)
inline

The context for the call to GetDimensionValues. This can be RESERVATIONS or COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to RESERVATIONS, the resulting dimension values can be used in the GetReservationUtilization operation. If the context is set to COST_AND_USAGE, the resulting dimension values can be used in the GetCostAndUsage operation.

If you set the context to COST_AND_USAGE, you can use the following dimensions for searching:

  • AZ - The Availability Zone. An example is us-east-1a.

  • DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.

  • INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

  • LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.

  • LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.

  • OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.

  • OPERATION - The action performed. Examples include RunInstance and CreateBucket.

  • PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

  • PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.

  • SERVICE - The AWS service such as Amazon DynamoDB.

  • USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.

  • USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.

  • REGION - The AWS Region.

  • RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.

  • RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.

If you set the context to RESERVATIONS, you can use the following dimensions for searching:

  • AZ - The Availability Zone. An example is us-east-1a.

  • CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.

  • DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.

  • INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

  • LINKED_ACCOUNT

    • The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.

  • PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

  • REGION - The AWS Region.

  • SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.

  • TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).

  • TENANCY - The tenancy of a resource. Examples are shared or dedicated.

If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:

  • SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)

  • PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)

  • REGION - The AWS Region.

  • INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)

  • LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.

  • SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan

Definition at line 432 of file GetDimensionValuesRequest.h.

◆ SetDimension() [1/2]

void Aws::CostExplorer::Model::GetDimensionValuesRequest::SetDimension ( const Dimension value)
inline

The name of the dimension. Each Dimension is available for a different Context. For more information, see Context.

Definition at line 158 of file GetDimensionValuesRequest.h.

◆ SetDimension() [2/2]

void Aws::CostExplorer::Model::GetDimensionValuesRequest::SetDimension ( Dimension &&  value)
inline

The name of the dimension. Each Dimension is available for a different Context. For more information, see Context.

Definition at line 165 of file GetDimensionValuesRequest.h.

◆ SetFilter() [1/2]

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

Definition at line 568 of file GetDimensionValuesRequest.h.

◆ SetFilter() [2/2]

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

Definition at line 571 of file GetDimensionValuesRequest.h.

◆ SetMaxResults()

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

This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

For GetDimensionValues, MaxResults has an upper limit of 1000.

Definition at line 734 of file GetDimensionValuesRequest.h.

◆ SetNextPageToken() [1/3]

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

◆ SetNextPageToken() [2/3]

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

◆ SetNextPageToken() [3/3]

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

◆ SetSearchString() [1/3]

void Aws::CostExplorer::Model::GetDimensionValuesRequest::SetSearchString ( Aws::String &&  value)
inline

The value that you want to search the filter values for.

Definition at line 61 of file GetDimensionValuesRequest.h.

◆ SetSearchString() [2/3]

void Aws::CostExplorer::Model::GetDimensionValuesRequest::SetSearchString ( const Aws::String value)
inline

The value that you want to search the filter values for.

Definition at line 56 of file GetDimensionValuesRequest.h.

◆ SetSearchString() [3/3]

void Aws::CostExplorer::Model::GetDimensionValuesRequest::SetSearchString ( const char *  value)
inline

The value that you want to search the filter values for.

Definition at line 66 of file GetDimensionValuesRequest.h.

◆ SetSortBy() [1/2]

void Aws::CostExplorer::Model::GetDimensionValuesRequest::SetSortBy ( Aws::Vector< SortDefinition > &&  value)
inline

The value by which you want to sort the data.

The key represents cost and usage metrics. The following values are supported:

  • BlendedCost

  • UnblendedCost

  • AmortizedCost

  • NetAmortizedCost

  • NetUnblendedCost

  • UsageQuantity

  • NormalizedUsageAmount

Supported values for SortOrder are ASCENDING or DESCENDING.

When you specify a SortBy paramater, the context must be COST_AND_USAGE. Further, when using SortBy, NextPageToken and SearchString are not supported.

Definition at line 642 of file GetDimensionValuesRequest.h.

◆ SetSortBy() [2/2]

void Aws::CostExplorer::Model::GetDimensionValuesRequest::SetSortBy ( const Aws::Vector< SortDefinition > &  value)
inline

The value by which you want to sort the data.

The key represents cost and usage metrics. The following values are supported:

  • BlendedCost

  • UnblendedCost

  • AmortizedCost

  • NetAmortizedCost

  • NetUnblendedCost

  • UsageQuantity

  • NormalizedUsageAmount

Supported values for SortOrder are ASCENDING or DESCENDING.

When you specify a SortBy paramater, the context must be COST_AND_USAGE. Further, when using SortBy, NextPageToken and SearchString are not supported.

Definition at line 626 of file GetDimensionValuesRequest.h.

◆ SetTimePeriod() [1/2]

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

The start and end dates for retrieving the dimension values. 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 109 of file GetDimensionValuesRequest.h.

◆ SetTimePeriod() [2/2]

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

The start and end dates for retrieving the dimension values. 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 118 of file GetDimensionValuesRequest.h.

◆ SortByHasBeenSet()

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

The value by which you want to sort the data.

The key represents cost and usage metrics. The following values are supported:

  • BlendedCost

  • UnblendedCost

  • AmortizedCost

  • NetAmortizedCost

  • NetUnblendedCost

  • UsageQuantity

  • NormalizedUsageAmount

Supported values for SortOrder are ASCENDING or DESCENDING.

When you specify a SortBy paramater, the context must be COST_AND_USAGE. Further, when using SortBy, NextPageToken and SearchString are not supported.

Definition at line 610 of file GetDimensionValuesRequest.h.

◆ TimePeriodHasBeenSet()

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

The start and end dates for retrieving the dimension values. 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 GetDimensionValuesRequest.h.

◆ WithContext() [1/2]

GetDimensionValuesRequest& Aws::CostExplorer::Model::GetDimensionValuesRequest::WithContext ( const Context value)
inline

The context for the call to GetDimensionValues. This can be RESERVATIONS or COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to RESERVATIONS, the resulting dimension values can be used in the GetReservationUtilization operation. If the context is set to COST_AND_USAGE, the resulting dimension values can be used in the GetCostAndUsage operation.

If you set the context to COST_AND_USAGE, you can use the following dimensions for searching:

  • AZ - The Availability Zone. An example is us-east-1a.

  • DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.

  • INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

  • LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.

  • LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.

  • OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.

  • OPERATION - The action performed. Examples include RunInstance and CreateBucket.

  • PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

  • PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.

  • SERVICE - The AWS service such as Amazon DynamoDB.

  • USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.

  • USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.

  • REGION - The AWS Region.

  • RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.

  • RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.

If you set the context to RESERVATIONS, you can use the following dimensions for searching:

  • AZ - The Availability Zone. An example is us-east-1a.

  • CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.

  • DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.

  • INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

  • LINKED_ACCOUNT

    • The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.

  • PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

  • REGION - The AWS Region.

  • SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.

  • TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).

  • TENANCY - The tenancy of a resource. Examples are shared or dedicated.

If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:

  • SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)

  • PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)

  • REGION - The AWS Region.

  • INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)

  • LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.

  • SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan

Definition at line 495 of file GetDimensionValuesRequest.h.

◆ WithContext() [2/2]

GetDimensionValuesRequest& Aws::CostExplorer::Model::GetDimensionValuesRequest::WithContext ( Context &&  value)
inline

The context for the call to GetDimensionValues. This can be RESERVATIONS or COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to RESERVATIONS, the resulting dimension values can be used in the GetReservationUtilization operation. If the context is set to COST_AND_USAGE, the resulting dimension values can be used in the GetCostAndUsage operation.

If you set the context to COST_AND_USAGE, you can use the following dimensions for searching:

  • AZ - The Availability Zone. An example is us-east-1a.

  • DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.

  • INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

  • LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.

  • LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.

  • OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.

  • OPERATION - The action performed. Examples include RunInstance and CreateBucket.

  • PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

  • PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.

  • SERVICE - The AWS service such as Amazon DynamoDB.

  • USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.

  • USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.

  • REGION - The AWS Region.

  • RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.

  • RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.

If you set the context to RESERVATIONS, you can use the following dimensions for searching:

  • AZ - The Availability Zone. An example is us-east-1a.

  • CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.

  • DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.

  • INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

  • LINKED_ACCOUNT

    • The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.

  • PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

  • REGION - The AWS Region.

  • SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.

  • TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).

  • TENANCY - The tenancy of a resource. Examples are shared or dedicated.

If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:

  • SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)

  • PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)

  • REGION - The AWS Region.

  • INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)

  • LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.

  • SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan

Definition at line 558 of file GetDimensionValuesRequest.h.

◆ WithDimension() [1/2]

GetDimensionValuesRequest& Aws::CostExplorer::Model::GetDimensionValuesRequest::WithDimension ( const Dimension value)
inline

The name of the dimension. Each Dimension is available for a different Context. For more information, see Context.

Definition at line 172 of file GetDimensionValuesRequest.h.

◆ WithDimension() [2/2]

GetDimensionValuesRequest& Aws::CostExplorer::Model::GetDimensionValuesRequest::WithDimension ( Dimension &&  value)
inline

The name of the dimension. Each Dimension is available for a different Context. For more information, see Context.

Definition at line 179 of file GetDimensionValuesRequest.h.

◆ WithFilter() [1/2]

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

Definition at line 574 of file GetDimensionValuesRequest.h.

◆ WithFilter() [2/2]

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

Definition at line 577 of file GetDimensionValuesRequest.h.

◆ WithMaxResults()

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

This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

For GetDimensionValues, MaxResults has an upper limit of 1000.

Definition at line 743 of file GetDimensionValuesRequest.h.

◆ WithNextPageToken() [1/3]

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

◆ WithNextPageToken() [2/3]

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

◆ WithNextPageToken() [3/3]

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

◆ WithSearchString() [1/3]

GetDimensionValuesRequest& Aws::CostExplorer::Model::GetDimensionValuesRequest::WithSearchString ( Aws::String &&  value)
inline

The value that you want to search the filter values for.

Definition at line 76 of file GetDimensionValuesRequest.h.

◆ WithSearchString() [2/3]

GetDimensionValuesRequest& Aws::CostExplorer::Model::GetDimensionValuesRequest::WithSearchString ( const Aws::String value)
inline

The value that you want to search the filter values for.

Definition at line 71 of file GetDimensionValuesRequest.h.

◆ WithSearchString() [3/3]

GetDimensionValuesRequest& Aws::CostExplorer::Model::GetDimensionValuesRequest::WithSearchString ( const char *  value)
inline

The value that you want to search the filter values for.

Definition at line 81 of file GetDimensionValuesRequest.h.

◆ WithSortBy() [1/2]

GetDimensionValuesRequest& Aws::CostExplorer::Model::GetDimensionValuesRequest::WithSortBy ( Aws::Vector< SortDefinition > &&  value)
inline

The value by which you want to sort the data.

The key represents cost and usage metrics. The following values are supported:

  • BlendedCost

  • UnblendedCost

  • AmortizedCost

  • NetAmortizedCost

  • NetUnblendedCost

  • UsageQuantity

  • NormalizedUsageAmount

Supported values for SortOrder are ASCENDING or DESCENDING.

When you specify a SortBy paramater, the context must be COST_AND_USAGE. Further, when using SortBy, NextPageToken and SearchString are not supported.

Definition at line 674 of file GetDimensionValuesRequest.h.

◆ WithSortBy() [2/2]

GetDimensionValuesRequest& Aws::CostExplorer::Model::GetDimensionValuesRequest::WithSortBy ( const Aws::Vector< SortDefinition > &  value)
inline

The value by which you want to sort the data.

The key represents cost and usage metrics. The following values are supported:

  • BlendedCost

  • UnblendedCost

  • AmortizedCost

  • NetAmortizedCost

  • NetUnblendedCost

  • UsageQuantity

  • NormalizedUsageAmount

Supported values for SortOrder are ASCENDING or DESCENDING.

When you specify a SortBy paramater, the context must be COST_AND_USAGE. Further, when using SortBy, NextPageToken and SearchString are not supported.

Definition at line 658 of file GetDimensionValuesRequest.h.

◆ WithTimePeriod() [1/2]

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

The start and end dates for retrieving the dimension values. 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 127 of file GetDimensionValuesRequest.h.

◆ WithTimePeriod() [2/2]

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

The start and end dates for retrieving the dimension values. 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 136 of file GetDimensionValuesRequest.h.


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