AWSCostExplorerClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.costexplorer.AWSCostExplorerClient

All Implemented Interfaces:

AWSCostExplorer

Direct Known Subclasses:

AWSCostExplorerAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSCostExplorerClient
extends AmazonWebServiceClient
implements AWSCostExplorer
```
Client for accessing AWS Cost Explorer. All service calls made using this client are blocking, and will not return until the service call completes.

The Cost Explorer API enables you to programmatically query your cost and usage data. You can query for aggregated data such as total monthly costs or total daily usage. You can also query for granular data, such as the number of daily write operations for Amazon DynamoDB database tables in your production environment.

Service Endpoint

The Cost Explorer API provides the following endpoint:
- https://ce.us-east-1.amazonaws.com
For information about costs associated with the Cost Explorer API, see AWS Cost Management Pricing.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AWSCostExplorerClientBuilder`	`builder()`
`CreateAnomalyMonitorResult`	`createAnomalyMonitor(CreateAnomalyMonitorRequest request)` Creates a new cost anomaly detection monitor with the requested type and monitor specification.
`CreateAnomalySubscriptionResult`	`createAnomalySubscription(CreateAnomalySubscriptionRequest request)` Adds a subscription to a cost anomaly detection monitor.
`CreateCostCategoryDefinitionResult`	`createCostCategoryDefinition(CreateCostCategoryDefinitionRequest request)` Creates a new Cost Category with the requested name and rules.
`DeleteAnomalyMonitorResult`	`deleteAnomalyMonitor(DeleteAnomalyMonitorRequest request)` Deletes a cost anomaly monitor.
`DeleteAnomalySubscriptionResult`	`deleteAnomalySubscription(DeleteAnomalySubscriptionRequest request)` Deletes a cost anomaly subscription.
`DeleteCostCategoryDefinitionResult`	`deleteCostCategoryDefinition(DeleteCostCategoryDefinitionRequest request)` Deletes a Cost Category.
`DescribeCostCategoryDefinitionResult`	`describeCostCategoryDefinition(DescribeCostCategoryDefinitionRequest request)` Returns the name, ARN, rules, definition, and effective dates of a Cost Category that's defined in the account.
`GetAnomaliesResult`	`getAnomalies(GetAnomaliesRequest request)` Retrieves all of the cost anomalies detected on your account, during the time period specified by the `DateInterval` object.
`GetAnomalyMonitorsResult`	`getAnomalyMonitors(GetAnomalyMonitorsRequest request)` Retrieves the cost anomaly monitor definitions for your account.
`GetAnomalySubscriptionsResult`	`getAnomalySubscriptions(GetAnomalySubscriptionsRequest request)` Retrieves the cost anomaly subscription objects for your account.
`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.
`GetCostAndUsageWithResourcesResult`	`getCostAndUsageWithResources(GetCostAndUsageWithResourcesRequest request)` Retrieves cost and usage metrics with resources for your account.
`GetCostCategoriesResult`	`getCostCategories(GetCostCategoriesRequest request)` Retrieves an array of Cost Category names and values incurred cost.
`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.
`GetRightsizingRecommendationResult`	`getRightsizingRecommendation(GetRightsizingRecommendationRequest request)` Creates recommendations that help you save cost by identifying idle and underutilized Amazon EC2 instances.
`GetSavingsPlansCoverageResult`	`getSavingsPlansCoverage(GetSavingsPlansCoverageRequest request)` Retrieves the Savings Plans covered for your account.
`GetSavingsPlansPurchaseRecommendationResult`	`getSavingsPlansPurchaseRecommendation(GetSavingsPlansPurchaseRecommendationRequest request)` Retrieves your request parameters, Savings Plan Recommendations Summary and Details.
`GetSavingsPlansUtilizationResult`	`getSavingsPlansUtilization(GetSavingsPlansUtilizationRequest request)` Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity.
`GetSavingsPlansUtilizationDetailsResult`	`getSavingsPlansUtilizationDetails(GetSavingsPlansUtilizationDetailsRequest request)` Retrieves attribute data along with aggregate utilization and savings data for a given time period.
`GetTagsResult`	`getTags(GetTagsRequest request)` Queries for available tag keys and tag values for a specified period.
`GetUsageForecastResult`	`getUsageForecast(GetUsageForecastRequest request)` Retrieves a forecast for how much Amazon Web Services predicts that you will use over the forecast time period that you select, based on your past usage.
`ListCostCategoryDefinitionsResult`	`listCostCategoryDefinitions(ListCostCategoryDefinitionsRequest request)` Returns the name, ARN, `NumberOfRules` and effective dates of all Cost Categories defined in the account.
`ProvideAnomalyFeedbackResult`	`provideAnomalyFeedback(ProvideAnomalyFeedbackRequest request)` Modifies the feedback property of a given cost anomaly.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`UpdateAnomalyMonitorResult`	`updateAnomalyMonitor(UpdateAnomalyMonitorRequest request)` Updates an existing cost anomaly monitor.
`UpdateAnomalySubscriptionResult`	`updateAnomalySubscription(UpdateAnomalySubscriptionRequest request)` Updates an existing cost anomaly monitor subscription.
`UpdateCostCategoryDefinitionResult`	`updateCostCategoryDefinition(UpdateCostCategoryDefinitionRequest request)` Updates an existing Cost Category.

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

