com.amazonaws.services.costoptimizationhub

Class AWSCostOptimizationHubClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.costoptimizationhub.AWSCostOptimizationHubClient

All Implemented Interfaces:

AWSCostOptimizationHub

Direct Known Subclasses:

AWSCostOptimizationHubAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSCostOptimizationHubClient
extends AmazonWebServiceClient
implements AWSCostOptimizationHub

Client for accessing Cost Optimization Hub. All service calls made using this client are blocking, and will not return until the service call completes.

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
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.costoptimizationhub.AWSCostOptimizationHub

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSCostOptimizationHubClientBuilder	builder()
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetPreferencesResult	getPreferences(GetPreferencesRequest request) Returns a set of preferences for an account in order to add account-specific preferences into the service.
GetRecommendationResult	getRecommendation(GetRecommendationRequest request) Returns both the current and recommended resource configuration and the estimated cost impact for a recommendation.
ListEnrollmentStatusesResult	listEnrollmentStatuses(ListEnrollmentStatusesRequest request) Retrieves the enrollment status for an account.
ListRecommendationsResult	listRecommendations(ListRecommendationsRequest request) Returns a list of recommendations.
ListRecommendationSummariesResult	listRecommendationSummaries(ListRecommendationSummariesRequest request) 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 request) Updates the enrollment (opt in and opt out) status of an account to the Cost Optimization Hub service.
UpdatePreferencesResult	updatePreferences(UpdatePreferencesRequest request) Updates a set of preferences for an account in order to add account-specific preferences into the service.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSCostOptimizationHubClientBuilder builder()

getPreferences

public GetPreferencesResult getPreferences(GetPreferencesRequest request)

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.

Specified by:

getPreferences in interface AWSCostOptimizationHub

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

public GetRecommendationResult getRecommendation(GetRecommendationRequest request)

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.

Specified by:

getRecommendation in interface AWSCostOptimizationHub

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

public ListEnrollmentStatusesResult listEnrollmentStatuses(ListEnrollmentStatusesRequest request)

Retrieves the enrollment status for an account. It can also return the list of accounts that are enrolled under the organization.

Specified by:

listEnrollmentStatuses in interface AWSCostOptimizationHub

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

public ListRecommendationSummariesResult listRecommendationSummaries(ListRecommendationSummariesRequest request)

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.

Specified by:

listRecommendationSummaries in interface AWSCostOptimizationHub

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

public ListRecommendationsResult listRecommendations(ListRecommendationsRequest request)

Returns a list of recommendations.

Specified by:

listRecommendations in interface AWSCostOptimizationHub

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

public UpdateEnrollmentStatusResult updateEnrollmentStatus(UpdateEnrollmentStatusRequest request)

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.

Specified by:

updateEnrollmentStatus in interface AWSCostOptimizationHub

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

public UpdatePreferencesResult updatePreferences(UpdatePreferencesRequest request)

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.

Specified by:

updatePreferences in interface AWSCostOptimizationHub

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSCostOptimizationHub

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from interface: AWSCostOptimizationHub

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.

Specified by:

shutdown in interface AWSCostOptimizationHub

Overrides:

shutdown in class AmazonWebServiceClient