com.amazonaws.services.computeoptimizer

Interface AWSComputeOptimizer

All Known Subinterfaces:

AWSComputeOptimizerAsync

All Known Implementing Classes:

AbstractAWSComputeOptimizer, AbstractAWSComputeOptimizerAsync, AWSComputeOptimizerAsyncClient, AWSComputeOptimizerClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSComputeOptimizer

Interface for accessing AWS Compute Optimizer.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSComputeOptimizer instead.

AWS Compute Optimizer is a service that analyzes the configuration and utilization metrics of your AWS resources, such as EC2 instances and Auto Scaling groups. It reports whether your resources are optimal, and generates optimization recommendations to reduce the cost and improve the performance of your workloads. Compute Optimizer also provides recent utilization metric data, as well as projected utilization metric data for the recommendations, which you can use to evaluate which recommendation provides the best price-performance trade-off. The analysis of your usage patterns can help you decide when to move or resize your running resources, and still meet your performance and capacity requirements. For more information about Compute Optimizer, see the AWS Compute Optimizer User Guide.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
GetAutoScalingGroupRecommendationsResult	getAutoScalingGroupRecommendations(GetAutoScalingGroupRecommendationsRequest getAutoScalingGroupRecommendationsRequest) Returns Auto Scaling group recommendations.
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.
GetEC2InstanceRecommendationsResult	getEC2InstanceRecommendations(GetEC2InstanceRecommendationsRequest getEC2InstanceRecommendationsRequest) Returns Amazon EC2 instance recommendations.
GetEC2RecommendationProjectedMetricsResult	getEC2RecommendationProjectedMetrics(GetEC2RecommendationProjectedMetricsRequest getEC2RecommendationProjectedMetricsRequest) Returns the projected utilization metrics of Amazon EC2 instance recommendations.
GetEnrollmentStatusResult	getEnrollmentStatus(GetEnrollmentStatusRequest getEnrollmentStatusRequest) Returns the enrollment (opt in) status of an account to the AWS Compute Optimizer service.
GetRecommendationSummariesResult	getRecommendationSummaries(GetRecommendationSummariesRequest getRecommendationSummariesRequest) Returns the optimization findings for an account.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateEnrollmentStatusResult	updateEnrollmentStatus(UpdateEnrollmentStatusRequest updateEnrollmentStatusRequest) Updates the enrollment (opt in) status of an account to the AWS Compute Optimizer 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

getAutoScalingGroupRecommendations

GetAutoScalingGroupRecommendationsResult getAutoScalingGroupRecommendations(GetAutoScalingGroupRecommendationsRequest getAutoScalingGroupRecommendationsRequest)

Returns Auto Scaling group recommendations.

AWS Compute Optimizer currently generates recommendations for Auto Scaling groups that are configured to run instances of the M, C, R, T, and X instance families. The service does not generate recommendations for Auto Scaling groups that have a scaling policy attached to them, or that do not have the same values for desired, minimum, and maximum capacity. In order for Compute Optimizer to analyze your Auto Scaling groups, they must be of a fixed size. For more information, see the AWS Compute Optimizer User Guide.

Parameters:

getAutoScalingGroupRecommendationsRequest -

Returns:

Result of the GetAutoScalingGroupRecommendations operation returned by the service.

Throws:

OptInRequiredException - You must opt in to the service to perform this action.

InternalServerException - The request processing has failed because of an unknown error, exception, or failure.

ServiceUnavailableException - The request has failed due to a temporary failure of the server.

AccessDeniedException - You do not have sufficient access to perform this action.

InvalidParameterValueException - An invalid or out-of-range value was supplied for the input parameter.

ResourceNotFoundException - The specified resource was not found.

MissingAuthenticationTokenException - The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

ThrottlingException - The limit on the number of requests per second was exceeded.

See Also:

AWS API Documentation

getEC2InstanceRecommendations

GetEC2InstanceRecommendationsResult getEC2InstanceRecommendations(GetEC2InstanceRecommendationsRequest getEC2InstanceRecommendationsRequest)

Returns Amazon EC2 instance recommendations.

AWS Compute Optimizer currently generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) and Amazon EC2 Auto Scaling. It generates recommendations for M, C, R, T, and X instance families. For more information, see the AWS Compute Optimizer User Guide.

Parameters:

getEC2InstanceRecommendationsRequest -

Returns:

Result of the GetEC2InstanceRecommendations operation returned by the service.