- Method Detail
  - builder
```
public static AWSCostExplorerClientBuilder builder()
```
  - createAnomalyMonitor
```
public CreateAnomalyMonitorResult createAnomalyMonitor(CreateAnomalyMonitorRequest request)
```
    Creates a new cost anomaly detection monitor with the requested type and monitor specification.
    
    Specified by:
    
    createAnomalyMonitor in interface AWSCostExplorer
    
    Parameters:
    
    createAnomalyMonitorRequest -
    
    Returns:
    
    Result of the CreateAnomalyMonitor operation returned by the service.
    
    Throws:
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    See Also:
    
    AWS API Documentation
  - createAnomalySubscription
```
public CreateAnomalySubscriptionResult createAnomalySubscription(CreateAnomalySubscriptionRequest request)
```
    Adds a subscription to a cost anomaly detection monitor. You can use each subscription to define subscribers with email or SNS notifications. Email subscribers can set a dollar threshold and a time frequency for receiving notifications.
    
    Specified by:
    
    createAnomalySubscription in interface AWSCostExplorer
    
    Parameters:
    
    createAnomalySubscriptionRequest -
    
    Returns:
    
    Result of the CreateAnomalySubscription operation returned by the service.
    
    Throws:
    
    UnknownMonitorException - The cost anomaly monitor does not exist for the account.
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    See Also:
    
    AWS API Documentation
  - createCostCategoryDefinition
```
public CreateCostCategoryDefinitionResult createCostCategoryDefinition(CreateCostCategoryDefinitionRequest request)
```
    Creates a new Cost Category with the requested name and rules.
    
    Specified by:
    
    createCostCategoryDefinition in interface AWSCostExplorer
    
    Parameters:
    
    createCostCategoryDefinitionRequest -
    
    Returns:
    
    Result of the CreateCostCategoryDefinition operation returned by the service.
    
    Throws:
    
    ServiceQuotaExceededException - You've reached the limit on the number of resources you can create, or exceeded the size of an individual resource.
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    See Also:
    
    AWS API Documentation
  - deleteAnomalyMonitor
```
public DeleteAnomalyMonitorResult deleteAnomalyMonitor(DeleteAnomalyMonitorRequest request)
```
    Deletes a cost anomaly monitor.
    
    Specified by:
    
    deleteAnomalyMonitor in interface AWSCostExplorer
    
    Parameters:
    
    deleteAnomalyMonitorRequest -
    
    Returns:
    
    Result of the DeleteAnomalyMonitor operation returned by the service.
    
    Throws:
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    UnknownMonitorException - The cost anomaly monitor does not exist for the account.
    
    See Also:
    
    AWS API Documentation
  - deleteAnomalySubscription
