com.amazonaws.services.computeoptimizer

Class AWSComputeOptimizerClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.computeoptimizer.AWSComputeOptimizerClient

All Implemented Interfaces:

AWSComputeOptimizer

Direct Known Subclasses:

AWSComputeOptimizerAsyncClient

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

Client for accessing AWS Compute Optimizer. All service calls made using this client are blocking, and will not return until the service call completes.

AWS Compute Optimizer is a service that analyzes the configuration and utilization metrics of your AWS compute resources, such as EC2 instances, Auto Scaling groups, AWS Lambda functions, and Amazon EBS volumes. 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, including the required permissions to use the service, see the AWS Compute Optimizer User Guide.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.computeoptimizer.AWSComputeOptimizer

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSComputeOptimizerClientBuilder	builder()
DescribeRecommendationExportJobsResult	describeRecommendationExportJobs(DescribeRecommendationExportJobsRequest request) Describes recommendation export jobs created in the last seven days.
ExportAutoScalingGroupRecommendationsResult	exportAutoScalingGroupRecommendations(ExportAutoScalingGroupRecommendationsRequest request) Exports optimization recommendations for Auto Scaling groups.
ExportEBSVolumeRecommendationsResult	exportEBSVolumeRecommendations(ExportEBSVolumeRecommendationsRequest request) Exports optimization recommendations for Amazon EBS volumes.
ExportEC2InstanceRecommendationsResult	exportEC2InstanceRecommendations(ExportEC2InstanceRecommendationsRequest request) Exports optimization recommendations for Amazon EC2 instances.
ExportLambdaFunctionRecommendationsResult	exportLambdaFunctionRecommendations(ExportLambdaFunctionRecommendationsRequest request) Exports optimization recommendations for AWS Lambda functions.
GetAutoScalingGroupRecommendationsResult	getAutoScalingGroupRecommendations(GetAutoScalingGroupRecommendationsRequest request) 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.
GetEBSVolumeRecommendationsResult	getEBSVolumeRecommendations(GetEBSVolumeRecommendationsRequest request) Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.
GetEC2InstanceRecommendationsResult	getEC2InstanceRecommendations(GetEC2InstanceRecommendationsRequest request) Returns Amazon EC2 instance recommendations.
GetEC2RecommendationProjectedMetricsResult	getEC2RecommendationProjectedMetrics(GetEC2RecommendationProjectedMetricsRequest request) Returns the projected utilization metrics of Amazon EC2 instance recommendations.
GetEnrollmentStatusResult	getEnrollmentStatus(GetEnrollmentStatusRequest request) Returns the enrollment (opt in) status of an account to the AWS Compute Optimizer service.
GetLambdaFunctionRecommendationsResult	getLambdaFunctionRecommendations(GetLambdaFunctionRecommendationsRequest request) Returns AWS Lambda function recommendations.
GetRecommendationSummariesResult	getRecommendationSummaries(GetRecommendationSummariesRequest request) 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 request) Updates the enrollment (opt in and opt out) status of an account to the AWS Compute Optimizer service.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static AWSComputeOptimizerClientBuilder builder()

describeRecommendationExportJobs

public DescribeRecommendationExportJobsResult describeRecommendationExportJobs(DescribeRecommendationExportJobsRequest request)

Describes recommendation export jobs created in the last seven days.

Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your recommendations. Then use the DescribeRecommendationExportJobs action to view your export jobs.

Specified by:

describeRecommendationExportJobs in interface AWSComputeOptimizer

Parameters:

describeRecommendationExportJobsRequest -

Returns:

Result of the DescribeRecommendationExportJobs operation returned by the service.

Throws:

OptInRequiredException - The account is not opted in to AWS Compute Optimizer.

InternalServerException - An internal error has occurred. Try your call again.

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 - A resource that is required for the action doesn't exist.

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

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

exportAutoScalingGroupRecommendations

public ExportAutoScalingGroupRecommendationsResult exportAutoScalingGroupRecommendations(ExportAutoScalingGroupRecommendationsRequest request)

Exports optimization recommendations for Auto Scaling groups.

Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.

You can have only one Auto Scaling group export job in progress per AWS Region.

Specified by:

exportAutoScalingGroupRecommendations in interface AWSComputeOptimizer

Parameters:

exportAutoScalingGroupRecommendationsRequest -

Returns:

Result of the ExportAutoScalingGroupRecommendations operation returned by the service.

Throws:

