@Generated(value="software.amazon.awssdk:codegen") public interface CostExplorerClient extends SdkClient, SdkAutoCloseable
builder()
method.
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 |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static CostExplorerClientBuilder |
builder()
Create a builder that can be used to configure and create a
CostExplorerClient . |
static CostExplorerClient |
create()
Create a
CostExplorerClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from
the DefaultCredentialsProvider . |
default GetCostAndUsageResponse |
getCostAndUsage(Consumer<GetCostAndUsageRequest.Builder> getCostAndUsageRequest)
Retrieve cost and usage metrics for your account.
|
default GetCostAndUsageResponse |
getCostAndUsage(GetCostAndUsageRequest getCostAndUsageRequest)
Retrieve cost and usage metrics for your account.
|
default GetDimensionValuesResponse |
getDimensionValues(Consumer<GetDimensionValuesRequest.Builder> getDimensionValuesRequest)
You can use
GetDimensionValues to retrieve all available filter values for a specific filter over a
period of time. |
default GetDimensionValuesResponse |
getDimensionValues(GetDimensionValuesRequest getDimensionValuesRequest)
You can use
GetDimensionValues to retrieve all available filter values for a specific filter over a
period of time. |
default GetReservationUtilizationResponse |
getReservationUtilization(Consumer<GetReservationUtilizationRequest.Builder> getReservationUtilizationRequest)
You can retrieve the Reservation utilization for your account.
|
default GetReservationUtilizationResponse |
getReservationUtilization(GetReservationUtilizationRequest getReservationUtilizationRequest)
You can retrieve the Reservation utilization for your account.
|
default GetTagsResponse |
getTags(Consumer<GetTagsRequest.Builder> getTagsRequest)
You can query for available tag keys and tag values for a specified period.
|
default GetTagsResponse |
getTags(GetTagsRequest getTagsRequest)
You can query for available tag keys and tag values for a specified period.
|
static ServiceMetadata |
serviceMetadata() |
serviceName
close
static final String SERVICE_NAME
static CostExplorerClient create()
CostExplorerClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from
the DefaultCredentialsProvider
.static CostExplorerClientBuilder builder()
CostExplorerClient
.default GetCostAndUsageResponse getCostAndUsage(GetCostAndUsageRequest getCostAndUsageRequest) throws LimitExceededException, SdkServiceException, SdkClientException, CostExplorerException
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 AWS Service
or AvailabilityZone
, 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.
getCostAndUsageRequest
- LimitExceededException
- You made too many calls in a short period of time. Try again later.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CostExplorerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default GetCostAndUsageResponse getCostAndUsage(Consumer<GetCostAndUsageRequest.Builder> getCostAndUsageRequest) throws LimitExceededException, SdkServiceException, SdkClientException, CostExplorerException
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 AWS Service
or AvailabilityZone
, 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.
getCostAndUsageRequest
- LimitExceededException
- You made too many calls in a short period of time. Try again later.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CostExplorerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default GetDimensionValuesResponse getDimensionValues(GetDimensionValuesRequest getDimensionValuesRequest) throws LimitExceededException, SdkServiceException, SdkClientException, CostExplorerException
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.
getDimensionValuesRequest
- LimitExceededException
- You made too many calls in a short period of time. Try again later.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CostExplorerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default GetDimensionValuesResponse getDimensionValues(Consumer<GetDimensionValuesRequest.Builder> getDimensionValuesRequest) throws LimitExceededException, SdkServiceException, SdkClientException, CostExplorerException
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.
getDimensionValuesRequest
- LimitExceededException
- You made too many calls in a short period of time. Try again later.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CostExplorerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default GetReservationUtilizationResponse getReservationUtilization(GetReservationUtilizationRequest getReservationUtilizationRequest) throws LimitExceededException, SdkServiceException, SdkClientException, CostExplorerException
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
.
getReservationUtilizationRequest
- LimitExceededException
- You made too many calls in a short period of time. Try again later.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CostExplorerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default GetReservationUtilizationResponse getReservationUtilization(Consumer<GetReservationUtilizationRequest.Builder> getReservationUtilizationRequest) throws LimitExceededException, SdkServiceException, SdkClientException, CostExplorerException
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
.
getReservationUtilizationRequest
- LimitExceededException
- You made too many calls in a short period of time. Try again later.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CostExplorerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default GetTagsResponse getTags(GetTagsRequest getTagsRequest) throws LimitExceededException, SdkServiceException, SdkClientException, CostExplorerException
You can query for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string.
getTagsRequest
- LimitExceededException
- You made too many calls in a short period of time. Try again later.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CostExplorerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
default GetTagsResponse getTags(Consumer<GetTagsRequest.Builder> getTagsRequest) throws LimitExceededException, SdkServiceException, SdkClientException, CostExplorerException
You can query for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string.
getTagsRequest
- LimitExceededException
- You made too many calls in a short period of time. Try again later.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CostExplorerException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.SdkServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.