@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSCostExplorerClient extends AmazonWebServiceClient implements AWSCostExplorer
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.
Modifier and Type | Field and Description |
---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to this client
|
client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
ENDPOINT_PREFIX
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
shutdown
protected static final ClientConfigurationFactory configFactory
public static AWSCostExplorerClientBuilder builder()
public CreateCostCategoryDefinitionResult createCostCategoryDefinition(CreateCostCategoryDefinitionRequest request)
Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).
Creates a new Cost Category with the requested name and rules.
createCostCategoryDefinition
in interface AWSCostExplorer
createCostCategoryDefinitionRequest
- ServiceQuotaExceededException
- You've reached the limit on the number of resources you can create, or exceeded the size of an individual
resources.LimitExceededException
- You made too many calls in a short period of time. Try again later.public DeleteCostCategoryDefinitionResult deleteCostCategoryDefinition(DeleteCostCategoryDefinitionRequest request)
Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).
Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category.
deleteCostCategoryDefinition
in interface AWSCostExplorer
deleteCostCategoryDefinitionRequest
- 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.public DescribeCostCategoryDefinitionResult describeCostCategoryDefinition(DescribeCostCategoryDefinitionRequest request)
Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).
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.
describeCostCategoryDefinition
in interface AWSCostExplorer
describeCostCategoryDefinitionRequest
- 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.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. Master accounts in an organization in AWS Organizations have access to all
member accounts.
getCostAndUsage
in interface AWSCostExplorer
getCostAndUsageRequest
- 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.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. Master accounts 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.
getCostAndUsageWithResources
in interface AWSCostExplorer
getCostAndUsageWithResourcesRequest
- 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.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.
getCostForecast
in interface AWSCostExplorer
getCostForecastRequest
- LimitExceededException
- You made too many calls in a short period of time. Try again later.DataUnavailableException
- The requested data is unavailable.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.
getDimensionValues
in interface AWSCostExplorer
getDimensionValuesRequest
- 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.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 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.
getReservationCoverage
in interface AWSCostExplorer
getReservationCoverageRequest
- You can use the following request parameters to query for how much of your instance usage a reservation
covered.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.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.
getReservationPurchaseRecommendation
in interface AWSCostExplorer
getReservationPurchaseRecommendationRequest
- 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.public GetReservationUtilizationResult getReservationUtilization(GetReservationUtilizationRequest request)
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
.
getReservationUtilization
in interface AWSCostExplorer
getReservationUtilizationRequest
- 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.public GetRightsizingRecommendationResult getRightsizingRecommendation(GetRightsizingRecommendationRequest request)
Creates recommendations that helps 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.
getRightsizingRecommendation
in interface AWSCostExplorer
getRightsizingRecommendationRequest
- 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.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 master account can see the coverage of the associated member accounts. 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.
getSavingsPlansCoverage
in interface AWSCostExplorer
getSavingsPlansCoverageRequest
- 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.public GetSavingsPlansPurchaseRecommendationResult getSavingsPlansPurchaseRecommendation(GetSavingsPlansPurchaseRecommendationRequest request)
Retrieves your request parameters, Savings Plan Recommendations Summary and Details.
getSavingsPlansPurchaseRecommendation
in interface AWSCostExplorer
getSavingsPlansPurchaseRecommendationRequest
- 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.public GetSavingsPlansUtilizationResult getSavingsPlansUtilization(GetSavingsPlansUtilizationRequest request)
Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity.
Master accounts 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
.
getSavingsPlansUtilization
in interface AWSCostExplorer
getSavingsPlansUtilizationRequest
- LimitExceededException
- You made too many calls in a short period of time. Try again later.DataUnavailableException
- The requested data is unavailable.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
.
getSavingsPlansUtilizationDetails
in interface AWSCostExplorer
getSavingsPlansUtilizationDetailsRequest
- 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.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.
getTags
in interface AWSCostExplorer
getTagsRequest
- 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.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.
getUsageForecast
in interface AWSCostExplorer
getUsageForecastRequest
- 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
.public ListCostCategoryDefinitionsResult listCostCategoryDefinitions(ListCostCategoryDefinitionsRequest request)
Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).
Returns the name, ARN 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
in interface AWSCostExplorer
listCostCategoryDefinitionsRequest
- LimitExceededException
- You made too many calls in a short period of time. Try again later.public UpdateCostCategoryDefinitionResult updateCostCategoryDefinition(UpdateCostCategoryDefinitionRequest request)
Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10).
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.
updateCostCategoryDefinition
in interface AWSCostExplorer
updateCostCategoryDefinitionRequest
- 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
resources.LimitExceededException
- You made too many calls in a short period of time. Try again later.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata
in interface AWSCostExplorer
request
- The originally executed requestCopyright © 2020. All rights reserved.