Throws:

OptInRequiredException - You must opt in to the service to perform this action.

InternalServerException - The request processing has failed because of an unknown error, exception, or failure.

ServiceUnavailableException - The request has failed due to a temporary failure of the server.

AccessDeniedException - You do not have sufficient access to perform this action.

InvalidParameterValueException - An invalid or out-of-range value was supplied for the input parameter.

ResourceNotFoundException - The specified resource was not found.

MissingAuthenticationTokenException - The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

ThrottlingException - The limit on the number of requests per second was exceeded.

See Also:

AWS API Documentation

getEC2RecommendationProjectedMetrics

GetEC2RecommendationProjectedMetricsResult getEC2RecommendationProjectedMetrics(GetEC2RecommendationProjectedMetricsRequest getEC2RecommendationProjectedMetricsRequest)

Returns the projected utilization metrics of Amazon EC2 instance recommendations.

Parameters:

getEC2RecommendationProjectedMetricsRequest -

Returns:

Result of the GetEC2RecommendationProjectedMetrics operation returned by the service.

Throws:

OptInRequiredException - You must opt in to the service to perform this action.

InternalServerException - The request processing has failed because of an unknown error, exception, or failure.

ServiceUnavailableException - The request has failed due to a temporary failure of the server.

AccessDeniedException - You do not have sufficient access to perform this action.

InvalidParameterValueException - An invalid or out-of-range value was supplied for the input parameter.

ResourceNotFoundException - The specified resource was not found.

MissingAuthenticationTokenException - The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

ThrottlingException - The limit on the number of requests per second was exceeded.

See Also:

AWS API Documentation

getEnrollmentStatus

GetEnrollmentStatusResult getEnrollmentStatus(GetEnrollmentStatusRequest getEnrollmentStatusRequest)

Returns the enrollment (opt in) status of an account to the AWS Compute Optimizer service.

If the account is a master account of an organization, this operation also confirms the enrollment status of member accounts within the organization.

Parameters:

getEnrollmentStatusRequest -

Returns:

Result of the GetEnrollmentStatus operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception, or failure.

ServiceUnavailableException - The request has failed due to a temporary failure of the server.

AccessDeniedException - You do not have sufficient access to perform this action.

InvalidParameterValueException - An invalid or out-of-range value was supplied for the input parameter.

MissingAuthenticationTokenException - The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

ThrottlingException - The limit on the number of requests per second was exceeded.

See Also:

AWS API Documentation

getRecommendationSummaries

GetRecommendationSummariesResult getRecommendationSummaries(GetRecommendationSummariesRequest getRecommendationSummariesRequest)

Returns the optimization findings for an account.

For example, it returns the number of Amazon EC2 instances in an account that are under-provisioned, over-provisioned, or optimized. It also returns the number of Auto Scaling groups in an account that are not optimized, or optimized.

Parameters:

getRecommendationSummariesRequest -

Returns:

Result of the GetRecommendationSummaries operation returned by the service.

Throws:

OptInRequiredException - You must opt in to the service to perform this action.

InternalServerException - The request processing has failed because of an unknown error, exception, or failure.

ServiceUnavailableException - The request has failed due to a temporary failure of the server.

AccessDeniedException - You do not have sufficient access to perform this action.

InvalidParameterValueException - An invalid or out-of-range value was supplied for the input parameter.

MissingAuthenticationTokenException - The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

ThrottlingException - The limit on the number of requests per second was exceeded.

See Also:

AWS API Documentation

updateEnrollmentStatus

UpdateEnrollmentStatusResult updateEnrollmentStatus(UpdateEnrollmentStatusRequest updateEnrollmentStatusRequest)

Updates the enrollment (opt in) status of an account to the AWS Compute Optimizer service.

If the account is a master account of an organization, this operation can also enroll member accounts within the organization.

Parameters:

updateEnrollmentStatusRequest -

Returns:

Result of the UpdateEnrollmentStatus operation returned by the service.

Throws:

InternalServerException - The request processing has failed because of an unknown error, exception, or failure.

ServiceUnavailableException - The request has failed due to a temporary failure of the server.

AccessDeniedException - You do not have sufficient access to perform this action.

InvalidParameterValueException - An invalid or out-of-range value was supplied for the input parameter.

MissingAuthenticationTokenException - The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

ThrottlingException - The limit on the number of requests per second was exceeded.

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.