AbstractAWSCostExplorer (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.costexplorer.AbstractAWSCostExplorer

All Implemented Interfaces:

AWSCostExplorer

Direct Known Subclasses:

AbstractAWSCostExplorerAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSCostExplorer
extends Object
implements AWSCostExplorer
```
Abstract implementation of AWSCostExplorer. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.costexplorer.AWSCostExplorer
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetCostAndUsageResult`	`getCostAndUsage(GetCostAndUsageRequest request)` Retrieves cost and usage metrics for your account.
`GetCostForecastResult`	`getCostForecast(GetCostForecastRequest request)` Retrieves a forecast for how much Amazon Web Services predicts that you will spend over the forecast time period that you select, based on your past costs.
`GetDimensionValuesResult`	`getDimensionValues(GetDimensionValuesRequest request)` Retrieves all available filter values for a specified filter over a period of time.
`GetReservationCoverageResult`	`getReservationCoverage(GetReservationCoverageRequest request)` Retrieves the reservation coverage for your account.
`GetReservationPurchaseRecommendationResult`	`getReservationPurchaseRecommendation(GetReservationPurchaseRecommendationRequest request)` Gets recommendations for which reservations to purchase.
`GetReservationUtilizationResult`	`getReservationUtilization(GetReservationUtilizationRequest request)` Retrieves the reservation utilization for your account.
`GetTagsResult`	`getTags(GetTagsRequest request)` Queries for available tag keys and tag values for a specified period.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getCostAndUsage
```
public GetCostAndUsageResult getCostAndUsage(GetCostAndUsageRequest request)
```
    Description copied from interface: AWSCostExplorer
    
    Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as BlendedCosts or UsageQuantity, that you want the request to return. You can also filter and group your data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Master accounts in an organization in AWS Organizations have access to all member accounts.
    
    Specified by:
    
    getCostAndUsage in interface AWSCostExplorer
    
    Returns:
    
    Result of the GetCostAndUsage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getCostForecast
```
public GetCostForecastResult getCostForecast(GetCostForecastRequest request)
```
    Description copied from interface: AWSCostExplorer
    
    Retrieves a forecast for how much Amazon Web Services predicts that you will spend over the forecast time period that you select, based on your past costs.
    
    Specified by:
    
    getCostForecast in interface AWSCostExplorer
    
    Returns:
    
    Result of the GetCostForecast operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDimensionValues
```
public GetDimensionValuesResult getDimensionValues(GetDimensionValuesRequest request)
```
    Description copied from interface: AWSCostExplorer
    
    Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string.
    
    Specified by:
    
    getDimensionValues in interface AWSCostExplorer
    
    Returns:
    
    Result of the GetDimensionValues operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getReservationCoverage
```
public GetReservationCoverageResult getReservationCoverage(GetReservationCoverageRequest request)
```
    Description copied from interface: AWSCostExplorer
    Retrieves the reservation coverage for your account. This enables 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:
    - AZ
    - CACHE_ENGINE
    - DATABASE_ENGINE
    - DEPLOYMENT_OPTION
    - INSTANCE_TYPE
    - LINKED_ACCOUNT
    - OPERATING_SYSTEM
    - PLATFORM
    - REGION
    - SERVICE
    - TAG
    - TENANCY
    To determine valid values for a dimension, use the GetDimensionValues operation.
    Specified by:
    
    getReservationCoverage in interface AWSCostExplorer
    
    Parameters:
    
    request - You can use the following request parameters to query for how much of your instance usage a reservation covered.
    
    Returns:
    
    Result of the GetReservationCoverage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getReservationPurchaseRecommendation
```
public GetReservationPurchaseRecommendationResult getReservationPurchaseRecommendation(GetReservationPurchaseRecommendationRequest request)
```
    Description copied from interface: AWSCostExplorer
    
    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.
    
    For example, AWS automatically aggregates your Amazon 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 c4.large because that is the smallest size instance in the c4 instance family.
    
    Specified by:
    
    getReservationPurchaseRecommendation in interface AWSCostExplorer
    
    Returns:
    
    Result of the GetReservationPurchaseRecommendation operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getReservationUtilization
```
public GetReservationUtilizationResult getReservationUtilization(GetReservationUtilizationRequest request)
```
    Description copied from interface: AWSCostExplorer
    
    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 GetDimensionValues to determine the possible dimension values. Currently, you can group only by SUBSCRIPTION_ID.
    
    Specified by:
    
    getReservationUtilization in interface AWSCostExplorer
    
    Returns:
    
    Result of the GetReservationUtilization operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getTags
```
public GetTagsResult getTags(GetTagsRequest request)
```
    Description copied from interface: AWSCostExplorer
    
    Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string.
    
    Specified by:
    
    getTags in interface AWSCostExplorer
    
    Returns:
    
    Result of the GetTags operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSCostExplorer
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSCostExplorer
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSCostExplorer
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSCostExplorer
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAWSCostExplorer

Field Summary

Fields inherited from interface com.amazonaws.services.costexplorer.AWSCostExplorer

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getCostAndUsage

getCostForecast

getDimensionValues

getReservationCoverage

getReservationPurchaseRecommendation

getReservationUtilization

getTags

shutdown

getCachedResponseMetadata