@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 DynamoDB database tables in your production environment.
Service Endpoint
The Cost Explorer API provides the following endpoint:
https://ce.us-east-1.amazonaws.com
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)
Retrieve cost and usage metrics for your account.
|
GetDimensionValuesResult |
getDimensionValues(GetDimensionValuesRequest request)
You can use
GetDimensionValues to retrieve all available filter values for a specific filter over a
period of time. |
GetReservationCoverageResult |
getReservationCoverage(GetReservationCoverageRequest request)
Retrieve the reservation coverage for your account.
|
GetReservationUtilizationResult |
getReservationUtilization(GetReservationUtilizationRequest request)
You can retrieve the Reservation utilization for your account.
|
GetTagsResult |
getTags(GetTagsRequest request)
You can query for available tag keys and tag values for a specified period.
|
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, 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)
Retrieve 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. See the GetDimensionValues
action for a complete list of the valid dimensions. Master
accounts in an organization 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.public GetDimensionValuesResult getDimensionValues(GetDimensionValuesRequest request)
You can use GetDimensionValues
to retrieve all available filter values for a specific 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.InvalidNextTokenException
- The pagination token is invalid. Try again without a pagination token.public GetReservationCoverageResult getReservationCoverage(GetReservationCoverageRequest request)
Retrieve the reservation coverage for your account. An organization's master account has access to the associated member accounts. For any time period, you can filter data about reservation usage by the following dimensions.
AZ
INSTANCE_TYPE
LINKED_ACCOUNT
PLATFORM
REGION
TENANCY
To determine valid values for a dimension, use the GetDimensionValues
operation.
getReservationCoverage
in interface AWSCostExplorer
getReservationCoverageRequest
- You can query for how much of your instance usage was 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 GetReservationUtilizationResult getReservationUtilization(GetReservationUtilizationRequest request)
You can retrieve the Reservation utilization for your account. Master accounts in an organization have access to
their associated 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)
You can query 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.InvalidNextTokenException
- The pagination token is invalid. Try again 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.