```
public DeleteAnomalySubscriptionResult deleteAnomalySubscription(DeleteAnomalySubscriptionRequest request)
```
    Deletes a cost anomaly subscription.
    
    Specified by:
    
    deleteAnomalySubscription in interface AWSCostExplorer
    
    Parameters:
    
    deleteAnomalySubscriptionRequest -
    
    Returns:
    
    Result of the DeleteAnomalySubscription operation returned by the service.
    
    Throws:
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    UnknownSubscriptionException - The cost anomaly subscription does not exist for the account.
    
    See Also:
    
    AWS API Documentation
  - deleteCostCategoryDefinition
```
public DeleteCostCategoryDefinitionResult deleteCostCategoryDefinition(DeleteCostCategoryDefinitionRequest request)
```
    Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category.
    
    Specified by:
    
    deleteCostCategoryDefinition in interface AWSCostExplorer
    
    Parameters:
    
    deleteCostCategoryDefinitionRequest -
    
    Returns:
    
    Result of the DeleteCostCategoryDefinition operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified ARN in the request doesn't exist.
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    See Also:
    
    AWS API Documentation
  - describeCostCategoryDefinition
```
public DescribeCostCategoryDefinitionResult describeCostCategoryDefinition(DescribeCostCategoryDefinitionRequest request)
```
    Returns the name, ARN, rules, definition, and effective dates of a Cost Category that's defined in the account.
    
    You have the option to use EffectiveOn to return a Cost Category that is active on a specific date. If there is no EffectiveOn specified, you’ll see a Cost Category that is effective on the current date. If Cost Category is still effective, EffectiveEnd is omitted in the response.
    
    Specified by:
    
    describeCostCategoryDefinition in interface AWSCostExplorer
    
    Parameters:
    
    describeCostCategoryDefinitionRequest -
    
    Returns:
    
    Result of the DescribeCostCategoryDefinition operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified ARN in the request doesn't exist.
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    See Also:
    
    AWS API Documentation
  - getAnomalies
```
public GetAnomaliesResult getAnomalies(GetAnomaliesRequest request)
```
    Retrieves all of the cost anomalies detected on your account, during the time period specified by the DateInterval object.
    
    Specified by:
    
    getAnomalies in interface AWSCostExplorer
    
    Parameters:
    
    getAnomaliesRequest -
    
    Returns:
    
    Result of the GetAnomalies operation returned by the service.
    
    Throws:
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    InvalidNextTokenException - The pagination token is invalid. Try again without a pagination token.
    
    See Also:
    
    AWS API Documentation
  - getAnomalyMonitors
```
public GetAnomalyMonitorsResult getAnomalyMonitors(GetAnomalyMonitorsRequest request)
```
    Retrieves the cost anomaly monitor definitions for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).
    
    Specified by:
    
    getAnomalyMonitors in interface AWSCostExplorer
    
    Parameters:
    
    getAnomalyMonitorsRequest -
    
    Returns:
    
    Result of the GetAnomalyMonitors operation returned by the service.
    
    Throws:
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    UnknownMonitorException - The cost anomaly monitor does not exist for the account.
    
    InvalidNextTokenException - The pagination token is invalid. Try again without a pagination token.
    
    See Also:
    
    AWS API Documentation
  - getAnomalySubscriptions
```
public GetAnomalySubscriptionsResult getAnomalySubscriptions(GetAnomalySubscriptionsRequest request)
```
    Retrieves the cost anomaly subscription objects for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).
    
    Specified by:
    
    getAnomalySubscriptions in interface AWSCostExplorer
    
    Parameters:
    
    getAnomalySubscriptionsRequest -
    
    Returns:
    
    Result of the GetAnomalySubscriptions operation returned by the service.
    
    Throws:
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    UnknownSubscriptionException - The cost anomaly subscription does not exist for the account.
    
    InvalidNextTokenException - The pagination token is invalid. Try again without a pagination token.
    
    See Also:
    
    AWS API Documentation
  - getCostAndUsage
