@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface CostExplorerClient extends SdkClient
builder() method.
You can use the Cost Explorer API 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. This might include 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 the costs that are associated with the Cost Explorer API, see Amazon Web Services Cost Management Pricing.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
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 CreateAnomalyMonitorResponse |
createAnomalyMonitor(Consumer<CreateAnomalyMonitorRequest.Builder> createAnomalyMonitorRequest)
Creates a new cost anomaly detection monitor with the requested type and monitor specification.
|
default CreateAnomalyMonitorResponse |
createAnomalyMonitor(CreateAnomalyMonitorRequest createAnomalyMonitorRequest)
Creates a new cost anomaly detection monitor with the requested type and monitor specification.
|
default CreateAnomalySubscriptionResponse |
createAnomalySubscription(Consumer<CreateAnomalySubscriptionRequest.Builder> createAnomalySubscriptionRequest)
Adds a subscription to a cost anomaly detection monitor.
|
default CreateAnomalySubscriptionResponse |
createAnomalySubscription(CreateAnomalySubscriptionRequest createAnomalySubscriptionRequest)
Adds a subscription to a cost anomaly detection monitor.
|
default CreateCostCategoryDefinitionResponse |
createCostCategoryDefinition(Consumer<CreateCostCategoryDefinitionRequest.Builder> createCostCategoryDefinitionRequest)
Creates a new Cost Category with the requested name and rules.
|
default CreateCostCategoryDefinitionResponse |
createCostCategoryDefinition(CreateCostCategoryDefinitionRequest createCostCategoryDefinitionRequest)
Creates a new Cost Category with the requested name and rules.
|
default DeleteAnomalyMonitorResponse |
deleteAnomalyMonitor(Consumer<DeleteAnomalyMonitorRequest.Builder> deleteAnomalyMonitorRequest)
Deletes a cost anomaly monitor.
|
default DeleteAnomalyMonitorResponse |
deleteAnomalyMonitor(DeleteAnomalyMonitorRequest deleteAnomalyMonitorRequest)
Deletes a cost anomaly monitor.
|
default DeleteAnomalySubscriptionResponse |
deleteAnomalySubscription(Consumer<DeleteAnomalySubscriptionRequest.Builder> deleteAnomalySubscriptionRequest)
Deletes a cost anomaly subscription.
|
default DeleteAnomalySubscriptionResponse |
deleteAnomalySubscription(DeleteAnomalySubscriptionRequest deleteAnomalySubscriptionRequest)
Deletes a cost anomaly subscription.
|
default DeleteCostCategoryDefinitionResponse |
deleteCostCategoryDefinition(Consumer<DeleteCostCategoryDefinitionRequest.Builder> deleteCostCategoryDefinitionRequest)
Deletes a Cost Category.
|
default DeleteCostCategoryDefinitionResponse |
deleteCostCategoryDefinition(DeleteCostCategoryDefinitionRequest deleteCostCategoryDefinitionRequest)
Deletes a Cost Category.
|
default DescribeCostCategoryDefinitionResponse |
describeCostCategoryDefinition(Consumer<DescribeCostCategoryDefinitionRequest.Builder> describeCostCategoryDefinitionRequest)
Returns the name, Amazon Resource Name (ARN), rules, definition, and effective dates of a Cost Category that's
defined in the account.
|
default DescribeCostCategoryDefinitionResponse |
describeCostCategoryDefinition(DescribeCostCategoryDefinitionRequest describeCostCategoryDefinitionRequest)
Returns the name, Amazon Resource Name (ARN), rules, definition, and effective dates of a Cost Category that's
defined in the account.
|
default GetAnomaliesResponse |
getAnomalies(Consumer<GetAnomaliesRequest.Builder> getAnomaliesRequest)
Retrieves all of the cost anomalies detected on your account during the time period that's specified by the
DateInterval object. |
default GetAnomaliesResponse |
getAnomalies(GetAnomaliesRequest getAnomaliesRequest)
Retrieves all of the cost anomalies detected on your account during the time period that's specified by the
DateInterval object. |
default GetAnomalyMonitorsResponse |
getAnomalyMonitors(Consumer<GetAnomalyMonitorsRequest.Builder> getAnomalyMonitorsRequest)
Retrieves the cost anomaly monitor definitions for your account.
|
default GetAnomalyMonitorsResponse |
getAnomalyMonitors(GetAnomalyMonitorsRequest getAnomalyMonitorsRequest)
Retrieves the cost anomaly monitor definitions for your account.
|
default GetAnomalySubscriptionsResponse |
getAnomalySubscriptions(Consumer<GetAnomalySubscriptionsRequest.Builder> getAnomalySubscriptionsRequest)
Retrieves the cost anomaly subscription objects for your account.
|
default GetAnomalySubscriptionsResponse |
getAnomalySubscriptions(GetAnomalySubscriptionsRequest getAnomalySubscriptionsRequest)
Retrieves the cost anomaly subscription objects for your account.
|
default GetCostAndUsageResponse |
getCostAndUsage(Consumer<GetCostAndUsageRequest.Builder> getCostAndUsageRequest)
Retrieves cost and usage metrics for your account.
|
default GetCostAndUsageResponse |
getCostAndUsage(GetCostAndUsageRequest getCostAndUsageRequest)
Retrieves cost and usage metrics for your account.
|
default GetCostAndUsageWithResourcesResponse |
getCostAndUsageWithResources(Consumer<GetCostAndUsageWithResourcesRequest.Builder> getCostAndUsageWithResourcesRequest)
Retrieves cost and usage metrics with resources for your account.
|
default GetCostAndUsageWithResourcesResponse |
getCostAndUsageWithResources(GetCostAndUsageWithResourcesRequest getCostAndUsageWithResourcesRequest)
Retrieves cost and usage metrics with resources for your account.
|
default GetCostCategoriesResponse |
getCostCategories(Consumer<GetCostCategoriesRequest.Builder> getCostCategoriesRequest)
Retrieves an array of Cost Category names and values incurred cost.
|
default GetCostCategoriesResponse |
getCostCategories(GetCostCategoriesRequest getCostCategoriesRequest)
Retrieves an array of Cost Category names and values incurred cost.
|
default GetCostForecastResponse |
getCostForecast(Consumer<GetCostForecastRequest.Builder> getCostForecastRequest)
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.
|
default GetCostForecastResponse |
getCostForecast(GetCostForecastRequest getCostForecastRequest)
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.
|
default GetDimensionValuesResponse |
getDimensionValues(Consumer<GetDimensionValuesRequest.Builder> getDimensionValuesRequest)
Retrieves all available filter values for a specified filter over a period of time.
|
default GetDimensionValuesResponse |
getDimensionValues(GetDimensionValuesRequest getDimensionValuesRequest)
Retrieves all available filter values for a specified filter over a period of time.
|
default GetReservationCoverageResponse |
getReservationCoverage(Consumer<GetReservationCoverageRequest.Builder> getReservationCoverageRequest)
Retrieves the reservation coverage for your account, which you can use 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.
|
default GetReservationCoverageResponse |
getReservationCoverage(GetReservationCoverageRequest getReservationCoverageRequest)
Retrieves the reservation coverage for your account, which you can use 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.
|
default GetReservationPurchaseRecommendationResponse |
getReservationPurchaseRecommendation(Consumer<GetReservationPurchaseRecommendationRequest.Builder> getReservationPurchaseRecommendationRequest)
Gets recommendations for reservation purchases.
|
default GetReservationPurchaseRecommendationResponse |
getReservationPurchaseRecommendation(GetReservationPurchaseRecommendationRequest getReservationPurchaseRecommendationRequest)
Gets recommendations for reservation purchases.
|
default GetReservationUtilizationResponse |
getReservationUtilization(Consumer<GetReservationUtilizationRequest.Builder> getReservationUtilizationRequest)
Retrieves the reservation utilization for your account.
|
default GetReservationUtilizationResponse |
getReservationUtilization(GetReservationUtilizationRequest getReservationUtilizationRequest)
Retrieves the reservation utilization for your account.
|
default GetRightsizingRecommendationResponse |
getRightsizingRecommendation(Consumer<GetRightsizingRecommendationRequest.Builder> getRightsizingRecommendationRequest)
Creates recommendations that help you save cost by identifying idle and underutilized Amazon EC2 instances.
|
default GetRightsizingRecommendationResponse |
getRightsizingRecommendation(GetRightsizingRecommendationRequest getRightsizingRecommendationRequest)
Creates recommendations that help you save cost by identifying idle and underutilized Amazon EC2 instances.
|
default GetSavingsPlansCoverageResponse |
getSavingsPlansCoverage(Consumer<GetSavingsPlansCoverageRequest.Builder> getSavingsPlansCoverageRequest)
Retrieves the Savings Plans covered for your account.
|
default GetSavingsPlansCoverageResponse |
getSavingsPlansCoverage(GetSavingsPlansCoverageRequest getSavingsPlansCoverageRequest)
Retrieves the Savings Plans covered for your account.
|
default GetSavingsPlansCoverageIterable |
getSavingsPlansCoveragePaginator(Consumer<GetSavingsPlansCoverageRequest.Builder> getSavingsPlansCoverageRequest)
Retrieves the Savings Plans covered for your account.
|
default GetSavingsPlansCoverageIterable |
getSavingsPlansCoveragePaginator(GetSavingsPlansCoverageRequest getSavingsPlansCoverageRequest)
Retrieves the Savings Plans covered for your account.
|
default GetSavingsPlansPurchaseRecommendationResponse |
getSavingsPlansPurchaseRecommendation(Consumer<GetSavingsPlansPurchaseRecommendationRequest.Builder> getSavingsPlansPurchaseRecommendationRequest)
Retrieves your request parameters, Savings Plan Recommendations Summary and Details.
|
default GetSavingsPlansPurchaseRecommendationResponse |
getSavingsPlansPurchaseRecommendation(GetSavingsPlansPurchaseRecommendationRequest getSavingsPlansPurchaseRecommendationRequest)
Retrieves your request parameters, Savings Plan Recommendations Summary and Details.
|
default GetSavingsPlansUtilizationResponse |
getSavingsPlansUtilization(Consumer<GetSavingsPlansUtilizationRequest.Builder> getSavingsPlansUtilizationRequest)
Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity.
|
default GetSavingsPlansUtilizationResponse |
getSavingsPlansUtilization(GetSavingsPlansUtilizationRequest getSavingsPlansUtilizationRequest)
Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity.
|
default GetSavingsPlansUtilizationDetailsResponse |
getSavingsPlansUtilizationDetails(Consumer<GetSavingsPlansUtilizationDetailsRequest.Builder> getSavingsPlansUtilizationDetailsRequest)
Retrieves attribute data along with aggregate utilization and savings data for a given time period.
|
default GetSavingsPlansUtilizationDetailsResponse |
getSavingsPlansUtilizationDetails(GetSavingsPlansUtilizationDetailsRequest getSavingsPlansUtilizationDetailsRequest)
Retrieves attribute data along with aggregate utilization and savings data for a given time period.
|
default GetSavingsPlansUtilizationDetailsIterable |
getSavingsPlansUtilizationDetailsPaginator(Consumer<GetSavingsPlansUtilizationDetailsRequest.Builder> getSavingsPlansUtilizationDetailsRequest)
Retrieves attribute data along with aggregate utilization and savings data for a given time period.
|
default GetSavingsPlansUtilizationDetailsIterable |
getSavingsPlansUtilizationDetailsPaginator(GetSavingsPlansUtilizationDetailsRequest getSavingsPlansUtilizationDetailsRequest)
Retrieves attribute data along with aggregate utilization and savings data for a given time period.
|
default GetTagsResponse |
getTags(Consumer<GetTagsRequest.Builder> getTagsRequest)
Queries for available tag keys and tag values for a specified period.
|
default GetTagsResponse |
getTags(GetTagsRequest getTagsRequest)
Queries for available tag keys and tag values for a specified period.
|
default GetUsageForecastResponse |
getUsageForecast(Consumer<GetUsageForecastRequest.Builder> getUsageForecastRequest)
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.
|
default GetUsageForecastResponse |
getUsageForecast(GetUsageForecastRequest getUsageForecastRequest)
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.
|
default ListCostAllocationTagsResponse |
listCostAllocationTags(Consumer<ListCostAllocationTagsRequest.Builder> listCostAllocationTagsRequest)
Get a list of cost allocation tags.
|
default ListCostAllocationTagsResponse |
listCostAllocationTags(ListCostAllocationTagsRequest listCostAllocationTagsRequest)
Get a list of cost allocation tags.
|
default ListCostAllocationTagsIterable |
listCostAllocationTagsPaginator(Consumer<ListCostAllocationTagsRequest.Builder> listCostAllocationTagsRequest)
Get a list of cost allocation tags.
|
default ListCostAllocationTagsIterable |
listCostAllocationTagsPaginator(ListCostAllocationTagsRequest listCostAllocationTagsRequest)
Get a list of cost allocation tags.
|
default ListCostCategoryDefinitionsResponse |
listCostCategoryDefinitions(Consumer<ListCostCategoryDefinitionsRequest.Builder> listCostCategoryDefinitionsRequest)
Returns the name, Amazon Resource Name (ARN),
NumberOfRules and effective dates of all Cost
Categories defined in the account. |
default ListCostCategoryDefinitionsResponse |
listCostCategoryDefinitions(ListCostCategoryDefinitionsRequest listCostCategoryDefinitionsRequest)
Returns the name, Amazon Resource Name (ARN),
NumberOfRules and effective dates of all Cost
Categories defined in the account. |
default ListCostCategoryDefinitionsIterable |
listCostCategoryDefinitionsPaginator(Consumer<ListCostCategoryDefinitionsRequest.Builder> listCostCategoryDefinitionsRequest)
Returns the name, Amazon Resource Name (ARN),
NumberOfRules and effective dates of all Cost
Categories defined in the account. |
default ListCostCategoryDefinitionsIterable |
listCostCategoryDefinitionsPaginator(ListCostCategoryDefinitionsRequest listCostCategoryDefinitionsRequest)
Returns the name, Amazon Resource Name (ARN),
NumberOfRules and effective dates of all Cost
Categories defined in the account. |
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns a list of resource tags associated with the resource specified by the Amazon Resource Name (ARN).
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of resource tags associated with the resource specified by the Amazon Resource Name (ARN).
|
default ProvideAnomalyFeedbackResponse |
provideAnomalyFeedback(Consumer<ProvideAnomalyFeedbackRequest.Builder> provideAnomalyFeedbackRequest)
Modifies the feedback property of a given cost anomaly.
|
default ProvideAnomalyFeedbackResponse |
provideAnomalyFeedback(ProvideAnomalyFeedbackRequest provideAnomalyFeedbackRequest)
Modifies the feedback property of a given cost anomaly.
|
static ServiceMetadata |
serviceMetadata() |
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
An API operation for adding one or more tags (key-value pairs) to a resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
An API operation for adding one or more tags (key-value pairs) to a resource.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes one or more tags from a resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from a resource.
|
default UpdateAnomalyMonitorResponse |
updateAnomalyMonitor(Consumer<UpdateAnomalyMonitorRequest.Builder> updateAnomalyMonitorRequest)
Updates an existing cost anomaly monitor.
|
default UpdateAnomalyMonitorResponse |
updateAnomalyMonitor(UpdateAnomalyMonitorRequest updateAnomalyMonitorRequest)
Updates an existing cost anomaly monitor.
|
default UpdateAnomalySubscriptionResponse |
updateAnomalySubscription(Consumer<UpdateAnomalySubscriptionRequest.Builder> updateAnomalySubscriptionRequest)
Updates an existing cost anomaly monitor subscription.
|
default UpdateAnomalySubscriptionResponse |
updateAnomalySubscription(UpdateAnomalySubscriptionRequest updateAnomalySubscriptionRequest)
Updates an existing cost anomaly monitor subscription.
|
default UpdateCostAllocationTagsStatusResponse |
updateCostAllocationTagsStatus(Consumer<UpdateCostAllocationTagsStatusRequest.Builder> updateCostAllocationTagsStatusRequest)
Updates status for cost allocation tags in bulk, with maximum batch size of 20.
|
default UpdateCostAllocationTagsStatusResponse |
updateCostAllocationTagsStatus(UpdateCostAllocationTagsStatusRequest updateCostAllocationTagsStatusRequest)
Updates status for cost allocation tags in bulk, with maximum batch size of 20.
|
default UpdateCostCategoryDefinitionResponse |
updateCostCategoryDefinition(Consumer<UpdateCostCategoryDefinitionRequest.Builder> updateCostCategoryDefinitionRequest)
Updates an existing Cost Category.
|
default UpdateCostCategoryDefinitionResponse |
updateCostCategoryDefinition(UpdateCostCategoryDefinitionRequest updateCostCategoryDefinitionRequest)
Updates an existing Cost Category.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static CostExplorerClient create()
CostExplorerClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static CostExplorerClientBuilder builder()
CostExplorerClient.default CreateAnomalyMonitorResponse createAnomalyMonitor(CreateAnomalyMonitorRequest createAnomalyMonitorRequest) throws LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException
Creates a new cost anomaly detection monitor with the requested type and monitor specification.
createAnomalyMonitorRequest - 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.AwsServiceExceptiondefault CreateAnomalyMonitorResponse createAnomalyMonitor(Consumer<CreateAnomalyMonitorRequest.Builder> createAnomalyMonitorRequest) throws LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException
Creates a new cost anomaly detection monitor with the requested type and monitor specification.
This is a convenience which creates an instance of the CreateAnomalyMonitorRequest.Builder avoiding the
need to create one manually via CreateAnomalyMonitorRequest.builder()
createAnomalyMonitorRequest - A Consumer that will call methods on CreateAnomalyMonitorRequest.Builder to create a
request.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.AwsServiceExceptiondefault CreateAnomalySubscriptionResponse createAnomalySubscription(CreateAnomalySubscriptionRequest createAnomalySubscriptionRequest) throws UnknownMonitorException, LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException
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.
createAnomalySubscriptionRequest - 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.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.AwsServiceExceptiondefault CreateAnomalySubscriptionResponse createAnomalySubscription(Consumer<CreateAnomalySubscriptionRequest.Builder> createAnomalySubscriptionRequest) throws UnknownMonitorException, LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException
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.
This is a convenience which creates an instance of the CreateAnomalySubscriptionRequest.Builder avoiding
the need to create one manually via CreateAnomalySubscriptionRequest.builder()
createAnomalySubscriptionRequest - A Consumer that will call methods on CreateAnomalySubscriptionRequest.Builder to create a
request.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.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.AwsServiceExceptiondefault CreateCostCategoryDefinitionResponse createCostCategoryDefinition(CreateCostCategoryDefinitionRequest createCostCategoryDefinitionRequest) throws ServiceQuotaExceededException, LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException
Creates a new Cost Category with the requested name and rules.
createCostCategoryDefinitionRequest - 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.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.AwsServiceExceptiondefault CreateCostCategoryDefinitionResponse createCostCategoryDefinition(Consumer<CreateCostCategoryDefinitionRequest.Builder> createCostCategoryDefinitionRequest) throws ServiceQuotaExceededException, LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException
Creates a new Cost Category with the requested name and rules.
This is a convenience which creates an instance of the CreateCostCategoryDefinitionRequest.Builder
avoiding the need to create one manually via CreateCostCategoryDefinitionRequest.builder()
createCostCategoryDefinitionRequest - A Consumer that will call methods on CreateCostCategoryDefinitionRequest.Builder to create
a request.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.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.AwsServiceExceptiondefault DeleteAnomalyMonitorResponse deleteAnomalyMonitor(DeleteAnomalyMonitorRequest deleteAnomalyMonitorRequest) throws LimitExceededException, UnknownMonitorException, AwsServiceException, SdkClientException, CostExplorerException
Deletes a cost anomaly monitor.
deleteAnomalyMonitorRequest - 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.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.AwsServiceExceptiondefault DeleteAnomalyMonitorResponse deleteAnomalyMonitor(Consumer<DeleteAnomalyMonitorRequest.Builder> deleteAnomalyMonitorRequest) throws LimitExceededException, UnknownMonitorException, AwsServiceException, SdkClientException, CostExplorerException
Deletes a cost anomaly monitor.
This is a convenience which creates an instance of the DeleteAnomalyMonitorRequest.Builder avoiding the
need to create one manually via DeleteAnomalyMonitorRequest.builder()
deleteAnomalyMonitorRequest - A Consumer that will call methods on DeleteAnomalyMonitorRequest.Builder to create a
request.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.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.AwsServiceExceptiondefault DeleteAnomalySubscriptionResponse deleteAnomalySubscription(DeleteAnomalySubscriptionRequest deleteAnomalySubscriptionRequest) throws LimitExceededException, UnknownSubscriptionException, AwsServiceException, SdkClientException, CostExplorerException
Deletes a cost anomaly subscription.
deleteAnomalySubscriptionRequest - 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.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.AwsServiceExceptiondefault DeleteAnomalySubscriptionResponse deleteAnomalySubscription(Consumer<DeleteAnomalySubscriptionRequest.Builder> deleteAnomalySubscriptionRequest) throws LimitExceededException, UnknownSubscriptionException, AwsServiceException, SdkClientException, CostExplorerException
Deletes a cost anomaly subscription.
This is a convenience which creates an instance of the DeleteAnomalySubscriptionRequest.Builder avoiding
the need to create one manually via DeleteAnomalySubscriptionRequest.builder()
deleteAnomalySubscriptionRequest - A Consumer that will call methods on DeleteAnomalySubscriptionRequest.Builder to create a
request.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.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.AwsServiceExceptiondefault DeleteCostCategoryDefinitionResponse deleteCostCategoryDefinition(DeleteCostCategoryDefinitionRequest deleteCostCategoryDefinitionRequest) throws ResourceNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException
Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category.
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.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.AwsServiceExceptiondefault DeleteCostCategoryDefinitionResponse deleteCostCategoryDefinition(Consumer<DeleteCostCategoryDefinitionRequest.Builder> deleteCostCategoryDefinitionRequest) throws ResourceNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException
Deletes a Cost Category. Expenses from this month going forward will no longer be categorized with this Cost Category.
This is a convenience which creates an instance of the DeleteCostCategoryDefinitionRequest.Builder
avoiding the need to create one manually via DeleteCostCategoryDefinitionRequest.builder()
deleteCostCategoryDefinitionRequest - A Consumer that will call methods on DeleteCostCategoryDefinitionRequest.Builder to create
a request.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.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.AwsServiceExceptiondefault DescribeCostCategoryDefinitionResponse describeCostCategoryDefinition(DescribeCostCategoryDefinitionRequest describeCostCategoryDefinitionRequest) throws ResourceNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException
Returns the name, Amazon Resource 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's active on a specific date.
If there's no EffectiveOn specified, you see a Cost Category that's effective on the current date.
If Cost Category is still effective, EffectiveEnd is omitted in the response.
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.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.AwsServiceExceptiondefault DescribeCostCategoryDefinitionResponse describeCostCategoryDefinition(Consumer<DescribeCostCategoryDefinitionRequest.Builder> describeCostCategoryDefinitionRequest) throws ResourceNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException
Returns the name, Amazon Resource 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's active on a specific date.
If there's no EffectiveOn specified, you see a Cost Category that's effective on the current date.
If Cost Category is still effective, EffectiveEnd is omitted in the response.
This is a convenience which creates an instance of the DescribeCostCategoryDefinitionRequest.Builder
avoiding the need to create one manually via DescribeCostCategoryDefinitionRequest.builder()
describeCostCategoryDefinitionRequest - A Consumer that will call methods on DescribeCostCategoryDefinitionRequest.Builder to
create a request.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.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.AwsServiceExceptiondefault GetAnomaliesResponse getAnomalies(GetAnomaliesRequest getAnomaliesRequest) throws LimitExceededException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException
Retrieves all of the cost anomalies detected on your account during the time period that's specified by the
DateInterval object.
getAnomaliesRequest - 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.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.AwsServiceExceptiondefault GetAnomaliesResponse getAnomalies(Consumer<GetAnomaliesRequest.Builder> getAnomaliesRequest) throws LimitExceededException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException
Retrieves all of the cost anomalies detected on your account during the time period that's specified by the
DateInterval object.
This is a convenience which creates an instance of the GetAnomaliesRequest.Builder avoiding the need to
create one manually via GetAnomaliesRequest.builder()
getAnomaliesRequest - A Consumer that will call methods on GetAnomaliesRequest.Builder to create a request.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.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.AwsServiceExceptiondefault GetAnomalyMonitorsResponse getAnomalyMonitors(GetAnomalyMonitorsRequest getAnomalyMonitorsRequest) throws LimitExceededException, UnknownMonitorException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException
Retrieves the cost anomaly monitor definitions for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).
getAnomalyMonitorsRequest - 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.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.AwsServiceExceptiondefault GetAnomalyMonitorsResponse getAnomalyMonitors(Consumer<GetAnomalyMonitorsRequest.Builder> getAnomalyMonitorsRequest) throws LimitExceededException, UnknownMonitorException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException
Retrieves the cost anomaly monitor definitions for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).
This is a convenience which creates an instance of the GetAnomalyMonitorsRequest.Builder avoiding the
need to create one manually via GetAnomalyMonitorsRequest.builder()
getAnomalyMonitorsRequest - A Consumer that will call methods on GetAnomalyMonitorsRequest.Builder to create a
request.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.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.AwsServiceExceptiondefault GetAnomalySubscriptionsResponse getAnomalySubscriptions(GetAnomalySubscriptionsRequest getAnomalySubscriptionsRequest) throws LimitExceededException, UnknownSubscriptionException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException
Retrieves the cost anomaly subscription objects for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).
getAnomalySubscriptionsRequest - 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.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.AwsServiceExceptiondefault GetAnomalySubscriptionsResponse getAnomalySubscriptions(Consumer<GetAnomalySubscriptionsRequest.Builder> getAnomalySubscriptionsRequest) throws LimitExceededException, UnknownSubscriptionException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException
Retrieves the cost anomaly subscription objects for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).
This is a convenience which creates an instance of the GetAnomalySubscriptionsRequest.Builder avoiding
the need to create one manually via GetAnomalySubscriptionsRequest.builder()
getAnomalySubscriptionsRequest - A Consumer that will call methods on GetAnomalySubscriptionsRequest.Builder to create a
request.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.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.AwsServiceExceptiondefault GetCostAndUsageResponse getCostAndUsage(GetCostAndUsageRequest getCostAndUsageRequest) throws LimitExceededException, BillExpirationException, DataUnavailableException, InvalidNextTokenException, RequestChangedException, AwsServiceException, SdkClientException, CostExplorerException
Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric that you
want the request to return. For example, you can specify BlendedCosts or UsageQuantity.
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 Organizations have access to all
member accounts.
For information about filter limitations, see Quotas and restrictions in the Billing and Cost Management User Guide.
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.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.AwsServiceExceptiondefault GetCostAndUsageResponse getCostAndUsage(Consumer<GetCostAndUsageRequest.Builder> getCostAndUsageRequest) throws LimitExceededException, BillExpirationException, DataUnavailableException, InvalidNextTokenException, RequestChangedException, AwsServiceException, SdkClientException, CostExplorerException
Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric that you
want the request to return. For example, you can specify BlendedCosts or UsageQuantity.
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 Organizations have access to all
member accounts.
For information about filter limitations, see Quotas and restrictions in the Billing and Cost Management User Guide.
This is a convenience which creates an instance of the GetCostAndUsageRequest.Builder avoiding the need
to create one manually via GetCostAndUsageRequest.builder()
getCostAndUsageRequest - A Consumer that will call methods on GetCostAndUsageRequest.Builder to create a request.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.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.AwsServiceExceptiondefault GetCostAndUsageWithResourcesResponse getCostAndUsageWithResources(GetCostAndUsageWithResourcesRequest getCostAndUsageWithResourcesRequest) throws DataUnavailableException, LimitExceededException, BillExpirationException, InvalidNextTokenException, RequestChangedException, AwsServiceException, SdkClientException, CostExplorerException
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 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 about how to access the Settings page, see Controlling Access for Cost Explorer in the Billing and Cost Management User Guide.
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.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.AwsServiceExceptiondefault GetCostAndUsageWithResourcesResponse getCostAndUsageWithResources(Consumer<GetCostAndUsageWithResourcesRequest.Builder> getCostAndUsageWithResourcesRequest) throws DataUnavailableException, LimitExceededException, BillExpirationException, InvalidNextTokenException, RequestChangedException, AwsServiceException, SdkClientException, CostExplorerException
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 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 about how to access the Settings page, see Controlling Access for Cost Explorer in the Billing and Cost Management User Guide.
This is a convenience which creates an instance of the GetCostAndUsageWithResourcesRequest.Builder
avoiding the need to create one manually via GetCostAndUsageWithResourcesRequest.builder()
getCostAndUsageWithResourcesRequest - A Consumer that will call methods on GetCostAndUsageWithResourcesRequest.Builder to create
a request.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.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.AwsServiceExceptiondefault GetCostCategoriesResponse getCostCategories(GetCostCategoriesRequest getCostCategoriesRequest) throws LimitExceededException, BillExpirationException, DataUnavailableException, InvalidNextTokenException, RequestChangedException, AwsServiceException, SdkClientException, CostExplorerException
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.
getCostCategoriesRequest - 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.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.AwsServiceExceptiondefault GetCostCategoriesResponse getCostCategories(Consumer<GetCostCategoriesRequest.Builder> getCostCategoriesRequest) throws LimitExceededException, BillExpirationException, DataUnavailableException, InvalidNextTokenException, RequestChangedException, AwsServiceException, SdkClientException, CostExplorerException
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.
This is a convenience which creates an instance of the GetCostCategoriesRequest.Builder avoiding the need
to create one manually via GetCostCategoriesRequest.builder()
getCostCategoriesRequest - A Consumer that will call methods on GetCostCategoriesRequest.Builder to create a request.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.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.AwsServiceExceptiondefault GetCostForecastResponse getCostForecast(GetCostForecastRequest getCostForecastRequest) throws LimitExceededException, DataUnavailableException, AwsServiceException, SdkClientException, CostExplorerException
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.
getCostForecastRequest - LimitExceededException - You made too many calls in a short period of time. Try again later.DataUnavailableException - The requested data is unavailable.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.AwsServiceExceptiondefault GetCostForecastResponse getCostForecast(Consumer<GetCostForecastRequest.Builder> getCostForecastRequest) throws LimitExceededException, DataUnavailableException, AwsServiceException, SdkClientException, CostExplorerException
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.
This is a convenience which creates an instance of the GetCostForecastRequest.Builder avoiding the need
to create one manually via GetCostForecastRequest.builder()
getCostForecastRequest - A Consumer that will call methods on GetCostForecastRequest.Builder to create a request.LimitExceededException - You made too many calls in a short period of time. Try again later.DataUnavailableException - The requested data is unavailable.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.AwsServiceExceptiondefault GetDimensionValuesResponse getDimensionValues(GetDimensionValuesRequest getDimensionValuesRequest) throws LimitExceededException, BillExpirationException, DataUnavailableException, InvalidNextTokenException, RequestChangedException, AwsServiceException, SdkClientException, CostExplorerException
Retrieves all available filter values for a specified 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.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.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.AwsServiceExceptiondefault GetDimensionValuesResponse getDimensionValues(Consumer<GetDimensionValuesRequest.Builder> getDimensionValuesRequest) throws LimitExceededException, BillExpirationException, DataUnavailableException, InvalidNextTokenException, RequestChangedException, AwsServiceException, SdkClientException, CostExplorerException
Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string.
This is a convenience which creates an instance of the GetDimensionValuesRequest.Builder avoiding the
need to create one manually via GetDimensionValuesRequest.builder()
getDimensionValuesRequest - A Consumer that will call methods on GetDimensionValuesRequest.Builder to create a
request.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.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.AwsServiceExceptiondefault GetReservationCoverageResponse getReservationCoverage(GetReservationCoverageRequest getReservationCoverageRequest) throws LimitExceededException, DataUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException
Retrieves the reservation coverage for your account, which you can use 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.
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.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.AwsServiceExceptiondefault GetReservationCoverageResponse getReservationCoverage(Consumer<GetReservationCoverageRequest.Builder> getReservationCoverageRequest) throws LimitExceededException, DataUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException
Retrieves the reservation coverage for your account, which you can use 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.
This is a convenience which creates an instance of the GetReservationCoverageRequest.Builder avoiding the
need to create one manually via GetReservationCoverageRequest.builder()
getReservationCoverageRequest - A Consumer that will call methods on GetReservationCoverageRequest.Builder to create a
request. 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.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.AwsServiceExceptiondefault GetReservationPurchaseRecommendationResponse getReservationPurchaseRecommendation(GetReservationPurchaseRecommendationRequest getReservationPurchaseRecommendationRequest) throws LimitExceededException, DataUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException
Gets recommendations for reservation purchases. These recommendations might help you to reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.
Amazon Web Services 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 Amazon Web Services has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of Reserved Instance (RI) to purchase to maximize your estimated savings.
For example, Amazon Web Services 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. Amazon Web Services recommends the smallest size instance in an instance family. This makes
it easier to purchase a size-flexible Reserved Instance (RI). Amazon Web Services also shows the equal number of
normalized units. This way, you can purchase any instance size that you want. For this example, your RI
recommendation is for c4.large because that is the smallest size instance in the c4 instance family.
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.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.AwsServiceExceptiondefault GetReservationPurchaseRecommendationResponse getReservationPurchaseRecommendation(Consumer<GetReservationPurchaseRecommendationRequest.Builder> getReservationPurchaseRecommendationRequest) throws LimitExceededException, DataUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException
Gets recommendations for reservation purchases. These recommendations might help you to reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.
Amazon Web Services 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 Amazon Web Services has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of Reserved Instance (RI) to purchase to maximize your estimated savings.
For example, Amazon Web Services 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. Amazon Web Services recommends the smallest size instance in an instance family. This makes
it easier to purchase a size-flexible Reserved Instance (RI). Amazon Web Services also shows the equal number of
normalized units. This way, you can purchase any instance size that you want. For this example, your RI
recommendation is for c4.large because that is the smallest size instance in the c4 instance family.
This is a convenience which creates an instance of the
GetReservationPurchaseRecommendationRequest.Builder avoiding the need to create one manually via
GetReservationPurchaseRecommendationRequest.builder()
getReservationPurchaseRecommendationRequest - A Consumer that will call methods on GetReservationPurchaseRecommendationRequest.Builder
to create a request.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.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.AwsServiceExceptiondefault GetReservationUtilizationResponse getReservationUtilization(GetReservationUtilizationRequest getReservationUtilizationRequest) throws LimitExceededException, DataUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException
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.
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.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.AwsServiceExceptiondefault GetReservationUtilizationResponse getReservationUtilization(Consumer<GetReservationUtilizationRequest.Builder> getReservationUtilizationRequest) throws LimitExceededException, DataUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException
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.
This is a convenience which creates an instance of the GetReservationUtilizationRequest.Builder avoiding
the need to create one manually via GetReservationUtilizationRequest.builder()
getReservationUtilizationRequest - A Consumer that will call methods on GetReservationUtilizationRequest.Builder to create a
request.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.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.AwsServiceExceptiondefault GetRightsizingRecommendationResponse getRightsizingRecommendation(GetRightsizingRecommendationRequest getRightsizingRecommendationRequest) throws LimitExceededException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException
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 more information about calculation and function, see Optimizing Your Cost with Rightsizing Recommendations in the Billing and Cost Management User Guide.
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.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.AwsServiceExceptiondefault GetRightsizingRecommendationResponse getRightsizingRecommendation(Consumer<GetRightsizingRecommendationRequest.Builder> getRightsizingRecommendationRequest) throws LimitExceededException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException
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 more information about calculation and function, see Optimizing Your Cost with Rightsizing Recommendations in the Billing and Cost Management User Guide.
This is a convenience which creates an instance of the GetRightsizingRecommendationRequest.Builder
avoiding the need to create one manually via GetRightsizingRecommendationRequest.builder()
getRightsizingRecommendationRequest - A Consumer that will call methods on GetRightsizingRecommendationRequest.Builder to create
a request.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.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.AwsServiceExceptiondefault GetSavingsPlansCoverageResponse getSavingsPlansCoverage(GetSavingsPlansCoverageRequest getSavingsPlansCoverageRequest) throws LimitExceededException, DataUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException
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.
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.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.AwsServiceExceptiondefault GetSavingsPlansCoverageResponse getSavingsPlansCoverage(Consumer<GetSavingsPlansCoverageRequest.Builder> getSavingsPlansCoverageRequest) throws LimitExceededException, DataUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException
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.
This is a convenience which creates an instance of the GetSavingsPlansCoverageRequest.Builder avoiding
the need to create one manually via GetSavingsPlansCoverageRequest.builder()
getSavingsPlansCoverageRequest - A Consumer that will call methods on GetSavingsPlansCoverageRequest.Builder to create a
request.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.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.AwsServiceExceptiondefault GetSavingsPlansCoverageIterable getSavingsPlansCoveragePaginator(GetSavingsPlansCoverageRequest getSavingsPlansCoverageRequest) throws LimitExceededException, DataUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException
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.
This is a variant of
getSavingsPlansCoverage(software.amazon.awssdk.services.costexplorer.model.GetSavingsPlansCoverageRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.costexplorer.paginators.GetSavingsPlansCoverageIterable responses = client.getSavingsPlansCoveragePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.costexplorer.paginators.GetSavingsPlansCoverageIterable responses = client
.getSavingsPlansCoveragePaginator(request);
for (software.amazon.awssdk.services.costexplorer.model.GetSavingsPlansCoverageResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.costexplorer.paginators.GetSavingsPlansCoverageIterable responses = client.getSavingsPlansCoveragePaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSavingsPlansCoverage(software.amazon.awssdk.services.costexplorer.model.GetSavingsPlansCoverageRequest)
operation.
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.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.AwsServiceExceptiondefault GetSavingsPlansCoverageIterable getSavingsPlansCoveragePaginator(Consumer<GetSavingsPlansCoverageRequest.Builder> getSavingsPlansCoverageRequest) throws LimitExceededException, DataUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException
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.
This is a variant of
getSavingsPlansCoverage(software.amazon.awssdk.services.costexplorer.model.GetSavingsPlansCoverageRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.costexplorer.paginators.GetSavingsPlansCoverageIterable responses = client.getSavingsPlansCoveragePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.costexplorer.paginators.GetSavingsPlansCoverageIterable responses = client
.getSavingsPlansCoveragePaginator(request);
for (software.amazon.awssdk.services.costexplorer.model.GetSavingsPlansCoverageResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.costexplorer.paginators.GetSavingsPlansCoverageIterable responses = client.getSavingsPlansCoveragePaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSavingsPlansCoverage(software.amazon.awssdk.services.costexplorer.model.GetSavingsPlansCoverageRequest)
operation.
This is a convenience which creates an instance of the GetSavingsPlansCoverageRequest.Builder avoiding
the need to create one manually via GetSavingsPlansCoverageRequest.builder()
getSavingsPlansCoverageRequest - A Consumer that will call methods on GetSavingsPlansCoverageRequest.Builder to create a
request.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.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.AwsServiceExceptiondefault GetSavingsPlansPurchaseRecommendationResponse getSavingsPlansPurchaseRecommendation(GetSavingsPlansPurchaseRecommendationRequest getSavingsPlansPurchaseRecommendationRequest) throws LimitExceededException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException
Retrieves your request parameters, Savings Plan Recommendations Summary and Details.
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.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.AwsServiceExceptiondefault GetSavingsPlansPurchaseRecommendationResponse getSavingsPlansPurchaseRecommendation(Consumer<GetSavingsPlansPurchaseRecommendationRequest.Builder> getSavingsPlansPurchaseRecommendationRequest) throws LimitExceededException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException
Retrieves your request parameters, Savings Plan Recommendations Summary and Details.
This is a convenience which creates an instance of the
GetSavingsPlansPurchaseRecommendationRequest.Builder avoiding the need to create one manually via
GetSavingsPlansPurchaseRecommendationRequest.builder()
getSavingsPlansPurchaseRecommendationRequest - A Consumer that will call methods on GetSavingsPlansPurchaseRecommendationRequest.Builder
to create a request.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.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.AwsServiceExceptiondefault GetSavingsPlansUtilizationResponse getSavingsPlansUtilization(GetSavingsPlansUtilizationRequest getSavingsPlansUtilizationRequest) throws LimitExceededException, DataUnavailableException, AwsServiceException, SdkClientException, CostExplorerException
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 can't group by any dimension values for GetSavingsPlansUtilization.
getSavingsPlansUtilizationRequest - LimitExceededException - You made too many calls in a short period of time. Try again later.DataUnavailableException - The requested data is unavailable.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.AwsServiceExceptiondefault GetSavingsPlansUtilizationResponse getSavingsPlansUtilization(Consumer<GetSavingsPlansUtilizationRequest.Builder> getSavingsPlansUtilizationRequest) throws LimitExceededException, DataUnavailableException, AwsServiceException, SdkClientException, CostExplorerException
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 can't group by any dimension values for GetSavingsPlansUtilization.
This is a convenience which creates an instance of the GetSavingsPlansUtilizationRequest.Builder avoiding
the need to create one manually via GetSavingsPlansUtilizationRequest.builder()
getSavingsPlansUtilizationRequest - A Consumer that will call methods on GetSavingsPlansUtilizationRequest.Builder to create a
request.LimitExceededException - You made too many calls in a short period of time. Try again later.DataUnavailableException - The requested data is unavailable.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.AwsServiceExceptiondefault GetSavingsPlansUtilizationDetailsResponse getSavingsPlansUtilizationDetails(GetSavingsPlansUtilizationDetailsRequest getSavingsPlansUtilizationDetailsRequest) throws LimitExceededException, DataUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException
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.
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.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.AwsServiceExceptiondefault GetSavingsPlansUtilizationDetailsResponse getSavingsPlansUtilizationDetails(Consumer<GetSavingsPlansUtilizationDetailsRequest.Builder> getSavingsPlansUtilizationDetailsRequest) throws LimitExceededException, DataUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException
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.
This is a convenience which creates an instance of the GetSavingsPlansUtilizationDetailsRequest.Builder
avoiding the need to create one manually via GetSavingsPlansUtilizationDetailsRequest.builder()
getSavingsPlansUtilizationDetailsRequest - A Consumer that will call methods on GetSavingsPlansUtilizationDetailsRequest.Builder to
create a request.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.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.AwsServiceExceptiondefault GetSavingsPlansUtilizationDetailsIterable getSavingsPlansUtilizationDetailsPaginator(GetSavingsPlansUtilizationDetailsRequest getSavingsPlansUtilizationDetailsRequest) throws LimitExceededException, DataUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException
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.
This is a variant of
getSavingsPlansUtilizationDetails(software.amazon.awssdk.services.costexplorer.model.GetSavingsPlansUtilizationDetailsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.costexplorer.paginators.GetSavingsPlansUtilizationDetailsIterable responses = client.getSavingsPlansUtilizationDetailsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.costexplorer.paginators.GetSavingsPlansUtilizationDetailsIterable responses = client
.getSavingsPlansUtilizationDetailsPaginator(request);
for (software.amazon.awssdk.services.costexplorer.model.GetSavingsPlansUtilizationDetailsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.costexplorer.paginators.GetSavingsPlansUtilizationDetailsIterable responses = client.getSavingsPlansUtilizationDetailsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSavingsPlansUtilizationDetails(software.amazon.awssdk.services.costexplorer.model.GetSavingsPlansUtilizationDetailsRequest)
operation.
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.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.AwsServiceExceptiondefault GetSavingsPlansUtilizationDetailsIterable getSavingsPlansUtilizationDetailsPaginator(Consumer<GetSavingsPlansUtilizationDetailsRequest.Builder> getSavingsPlansUtilizationDetailsRequest) throws LimitExceededException, DataUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException
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.
This is a variant of
getSavingsPlansUtilizationDetails(software.amazon.awssdk.services.costexplorer.model.GetSavingsPlansUtilizationDetailsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.costexplorer.paginators.GetSavingsPlansUtilizationDetailsIterable responses = client.getSavingsPlansUtilizationDetailsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.costexplorer.paginators.GetSavingsPlansUtilizationDetailsIterable responses = client
.getSavingsPlansUtilizationDetailsPaginator(request);
for (software.amazon.awssdk.services.costexplorer.model.GetSavingsPlansUtilizationDetailsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.costexplorer.paginators.GetSavingsPlansUtilizationDetailsIterable responses = client.getSavingsPlansUtilizationDetailsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSavingsPlansUtilizationDetails(software.amazon.awssdk.services.costexplorer.model.GetSavingsPlansUtilizationDetailsRequest)
operation.
This is a convenience which creates an instance of the GetSavingsPlansUtilizationDetailsRequest.Builder
avoiding the need to create one manually via GetSavingsPlansUtilizationDetailsRequest.builder()
getSavingsPlansUtilizationDetailsRequest - A Consumer that will call methods on GetSavingsPlansUtilizationDetailsRequest.Builder to
create a request.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.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.AwsServiceExceptiondefault GetTagsResponse getTags(GetTagsRequest getTagsRequest) throws LimitExceededException, BillExpirationException, DataUnavailableException, InvalidNextTokenException, RequestChangedException, AwsServiceException, SdkClientException, CostExplorerException
Queries 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.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.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.AwsServiceExceptiondefault GetTagsResponse getTags(Consumer<GetTagsRequest.Builder> getTagsRequest) throws LimitExceededException, BillExpirationException, DataUnavailableException, InvalidNextTokenException, RequestChangedException, AwsServiceException, SdkClientException, CostExplorerException
Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string.
This is a convenience which creates an instance of the GetTagsRequest.Builder avoiding the need to create
one manually via GetTagsRequest.builder()
getTagsRequest - A Consumer that will call methods on GetTagsRequest.Builder to create a request.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.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.AwsServiceExceptiondefault GetUsageForecastResponse getUsageForecast(GetUsageForecastRequest getUsageForecastRequest) throws LimitExceededException, DataUnavailableException, UnresolvableUsageUnitException, AwsServiceException, SdkClientException, CostExplorerException
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.
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.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.AwsServiceExceptiondefault GetUsageForecastResponse getUsageForecast(Consumer<GetUsageForecastRequest.Builder> getUsageForecastRequest) throws LimitExceededException, DataUnavailableException, UnresolvableUsageUnitException, AwsServiceException, SdkClientException, CostExplorerException
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.
This is a convenience which creates an instance of the GetUsageForecastRequest.Builder avoiding the need
to create one manually via GetUsageForecastRequest.builder()
getUsageForecastRequest - A Consumer that will call methods on GetUsageForecastRequest.Builder to create a request.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.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.AwsServiceExceptiondefault ListCostAllocationTagsResponse listCostAllocationTags(ListCostAllocationTagsRequest listCostAllocationTagsRequest) throws LimitExceededException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException
Get a list of cost allocation tags. All inputs in the API are optional and serve as filters. By default, all cost allocation tags are returned.
listCostAllocationTagsRequest - 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.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.AwsServiceExceptiondefault ListCostAllocationTagsResponse listCostAllocationTags(Consumer<ListCostAllocationTagsRequest.Builder> listCostAllocationTagsRequest) throws LimitExceededException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException
Get a list of cost allocation tags. All inputs in the API are optional and serve as filters. By default, all cost allocation tags are returned.
This is a convenience which creates an instance of the ListCostAllocationTagsRequest.Builder avoiding the
need to create one manually via ListCostAllocationTagsRequest.builder()
listCostAllocationTagsRequest - A Consumer that will call methods on ListCostAllocationTagsRequest.Builder to create a
request.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.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.AwsServiceExceptiondefault ListCostAllocationTagsIterable listCostAllocationTagsPaginator(ListCostAllocationTagsRequest listCostAllocationTagsRequest) throws LimitExceededException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException
Get a list of cost allocation tags. All inputs in the API are optional and serve as filters. By default, all cost allocation tags are returned.
This is a variant of
listCostAllocationTags(software.amazon.awssdk.services.costexplorer.model.ListCostAllocationTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.costexplorer.paginators.ListCostAllocationTagsIterable responses = client.listCostAllocationTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.costexplorer.paginators.ListCostAllocationTagsIterable responses = client
.listCostAllocationTagsPaginator(request);
for (software.amazon.awssdk.services.costexplorer.model.ListCostAllocationTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.costexplorer.paginators.ListCostAllocationTagsIterable responses = client.listCostAllocationTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCostAllocationTags(software.amazon.awssdk.services.costexplorer.model.ListCostAllocationTagsRequest)
operation.
listCostAllocationTagsRequest - 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.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.AwsServiceExceptiondefault ListCostAllocationTagsIterable listCostAllocationTagsPaginator(Consumer<ListCostAllocationTagsRequest.Builder> listCostAllocationTagsRequest) throws LimitExceededException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException
Get a list of cost allocation tags. All inputs in the API are optional and serve as filters. By default, all cost allocation tags are returned.
This is a variant of
listCostAllocationTags(software.amazon.awssdk.services.costexplorer.model.ListCostAllocationTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.costexplorer.paginators.ListCostAllocationTagsIterable responses = client.listCostAllocationTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.costexplorer.paginators.ListCostAllocationTagsIterable responses = client
.listCostAllocationTagsPaginator(request);
for (software.amazon.awssdk.services.costexplorer.model.ListCostAllocationTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.costexplorer.paginators.ListCostAllocationTagsIterable responses = client.listCostAllocationTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCostAllocationTags(software.amazon.awssdk.services.costexplorer.model.ListCostAllocationTagsRequest)
operation.
This is a convenience which creates an instance of the ListCostAllocationTagsRequest.Builder avoiding the
need to create one manually via ListCostAllocationTagsRequest.builder()
listCostAllocationTagsRequest - A Consumer that will call methods on ListCostAllocationTagsRequest.Builder to create a
request.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.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.AwsServiceExceptiondefault ListCostCategoryDefinitionsResponse listCostCategoryDefinitions(ListCostCategoryDefinitionsRequest listCostCategoryDefinitionsRequest) throws LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException
Returns the name, Amazon Resource 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.
listCostCategoryDefinitionsRequest - 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.AwsServiceExceptiondefault ListCostCategoryDefinitionsResponse listCostCategoryDefinitions(Consumer<ListCostCategoryDefinitionsRequest.Builder> listCostCategoryDefinitionsRequest) throws LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException
Returns the name, Amazon Resource 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.
This is a convenience which creates an instance of the ListCostCategoryDefinitionsRequest.Builder
avoiding the need to create one manually via ListCostCategoryDefinitionsRequest.builder()
listCostCategoryDefinitionsRequest - A Consumer that will call methods on ListCostCategoryDefinitionsRequest.Builder to create
a request.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.AwsServiceExceptiondefault ListCostCategoryDefinitionsIterable listCostCategoryDefinitionsPaginator(ListCostCategoryDefinitionsRequest listCostCategoryDefinitionsRequest) throws LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException
Returns the name, Amazon Resource 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.
This is a variant of
listCostCategoryDefinitions(software.amazon.awssdk.services.costexplorer.model.ListCostCategoryDefinitionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.costexplorer.paginators.ListCostCategoryDefinitionsIterable responses = client.listCostCategoryDefinitionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.costexplorer.paginators.ListCostCategoryDefinitionsIterable responses = client
.listCostCategoryDefinitionsPaginator(request);
for (software.amazon.awssdk.services.costexplorer.model.ListCostCategoryDefinitionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.costexplorer.paginators.ListCostCategoryDefinitionsIterable responses = client.listCostCategoryDefinitionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCostCategoryDefinitions(software.amazon.awssdk.services.costexplorer.model.ListCostCategoryDefinitionsRequest)
operation.
listCostCategoryDefinitionsRequest - 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.AwsServiceExceptiondefault ListCostCategoryDefinitionsIterable listCostCategoryDefinitionsPaginator(Consumer<ListCostCategoryDefinitionsRequest.Builder> listCostCategoryDefinitionsRequest) throws LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException
Returns the name, Amazon Resource 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.
This is a variant of
listCostCategoryDefinitions(software.amazon.awssdk.services.costexplorer.model.ListCostCategoryDefinitionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.costexplorer.paginators.ListCostCategoryDefinitionsIterable responses = client.listCostCategoryDefinitionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.costexplorer.paginators.ListCostCategoryDefinitionsIterable responses = client
.listCostCategoryDefinitionsPaginator(request);
for (software.amazon.awssdk.services.costexplorer.model.ListCostCategoryDefinitionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.costexplorer.paginators.ListCostCategoryDefinitionsIterable responses = client.listCostCategoryDefinitionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCostCategoryDefinitions(software.amazon.awssdk.services.costexplorer.model.ListCostCategoryDefinitionsRequest)
operation.
This is a convenience which creates an instance of the ListCostCategoryDefinitionsRequest.Builder
avoiding the need to create one manually via ListCostCategoryDefinitionsRequest.builder()
listCostCategoryDefinitionsRequest - A Consumer that will call methods on ListCostCategoryDefinitionsRequest.Builder to create
a request.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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException
Returns a list of resource tags associated with the resource specified by the Amazon Resource Name (ARN).
listTagsForResourceRequest - 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.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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException
Returns a list of resource tags associated with the resource specified by the Amazon Resource Name (ARN).
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.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.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.AwsServiceExceptiondefault ProvideAnomalyFeedbackResponse provideAnomalyFeedback(ProvideAnomalyFeedbackRequest provideAnomalyFeedbackRequest) throws LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException
Modifies the feedback property of a given cost anomaly.
provideAnomalyFeedbackRequest - 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.AwsServiceExceptiondefault ProvideAnomalyFeedbackResponse provideAnomalyFeedback(Consumer<ProvideAnomalyFeedbackRequest.Builder> provideAnomalyFeedbackRequest) throws LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException
Modifies the feedback property of a given cost anomaly.
This is a convenience which creates an instance of the ProvideAnomalyFeedbackRequest.Builder avoiding the
need to create one manually via ProvideAnomalyFeedbackRequest.builder()
provideAnomalyFeedbackRequest - A Consumer that will call methods on ProvideAnomalyFeedbackRequest.Builder to create a
request.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.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, TooManyTagsException, LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException
An API operation for adding one or more tags (key-value pairs) to a resource.
You can use the TagResource operation with a resource that already has tags. If you specify a new
tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a
tag key that is already associated with the resource, the new tag value you specify replaces the previous value
for that tag.
Although the maximum number of array members is 200, user-tag maximum is 50. The remaining are reserved for Amazon Web Services use.
tagResourceRequest - ResourceNotFoundException - The specified ARN in the request doesn't exist.TooManyTagsException - Can occur if you specify a number of tags for a resource greater than the maximum 50 user tags per
resource.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.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, TooManyTagsException, LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException
An API operation for adding one or more tags (key-value pairs) to a resource.
You can use the TagResource operation with a resource that already has tags. If you specify a new
tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a
tag key that is already associated with the resource, the new tag value you specify replaces the previous value
for that tag.
Although the maximum number of array members is 200, user-tag maximum is 50. The remaining are reserved for Amazon Web Services use.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.ResourceNotFoundException - The specified ARN in the request doesn't exist.TooManyTagsException - Can occur if you specify a number of tags for a resource greater than the maximum 50 user tags per
resource.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.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException
Removes one or more tags from a resource. Specify only tag keys in your request. Don't specify the value.
untagResourceRequest - 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.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.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException
Removes one or more tags from a resource. Specify only tag keys in your request. Don't specify the value.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.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.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.AwsServiceExceptiondefault UpdateAnomalyMonitorResponse updateAnomalyMonitor(UpdateAnomalyMonitorRequest updateAnomalyMonitorRequest) throws LimitExceededException, UnknownMonitorException, AwsServiceException, SdkClientException, CostExplorerException
Updates an existing cost anomaly monitor. The changes made are applied going forward, and doesn't change anomalies detected in the past.
updateAnomalyMonitorRequest - 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.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.AwsServiceExceptiondefault UpdateAnomalyMonitorResponse updateAnomalyMonitor(Consumer<UpdateAnomalyMonitorRequest.Builder> updateAnomalyMonitorRequest) throws LimitExceededException, UnknownMonitorException, AwsServiceException, SdkClientException, CostExplorerException
Updates an existing cost anomaly monitor. The changes made are applied going forward, and doesn't change anomalies detected in the past.
This is a convenience which creates an instance of the UpdateAnomalyMonitorRequest.Builder avoiding the
need to create one manually via UpdateAnomalyMonitorRequest.builder()
updateAnomalyMonitorRequest - A Consumer that will call methods on UpdateAnomalyMonitorRequest.Builder to create a
request.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.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.AwsServiceExceptiondefault UpdateAnomalySubscriptionResponse updateAnomalySubscription(UpdateAnomalySubscriptionRequest updateAnomalySubscriptionRequest) throws LimitExceededException, UnknownMonitorException, UnknownSubscriptionException, AwsServiceException, SdkClientException, CostExplorerException
Updates an existing cost anomaly monitor subscription.
updateAnomalySubscriptionRequest - 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.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.AwsServiceExceptiondefault UpdateAnomalySubscriptionResponse updateAnomalySubscription(Consumer<UpdateAnomalySubscriptionRequest.Builder> updateAnomalySubscriptionRequest) throws LimitExceededException, UnknownMonitorException, UnknownSubscriptionException, AwsServiceException, SdkClientException, CostExplorerException
Updates an existing cost anomaly monitor subscription.
This is a convenience which creates an instance of the UpdateAnomalySubscriptionRequest.Builder avoiding
the need to create one manually via UpdateAnomalySubscriptionRequest.builder()
updateAnomalySubscriptionRequest - A Consumer that will call methods on UpdateAnomalySubscriptionRequest.Builder to create a
request.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.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.AwsServiceExceptiondefault UpdateCostAllocationTagsStatusResponse updateCostAllocationTagsStatus(UpdateCostAllocationTagsStatusRequest updateCostAllocationTagsStatusRequest) throws LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException
Updates status for cost allocation tags in bulk, with maximum batch size of 20. If the tag status that's updated is the same as the existing tag status, the request doesn't fail. Instead, it doesn't have any effect on the tag status (for example, activating the active tag).
updateCostAllocationTagsStatusRequest - 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.AwsServiceExceptiondefault UpdateCostAllocationTagsStatusResponse updateCostAllocationTagsStatus(Consumer<UpdateCostAllocationTagsStatusRequest.Builder> updateCostAllocationTagsStatusRequest) throws LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException
Updates status for cost allocation tags in bulk, with maximum batch size of 20. If the tag status that's updated is the same as the existing tag status, the request doesn't fail. Instead, it doesn't have any effect on the tag status (for example, activating the active tag).
This is a convenience which creates an instance of the UpdateCostAllocationTagsStatusRequest.Builder
avoiding the need to create one manually via UpdateCostAllocationTagsStatusRequest.builder()
updateCostAllocationTagsStatusRequest - A Consumer that will call methods on UpdateCostAllocationTagsStatusRequest.Builder to
create a request.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.AwsServiceExceptiondefault UpdateCostCategoryDefinitionResponse updateCostCategoryDefinition(UpdateCostCategoryDefinitionRequest updateCostCategoryDefinitionRequest) throws ResourceNotFoundException, ServiceQuotaExceededException, LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException
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.
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
resource.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.AwsServiceExceptiondefault UpdateCostCategoryDefinitionResponse updateCostCategoryDefinition(Consumer<UpdateCostCategoryDefinitionRequest.Builder> updateCostCategoryDefinitionRequest) throws ResourceNotFoundException, ServiceQuotaExceededException, LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException
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.
This is a convenience which creates an instance of the UpdateCostCategoryDefinitionRequest.Builder
avoiding the need to create one manually via UpdateCostCategoryDefinitionRequest.builder()
updateCostCategoryDefinitionRequest - A Consumer that will call methods on UpdateCostCategoryDefinitionRequest.Builder to create
a request.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.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.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2022. All rights reserved.