OptInRequiredException - The account is not opted in to AWS Compute Optimizer.

InternalServerException - An internal error has occurred. Try your call again.

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 request was denied due to request throttling.

LimitExceededException - The request exceeds a limit of the service.

See Also:

AWS API Documentation

exportEBSVolumeRecommendations

public ExportEBSVolumeRecommendationsResult exportEBSVolumeRecommendations(ExportEBSVolumeRecommendationsRequest request)

Exports optimization recommendations for Amazon EBS volumes.

Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.

You can have only one Amazon EBS volume export job in progress per AWS Region.

Specified by:

exportEBSVolumeRecommendations in interface AWSComputeOptimizer

Parameters:

exportEBSVolumeRecommendationsRequest -

Returns:

Result of the ExportEBSVolumeRecommendations operation returned by the service.

Throws:

OptInRequiredException - The account is not opted in to AWS Compute Optimizer.

InternalServerException - An internal error has occurred. Try your call again.

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 request was denied due to request throttling.

LimitExceededException - The request exceeds a limit of the service.

See Also:

AWS API Documentation

exportEC2InstanceRecommendations

public ExportEC2InstanceRecommendationsResult exportEC2InstanceRecommendations(ExportEC2InstanceRecommendationsRequest request)

Exports optimization recommendations for Amazon EC2 instances.

Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.

You can have only one Amazon EC2 instance export job in progress per AWS Region.

Specified by:

exportEC2InstanceRecommendations in interface AWSComputeOptimizer

Parameters:

exportEC2InstanceRecommendationsRequest -

Returns:

Result of the ExportEC2InstanceRecommendations operation returned by the service.

Throws:

OptInRequiredException - The account is not opted in to AWS Compute Optimizer.

InternalServerException - An internal error has occurred. Try your call again.

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 request was denied due to request throttling.

LimitExceededException - The request exceeds a limit of the service.

See Also:

AWS API Documentation

exportLambdaFunctionRecommendations

public ExportLambdaFunctionRecommendationsResult exportLambdaFunctionRecommendations(ExportLambdaFunctionRecommendationsRequest request)

Exports optimization recommendations for AWS Lambda functions.

Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.

You can have only one Lambda function export job in progress per AWS Region.

Specified by:

exportLambdaFunctionRecommendations in interface AWSComputeOptimizer

Parameters:

exportLambdaFunctionRecommendationsRequest -

Returns:

Result of the ExportLambdaFunctionRecommendations operation returned by the service.

Throws:

OptInRequiredException - The account is not opted in to AWS Compute Optimizer.

InternalServerException - An internal error has occurred. Try your call again.

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 request was denied due to request throttling.

LimitExceededException - The request exceeds a limit of the service.

See Also:

AWS API Documentation

getAutoScalingGroupRecommendations

public GetAutoScalingGroupRecommendationsResult getAutoScalingGroupRecommendations(GetAutoScalingGroupRecommendationsRequest request)

Returns Auto Scaling group recommendations.

AWS Compute Optimizer generates recommendations for Amazon EC2 Auto Scaling groups that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide.

Specified by:

getAutoScalingGroupRecommendations in interface AWSComputeOptimizer

Parameters:

getAutoScalingGroupRecommendationsRequest -

Returns:

Result of the GetAutoScalingGroupRecommendations operation returned by the service.

Throws:

OptInRequiredException - The account is not opted in to AWS Compute Optimizer.

InternalServerException - An internal error has occurred. Try your call again.

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 - A resource that is required for the action doesn't exist.

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

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

getEBSVolumeRecommendations

public GetEBSVolumeRecommendationsResult getEBSVolumeRecommendations(GetEBSVolumeRecommendationsRequest request)

Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.

AWS Compute Optimizer generates recommendations for Amazon EBS volumes that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide.

Specified by:

getEBSVolumeRecommendations in interface AWSComputeOptimizer

Parameters:

getEBSVolumeRecommendationsRequest -

Returns:

Result of the GetEBSVolumeRecommendations operation returned by the service.

Throws:

OptInRequiredException - The account is not opted in to AWS Compute Optimizer.

InternalServerException - An internal error has occurred. Try your call again.

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 - A resource that is required for the action doesn't exist.

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

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

getEC2InstanceRecommendations

public GetEC2InstanceRecommendationsResult getEC2InstanceRecommendations(GetEC2InstanceRecommendationsRequest request)

Returns Amazon EC2 instance recommendations.

AWS Compute Optimizer generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide.