```
public GetCostAndUsageResult getCostAndUsage(GetCostAndUsageRequest request)
```
    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. Management account in an organization in AWS Organizations have access to all member accounts.
    
    For information about filter limitations, see Quotas and restrictions in the Billing and Cost Management User Guide.
    
    Specified by:
    
    getCostAndUsage in interface AWSCostExplorer
    
    Parameters:
    
    getCostAndUsageRequest -
    
    Returns:
    
    Result of the GetCostAndUsage operation returned by the service.
    
    Throws:
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    BillExpirationException - The requested report expired. Update the date interval and try again.
    
    DataUnavailableException - The requested data is unavailable.
    
    InvalidNextTokenException - The pagination token is invalid. Try again without a pagination token.
    
    RequestChangedException - Your request parameters changed between pages. Try again with the old parameters or without a pagination token.
    
    See Also:
    
    AWS API Documentation
  - getCostAndUsageWithResources
```
public GetCostAndUsageWithResourcesResult getCostAndUsageWithResources(GetCostAndUsageWithResourcesRequest request)
```
    Retrieves cost and usage metrics with resources 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. Management account in an organization in AWS Organizations have access to all member accounts. This API is currently available for the Amazon Elastic Compute Cloud – Compute service only.
    
    This is an opt-in only feature. You can enable this feature from the Cost Explorer Settings page. For information on how to access the Settings page, see Controlling Access for Cost Explorer in the AWS Billing and Cost Management User Guide.
    
    Specified by:
    
    getCostAndUsageWithResources in interface AWSCostExplorer
    
    Parameters:
    
    getCostAndUsageWithResourcesRequest -
    
    Returns:
    
    Result of the GetCostAndUsageWithResources operation returned by the service.
    
    Throws:
    
    DataUnavailableException - The requested data is unavailable.
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    BillExpirationException - The requested report expired. Update the date interval and try again.
    
    InvalidNextTokenException - The pagination token is invalid. Try again without a pagination token.
    
    RequestChangedException - Your request parameters changed between pages. Try again with the old parameters or without a pagination token.
    
    See Also:
    
    AWS API Documentation
  - getCostCategories
```
public GetCostCategoriesResult getCostCategories(GetCostCategoriesRequest request)
```
    Retrieves an array of Cost Category names and values incurred cost.
    
    If some Cost Category names and values are not associated with any cost, they will not be returned by this API.
    
    Specified by:
    
    getCostCategories in interface AWSCostExplorer
    
    Parameters:
    
    getCostCategoriesRequest -
    
    Returns:
    
    Result of the GetCostCategories operation returned by the service.
    
    Throws:
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    BillExpirationException - The requested report expired. Update the date interval and try again.
    
    DataUnavailableException - The requested data is unavailable.
    
    InvalidNextTokenException - The pagination token is invalid. Try again without a pagination token.
    
    RequestChangedException - Your request parameters changed between pages. Try again with the old parameters or without a pagination token.
    
    See Also:
    
    AWS API Documentation
  - getCostForecast
