@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSCostExplorerClient extends AmazonWebServiceClient implements AWSCostExplorer
The Cost Explorer API allows 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, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
static AWSCostExplorerClientBuilder |
builder() |
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.
|
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.
|
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, 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 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 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 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:
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 is covered by a
reservation.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 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 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 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 © 2018. All rights reserved.