Interface CostExplorerClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionstatic CostExplorerClientBuilderbuilder()Create a builder that can be used to configure and create aCostExplorerClient.static CostExplorerClientcreate()Create aCostExplorerClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateAnomalyMonitorResponsecreateAnomalyMonitor(Consumer<CreateAnomalyMonitorRequest.Builder> createAnomalyMonitorRequest) Creates a new cost anomaly detection monitor with the requested type and monitor specification.default CreateAnomalyMonitorResponsecreateAnomalyMonitor(CreateAnomalyMonitorRequest createAnomalyMonitorRequest) Creates a new cost anomaly detection monitor with the requested type and monitor specification.createAnomalySubscription(Consumer<CreateAnomalySubscriptionRequest.Builder> createAnomalySubscriptionRequest) Adds an alert subscription to a cost anomaly detection monitor.createAnomalySubscription(CreateAnomalySubscriptionRequest createAnomalySubscriptionRequest) Adds an alert subscription to a cost anomaly detection monitor.createCostCategoryDefinition(Consumer<CreateCostCategoryDefinitionRequest.Builder> createCostCategoryDefinitionRequest) Creates a new Cost Category with the requested name and rules.createCostCategoryDefinition(CreateCostCategoryDefinitionRequest createCostCategoryDefinitionRequest) Creates a new Cost Category with the requested name and rules.default DeleteAnomalyMonitorResponsedeleteAnomalyMonitor(Consumer<DeleteAnomalyMonitorRequest.Builder> deleteAnomalyMonitorRequest) Deletes a cost anomaly monitor.default DeleteAnomalyMonitorResponsedeleteAnomalyMonitor(DeleteAnomalyMonitorRequest deleteAnomalyMonitorRequest) Deletes a cost anomaly monitor.deleteAnomalySubscription(Consumer<DeleteAnomalySubscriptionRequest.Builder> deleteAnomalySubscriptionRequest) Deletes a cost anomaly subscription.deleteAnomalySubscription(DeleteAnomalySubscriptionRequest deleteAnomalySubscriptionRequest) Deletes a cost anomaly subscription.deleteCostCategoryDefinition(Consumer<DeleteCostCategoryDefinitionRequest.Builder> deleteCostCategoryDefinitionRequest) Deletes a Cost Category.deleteCostCategoryDefinition(DeleteCostCategoryDefinitionRequest deleteCostCategoryDefinitionRequest) Deletes a Cost Category.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.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 GetAnomaliesResponsegetAnomalies(Consumer<GetAnomaliesRequest.Builder> getAnomaliesRequest) Retrieves all of the cost anomalies detected on your account during the time period that's specified by theDateIntervalobject.default GetAnomaliesResponsegetAnomalies(GetAnomaliesRequest getAnomaliesRequest) Retrieves all of the cost anomalies detected on your account during the time period that's specified by theDateIntervalobject.default GetAnomalyMonitorsResponsegetAnomalyMonitors(Consumer<GetAnomalyMonitorsRequest.Builder> getAnomalyMonitorsRequest) Retrieves the cost anomaly monitor definitions for your account.default GetAnomalyMonitorsResponsegetAnomalyMonitors(GetAnomalyMonitorsRequest getAnomalyMonitorsRequest) Retrieves the cost anomaly monitor definitions for your account.default GetAnomalySubscriptionsResponsegetAnomalySubscriptions(Consumer<GetAnomalySubscriptionsRequest.Builder> getAnomalySubscriptionsRequest) Retrieves the cost anomaly subscription objects for your account.default GetAnomalySubscriptionsResponsegetAnomalySubscriptions(GetAnomalySubscriptionsRequest getAnomalySubscriptionsRequest) Retrieves the cost anomaly subscription objects for your account.getApproximateUsageRecords(Consumer<GetApproximateUsageRecordsRequest.Builder> getApproximateUsageRecordsRequest) Retrieves estimated usage records for hourly granularity or resource-level data at daily granularity.getApproximateUsageRecords(GetApproximateUsageRecordsRequest getApproximateUsageRecordsRequest) Retrieves estimated usage records for hourly granularity or resource-level data at daily granularity.default GetCostAndUsageResponsegetCostAndUsage(Consumer<GetCostAndUsageRequest.Builder> getCostAndUsageRequest) Retrieves cost and usage metrics for your account.default GetCostAndUsageResponsegetCostAndUsage(GetCostAndUsageRequest getCostAndUsageRequest) Retrieves cost and usage metrics for your account.getCostAndUsageWithResources(Consumer<GetCostAndUsageWithResourcesRequest.Builder> getCostAndUsageWithResourcesRequest) Retrieves cost and usage metrics with resources for your account.getCostAndUsageWithResources(GetCostAndUsageWithResourcesRequest getCostAndUsageWithResourcesRequest) Retrieves cost and usage metrics with resources for your account.default GetCostCategoriesResponsegetCostCategories(Consumer<GetCostCategoriesRequest.Builder> getCostCategoriesRequest) Retrieves an array of Cost Category names and values incurred cost.default GetCostCategoriesResponsegetCostCategories(GetCostCategoriesRequest getCostCategoriesRequest) Retrieves an array of Cost Category names and values incurred cost.default GetCostForecastResponsegetCostForecast(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 GetCostForecastResponsegetCostForecast(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 GetDimensionValuesResponsegetDimensionValues(Consumer<GetDimensionValuesRequest.Builder> getDimensionValuesRequest) Retrieves all available filter values for a specified filter over a period of time.default GetDimensionValuesResponsegetDimensionValues(GetDimensionValuesRequest getDimensionValuesRequest) Retrieves all available filter values for a specified filter over a period of time.default GetReservationCoverageResponsegetReservationCoverage(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 GetReservationCoverageResponsegetReservationCoverage(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.getReservationPurchaseRecommendation(Consumer<GetReservationPurchaseRecommendationRequest.Builder> getReservationPurchaseRecommendationRequest) Gets recommendations for reservation purchases.getReservationPurchaseRecommendation(GetReservationPurchaseRecommendationRequest getReservationPurchaseRecommendationRequest) Gets recommendations for reservation purchases.getReservationUtilization(Consumer<GetReservationUtilizationRequest.Builder> getReservationUtilizationRequest) Retrieves the reservation utilization for your account.getReservationUtilization(GetReservationUtilizationRequest getReservationUtilizationRequest) Retrieves the reservation utilization for your account.getRightsizingRecommendation(Consumer<GetRightsizingRecommendationRequest.Builder> getRightsizingRecommendationRequest) Creates recommendations that help you save cost by identifying idle and underutilized Amazon EC2 instances.getRightsizingRecommendation(GetRightsizingRecommendationRequest getRightsizingRecommendationRequest) Creates recommendations that help you save cost by identifying idle and underutilized Amazon EC2 instances.getSavingsPlanPurchaseRecommendationDetails(Consumer<GetSavingsPlanPurchaseRecommendationDetailsRequest.Builder> getSavingsPlanPurchaseRecommendationDetailsRequest) Retrieves the details for a Savings Plan recommendation.getSavingsPlanPurchaseRecommendationDetails(GetSavingsPlanPurchaseRecommendationDetailsRequest getSavingsPlanPurchaseRecommendationDetailsRequest) Retrieves the details for a Savings Plan recommendation.default GetSavingsPlansCoverageResponsegetSavingsPlansCoverage(Consumer<GetSavingsPlansCoverageRequest.Builder> getSavingsPlansCoverageRequest) Retrieves the Savings Plans covered for your account.default GetSavingsPlansCoverageResponsegetSavingsPlansCoverage(GetSavingsPlansCoverageRequest getSavingsPlansCoverageRequest) Retrieves the Savings Plans covered for your account.default GetSavingsPlansCoverageIterablegetSavingsPlansCoveragePaginator(Consumer<GetSavingsPlansCoverageRequest.Builder> getSavingsPlansCoverageRequest) This is a variant ofgetSavingsPlansCoverage(software.amazon.awssdk.services.costexplorer.model.GetSavingsPlansCoverageRequest)operation.default GetSavingsPlansCoverageIterablegetSavingsPlansCoveragePaginator(GetSavingsPlansCoverageRequest getSavingsPlansCoverageRequest) This is a variant ofgetSavingsPlansCoverage(software.amazon.awssdk.services.costexplorer.model.GetSavingsPlansCoverageRequest)operation.getSavingsPlansPurchaseRecommendation(Consumer<GetSavingsPlansPurchaseRecommendationRequest.Builder> getSavingsPlansPurchaseRecommendationRequest) Retrieves the Savings Plans recommendations for your account.getSavingsPlansPurchaseRecommendation(GetSavingsPlansPurchaseRecommendationRequest getSavingsPlansPurchaseRecommendationRequest) Retrieves the Savings Plans recommendations for your account.getSavingsPlansUtilization(Consumer<GetSavingsPlansUtilizationRequest.Builder> getSavingsPlansUtilizationRequest) Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity.getSavingsPlansUtilization(GetSavingsPlansUtilizationRequest getSavingsPlansUtilizationRequest) Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity.getSavingsPlansUtilizationDetails(Consumer<GetSavingsPlansUtilizationDetailsRequest.Builder> getSavingsPlansUtilizationDetailsRequest) Retrieves attribute data along with aggregate utilization and savings data for a given time period.getSavingsPlansUtilizationDetails(GetSavingsPlansUtilizationDetailsRequest getSavingsPlansUtilizationDetailsRequest) Retrieves attribute data along with aggregate utilization and savings data for a given time period.getSavingsPlansUtilizationDetailsPaginator(Consumer<GetSavingsPlansUtilizationDetailsRequest.Builder> getSavingsPlansUtilizationDetailsRequest) This is a variant ofgetSavingsPlansUtilizationDetails(software.amazon.awssdk.services.costexplorer.model.GetSavingsPlansUtilizationDetailsRequest)operation.getSavingsPlansUtilizationDetailsPaginator(GetSavingsPlansUtilizationDetailsRequest getSavingsPlansUtilizationDetailsRequest) This is a variant ofgetSavingsPlansUtilizationDetails(software.amazon.awssdk.services.costexplorer.model.GetSavingsPlansUtilizationDetailsRequest)operation.default GetTagsResponsegetTags(Consumer<GetTagsRequest.Builder> getTagsRequest) Queries for available tag keys and tag values for a specified period.default GetTagsResponsegetTags(GetTagsRequest getTagsRequest) Queries for available tag keys and tag values for a specified period.default GetUsageForecastResponsegetUsageForecast(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 GetUsageForecastResponsegetUsageForecast(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.listCostAllocationTagBackfillHistory(Consumer<ListCostAllocationTagBackfillHistoryRequest.Builder> listCostAllocationTagBackfillHistoryRequest) Retrieves a list of your historical cost allocation tag backfill requests.listCostAllocationTagBackfillHistory(ListCostAllocationTagBackfillHistoryRequest listCostAllocationTagBackfillHistoryRequest) Retrieves a list of your historical cost allocation tag backfill requests.listCostAllocationTagBackfillHistoryPaginator(Consumer<ListCostAllocationTagBackfillHistoryRequest.Builder> listCostAllocationTagBackfillHistoryRequest) listCostAllocationTagBackfillHistoryPaginator(ListCostAllocationTagBackfillHistoryRequest listCostAllocationTagBackfillHistoryRequest) default ListCostAllocationTagsResponselistCostAllocationTags(Consumer<ListCostAllocationTagsRequest.Builder> listCostAllocationTagsRequest) Get a list of cost allocation tags.default ListCostAllocationTagsResponselistCostAllocationTags(ListCostAllocationTagsRequest listCostAllocationTagsRequest) Get a list of cost allocation tags.default ListCostAllocationTagsIterablelistCostAllocationTagsPaginator(Consumer<ListCostAllocationTagsRequest.Builder> listCostAllocationTagsRequest) This is a variant oflistCostAllocationTags(software.amazon.awssdk.services.costexplorer.model.ListCostAllocationTagsRequest)operation.default ListCostAllocationTagsIterablelistCostAllocationTagsPaginator(ListCostAllocationTagsRequest listCostAllocationTagsRequest) This is a variant oflistCostAllocationTags(software.amazon.awssdk.services.costexplorer.model.ListCostAllocationTagsRequest)operation.listCostCategoryDefinitions(Consumer<ListCostCategoryDefinitionsRequest.Builder> listCostCategoryDefinitionsRequest) Returns the name, Amazon Resource Name (ARN),NumberOfRulesand effective dates of all Cost Categories defined in the account.listCostCategoryDefinitions(ListCostCategoryDefinitionsRequest listCostCategoryDefinitionsRequest) Returns the name, Amazon Resource Name (ARN),NumberOfRulesand effective dates of all Cost Categories defined in the account.listCostCategoryDefinitionsPaginator(Consumer<ListCostCategoryDefinitionsRequest.Builder> listCostCategoryDefinitionsRequest) This is a variant oflistCostCategoryDefinitions(software.amazon.awssdk.services.costexplorer.model.ListCostCategoryDefinitionsRequest)operation.listCostCategoryDefinitionsPaginator(ListCostCategoryDefinitionsRequest listCostCategoryDefinitionsRequest) This is a variant oflistCostCategoryDefinitions(software.amazon.awssdk.services.costexplorer.model.ListCostCategoryDefinitionsRequest)operation.listSavingsPlansPurchaseRecommendationGeneration(Consumer<ListSavingsPlansPurchaseRecommendationGenerationRequest.Builder> listSavingsPlansPurchaseRecommendationGenerationRequest) Retrieves a list of your historical recommendation generations within the past 30 days.listSavingsPlansPurchaseRecommendationGeneration(ListSavingsPlansPurchaseRecommendationGenerationRequest listSavingsPlansPurchaseRecommendationGenerationRequest) Retrieves a list of your historical recommendation generations within the past 30 days.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of resource tags associated with the resource specified by the Amazon Resource Name (ARN).default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of resource tags associated with the resource specified by the Amazon Resource Name (ARN).default ProvideAnomalyFeedbackResponseprovideAnomalyFeedback(Consumer<ProvideAnomalyFeedbackRequest.Builder> provideAnomalyFeedbackRequest) Modifies the feedback property of a given cost anomaly.default ProvideAnomalyFeedbackResponseprovideAnomalyFeedback(ProvideAnomalyFeedbackRequest provideAnomalyFeedbackRequest) Modifies the feedback property of a given cost anomaly.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadatastartCostAllocationTagBackfill(Consumer<StartCostAllocationTagBackfillRequest.Builder> startCostAllocationTagBackfillRequest) Request a cost allocation tag backfill.startCostAllocationTagBackfill(StartCostAllocationTagBackfillRequest startCostAllocationTagBackfillRequest) Request a cost allocation tag backfill.startSavingsPlansPurchaseRecommendationGeneration(Consumer<StartSavingsPlansPurchaseRecommendationGenerationRequest.Builder> startSavingsPlansPurchaseRecommendationGenerationRequest) Requests a Savings Plans recommendation generation.startSavingsPlansPurchaseRecommendationGeneration(StartSavingsPlansPurchaseRecommendationGenerationRequest startSavingsPlansPurchaseRecommendationGenerationRequest) Requests a Savings Plans recommendation generation.default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) An API operation for adding one or more tags (key-value pairs) to a resource.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest) An API operation for adding one or more tags (key-value pairs) to a resource.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags from a resource.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags from a resource.default UpdateAnomalyMonitorResponseupdateAnomalyMonitor(Consumer<UpdateAnomalyMonitorRequest.Builder> updateAnomalyMonitorRequest) Updates an existing cost anomaly monitor.default UpdateAnomalyMonitorResponseupdateAnomalyMonitor(UpdateAnomalyMonitorRequest updateAnomalyMonitorRequest) Updates an existing cost anomaly monitor.updateAnomalySubscription(Consumer<UpdateAnomalySubscriptionRequest.Builder> updateAnomalySubscriptionRequest) Updates an existing cost anomaly subscription.updateAnomalySubscription(UpdateAnomalySubscriptionRequest updateAnomalySubscriptionRequest) Updates an existing cost anomaly subscription.updateCostAllocationTagsStatus(Consumer<UpdateCostAllocationTagsStatusRequest.Builder> updateCostAllocationTagsStatusRequest) Updates status for cost allocation tags in bulk, with maximum batch size of 20.updateCostAllocationTagsStatus(UpdateCostAllocationTagsStatusRequest updateCostAllocationTagsStatusRequest) Updates status for cost allocation tags in bulk, with maximum batch size of 20.updateCostCategoryDefinition(Consumer<UpdateCostCategoryDefinitionRequest.Builder> updateCostCategoryDefinitionRequest) Updates an existing Cost Category.updateCostCategoryDefinition(UpdateCostCategoryDefinitionRequest updateCostCategoryDefinitionRequest) Updates an existing Cost Category.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
createAnomalyMonitor
default CreateAnomalyMonitorResponse createAnomalyMonitor(CreateAnomalyMonitorRequest createAnomalyMonitorRequest) throws LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException Creates a new cost anomaly detection monitor with the requested type and monitor specification.
- Parameters:
createAnomalyMonitorRequest-- Returns:
- Result of the CreateAnomalyMonitor operation returned by the service.
- See Also:
-
createAnomalyMonitor
default 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.Builderavoiding the need to create one manually viaCreateAnomalyMonitorRequest.builder()- Parameters:
createAnomalyMonitorRequest- AConsumerthat will call methods onCreateAnomalyMonitorRequest.Builderto create a request.- Returns:
- Result of the CreateAnomalyMonitor operation returned by the service.
- See Also:
-
createAnomalySubscription
default CreateAnomalySubscriptionResponse createAnomalySubscription(CreateAnomalySubscriptionRequest createAnomalySubscriptionRequest) throws UnknownMonitorException, LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException Adds an alert subscription to a cost anomaly detection monitor. You can use each subscription to define subscribers with email or SNS notifications. Email subscribers can set an absolute or percentage threshold and a time frequency for receiving notifications.
- Parameters:
createAnomalySubscriptionRequest-- Returns:
- Result of the CreateAnomalySubscription operation returned by the service.
- See Also:
-
createAnomalySubscription
default CreateAnomalySubscriptionResponse createAnomalySubscription(Consumer<CreateAnomalySubscriptionRequest.Builder> createAnomalySubscriptionRequest) throws UnknownMonitorException, LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException Adds an alert subscription to a cost anomaly detection monitor. You can use each subscription to define subscribers with email or SNS notifications. Email subscribers can set an absolute or percentage threshold and a time frequency for receiving notifications.
This is a convenience which creates an instance of the
CreateAnomalySubscriptionRequest.Builderavoiding the need to create one manually viaCreateAnomalySubscriptionRequest.builder()- Parameters:
createAnomalySubscriptionRequest- AConsumerthat will call methods onCreateAnomalySubscriptionRequest.Builderto create a request.- Returns:
- Result of the CreateAnomalySubscription operation returned by the service.
- See Also:
-
createCostCategoryDefinition
default CreateCostCategoryDefinitionResponse createCostCategoryDefinition(CreateCostCategoryDefinitionRequest createCostCategoryDefinitionRequest) throws ServiceQuotaExceededException, LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException Creates a new Cost Category with the requested name and rules.
- Parameters:
createCostCategoryDefinitionRequest-- Returns:
- Result of the CreateCostCategoryDefinition operation returned by the service.
- See Also:
-
createCostCategoryDefinition
default 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.Builderavoiding the need to create one manually viaCreateCostCategoryDefinitionRequest.builder()- Parameters:
createCostCategoryDefinitionRequest- AConsumerthat will call methods onCreateCostCategoryDefinitionRequest.Builderto create a request.- Returns:
- Result of the CreateCostCategoryDefinition operation returned by the service.
- See Also:
-
deleteAnomalyMonitor
default DeleteAnomalyMonitorResponse deleteAnomalyMonitor(DeleteAnomalyMonitorRequest deleteAnomalyMonitorRequest) throws LimitExceededException, UnknownMonitorException, AwsServiceException, SdkClientException, CostExplorerException Deletes a cost anomaly monitor.
- Parameters:
deleteAnomalyMonitorRequest-- Returns:
- Result of the DeleteAnomalyMonitor operation returned by the service.
- See Also:
-
deleteAnomalyMonitor
default 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.Builderavoiding the need to create one manually viaDeleteAnomalyMonitorRequest.builder()- Parameters:
deleteAnomalyMonitorRequest- AConsumerthat will call methods onDeleteAnomalyMonitorRequest.Builderto create a request.- Returns:
- Result of the DeleteAnomalyMonitor operation returned by the service.
- See Also:
-
deleteAnomalySubscription
default DeleteAnomalySubscriptionResponse deleteAnomalySubscription(DeleteAnomalySubscriptionRequest deleteAnomalySubscriptionRequest) throws LimitExceededException, UnknownSubscriptionException, AwsServiceException, SdkClientException, CostExplorerException Deletes a cost anomaly subscription.
- Parameters:
deleteAnomalySubscriptionRequest-- Returns:
- Result of the DeleteAnomalySubscription operation returned by the service.
- See Also:
-
deleteAnomalySubscription
default 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.Builderavoiding the need to create one manually viaDeleteAnomalySubscriptionRequest.builder()- Parameters:
deleteAnomalySubscriptionRequest- AConsumerthat will call methods onDeleteAnomalySubscriptionRequest.Builderto create a request.- Returns:
- Result of the DeleteAnomalySubscription operation returned by the service.
- See Also:
-
deleteCostCategoryDefinition
default 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.
- Parameters:
deleteCostCategoryDefinitionRequest-- Returns:
- Result of the DeleteCostCategoryDefinition operation returned by the service.
- See Also:
-
deleteCostCategoryDefinition
default 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.Builderavoiding the need to create one manually viaDeleteCostCategoryDefinitionRequest.builder()- Parameters:
deleteCostCategoryDefinitionRequest- AConsumerthat will call methods onDeleteCostCategoryDefinitionRequest.Builderto create a request.- Returns:
- Result of the DeleteCostCategoryDefinition operation returned by the service.
- See Also:
-
describeCostCategoryDefinition
default 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
EffectiveOnto return a Cost Category that's active on a specific date. If there's noEffectiveOnspecified, you see a Cost Category that's effective on the current date. If Cost Category is still effective,EffectiveEndis omitted in the response.- Parameters:
describeCostCategoryDefinitionRequest-- Returns:
- Result of the DescribeCostCategoryDefinition operation returned by the service.
- See Also:
-
describeCostCategoryDefinition
default 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
EffectiveOnto return a Cost Category that's active on a specific date. If there's noEffectiveOnspecified, you see a Cost Category that's effective on the current date. If Cost Category is still effective,EffectiveEndis omitted in the response.
This is a convenience which creates an instance of the
DescribeCostCategoryDefinitionRequest.Builderavoiding the need to create one manually viaDescribeCostCategoryDefinitionRequest.builder()- Parameters:
describeCostCategoryDefinitionRequest- AConsumerthat will call methods onDescribeCostCategoryDefinitionRequest.Builderto create a request.- Returns:
- Result of the DescribeCostCategoryDefinition operation returned by the service.
- See Also:
-
getAnomalies
default 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
DateIntervalobject. Anomalies are available for up to 90 days.- Parameters:
getAnomaliesRequest-- Returns:
- Result of the GetAnomalies operation returned by the service.
- See Also:
-
getAnomalies
default 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
DateIntervalobject. Anomalies are available for up to 90 days.
This is a convenience which creates an instance of the
GetAnomaliesRequest.Builderavoiding the need to create one manually viaGetAnomaliesRequest.builder()- Parameters:
getAnomaliesRequest- AConsumerthat will call methods onGetAnomaliesRequest.Builderto create a request.- Returns:
- Result of the GetAnomalies operation returned by the service.
- See Also:
-
getAnomalyMonitors
default 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).
- Parameters:
getAnomalyMonitorsRequest-- Returns:
- Result of the GetAnomalyMonitors operation returned by the service.
- See Also:
-
getAnomalyMonitors
default 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.Builderavoiding the need to create one manually viaGetAnomalyMonitorsRequest.builder()- Parameters:
getAnomalyMonitorsRequest- AConsumerthat will call methods onGetAnomalyMonitorsRequest.Builderto create a request.- Returns:
- Result of the GetAnomalyMonitors operation returned by the service.
- See Also:
-
getAnomalySubscriptions
default 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).
- Parameters:
getAnomalySubscriptionsRequest-- Returns:
- Result of the GetAnomalySubscriptions operation returned by the service.
- See Also:
-
getAnomalySubscriptions
default 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.Builderavoiding the need to create one manually viaGetAnomalySubscriptionsRequest.builder()- Parameters:
getAnomalySubscriptionsRequest- AConsumerthat will call methods onGetAnomalySubscriptionsRequest.Builderto create a request.- Returns:
- Result of the GetAnomalySubscriptions operation returned by the service.
- See Also:
-
getApproximateUsageRecords
default GetApproximateUsageRecordsResponse getApproximateUsageRecords(GetApproximateUsageRecordsRequest getApproximateUsageRecordsRequest) throws LimitExceededException, DataUnavailableException, AwsServiceException, SdkClientException, CostExplorerException Retrieves estimated usage records for hourly granularity or resource-level data at daily granularity.
- Parameters:
getApproximateUsageRecordsRequest-- Returns:
- Result of the GetApproximateUsageRecords operation returned by the service.
- See Also:
-
getApproximateUsageRecords
default GetApproximateUsageRecordsResponse getApproximateUsageRecords(Consumer<GetApproximateUsageRecordsRequest.Builder> getApproximateUsageRecordsRequest) throws LimitExceededException, DataUnavailableException, AwsServiceException, SdkClientException, CostExplorerException Retrieves estimated usage records for hourly granularity or resource-level data at daily granularity.
This is a convenience which creates an instance of the
GetApproximateUsageRecordsRequest.Builderavoiding the need to create one manually viaGetApproximateUsageRecordsRequest.builder()- Parameters:
getApproximateUsageRecordsRequest- AConsumerthat will call methods onGetApproximateUsageRecordsRequest.Builderto create a request.- Returns:
- Result of the GetApproximateUsageRecords operation returned by the service.
- See Also:
-
getCostAndUsage
default 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
BlendedCostsorUsageQuantity. You can also filter and group your data by various dimensions, such asSERVICEorAZ, 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.
- Parameters:
getCostAndUsageRequest-- Returns:
- Result of the GetCostAndUsage operation returned by the service.
- See Also:
-
getCostAndUsage
default 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
BlendedCostsorUsageQuantity. You can also filter and group your data by various dimensions, such asSERVICEorAZ, 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.Builderavoiding the need to create one manually viaGetCostAndUsageRequest.builder()- Parameters:
getCostAndUsageRequest- AConsumerthat will call methods onGetCostAndUsageRequest.Builderto create a request.- Returns:
- Result of the GetCostAndUsage operation returned by the service.
- See Also:
-
getCostAndUsageWithResources
default 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
BlendedCostsorUsageQuantity, that you want the request to return. You can also filter and group your data by various dimensions, such asSERVICEorAZ, 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.Hourly granularity is only available for EC2-Instances (Elastic Compute Cloud) resource-level data. All other resource-level data is available at daily granularity.
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.
- Parameters:
getCostAndUsageWithResourcesRequest-- Returns:
- Result of the GetCostAndUsageWithResources operation returned by the service.
- See Also:
-
getCostAndUsageWithResources
default 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
BlendedCostsorUsageQuantity, that you want the request to return. You can also filter and group your data by various dimensions, such asSERVICEorAZ, 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.Hourly granularity is only available for EC2-Instances (Elastic Compute Cloud) resource-level data. All other resource-level data is available at daily granularity.
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.Builderavoiding the need to create one manually viaGetCostAndUsageWithResourcesRequest.builder()- Parameters:
getCostAndUsageWithResourcesRequest- AConsumerthat will call methods onGetCostAndUsageWithResourcesRequest.Builderto create a request.- Returns:
- Result of the GetCostAndUsageWithResources operation returned by the service.
- See Also:
-
getCostCategories
default 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.
- Parameters:
getCostCategoriesRequest-- Returns:
- Result of the GetCostCategories operation returned by the service.
- See Also:
-
getCostCategories
default 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.Builderavoiding the need to create one manually viaGetCostCategoriesRequest.builder()- Parameters:
getCostCategoriesRequest- AConsumerthat will call methods onGetCostCategoriesRequest.Builderto create a request.- Returns:
- Result of the GetCostCategories operation returned by the service.
- See Also:
-
getCostForecast
default 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.
- Parameters:
getCostForecastRequest-- Returns:
- Result of the GetCostForecast operation returned by the service.
- See Also:
-
getCostForecast
default 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.Builderavoiding the need to create one manually viaGetCostForecastRequest.builder()- Parameters:
getCostForecastRequest- AConsumerthat will call methods onGetCostForecastRequest.Builderto create a request.- Returns:
- Result of the GetCostForecast operation returned by the service.
- See Also:
-
getDimensionValues
default 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.
- Parameters:
getDimensionValuesRequest-- Returns:
- Result of the GetDimensionValues operation returned by the service.
- See Also:
-
getDimensionValues
default 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.Builderavoiding the need to create one manually viaGetDimensionValuesRequest.builder()- Parameters:
getDimensionValuesRequest- AConsumerthat will call methods onGetDimensionValuesRequest.Builderto create a request.- Returns:
- Result of the GetDimensionValues operation returned by the service.
- See Also:
-
getReservationCoverage
default 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
GetDimensionValuesoperation.- Parameters:
getReservationCoverageRequest- You can use the following request parameters to query for how much of your instance usage a reservation covered.- Returns:
- Result of the GetReservationCoverage operation returned by the service.
- See Also:
-
-
getReservationCoverage
default 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
GetDimensionValuesoperation.
This is a convenience which creates an instance of the
GetReservationCoverageRequest.Builderavoiding the need to create one manually viaGetReservationCoverageRequest.builder()- Parameters:
getReservationCoverageRequest- AConsumerthat will call methods onGetReservationCoverageRequest.Builderto create a request. You can use the following request parameters to query for how much of your instance usage a reservation covered.- Returns:
- Result of the GetReservationCoverage operation returned by the service.
- See Also:
-
-
getReservationPurchaseRecommendation
default 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.largebecause that is the smallest size instance in the c4 instance family.- Parameters:
getReservationPurchaseRecommendationRequest-- Returns:
- Result of the GetReservationPurchaseRecommendation operation returned by the service.
- See Also:
-
getReservationPurchaseRecommendation
default 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.largebecause that is the smallest size instance in the c4 instance family.
This is a convenience which creates an instance of the
GetReservationPurchaseRecommendationRequest.Builderavoiding the need to create one manually viaGetReservationPurchaseRecommendationRequest.builder()- Parameters:
getReservationPurchaseRecommendationRequest- AConsumerthat will call methods onGetReservationPurchaseRecommendationRequest.Builderto create a request.- Returns:
- Result of the GetReservationPurchaseRecommendation operation returned by the service.
- See Also:
-
getReservationUtilization
default 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
GetDimensionValuesto determine the possible dimension values. Currently, you can group only bySUBSCRIPTION_ID.- Parameters:
getReservationUtilizationRequest-- Returns:
- Result of the GetReservationUtilization operation returned by the service.
- See Also:
-
getReservationUtilization
default 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
GetDimensionValuesto determine the possible dimension values. Currently, you can group only bySUBSCRIPTION_ID.
This is a convenience which creates an instance of the
GetReservationUtilizationRequest.Builderavoiding the need to create one manually viaGetReservationUtilizationRequest.builder()- Parameters:
getReservationUtilizationRequest- AConsumerthat will call methods onGetReservationUtilizationRequest.Builderto create a request.- Returns:
- Result of the GetReservationUtilization operation returned by the service.
- See Also:
-
getRightsizingRecommendation
default 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.
- Parameters:
getRightsizingRecommendationRequest-- Returns:
- Result of the GetRightsizingRecommendation operation returned by the service.
- See Also:
-
getRightsizingRecommendation
default 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.Builderavoiding the need to create one manually viaGetRightsizingRecommendationRequest.builder()- Parameters:
getRightsizingRecommendationRequest- AConsumerthat will call methods onGetRightsizingRecommendationRequest.Builderto create a request.- Returns:
- Result of the GetRightsizingRecommendation operation returned by the service.
- See Also:
-
getSavingsPlanPurchaseRecommendationDetails
default GetSavingsPlanPurchaseRecommendationDetailsResponse getSavingsPlanPurchaseRecommendationDetails(GetSavingsPlanPurchaseRecommendationDetailsRequest getSavingsPlanPurchaseRecommendationDetailsRequest) throws LimitExceededException, DataUnavailableException, AwsServiceException, SdkClientException, CostExplorerException Retrieves the details for a Savings Plan recommendation. These details include the hourly data-points that construct the cost, coverage, and utilization charts.
- Parameters:
getSavingsPlanPurchaseRecommendationDetailsRequest-- Returns:
- Result of the GetSavingsPlanPurchaseRecommendationDetails operation returned by the service.
- See Also:
-
getSavingsPlanPurchaseRecommendationDetails
default GetSavingsPlanPurchaseRecommendationDetailsResponse getSavingsPlanPurchaseRecommendationDetails(Consumer<GetSavingsPlanPurchaseRecommendationDetailsRequest.Builder> getSavingsPlanPurchaseRecommendationDetailsRequest) throws LimitExceededException, DataUnavailableException, AwsServiceException, SdkClientException, CostExplorerException Retrieves the details for a Savings Plan recommendation. These details include the hourly data-points that construct the cost, coverage, and utilization charts.
This is a convenience which creates an instance of the
GetSavingsPlanPurchaseRecommendationDetailsRequest.Builderavoiding the need to create one manually viaGetSavingsPlanPurchaseRecommendationDetailsRequest.builder()- Parameters:
getSavingsPlanPurchaseRecommendationDetailsRequest- AConsumerthat will call methods onGetSavingsPlanPurchaseRecommendationDetailsRequest.Builderto create a request.- Returns:
- Result of the GetSavingsPlanPurchaseRecommendationDetails operation returned by the service.
- See Also:
-
getSavingsPlansCoverage
default 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
GetDimensionValuesoperation.- Parameters:
getSavingsPlansCoverageRequest-- Returns:
- Result of the GetSavingsPlansCoverage operation returned by the service.
- See Also:
-
-
getSavingsPlansCoverage
default 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
GetDimensionValuesoperation.
This is a convenience which creates an instance of the
GetSavingsPlansCoverageRequest.Builderavoiding the need to create one manually viaGetSavingsPlansCoverageRequest.builder()- Parameters:
getSavingsPlansCoverageRequest- AConsumerthat will call methods onGetSavingsPlansCoverageRequest.Builderto create a request.- Returns:
- Result of the GetSavingsPlansCoverage operation returned by the service.
- See Also:
-
-
getSavingsPlansCoveragePaginator
default GetSavingsPlansCoverageIterable getSavingsPlansCoveragePaginator(GetSavingsPlansCoverageRequest getSavingsPlansCoverageRequest) throws LimitExceededException, DataUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException 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
2) Using For loopsoftware.amazon.awssdk.services.costexplorer.paginators.GetSavingsPlansCoverageIterable responses = client.getSavingsPlansCoveragePaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
getSavingsPlansCoverageRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getSavingsPlansCoveragePaginator
default GetSavingsPlansCoverageIterable getSavingsPlansCoveragePaginator(Consumer<GetSavingsPlansCoverageRequest.Builder> getSavingsPlansCoverageRequest) throws LimitExceededException, DataUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException 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
2) Using For loopsoftware.amazon.awssdk.services.costexplorer.paginators.GetSavingsPlansCoverageIterable responses = client.getSavingsPlansCoveragePaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaGetSavingsPlansCoverageRequest.builder()- Parameters:
getSavingsPlansCoverageRequest- AConsumerthat will call methods onGetSavingsPlansCoverageRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getSavingsPlansPurchaseRecommendation
default GetSavingsPlansPurchaseRecommendationResponse getSavingsPlansPurchaseRecommendation(GetSavingsPlansPurchaseRecommendationRequest getSavingsPlansPurchaseRecommendationRequest) throws LimitExceededException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException Retrieves the Savings Plans recommendations for your account. First use
StartSavingsPlansPurchaseRecommendationGenerationto generate a new set of recommendations, and then useGetSavingsPlansPurchaseRecommendationto retrieve them.- Parameters:
getSavingsPlansPurchaseRecommendationRequest-- Returns:
- Result of the GetSavingsPlansPurchaseRecommendation operation returned by the service.
- See Also:
-
getSavingsPlansPurchaseRecommendation
default GetSavingsPlansPurchaseRecommendationResponse getSavingsPlansPurchaseRecommendation(Consumer<GetSavingsPlansPurchaseRecommendationRequest.Builder> getSavingsPlansPurchaseRecommendationRequest) throws LimitExceededException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException Retrieves the Savings Plans recommendations for your account. First use
StartSavingsPlansPurchaseRecommendationGenerationto generate a new set of recommendations, and then useGetSavingsPlansPurchaseRecommendationto retrieve them.
This is a convenience which creates an instance of the
GetSavingsPlansPurchaseRecommendationRequest.Builderavoiding the need to create one manually viaGetSavingsPlansPurchaseRecommendationRequest.builder()- Parameters:
getSavingsPlansPurchaseRecommendationRequest- AConsumerthat will call methods onGetSavingsPlansPurchaseRecommendationRequest.Builderto create a request.- Returns:
- Result of the GetSavingsPlansPurchaseRecommendation operation returned by the service.
- See Also:
-
getSavingsPlansUtilization
default 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
GetDimensionValuesinSAVINGS_PLANSto determine the possible dimension values.You can't group by any dimension values for
GetSavingsPlansUtilization.- Parameters:
getSavingsPlansUtilizationRequest-- Returns:
- Result of the GetSavingsPlansUtilization operation returned by the service.
- See Also:
-
getSavingsPlansUtilization
default 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
GetDimensionValuesinSAVINGS_PLANSto 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.Builderavoiding the need to create one manually viaGetSavingsPlansUtilizationRequest.builder()- Parameters:
getSavingsPlansUtilizationRequest- AConsumerthat will call methods onGetSavingsPlansUtilizationRequest.Builderto create a request.- Returns:
- Result of the GetSavingsPlansUtilization operation returned by the service.
- See Also:
-
getSavingsPlansUtilizationDetails
default 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 toGetSavingsPlanUtilizationDetailsby providing individual dates. You can useGetDimensionValuesinSAVINGS_PLANSto determine the possible dimension values.GetSavingsPlanUtilizationDetailsinternally groups data bySavingsPlansArn.- Parameters:
getSavingsPlansUtilizationDetailsRequest-- Returns:
- Result of the GetSavingsPlansUtilizationDetails operation returned by the service.
- See Also:
-
getSavingsPlansUtilizationDetails
default 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 toGetSavingsPlanUtilizationDetailsby providing individual dates. You can useGetDimensionValuesinSAVINGS_PLANSto determine the possible dimension values.GetSavingsPlanUtilizationDetailsinternally groups data bySavingsPlansArn.
This is a convenience which creates an instance of the
GetSavingsPlansUtilizationDetailsRequest.Builderavoiding the need to create one manually viaGetSavingsPlansUtilizationDetailsRequest.builder()- Parameters:
getSavingsPlansUtilizationDetailsRequest- AConsumerthat will call methods onGetSavingsPlansUtilizationDetailsRequest.Builderto create a request.- Returns:
- Result of the GetSavingsPlansUtilizationDetails operation returned by the service.
- See Also:
-
getSavingsPlansUtilizationDetailsPaginator
default GetSavingsPlansUtilizationDetailsIterable getSavingsPlansUtilizationDetailsPaginator(GetSavingsPlansUtilizationDetailsRequest getSavingsPlansUtilizationDetailsRequest) throws LimitExceededException, DataUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException 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
2) Using For loopsoftware.amazon.awssdk.services.costexplorer.paginators.GetSavingsPlansUtilizationDetailsIterable responses = client.getSavingsPlansUtilizationDetailsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
getSavingsPlansUtilizationDetailsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getSavingsPlansUtilizationDetailsPaginator
default GetSavingsPlansUtilizationDetailsIterable getSavingsPlansUtilizationDetailsPaginator(Consumer<GetSavingsPlansUtilizationDetailsRequest.Builder> getSavingsPlansUtilizationDetailsRequest) throws LimitExceededException, DataUnavailableException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException 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
2) Using For loopsoftware.amazon.awssdk.services.costexplorer.paginators.GetSavingsPlansUtilizationDetailsIterable responses = client.getSavingsPlansUtilizationDetailsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaGetSavingsPlansUtilizationDetailsRequest.builder()- Parameters:
getSavingsPlansUtilizationDetailsRequest- AConsumerthat will call methods onGetSavingsPlansUtilizationDetailsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getTags
default 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.
- Parameters:
getTagsRequest-- Returns:
- Result of the GetTags operation returned by the service.
- See Also:
-
getTags
default 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.Builderavoiding the need to create one manually viaGetTagsRequest.builder()- Parameters:
getTagsRequest- AConsumerthat will call methods onGetTagsRequest.Builderto create a request.- Returns:
- Result of the GetTags operation returned by the service.
- See Also:
-
getUsageForecast
default 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.
- Parameters:
getUsageForecastRequest-- Returns:
- Result of the GetUsageForecast operation returned by the service.
- See Also:
-
getUsageForecast
default 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.Builderavoiding the need to create one manually viaGetUsageForecastRequest.builder()- Parameters:
getUsageForecastRequest- AConsumerthat will call methods onGetUsageForecastRequest.Builderto create a request.- Returns:
- Result of the GetUsageForecast operation returned by the service.
- See Also:
-
listCostAllocationTagBackfillHistory
default ListCostAllocationTagBackfillHistoryResponse listCostAllocationTagBackfillHistory(ListCostAllocationTagBackfillHistoryRequest listCostAllocationTagBackfillHistoryRequest) throws LimitExceededException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException Retrieves a list of your historical cost allocation tag backfill requests.
- Parameters:
listCostAllocationTagBackfillHistoryRequest-- Returns:
- Result of the ListCostAllocationTagBackfillHistory operation returned by the service.
- See Also:
-
listCostAllocationTagBackfillHistory
default ListCostAllocationTagBackfillHistoryResponse listCostAllocationTagBackfillHistory(Consumer<ListCostAllocationTagBackfillHistoryRequest.Builder> listCostAllocationTagBackfillHistoryRequest) throws LimitExceededException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException Retrieves a list of your historical cost allocation tag backfill requests.
This is a convenience which creates an instance of the
ListCostAllocationTagBackfillHistoryRequest.Builderavoiding the need to create one manually viaListCostAllocationTagBackfillHistoryRequest.builder()- Parameters:
listCostAllocationTagBackfillHistoryRequest- AConsumerthat will call methods onListCostAllocationTagBackfillHistoryRequest.Builderto create a request.- Returns:
- Result of the ListCostAllocationTagBackfillHistory operation returned by the service.
- See Also:
-
listCostAllocationTagBackfillHistoryPaginator
default ListCostAllocationTagBackfillHistoryIterable listCostAllocationTagBackfillHistoryPaginator(ListCostAllocationTagBackfillHistoryRequest listCostAllocationTagBackfillHistoryRequest) throws LimitExceededException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException This is a variant of
listCostAllocationTagBackfillHistory(software.amazon.awssdk.services.costexplorer.model.ListCostAllocationTagBackfillHistoryRequest)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
2) Using For loopsoftware.amazon.awssdk.services.costexplorer.paginators.ListCostAllocationTagBackfillHistoryIterable responses = client.listCostAllocationTagBackfillHistoryPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.costexplorer.paginators.ListCostAllocationTagBackfillHistoryIterable responses = client .listCostAllocationTagBackfillHistoryPaginator(request); for (software.amazon.awssdk.services.costexplorer.model.ListCostAllocationTagBackfillHistoryResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.costexplorer.paginators.ListCostAllocationTagBackfillHistoryIterable responses = client.listCostAllocationTagBackfillHistoryPaginator(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
listCostAllocationTagBackfillHistory(software.amazon.awssdk.services.costexplorer.model.ListCostAllocationTagBackfillHistoryRequest)operation.- Parameters:
listCostAllocationTagBackfillHistoryRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listCostAllocationTagBackfillHistoryPaginator
default ListCostAllocationTagBackfillHistoryIterable listCostAllocationTagBackfillHistoryPaginator(Consumer<ListCostAllocationTagBackfillHistoryRequest.Builder> listCostAllocationTagBackfillHistoryRequest) throws LimitExceededException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException This is a variant of
listCostAllocationTagBackfillHistory(software.amazon.awssdk.services.costexplorer.model.ListCostAllocationTagBackfillHistoryRequest)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
2) Using For loopsoftware.amazon.awssdk.services.costexplorer.paginators.ListCostAllocationTagBackfillHistoryIterable responses = client.listCostAllocationTagBackfillHistoryPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.costexplorer.paginators.ListCostAllocationTagBackfillHistoryIterable responses = client .listCostAllocationTagBackfillHistoryPaginator(request); for (software.amazon.awssdk.services.costexplorer.model.ListCostAllocationTagBackfillHistoryResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.costexplorer.paginators.ListCostAllocationTagBackfillHistoryIterable responses = client.listCostAllocationTagBackfillHistoryPaginator(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
listCostAllocationTagBackfillHistory(software.amazon.awssdk.services.costexplorer.model.ListCostAllocationTagBackfillHistoryRequest)operation.
This is a convenience which creates an instance of the
ListCostAllocationTagBackfillHistoryRequest.Builderavoiding the need to create one manually viaListCostAllocationTagBackfillHistoryRequest.builder()- Parameters:
listCostAllocationTagBackfillHistoryRequest- AConsumerthat will call methods onListCostAllocationTagBackfillHistoryRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listCostAllocationTags
default 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.
- Parameters:
listCostAllocationTagsRequest-- Returns:
- Result of the ListCostAllocationTags operation returned by the service.
- See Also:
-
listCostAllocationTags
default 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.Builderavoiding the need to create one manually viaListCostAllocationTagsRequest.builder()- Parameters:
listCostAllocationTagsRequest- AConsumerthat will call methods onListCostAllocationTagsRequest.Builderto create a request.- Returns:
- Result of the ListCostAllocationTags operation returned by the service.
- See Also:
-
listCostAllocationTagsPaginator
default ListCostAllocationTagsIterable listCostAllocationTagsPaginator(ListCostAllocationTagsRequest listCostAllocationTagsRequest) throws LimitExceededException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException 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
2) Using For loopsoftware.amazon.awssdk.services.costexplorer.paginators.ListCostAllocationTagsIterable responses = client.listCostAllocationTagsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listCostAllocationTagsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listCostAllocationTagsPaginator
default ListCostAllocationTagsIterable listCostAllocationTagsPaginator(Consumer<ListCostAllocationTagsRequest.Builder> listCostAllocationTagsRequest) throws LimitExceededException, InvalidNextTokenException, AwsServiceException, SdkClientException, CostExplorerException 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
2) Using For loopsoftware.amazon.awssdk.services.costexplorer.paginators.ListCostAllocationTagsIterable responses = client.listCostAllocationTagsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListCostAllocationTagsRequest.builder()- Parameters:
listCostAllocationTagsRequest- AConsumerthat will call methods onListCostAllocationTagsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listCostCategoryDefinitions
default ListCostCategoryDefinitionsResponse listCostCategoryDefinitions(ListCostCategoryDefinitionsRequest listCostCategoryDefinitionsRequest) throws LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException Returns the name, Amazon Resource Name (ARN),
NumberOfRulesand effective dates of all Cost Categories defined in the account. You have the option to useEffectiveOnto return a list of Cost Categories that were active on a specific date. If there is noEffectiveOnspecified, you’ll see Cost Categories that are effective on the current date. If Cost Category is still effective,EffectiveEndis omitted in the response.ListCostCategoryDefinitionssupports pagination. The request can have aMaxResultsrange up to 100.- Parameters:
listCostCategoryDefinitionsRequest-- Returns:
- Result of the ListCostCategoryDefinitions operation returned by the service.
- See Also:
-
listCostCategoryDefinitions
default ListCostCategoryDefinitionsResponse listCostCategoryDefinitions(Consumer<ListCostCategoryDefinitionsRequest.Builder> listCostCategoryDefinitionsRequest) throws LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException Returns the name, Amazon Resource Name (ARN),
NumberOfRulesand effective dates of all Cost Categories defined in the account. You have the option to useEffectiveOnto return a list of Cost Categories that were active on a specific date. If there is noEffectiveOnspecified, you’ll see Cost Categories that are effective on the current date. If Cost Category is still effective,EffectiveEndis omitted in the response.ListCostCategoryDefinitionssupports pagination. The request can have aMaxResultsrange up to 100.
This is a convenience which creates an instance of the
ListCostCategoryDefinitionsRequest.Builderavoiding the need to create one manually viaListCostCategoryDefinitionsRequest.builder()- Parameters:
listCostCategoryDefinitionsRequest- AConsumerthat will call methods onListCostCategoryDefinitionsRequest.Builderto create a request.- Returns:
- Result of the ListCostCategoryDefinitions operation returned by the service.
- See Also:
-
listCostCategoryDefinitionsPaginator
default ListCostCategoryDefinitionsIterable listCostCategoryDefinitionsPaginator(ListCostCategoryDefinitionsRequest listCostCategoryDefinitionsRequest) throws LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException 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
2) Using For loopsoftware.amazon.awssdk.services.costexplorer.paginators.ListCostCategoryDefinitionsIterable responses = client.listCostCategoryDefinitionsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listCostCategoryDefinitionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listCostCategoryDefinitionsPaginator
default ListCostCategoryDefinitionsIterable listCostCategoryDefinitionsPaginator(Consumer<ListCostCategoryDefinitionsRequest.Builder> listCostCategoryDefinitionsRequest) throws LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException 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
2) Using For loopsoftware.amazon.awssdk.services.costexplorer.paginators.ListCostCategoryDefinitionsIterable responses = client.listCostCategoryDefinitionsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListCostCategoryDefinitionsRequest.builder()- Parameters:
listCostCategoryDefinitionsRequest- AConsumerthat will call methods onListCostCategoryDefinitionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listSavingsPlansPurchaseRecommendationGeneration
default ListSavingsPlansPurchaseRecommendationGenerationResponse listSavingsPlansPurchaseRecommendationGeneration(ListSavingsPlansPurchaseRecommendationGenerationRequest listSavingsPlansPurchaseRecommendationGenerationRequest) throws LimitExceededException, InvalidNextTokenException, DataUnavailableException, AwsServiceException, SdkClientException, CostExplorerException Retrieves a list of your historical recommendation generations within the past 30 days.
- Parameters:
listSavingsPlansPurchaseRecommendationGenerationRequest-- Returns:
- Result of the ListSavingsPlansPurchaseRecommendationGeneration operation returned by the service.
- See Also:
-
listSavingsPlansPurchaseRecommendationGeneration
default ListSavingsPlansPurchaseRecommendationGenerationResponse listSavingsPlansPurchaseRecommendationGeneration(Consumer<ListSavingsPlansPurchaseRecommendationGenerationRequest.Builder> listSavingsPlansPurchaseRecommendationGenerationRequest) throws LimitExceededException, InvalidNextTokenException, DataUnavailableException, AwsServiceException, SdkClientException, CostExplorerException Retrieves a list of your historical recommendation generations within the past 30 days.
This is a convenience which creates an instance of the
ListSavingsPlansPurchaseRecommendationGenerationRequest.Builderavoiding the need to create one manually viaListSavingsPlansPurchaseRecommendationGenerationRequest.builder()- Parameters:
listSavingsPlansPurchaseRecommendationGenerationRequest- AConsumerthat will call methods onListSavingsPlansPurchaseRecommendationGenerationRequest.Builderto create a request.- Returns:
- Result of the ListSavingsPlansPurchaseRecommendationGeneration operation returned by the service.
- See Also:
-
listTagsForResource
default 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).
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default 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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
provideAnomalyFeedback
default ProvideAnomalyFeedbackResponse provideAnomalyFeedback(ProvideAnomalyFeedbackRequest provideAnomalyFeedbackRequest) throws LimitExceededException, AwsServiceException, SdkClientException, CostExplorerException Modifies the feedback property of a given cost anomaly.
- Parameters:
provideAnomalyFeedbackRequest-- Returns:
- Result of the ProvideAnomalyFeedback operation returned by the service.
- See Also:
-
provideAnomalyFeedback
default 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.Builderavoiding the need to create one manually viaProvideAnomalyFeedbackRequest.builder()- Parameters:
provideAnomalyFeedbackRequest- AConsumerthat will call methods onProvideAnomalyFeedbackRequest.Builderto create a request.- Returns:
- Result of the ProvideAnomalyFeedback operation returned by the service.
- See Also:
-
startCostAllocationTagBackfill
default StartCostAllocationTagBackfillResponse startCostAllocationTagBackfill(StartCostAllocationTagBackfillRequest startCostAllocationTagBackfillRequest) throws LimitExceededException, BackfillLimitExceededException, AwsServiceException, SdkClientException, CostExplorerException Request a cost allocation tag backfill. This will backfill the activation status (either
activeorinactive) for all tag keys frompara:BackfillFromup to the when this request is made.You can request a backfill once every 24 hours.
- Parameters:
startCostAllocationTagBackfillRequest-- Returns:
- Result of the StartCostAllocationTagBackfill operation returned by the service.
- See Also:
-
startCostAllocationTagBackfill
default StartCostAllocationTagBackfillResponse startCostAllocationTagBackfill(Consumer<StartCostAllocationTagBackfillRequest.Builder> startCostAllocationTagBackfillRequest) throws LimitExceededException, BackfillLimitExceededException, AwsServiceException, SdkClientException, CostExplorerException Request a cost allocation tag backfill. This will backfill the activation status (either
activeorinactive) for all tag keys frompara:BackfillFromup to the when this request is made.You can request a backfill once every 24 hours.
This is a convenience which creates an instance of the
StartCostAllocationTagBackfillRequest.Builderavoiding the need to create one manually viaStartCostAllocationTagBackfillRequest.builder()- Parameters:
startCostAllocationTagBackfillRequest- AConsumerthat will call methods onStartCostAllocationTagBackfillRequest.Builderto create a request.- Returns:
- Result of the StartCostAllocationTagBackfill operation returned by the service.
- See Also:
-
startSavingsPlansPurchaseRecommendationGeneration
default StartSavingsPlansPurchaseRecommendationGenerationResponse startSavingsPlansPurchaseRecommendationGeneration(StartSavingsPlansPurchaseRecommendationGenerationRequest startSavingsPlansPurchaseRecommendationGenerationRequest) throws LimitExceededException, ServiceQuotaExceededException, GenerationExistsException, DataUnavailableException, AwsServiceException, SdkClientException, CostExplorerException Requests a Savings Plans recommendation generation. This enables you to calculate a fresh set of Savings Plans recommendations that takes your latest usage data and current Savings Plans inventory into account. You can refresh Savings Plans recommendations up to three times daily for a consolidated billing family.
StartSavingsPlansPurchaseRecommendationGenerationhas no request syntax because no input parameters are needed to support this operation.- Parameters:
startSavingsPlansPurchaseRecommendationGenerationRequest-- Returns:
- Result of the StartSavingsPlansPurchaseRecommendationGeneration operation returned by the service.
- See Also:
-
startSavingsPlansPurchaseRecommendationGeneration
default StartSavingsPlansPurchaseRecommendationGenerationResponse startSavingsPlansPurchaseRecommendationGeneration(Consumer<StartSavingsPlansPurchaseRecommendationGenerationRequest.Builder> startSavingsPlansPurchaseRecommendationGenerationRequest) throws LimitExceededException, ServiceQuotaExceededException, GenerationExistsException, DataUnavailableException, AwsServiceException, SdkClientException, CostExplorerException Requests a Savings Plans recommendation generation. This enables you to calculate a fresh set of Savings Plans recommendations that takes your latest usage data and current Savings Plans inventory into account. You can refresh Savings Plans recommendations up to three times daily for a consolidated billing family.
StartSavingsPlansPurchaseRecommendationGenerationhas no request syntax because no input parameters are needed to support this operation.
This is a convenience which creates an instance of the
StartSavingsPlansPurchaseRecommendationGenerationRequest.Builderavoiding the need to create one manually viaStartSavingsPlansPurchaseRecommendationGenerationRequest.builder()- Parameters:
startSavingsPlansPurchaseRecommendationGenerationRequest- AConsumerthat will call methods onStartSavingsPlansPurchaseRecommendationGenerationRequest.Builderto create a request.- Returns:
- Result of the StartSavingsPlansPurchaseRecommendationGeneration operation returned by the service.
- See Also:
-
tagResource
default 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
TagResourceoperation 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.
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default 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
TagResourceoperation 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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default 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.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default 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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateAnomalyMonitor
default 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.
- Parameters:
updateAnomalyMonitorRequest-- Returns:
- Result of the UpdateAnomalyMonitor operation returned by the service.
- See Also:
-
updateAnomalyMonitor
default 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.Builderavoiding the need to create one manually viaUpdateAnomalyMonitorRequest.builder()- Parameters:
updateAnomalyMonitorRequest- AConsumerthat will call methods onUpdateAnomalyMonitorRequest.Builderto create a request.- Returns:
- Result of the UpdateAnomalyMonitor operation returned by the service.
- See Also:
-
updateAnomalySubscription
default UpdateAnomalySubscriptionResponse updateAnomalySubscription(UpdateAnomalySubscriptionRequest updateAnomalySubscriptionRequest) throws LimitExceededException, UnknownMonitorException, UnknownSubscriptionException, AwsServiceException, SdkClientException, CostExplorerException Updates an existing cost anomaly subscription. Specify the fields that you want to update. Omitted fields are unchanged.
The JSON below describes the generic construct for each type. See Request Parameters for possible values as they apply to
AnomalySubscription.- Parameters:
updateAnomalySubscriptionRequest-- Returns:
- Result of the UpdateAnomalySubscription operation returned by the service.
- See Also:
-
updateAnomalySubscription
default UpdateAnomalySubscriptionResponse updateAnomalySubscription(Consumer<UpdateAnomalySubscriptionRequest.Builder> updateAnomalySubscriptionRequest) throws LimitExceededException, UnknownMonitorException, UnknownSubscriptionException, AwsServiceException, SdkClientException, CostExplorerException Updates an existing cost anomaly subscription. Specify the fields that you want to update. Omitted fields are unchanged.
The JSON below describes the generic construct for each type. See Request Parameters for possible values as they apply to
AnomalySubscription.
This is a convenience which creates an instance of the
UpdateAnomalySubscriptionRequest.Builderavoiding the need to create one manually viaUpdateAnomalySubscriptionRequest.builder()- Parameters:
updateAnomalySubscriptionRequest- AConsumerthat will call methods onUpdateAnomalySubscriptionRequest.Builderto create a request.- Returns:
- Result of the UpdateAnomalySubscription operation returned by the service.
- See Also:
-
updateCostAllocationTagsStatus
default 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).
- Parameters:
updateCostAllocationTagsStatusRequest-- Returns:
- Result of the UpdateCostAllocationTagsStatus operation returned by the service.
- See Also:
-
updateCostAllocationTagsStatus
default 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.Builderavoiding the need to create one manually viaUpdateCostAllocationTagsStatusRequest.builder()- Parameters:
updateCostAllocationTagsStatusRequest- AConsumerthat will call methods onUpdateCostAllocationTagsStatusRequest.Builderto create a request.- Returns:
- Result of the UpdateCostAllocationTagsStatus operation returned by the service.
- See Also:
-
updateCostCategoryDefinition
default 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.
- Parameters:
updateCostCategoryDefinitionRequest-- Returns:
- Result of the UpdateCostCategoryDefinition operation returned by the service.
- See Also:
-
updateCostCategoryDefinition
default 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.Builderavoiding the need to create one manually viaUpdateCostCategoryDefinitionRequest.builder()- Parameters:
updateCostCategoryDefinitionRequest- AConsumerthat will call methods onUpdateCostCategoryDefinitionRequest.Builderto create a request.- Returns:
- Result of the UpdateCostCategoryDefinition operation returned by the service.
- See Also:
-
create
Create aCostExplorerClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aCostExplorerClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-