AWSCostOptimizationHub (AWS SDK for Java

All Known Subinterfaces:

AWSCostOptimizationHubAsync

All Known Implementing Classes:

AbstractAWSCostOptimizationHub, AbstractAWSCostOptimizationHubAsync, AWSCostOptimizationHubAsyncClient, AWSCostOptimizationHubClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSCostOptimizationHub
```
Interface for accessing Cost Optimization Hub.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSCostOptimizationHub instead.

You can use the Cost Optimization Hub API to programmatically identify, filter, aggregate, and quantify savings for your cost optimization recommendations across multiple Amazon Web Services Regions and Amazon Web Services accounts in your organization.

The Cost Optimization Hub API provides the following endpoint:
- https://cost-optimization-hub.us-east-1.amazonaws.com

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetPreferencesResult`	`getPreferences(GetPreferencesRequest getPreferencesRequest)` Returns a set of preferences for an account in order to add account-specific preferences into the service.
`GetRecommendationResult`	`getRecommendation(GetRecommendationRequest getRecommendationRequest)` Returns both the current and recommended resource configuration and the estimated cost impact for a recommendation.
`ListEnrollmentStatusesResult`	`listEnrollmentStatuses(ListEnrollmentStatusesRequest listEnrollmentStatusesRequest)` Retrieves the enrollment status for an account.
`ListRecommendationsResult`	`listRecommendations(ListRecommendationsRequest listRecommendationsRequest)` Returns a list of recommendations.
`ListRecommendationSummariesResult`	`listRecommendationSummaries(ListRecommendationSummariesRequest listRecommendationSummariesRequest)` Returns a concise representation of savings estimates for resources.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`UpdateEnrollmentStatusResult`	`updateEnrollmentStatus(UpdateEnrollmentStatusRequest updateEnrollmentStatusRequest)` Updates the enrollment (opt in and opt out) status of an account to the Cost Optimization Hub service.
`UpdatePreferencesResult`	`updatePreferences(UpdatePreferencesRequest updatePreferencesRequest)` Updates a set of preferences for an account in order to add account-specific preferences into the service.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - getPreferences
```
GetPreferencesResult getPreferences(GetPreferencesRequest getPreferencesRequest)
```
    Returns a set of preferences for an account in order to add account-specific preferences into the service. These preferences impact how the savings associated with recommendations are presented—estimated savings after discounts or estimated savings before discounts, for example.
    
    Parameters:
    
    getPreferencesRequest -
    
    Returns:
    
    Result of the GetPreferences operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    InternalServerException - An error on the server occurred during the processing of your request. Try again later.
    
    AccessDeniedException - You are not authorized to use this operation with the given parameters.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - getRecommendation
```
GetRecommendationResult getRecommendation(GetRecommendationRequest getRecommendationRequest)
```
    Returns both the current and recommended resource configuration and the estimated cost impact for a recommendation.
    
    The recommendationId is only valid for up to a maximum of 24 hours as recommendations are refreshed daily. To retrieve the recommendationId, use the ListRecommendations API.
    
    Parameters:
    
    getRecommendationRequest -
    
    Returns:
    
    Result of the GetRecommendation operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    InternalServerException - An error on the server occurred during the processing of your request. Try again later.
    
    AccessDeniedException - You are not authorized to use this operation with the given parameters.
    
    ResourceNotFoundException - The specified Amazon Resource Name (ARN) in the request doesn't exist.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - listEnrollmentStatuses
```
ListEnrollmentStatusesResult listEnrollmentStatuses(ListEnrollmentStatusesRequest listEnrollmentStatusesRequest)
```
    Retrieves the enrollment status for an account. It can also return the list of accounts that are enrolled under the organization.
    
    Parameters:
    
    listEnrollmentStatusesRequest -
    
    Returns:
    
    Result of the ListEnrollmentStatuses operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    InternalServerException - An error on the server occurred during the processing of your request. Try again later.
    
    AccessDeniedException - You are not authorized to use this operation with the given parameters.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - listRecommendationSummaries
```
ListRecommendationSummariesResult listRecommendationSummaries(ListRecommendationSummariesRequest listRecommendationSummariesRequest)
```
    Returns a concise representation of savings estimates for resources. Also returns de-duped savings across different types of recommendations.
    
    The following filters are not supported for this API: recommendationIds, resourceArns, and resourceIds.
    
    Parameters:
    
    listRecommendationSummariesRequest -
    
    Returns:
    
    Result of the ListRecommendationSummaries operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    InternalServerException - An error on the server occurred during the processing of your request. Try again later.
    
    AccessDeniedException - You are not authorized to use this operation with the given parameters.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - listRecommendations
```
ListRecommendationsResult listRecommendations(ListRecommendationsRequest listRecommendationsRequest)
```
    Returns a list of recommendations.
    
    Parameters:
    
    listRecommendationsRequest -
    
    Returns:
    
    Result of the ListRecommendations operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    InternalServerException - An error on the server occurred during the processing of your request. Try again later.
    
    AccessDeniedException - You are not authorized to use this operation with the given parameters.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - updateEnrollmentStatus
```
UpdateEnrollmentStatusResult updateEnrollmentStatus(UpdateEnrollmentStatusRequest updateEnrollmentStatusRequest)
```
    Updates the enrollment (opt in and opt out) status of an account to the Cost Optimization Hub service.
    
    If the account is a management account of an organization, this action can also be used to enroll member accounts of the organization.
    
    You must have the appropriate permissions to opt in to Cost Optimization Hub and to view its recommendations. When you opt in, Cost Optimization Hub automatically creates a service-linked role in your account to access its data.
    
    Parameters:
    
    updateEnrollmentStatusRequest -
    
    Returns:
    
    Result of the UpdateEnrollmentStatus operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    InternalServerException - An error on the server occurred during the processing of your request. Try again later.
    
    AccessDeniedException - You are not authorized to use this operation with the given parameters.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - updatePreferences
```
UpdatePreferencesResult updatePreferences(UpdatePreferencesRequest updatePreferencesRequest)
```
    Updates a set of preferences for an account in order to add account-specific preferences into the service. These preferences impact how the savings associated with recommendations are presented.
    
    Parameters:
    
    updatePreferencesRequest -
    
    Returns:
    
    Result of the UpdatePreferences operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.
    
    InternalServerException - An error on the server occurred during the processing of your request. Try again later.
    
    AccessDeniedException - You are not authorized to use this operation with the given parameters.
    
    ThrottlingException - The request was denied due to request throttling.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

AWS SDK for Java 1.x API Reference - 1.12.624

Interface AWSCostOptimizationHub

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

getPreferences

getRecommendation

listEnrollmentStatuses

listRecommendationSummaries

listRecommendations

updateEnrollmentStatus

updatePreferences

shutdown

getCachedResponseMetadata