Specified by:

getEC2InstanceRecommendations in interface AWSComputeOptimizer

Parameters:

getEC2InstanceRecommendationsRequest -

Returns:

Result of the GetEC2InstanceRecommendations operation returned by the service.

Throws:

OptInRequiredException - The account is not opted in to AWS Compute Optimizer.

InternalServerException - An internal error has occurred. Try your call again.

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 - A resource that is required for the action doesn't exist.

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

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

getEC2RecommendationProjectedMetrics

public GetEC2RecommendationProjectedMetricsResult getEC2RecommendationProjectedMetrics(GetEC2RecommendationProjectedMetricsRequest request)

Returns the projected utilization metrics of Amazon EC2 instance recommendations.

The Cpu and Memory metrics are the only projected utilization metrics returned when you run this action. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.

Specified by:

getEC2RecommendationProjectedMetrics in interface AWSComputeOptimizer

Parameters:

getEC2RecommendationProjectedMetricsRequest -

Returns:

Result of the GetEC2RecommendationProjectedMetrics operation returned by the service.

Throws:

OptInRequiredException - The account is not opted in to AWS Compute Optimizer.

InternalServerException - An internal error has occurred. Try your call again.

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 - A resource that is required for the action doesn't exist.

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

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

getEnrollmentStatus

public GetEnrollmentStatusResult getEnrollmentStatus(GetEnrollmentStatusRequest request)

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

If the account is the management account of an organization, this action also confirms the enrollment status of member accounts within the organization.

Specified by:

getEnrollmentStatus in interface AWSComputeOptimizer

Parameters:

getEnrollmentStatusRequest -

Returns:

Result of the GetEnrollmentStatus operation returned by the service.

Throws:

InternalServerException - An internal error has occurred. Try your call again.

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 request was denied due to request throttling.

See Also:

AWS API Documentation

getLambdaFunctionRecommendations

public GetLambdaFunctionRecommendationsResult getLambdaFunctionRecommendations(GetLambdaFunctionRecommendationsRequest request)

Returns AWS Lambda function recommendations.

AWS Compute Optimizer generates recommendations for functions that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide.

Specified by:

getLambdaFunctionRecommendations in interface AWSComputeOptimizer

Parameters:

getLambdaFunctionRecommendationsRequest -

Returns:

Result of the GetLambdaFunctionRecommendations operation returned by the service.

Throws:

OptInRequiredException - The account is not opted in to AWS Compute Optimizer.

InternalServerException - An internal error has occurred. Try your call again.

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 request was denied due to request throttling.

LimitExceededException - The request exceeds a limit of the service.

See Also:

AWS API Documentation

getRecommendationSummaries

public GetRecommendationSummariesResult getRecommendationSummaries(GetRecommendationSummariesRequest request)

Returns the optimization findings for an account.

It returns the number of:

• Amazon EC2 instances in an account that are Underprovisioned, Overprovisioned, or Optimized.

• Auto Scaling groups in an account that are NotOptimized, or Optimized.

• Amazon EBS volumes in an account that are NotOptimized, or Optimized.

• Lambda functions in an account that are NotOptimized, or Optimized.

Specified by:

getRecommendationSummaries in interface AWSComputeOptimizer

Parameters:

getRecommendationSummariesRequest -

Returns:

Result of the GetRecommendationSummaries operation returned by the service.

Throws:

OptInRequiredException - The account is not opted in to AWS Compute Optimizer.

InternalServerException - An internal error has occurred. Try your call again.

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 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 AWS Compute Optimizer service.

If the account is a management account of an organization, this action can also be used to enroll member accounts within the organization.

You must have the appropriate permissions to opt in to Compute Optimizer, to view its recommendations, and to opt out. For more information, see Controlling access with AWS Identity and Access Management in the AWS Compute Optimizer User Guide.

When you opt in, Compute Optimizer automatically creates a Service-Linked Role in your account to access its data. For more information, see Using Service-Linked Roles for AWS Compute Optimizer in the AWS Compute Optimizer User Guide.

Specified by:

updateEnrollmentStatus in interface AWSComputeOptimizer

Parameters:

updateEnrollmentStatusRequest -

Returns:

Result of the UpdateEnrollmentStatus operation returned by the service.

Throws:

InternalServerException - An internal error has occurred. Try your call again.

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 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 AWSComputeOptimizer

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 class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSComputeOptimizer

Overrides:

shutdown in class AmazonWebServiceClient