CostExplorerClient Class

Member Function Documentation

CostExplorerClient::CostExplorerClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a CostExplorerClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

CostExplorerClient::CostExplorerClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads CostExplorerClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] GetCostAndUsageResponse *CostExplorerClient::getCostAndUsage(const GetCostAndUsageRequest &request)

Sends request to the CostExplorerClient service, and returns a pointer to an GetCostAndUsageResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as <code>BlendedCosts</code> or <code>UsageQuantity</code>, that you want the request to return. You can also filter and group your data by various dimensions, such as <code>SERVICE</code> or <code>AZ</code>, in a specific time range. For a complete list of valid dimensions, see the <code> <a href="http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetDimensionValues.html">GetDimensionValues</a> </code> operation. Master accounts in an organization in AWS Organizations have access to all member

[slot] GetDimensionValuesResponse *CostExplorerClient::getDimensionValues(const GetDimensionValuesRequest &request)

Sends request to the CostExplorerClient service, and returns a pointer to an GetDimensionValuesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string.

[slot] GetReservationCoverageResponse *CostExplorerClient::getReservationCoverage(const GetReservationCoverageRequest &request)

Sends request to the CostExplorerClient service, and returns a pointer to an GetReservationCoverageResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves the reservation coverage for your account. This allows you to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation. An organization's master account can see the coverage of the associated member accounts. For any time period, you can filter data about reservation usage by the following

dimensions> <ul> <li>

A> </li> <li>

CACHE_ENGIN> </li> <li>

DATABASE_ENGIN> </li> <li>

DEPLOYMENT_OPTIO> </li> <li>

INSTANCE_TYP> </li> <li>

LINKED_ACCOUN> </li> <li>

OPERATING_SYSTE> </li> <li>

PLATFOR> </li> <li>

REGIO> </li> <li>

SERVIC> </li> <li>

TA> </li> <li>

TENANC> </li> </ul>

To determine valid values for a dimension, use the <code>GetDimensionValues</code> operation.

[slot] GetReservationPurchaseRecommendationResponse *CostExplorerClient::getReservationPurchaseRecommendation(const GetReservationPurchaseRecommendationRequest &request)

Sends request to the CostExplorerClient service, and returns a pointer to an GetReservationPurchaseRecommendationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets recommendations for which reservations to purchase. These recommendations could help you reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand

pricing>

AWS generates your recommendations by identifying your On-Demand usage during a specific time period and collecting your usage into categories that are eligible for a reservation. After AWS has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of RI to purchase to maximize your estimated savings.

</p

For example, AWS automatically aggregates your EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region and recommends that you buy size-flexible regional reservations to apply to the c4 family usage. AWS recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible RI. AWS also shows the equal number of normalized units so that you can purchase any instance size that you want. For this example, your RI recommendation would be for <code>c4.large</code>, because that is the smallest size instance in the c4 instance

[slot] GetReservationUtilizationResponse *CostExplorerClient::getReservationUtilization(const GetReservationUtilizationRequest &request)

Sends request to the CostExplorerClient service, and returns a pointer to an GetReservationUtilizationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves the reservation utilization for your account. Master accounts in an organization have access to member accounts. You can filter data by dimensions in a time period. You can use <code>GetDimensionValues</code> to determine the possible dimension values. Currently, you can group only by <code>SUBSCRIPTION_ID</code>.

[slot] GetTagsResponse *CostExplorerClient::getTags(const GetTagsRequest &request)

Sends request to the CostExplorerClient service, and returns a pointer to an GetTagsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string.