```
public 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.
    
    Specified by:
    
    getCostForecast in interface AWSCostExplorer
    
    Parameters:
    
    getCostForecastRequest -
    
    Returns:
    
    Result of the GetCostForecast operation returned by the service.
    
    Throws:
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    DataUnavailableException - The requested data is unavailable.
    
    See Also:
    
    AWS API Documentation
  - getDimensionValues
```
public GetDimensionValuesResult getDimensionValues(GetDimensionValuesRequest request)
```
    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
    
    Parameters:
    
    getDimensionValuesRequest -
    
    Returns:
    
    Result of the GetDimensionValues operation returned by the service.
    
    Throws:
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    BillExpirationException - The requested report expired. Update the date interval and try again.
    
    DataUnavailableException - The requested data is unavailable.
    
    InvalidNextTokenException - The pagination token is invalid. Try again without a pagination token.
    
    RequestChangedException - Your request parameters changed between pages. Try again with the old parameters or without a pagination token.
    
    See Also:
    
    AWS API Documentation
  - getReservationCoverage
```
public GetReservationCoverageResult getReservationCoverage(GetReservationCoverageRequest request)
```
    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 management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. 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:
    
    getReservationCoverageRequest - 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.
    
    Throws:
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    DataUnavailableException - The requested data is unavailable.
    
    InvalidNextTokenException - The pagination token is invalid. Try again without a pagination token.
    
    See Also:
    
    AWS API Documentation
  - getReservationPurchaseRecommendation
```
public GetReservationPurchaseRecommendationResult getReservationPurchaseRecommendation(GetReservationPurchaseRecommendationRequest request)
```
    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
    
    Parameters:
    
    getReservationPurchaseRecommendationRequest -
    
    Returns:
    
    Result of the GetReservationPurchaseRecommendation operation returned by the service.
    
    Throws:
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    DataUnavailableException - The requested data is unavailable.
    
    InvalidNextTokenException - The pagination token is invalid. Try again without a pagination token.
    
    See Also:
    
    AWS API Documentation
  - getReservationUtilization
```
public GetReservationUtilizationResult getReservationUtilization(GetReservationUtilizationRequest request)
```
    Retrieves the reservation utilization for your account. Management account 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
    
    Parameters:
    
    getReservationUtilizationRequest -
    
    Returns:
    
    Result of the GetReservationUtilization operation returned by the service.
    
    Throws:
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    DataUnavailableException - The requested data is unavailable.
    
    InvalidNextTokenException - The pagination token is invalid. Try again without a pagination token.
    
    See Also:
    
    AWS API Documentation
  - getRightsizingRecommendation
```
public GetRightsizingRecommendationResult getRightsizingRecommendation(GetRightsizingRecommendationRequest request)
```
    Creates recommendations that help you save cost by identifying idle and underutilized Amazon EC2 instances.
    
    Recommendations are generated to either downsize or terminate instances, along with providing savings detail and metrics. For details on calculation and function, see Optimizing Your Cost with Rightsizing Recommendations in the AWS Billing and Cost Management User Guide.
    
    Specified by:
    
    getRightsizingRecommendation in interface AWSCostExplorer
    
    Parameters:
    
    getRightsizingRecommendationRequest -
    
    Returns:
    
    Result of the GetRightsizingRecommendation operation returned by the service.
    
    Throws:
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    InvalidNextTokenException - The pagination token is invalid. Try again without a pagination token.
    
    See Also:
    
    AWS API Documentation
  - getSavingsPlansCoverage
```
public GetSavingsPlansCoverageResult getSavingsPlansCoverage(GetSavingsPlansCoverageRequest request)
```
    Retrieves the Savings Plans covered for your account. This enables you to see how much of your cost is covered by a Savings Plan. An organization’s management account can see the coverage of the associated member accounts. This supports dimensions, Cost Categories, and nested expressions. For any time period, you can filter data for Savings Plans usage with the following dimensions:
    - LINKED_ACCOUNT
    - REGION
    - SERVICE
    - INSTANCE_FAMILY
    To determine valid values for a dimension, use the GetDimensionValues operation.
    Specified by:
    
    getSavingsPlansCoverage in interface AWSCostExplorer
    
    Parameters:
    
    getSavingsPlansCoverageRequest -
    
    Returns:
    
    Result of the GetSavingsPlansCoverage operation returned by the service.
    
    Throws:
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    DataUnavailableException - The requested data is unavailable.
    
    InvalidNextTokenException - The pagination token is invalid. Try again without a pagination token.
    
    See Also:
    
    AWS API Documentation
  - getSavingsPlansPurchaseRecommendation
```
public GetSavingsPlansPurchaseRecommendationResult getSavingsPlansPurchaseRecommendation(GetSavingsPlansPurchaseRecommendationRequest request)
```
    Retrieves your request parameters, Savings Plan Recommendations Summary and Details.
    
    Specified by:
    
    getSavingsPlansPurchaseRecommendation in interface AWSCostExplorer
    
    Parameters:
    
    getSavingsPlansPurchaseRecommendationRequest -
    
    Returns:
    
    Result of the GetSavingsPlansPurchaseRecommendation operation returned by the service.
    
    Throws:
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    InvalidNextTokenException - The pagination token is invalid. Try again without a pagination token.
    
    See Also:
    
    AWS API Documentation
  - getSavingsPlansUtilization
```
public GetSavingsPlansUtilizationResult getSavingsPlansUtilization(GetSavingsPlansUtilizationRequest request)
```
    Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity. Management account in an organization have access to member accounts. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values.
    
    You cannot group by any dimension values for GetSavingsPlansUtilization.
    
    Specified by:
    
    getSavingsPlansUtilization in interface AWSCostExplorer
    
    Parameters:
    
    getSavingsPlansUtilizationRequest -
    
    Returns:
    
    Result of the GetSavingsPlansUtilization operation returned by the service.
    
    Throws:
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    DataUnavailableException - The requested data is unavailable.
    
    See Also:
    
    AWS API Documentation
  - getSavingsPlansUtilizationDetails
```
public GetSavingsPlansUtilizationDetailsResult getSavingsPlansUtilizationDetails(GetSavingsPlansUtilizationDetailsRequest request)
```
    Retrieves attribute data along with aggregate utilization and savings data for a given time period. This doesn't support granular or grouped data (daily/monthly) in response. You can't retrieve data by dates in a single response similar to GetSavingsPlanUtilization, but you have the option to make multiple calls to GetSavingsPlanUtilizationDetails by providing individual dates. You can use GetDimensionValues in SAVINGS_PLANS to determine the possible dimension values.
    
    GetSavingsPlanUtilizationDetails internally groups data by SavingsPlansArn.
    
    Specified by:
    
    getSavingsPlansUtilizationDetails in interface AWSCostExplorer
    
    Parameters:
    
    getSavingsPlansUtilizationDetailsRequest -
    
    Returns:
    
    Result of the GetSavingsPlansUtilizationDetails operation returned by the service.
    
    Throws:
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    DataUnavailableException - The requested data is unavailable.
    
    InvalidNextTokenException - The pagination token is invalid. Try again without a pagination token.
    
    See Also:
    
    AWS API Documentation
  - getTags
```
public GetTagsResult getTags(GetTagsRequest request)
```
    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
    
    Parameters:
    
    getTagsRequest -
    
    Returns:
    
    Result of the GetTags operation returned by the service.
    
    Throws:
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    BillExpirationException - The requested report expired. Update the date interval and try again.
    
    DataUnavailableException - The requested data is unavailable.
    
    InvalidNextTokenException - The pagination token is invalid. Try again without a pagination token.
    
    RequestChangedException - Your request parameters changed between pages. Try again with the old parameters or without a pagination token.
    
    See Also:
    
    AWS API Documentation
  - getUsageForecast
```
public GetUsageForecastResult getUsageForecast(GetUsageForecastRequest request)
```
    Retrieves a forecast for how much Amazon Web Services predicts that you will use over the forecast time period that you select, based on your past usage.
    
    Specified by:
    
    getUsageForecast in interface AWSCostExplorer
    
    Parameters:
    
    getUsageForecastRequest -
    
    Returns:
    
    Result of the GetUsageForecast operation returned by the service.
    
    Throws:
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    DataUnavailableException - The requested data is unavailable.
    
    UnresolvableUsageUnitException - Cost Explorer was unable to identify the usage unit. Provide UsageType/UsageTypeGroup filter selections that contain matching units, for example: hours.
    
    See Also:
    
    AWS API Documentation
  - listCostCategoryDefinitions
```
public ListCostCategoryDefinitionsResult listCostCategoryDefinitions(ListCostCategoryDefinitionsRequest request)
```
    Returns the name, ARN, NumberOfRules and effective dates of all Cost Categories defined in the account. You have the option to use EffectiveOn to return a list of Cost Categories that were active on a specific date. If there is no EffectiveOn specified, you’ll see Cost Categories that are effective on the current date. If Cost Category is still effective, EffectiveEnd is omitted in the response. ListCostCategoryDefinitions supports pagination. The request can have a MaxResults range up to 100.
    
    Specified by:
    
    listCostCategoryDefinitions in interface AWSCostExplorer
    
    Parameters:
    
    listCostCategoryDefinitionsRequest -
    
    Returns:
    
    Result of the ListCostCategoryDefinitions operation returned by the service.
    
    Throws:
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    See Also:
    
    AWS API Documentation
  - provideAnomalyFeedback
```
public ProvideAnomalyFeedbackResult provideAnomalyFeedback(ProvideAnomalyFeedbackRequest request)
```
    Modifies the feedback property of a given cost anomaly.
    
    Specified by:
    
    provideAnomalyFeedback in interface AWSCostExplorer
    
    Parameters:
    
    provideAnomalyFeedbackRequest -
    
    Returns:
    
    Result of the ProvideAnomalyFeedback operation returned by the service.
    
    Throws:
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    See Also:
    
    AWS API Documentation
  - updateAnomalyMonitor
```
public UpdateAnomalyMonitorResult updateAnomalyMonitor(UpdateAnomalyMonitorRequest request)
```
    Updates an existing cost anomaly monitor. The changes made are applied going forward, and does not change anomalies detected in the past.
    
    Specified by:
    
    updateAnomalyMonitor in interface AWSCostExplorer
    
    Parameters:
    
    updateAnomalyMonitorRequest -
    
    Returns:
    
    Result of the UpdateAnomalyMonitor operation returned by the service.
    
    Throws:
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    UnknownMonitorException - The cost anomaly monitor does not exist for the account.
    
    See Also:
    
    AWS API Documentation
  - updateAnomalySubscription
```
public UpdateAnomalySubscriptionResult updateAnomalySubscription(UpdateAnomalySubscriptionRequest request)
```
    Updates an existing cost anomaly monitor subscription.
    
    Specified by:
    
    updateAnomalySubscription in interface AWSCostExplorer
    
    Parameters:
    
    updateAnomalySubscriptionRequest -
    
    Returns:
    
    Result of the UpdateAnomalySubscription operation returned by the service.
    
    Throws:
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    UnknownMonitorException - The cost anomaly monitor does not exist for the account.
    
    UnknownSubscriptionException - The cost anomaly subscription does not exist for the account.
    
    See Also:
    
    AWS API Documentation
  - updateCostCategoryDefinition
```
public UpdateCostCategoryDefinitionResult updateCostCategoryDefinition(UpdateCostCategoryDefinitionRequest request)
```
    Updates an existing Cost Category. Changes made to the Cost Category rules will be used to categorize the current month’s expenses and future expenses. This won’t change categorization for the previous months.
    
    Specified by:
    
    updateCostCategoryDefinition in interface AWSCostExplorer
    
    Parameters:
    
    updateCostCategoryDefinitionRequest -
    
    Returns:
    
    Result of the UpdateCostCategoryDefinition operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified ARN in the request doesn't exist.
    
    ServiceQuotaExceededException - You've reached the limit on the number of resources you can create, or exceeded the size of an individual resource.
    
    LimitExceededException - You made too many calls in a short period of time. Try again later.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public 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. 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 the 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.
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSCostExplorer
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Did this page help you?

Class AWSCostExplorerClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

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

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

createAnomalyMonitor

createAnomalySubscription

createCostCategoryDefinition

deleteAnomalyMonitor

deleteAnomalySubscription

deleteCostCategoryDefinition

describeCostCategoryDefinition

getAnomalies

getAnomalyMonitors

getAnomalySubscriptions

getCostAndUsage

getCostAndUsageWithResources

getCostCategories

getCostForecast

getDimensionValues

getReservationCoverage

getReservationPurchaseRecommendation

getReservationUtilization

getRightsizingRecommendation

getSavingsPlansCoverage

getSavingsPlansPurchaseRecommendation

getSavingsPlansUtilization

getSavingsPlansUtilizationDetails

getTags

getUsageForecast

listCostCategoryDefinitions

provideAnomalyFeedback

updateAnomalyMonitor

updateAnomalySubscription

updateCostCategoryDefinition

getCachedResponseMetadata

shutdown